diff --git a/en/ruby/resources/responses/index.md b/en/ruby/resources/responses/index.md new file mode 100644 index 0000000..f74d0bc --- /dev/null +++ b/en/ruby/resources/responses/index.md @@ -0,0 +1,118474 @@ +# Responses + +## Create a model response + +`responses.create(**kwargs) -> Response` + +**post** `/responses` + +Creates a model response. Provide [text](https://platform.openai.com/docs/guides/text) or +[image](https://platform.openai.com/docs/guides/images) inputs to generate [text](https://platform.openai.com/docs/guides/text) +or [JSON](https://platform.openai.com/docs/guides/structured-outputs) outputs. Have the model call +your own [custom code](https://platform.openai.com/docs/guides/function-calling) or use built-in +[tools](https://platform.openai.com/docs/guides/tools) like [web search](https://platform.openai.com/docs/guides/tools-web-search) +or [file search](https://platform.openai.com/docs/guides/tools-file-search) to use your own data +as input for the model's response. + +### Parameters + +- `background: bool` + + Whether to run the model response in the background. + [Learn more](https://platform.openai.com/docs/guides/background). + +- `context_management: Array[ContextManagement{ type, compact_threshold}]` + + Context management configuration for this request. + + - `type: String` + + The context management entry type. Currently only 'compaction' is supported. + + - `compact_threshold: Integer` + + Token threshold at which compaction should be triggered for this entry. + +- `conversation: String | ResponseConversationParam` + + The conversation that this response belongs to. Items from this conversation are prepended to `input_items` for this response request. + Input items and output items from this response are automatically added to this conversation after this response completes. + + - `String = String` + + The unique ID of the conversation. + + - `class ResponseConversationParam` + + The conversation that this response belongs to. + + - `id: String` + + The unique ID of the conversation. + +- `include: Array[ResponseIncludable]` + + Specify additional output data to include in the model response. Currently supported values are: + + - `web_search_call.action.sources`: Include the sources of the web search tool call. + - `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items. + - `computer_call_output.output.image_url`: Include image urls from the computer call output. + - `file_search_call.results`: Include the search results of the file search tool call. + - `message.input_image.image_url`: Include image urls from the input message. + - `message.output_text.logprobs`: Include logprobs with assistant messages. + - `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program). + + - `:"file_search_call.results"` + + - `:"web_search_call.results"` + + - `:"web_search_call.action.sources"` + + - `:"message.input_image.image_url"` + + - `:"computer_call_output.output.image_url"` + + - `:"code_interpreter_call.outputs"` + + - `:"reasoning.encrypted_content"` + + - `:"message.output_text.logprobs"` + +- `input: String | ResponseInput` + + Text, image, or file inputs to the model, used to generate a response. + + Learn more: + + - [Text inputs and outputs](https://platform.openai.com/docs/guides/text) + - [Image inputs](https://platform.openai.com/docs/guides/images) + - [File inputs](https://platform.openai.com/docs/guides/pdf-files) + - [Conversation state](https://platform.openai.com/docs/guides/conversation-state) + - [Function calling](https://platform.openai.com/docs/guides/function-calling) + + - `String = String` + + A text input to the model, equivalent to a text input with the + `user` role. + + - `ResponseInput = Array[ResponseInputItem]` + + A list of one or many input items to the model, containing + different content types. + + - `class EasyInputMessage` + + 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. + + - `content: String | ResponseInputMessageContentList` + + Text, image, or audio input to the model, used to generate a response. + Can also contain previous assistant responses. + + - `String = String` + + A text input to the model. + + - `ResponseInputMessageContentList = Array[ResponseInputContent]` + + A list of one or many input items to the model, containing different content + types. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `role: :user | :assistant | :system | :developer` + + The role of the message input. One of `user`, `assistant`, `system`, or + `developer`. + + - `:user` + + - `:assistant` + + - `:system` + + - `:developer` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `type: :message` + + The type of the message input. Always `message`. + + - `:message` + + - `class Message` + + 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. + + - `content: ResponseInputMessageContentList` + + A list of one or many input items to the model, containing different content + types. + + - `role: :user | :system | :developer` + + The role of the message input. One of `user`, `system`, or `developer`. + + - `:user` + + - `:system` + + - `:developer` + + - `status: :in_progress | :completed | :incomplete` + + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the message input. Always set to `message`. + + - `:message` + + - `class ResponseOutputMessage` + + An output message from the model. + + - `id: String` + + The unique ID of the output message. + + - `content: Array[ResponseOutputText | ResponseOutputRefusal]` + + The content of the output message. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `role: :assistant` + + The role of the output message. Always `assistant`. + + - `:assistant` + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the output message. Always `message`. + + - `:message` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `class ResponseFileSearchToolCall` + + 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. + + - `id: String` + + The unique ID of the file search tool call. + + - `queries: Array[String]` + + The queries used to search for files. + + - `status: :in_progress | :searching | :completed | 2 more` + + The status of the file search tool call. One of `in_progress`, + `searching`, `incomplete` or `failed`, + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `type: :file_search_call` + + The type of the file search tool call. Always `file_search_call`. + + - `:file_search_call` + + - `results: Array[Result{ attributes, file_id, filename, 2 more}]` + + The results of the file search tool call. + + - `attributes: Hash[Symbol, String | Float | bool]` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. Keys are strings + with a maximum length of 64 characters. Values are strings with a maximum + length of 512 characters, booleans, or numbers. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `file_id: String` + + The unique ID of the file. + + - `filename: String` + + The name of the file. + + - `score: Float` + + The relevance score of the file - a value between 0 and 1. + + - `text: String` + + The text that was retrieved from the file. + + - `class ResponseComputerToolCall` + + 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. + + - `id: String` + + The unique ID of the computer call. + + - `call_id: String` + + An identifier used when responding to the tool call with output. + + - `pending_safety_checks: Array[PendingSafetyCheck{ id, code, message}]` + + The pending safety checks for the computer call. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :computer_call` + + The type of the computer call. Always `computer_call`. + + - `:computer_call` + + - `action: Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `actions: ComputerActionList` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `class ComputerCallOutput` + + The output of a computer tool call. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `id: String` + + The ID of the computer tool call output. + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionWebSearch` + + 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. + + - `id: String` + + The unique ID of the web search tool call. + + - `action: Search{ type, queries, query, sources} | OpenPage{ type, url} | FindInPage{ pattern, type, url}` + + An object describing the specific action taken in this web search call. + Includes details on how the model used the web (search, open_page, find_in_page). + + - `class Search` + + Action type "search" - Performs a web search query. + + - `type: :search` + + The action type. + + - `:search` + + - `queries: Array[String]` + + The search queries. + + - `query: String` + + The search query. + + - `sources: Array[Source{ type, url}]` + + The sources used in the search. + + - `type: :url` + + The type of source. Always `url`. + + - `:url` + + - `url: String` + + The URL of the source. + + - `class OpenPage` + + Action type "open_page" - Opens a specific URL from search results. + + - `type: :open_page` + + The action type. + + - `:open_page` + + - `url: String` + + The URL opened by the model. + + - `class FindInPage` + + Action type "find_in_page": Searches for a pattern within a loaded page. + + - `pattern: String` + + The pattern or text to search for within the page. + + - `type: :find_in_page` + + The action type. + + - `:find_in_page` + + - `url: String` + + The URL of the page searched for the pattern. + + - `status: :in_progress | :searching | :completed | :failed` + + The status of the web search tool call. + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:failed` + + - `type: :web_search_call` + + The type of the web search tool call. Always `web_search_call`. + + - `:web_search_call` + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `arguments: String` + + A JSON string of the arguments to pass to the function. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `name: String` + + The name of the function to run. + + - `type: :function_call` + + The type of the function tool call. Always `function_call`. + + - `:function_call` + + - `id: String` + + The unique ID of the function tool call. + + - `namespace: String` + + The namespace of the function to run. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class FunctionCallOutput` + + The output of a function tool call. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | ResponseFunctionCallOutputItemList` + + Text, image, or file output of the function tool call. + + - `String = String` + + A JSON string of the output of the function tool call. + + - `ResponseFunctionCallOutputItemList = Array[ResponseFunctionCallOutputItem]` + + An array of content outputs (text, image, file) for the function tool call. + + - `class ResponseInputTextContent` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImageContent` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision) + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFileContent` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The base64-encoded data of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `id: String` + + The unique ID of the function tool call output. Populated when this item is returned via API. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ToolSearchCall` + + - `arguments: untyped` + + The arguments supplied to the tool search call. + + - `type: :tool_search_call` + + The item type. Always `tool_search_call`. + + - `:tool_search_call` + + - `id: String` + + The unique ID of this tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseToolSearchOutputItemParam` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by the tool search output. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The item type. Always `tool_search_output`. + + - `:tool_search_output` + + - `id: String` + + The unique ID of this tool search output. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class AdditionalTools` + + - `role: :developer` + + The role that provided the additional tools. Only `developer` is supported. + + - `:developer` + + - `tools: Array[Tool]` + + A list of additional tools made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The item type. Always `additional_tools`. + + - `:additional_tools` + + - `id: String` + + The unique ID of this additional tools item. + + - `class ResponseReasoningItem` + + 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). + + - `id: String` + + The unique identifier of the reasoning content. + + - `summary: Array[Summary{ text, type}]` + + Reasoning summary content. + + - `text: String` + + A summary of the reasoning output from the model so far. + + - `type: :summary_text` + + The type of the object. Always `summary_text`. + + - `:summary_text` + + - `type: :reasoning` + + The type of the object. Always `reasoning`. + + - `:reasoning` + + - `content: Array[Content{ text, type}]` + + Reasoning text content. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `encrypted_content: String` + + The encrypted content of the reasoning item - populated when a response is + generated with `reasoning.encrypted_content` in the `include` parameter. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseCompactionItemParam` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `encrypted_content: String` + + The encrypted content of the compaction summary. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `id: String` + + The ID of the compaction item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `id: String` + + The unique ID of the code interpreter tool call. + + - `code: String` + + The code to run, or null if not available. + + - `container_id: String` + + The ID of the container used to run the code. + + - `outputs: Array[Logs{ logs, type} | Image{ type, url}]` + + The outputs generated by the code interpreter, such as logs or images. + Can be null if no outputs are available. + + - `class Logs` + + The logs output from the code interpreter. + + - `logs: String` + + The logs output from the code interpreter. + + - `type: :logs` + + The type of the output. Always `logs`. + + - `:logs` + + - `class Image` + + The image output from the code interpreter. + + - `type: :image` + + The type of the output. Always `image`. + + - `:image` + + - `url: String` + + The URL of the image output from the code interpreter. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:interpreting` + + - `:failed` + + - `type: :code_interpreter_call` + + The type of the code interpreter tool call. Always `code_interpreter_call`. + + - `:code_interpreter_call` + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCall` + + A tool representing a request to execute one or more shell commands. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + Ordered shell commands for the execution environment to run. + + - `max_output_length: Integer` + + Maximum number of UTF-8 characters to capture from combined stdout and stderr output. + + - `timeout_ms: Integer` + + Maximum wall-clock time in milliseconds to allow the shell commands to run. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `environment: LocalEnvironment | ContainerReference` + + The environment to execute the shell commands in. + + - `class LocalEnvironment` + + - `class ContainerReference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCallOutput` + + The streamed output items emitted by a shell tool call. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `output: Array[ResponseFunctionShellCallOutputContent]` + + Captured chunks of stdout and stderr output, along with their associated outcomes. + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + The exit or timeout outcome associated with this shell call. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + The exit code returned by the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + Captured stderr output for the shell call. + + - `stdout: String` + + Captured stdout output for the shell call. + + - `type: :shell_call_output` + + The type of the item. Always `shell_call_output`. + + - `:shell_call_output` + + - `id: String` + + The unique ID of the shell tool call output. Populated when this item is returned via API. + + - `max_output_length: Integer` + + The maximum number of UTF-8 characters captured for this shell call's combined output. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ApplyPatchCall` + + A tool call representing a request to create, delete, or update files using diff patches. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + The specific create, delete, or update instruction for the apply_patch tool call. + + - `class CreateFile` + + Instruction for creating a new file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply when creating the file. + + - `path: String` + + Path of the file to create relative to the workspace root. + + - `type: :create_file` + + The operation type. Always `create_file`. + + - `:create_file` + + - `class DeleteFile` + + Instruction for deleting an existing file via the apply_patch tool. + + - `path: String` + + Path of the file to delete relative to the workspace root. + + - `type: :delete_file` + + The operation type. Always `delete_file`. + + - `:delete_file` + + - `class UpdateFile` + + Instruction for updating an existing file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply to the existing file. + + - `path: String` + + Path of the file to update relative to the workspace root. + + - `type: :update_file` + + The operation type. Always `update_file`. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `class ApplyPatchCallOutput` + + The streamed output emitted by an apply patch tool call. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `output: String` + + Optional human-readable log text from the apply patch tool (e.g., patch results or errors). + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `id: String` + + The unique ID of the approval response + + - `reason: String` + + Optional reason for the decision. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class ResponseCustomToolCallOutput` + + The output of a custom tool call from your code, being sent back to the model. + + - `call_id: String` + + The call ID, used to map this custom tool call output to a custom tool call. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the custom tool call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the custom tool call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :custom_tool_call_output` + + The type of the custom tool call output. Always `custom_tool_call_output`. + + - `:custom_tool_call_output` + + - `id: String` + + The unique ID of the custom tool call output in the OpenAI platform. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `call_id: String` + + An identifier used to map this custom tool call to a tool call output. + + - `input: String` + + The input for the custom tool call generated by the model. + + - `name: String` + + The name of the custom tool being called. + + - `type: :custom_tool_call` + + The type of the custom tool call. Always `custom_tool_call`. + + - `:custom_tool_call` + + - `id: String` + + The unique ID of the custom tool call in the OpenAI platform. + + - `namespace: String` + + The namespace of the custom tool being called. + + - `class CompactionTrigger` + + Compacts the current context. Must be the final input item. + + - `type: :compaction_trigger` + + The type of the item. Always `compaction_trigger`. + + - `:compaction_trigger` + + - `class ItemReference` + + An internal identifier for an item to reference. + + - `id: String` + + The ID of the item to reference. + + - `type: :item_reference` + + The type of item to reference. Always `item_reference`. + + - `:item_reference` + +- `instructions: String` + + A system (or developer) message inserted into the model's context. + + When using along with `previous_response_id`, the instructions from a previous + response will not be carried over to the next response. This makes it simple + to swap out system (or developer) messages in new responses. + +- `max_output_tokens: Integer` + + An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://platform.openai.com/docs/guides/reasoning). + +- `max_tool_calls: Integer` + + 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: Metadata` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. + + Keys are strings with a maximum length of 64 characters. Values are strings + with a maximum length of 512 characters. + +- `model: ResponsesModel` + + Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI + offers a wide range of models with different capabilities, performance + characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) + to browse and compare available models. + + - `String = String` + + - `ChatModel = :"gpt-5.4" | :"gpt-5.4-mini" | :"gpt-5.4-nano" | 75 more` + + - `:"gpt-5.4"` + + - `:"gpt-5.4-mini"` + + - `:"gpt-5.4-nano"` + + - `:"gpt-5.4-mini-2026-03-17"` + + - `:"gpt-5.4-nano-2026-03-17"` + + - `:"gpt-5.3-chat-latest"` + + - `:"gpt-5.2"` + + - `:"gpt-5.2-2025-12-11"` + + - `:"gpt-5.2-chat-latest"` + + - `:"gpt-5.2-pro"` + + - `:"gpt-5.2-pro-2025-12-11"` + + - `:"gpt-5.1"` + + - `:"gpt-5.1-2025-11-13"` + + - `:"gpt-5.1-codex"` + + - `:"gpt-5.1-mini"` + + - `:"gpt-5.1-chat-latest"` + + - `:"gpt-5"` + + - `:"gpt-5-mini"` + + - `:"gpt-5-nano"` + + - `:"gpt-5-2025-08-07"` + + - `:"gpt-5-mini-2025-08-07"` + + - `:"gpt-5-nano-2025-08-07"` + + - `:"gpt-5-chat-latest"` + + - `:"gpt-4.1"` + + - `:"gpt-4.1-mini"` + + - `:"gpt-4.1-nano"` + + - `:"gpt-4.1-2025-04-14"` + + - `:"gpt-4.1-mini-2025-04-14"` + + - `:"gpt-4.1-nano-2025-04-14"` + + - `:"o4-mini"` + + - `:"o4-mini-2025-04-16"` + + - `:o3` + + - `:"o3-2025-04-16"` + + - `:"o3-mini"` + + - `:"o3-mini-2025-01-31"` + + - `:o1` + + - `:"o1-2024-12-17"` + + - `:"o1-preview"` + + - `:"o1-preview-2024-09-12"` + + - `:"o1-mini"` + + - `:"o1-mini-2024-09-12"` + + - `:"gpt-4o"` + + - `:"gpt-4o-2024-11-20"` + + - `:"gpt-4o-2024-08-06"` + + - `:"gpt-4o-2024-05-13"` + + - `:"gpt-4o-audio-preview"` + + - `:"gpt-4o-audio-preview-2024-10-01"` + + - `:"gpt-4o-audio-preview-2024-12-17"` + + - `:"gpt-4o-audio-preview-2025-06-03"` + + - `:"gpt-4o-mini-audio-preview"` + + - `:"gpt-4o-mini-audio-preview-2024-12-17"` + + - `:"gpt-4o-search-preview"` + + - `:"gpt-4o-mini-search-preview"` + + - `:"gpt-4o-search-preview-2025-03-11"` + + - `:"gpt-4o-mini-search-preview-2025-03-11"` + + - `:"chatgpt-4o-latest"` + + - `:"codex-mini-latest"` + + - `:"gpt-4o-mini"` + + - `:"gpt-4o-mini-2024-07-18"` + + - `:"gpt-4-turbo"` + + - `:"gpt-4-turbo-2024-04-09"` + + - `:"gpt-4-0125-preview"` + + - `:"gpt-4-turbo-preview"` + + - `:"gpt-4-1106-preview"` + + - `:"gpt-4-vision-preview"` + + - `:"gpt-4"` + + - `:"gpt-4-0314"` + + - `:"gpt-4-0613"` + + - `:"gpt-4-32k"` + + - `:"gpt-4-32k-0314"` + + - `:"gpt-4-32k-0613"` + + - `:"gpt-3.5-turbo"` + + - `:"gpt-3.5-turbo-16k"` + + - `:"gpt-3.5-turbo-0301"` + + - `:"gpt-3.5-turbo-0613"` + + - `:"gpt-3.5-turbo-1106"` + + - `:"gpt-3.5-turbo-0125"` + + - `:"gpt-3.5-turbo-16k-0613"` + + - `ResponsesOnlyModel = :"o1-pro" | :"o1-pro-2025-03-19" | :"o3-pro" | 11 more` + + - `:"o1-pro"` + + - `:"o1-pro-2025-03-19"` + + - `:"o3-pro"` + + - `:"o3-pro-2025-06-10"` + + - `:"o3-deep-research"` + + - `:"o3-deep-research-2025-06-26"` + + - `:"o4-mini-deep-research"` + + - `:"o4-mini-deep-research-2025-06-26"` + + - `:"computer-use-preview"` + + - `:"computer-use-preview-2025-03-11"` + + - `:"gpt-5-codex"` + + - `:"gpt-5-pro"` + + - `:"gpt-5-pro-2025-10-06"` + + - `:"gpt-5.1-codex-max"` + +- `moderation: Moderation{ model}` + + Configuration for running moderation on the input and output of this response. + + - `model: String` + + The moderation model to use for moderated completions, e.g. 'omni-moderation-latest'. + +- `parallel_tool_calls: bool` + + Whether to allow the model to run tool calls in parallel. + +- `previous_response_id: String` + + The unique ID of the previous response to the model. Use this to + create multi-turn conversations. Learn more about + [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. + +- `prompt: ResponsePrompt` + + Reference to a prompt template and its variables. + [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts). + + - `id: String` + + The unique identifier of the prompt template to use. + + - `variables: Hash[Symbol, String | ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Optional map of values to substitute in for variables in your + prompt. The substitution values can either be strings, or other + Response input types like images or files. + + - `String = String` + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `version: String` + + Optional version of the prompt template. + +- `prompt_cache_key: String` + + Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://platform.openai.com/docs/guides/prompt-caching). + +- `prompt_cache_retention: :in_memory | :"24h"` + + The retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention). + For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported. + + For older models that support both `in_memory` and `24h`, the default depends on your organization's data retention policy: + + - Organizations without ZDR enabled default to `24h`. + - Organizations with ZDR enabled default to `in_memory` when `prompt_cache_retention` is not specified. + + - `:in_memory` + + - `:"24h"` + +- `reasoning: Reasoning` + + **gpt-5 and o-series models only** + + Configuration options for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + + - `effort: ReasoningEffort` + + Constrains effort on reasoning for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing + reasoning effort can result in faster responses and fewer tokens used + on reasoning in a response. + + - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1. + - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. + - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. + - `xhigh` is supported for all models after `gpt-5.1-codex-max`. + + - `:none` + + - `:minimal` + + - `:low` + + - `:medium` + + - `:high` + + - `:xhigh` + + - `generate_summary: :auto | :concise | :detailed` + + **Deprecated:** use `summary` instead. + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `summary: :auto | :concise | :detailed` + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + `concise` is supported for `computer-use-preview` models and all reasoning models after `gpt-5`. + + - `:auto` + + - `:concise` + + - `:detailed` + +- `safety_identifier: String` + + A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + +- `service_tier: :auto | :default | :flex | 2 more` + + Specifies the processing type used for serving the request. + + - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. + - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. + - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier. + - When not set, the default behavior is 'auto'. + + When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter. + + - `:auto` + + - `:default` + + - `:flex` + + - `:scale` + + - `:priority` + +- `store: bool` + + Whether to store the generated model response for later retrieval via + API. + +- `stream: bool` + + If set to true, the model response data will be streamed to the client + as it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format). + See the [Streaming section below](https://platform.openai.com/docs/api-reference/responses-streaming) + for more information. + +- `stream_options: StreamOptions{ include_obfuscation}` + + Options for streaming responses. Only set this when you set `stream: true`. + + - `include_obfuscation: bool` + + When true, stream obfuscation will be enabled. Stream obfuscation adds + random characters to an `obfuscation` field on streaming delta events to + normalize payload sizes as a mitigation to certain side-channel attacks. + These obfuscation fields are included by default, but add a small amount + of overhead to the data stream. You can set `include_obfuscation` to + false to optimize for bandwidth if you trust the network links between + your application and the OpenAI API. + +- `temperature: Float` + + 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. + +- `text: ResponseTextConfig` + + 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) + + - `format_: ResponseFormatTextConfig` + + An object specifying the format that the model must output. + + Configuring `{ "type": "json_schema" }` enables Structured Outputs, + which ensures the model will match your supplied JSON schema. Learn more in the + [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). + + The default format is `{ "type": "text" }` with no additional options. + + **Not recommended for gpt-4o and newer models:** + + Setting to `{ "type": "json_object" }` enables the older JSON mode, which + ensures the message the model generates is valid JSON. Using `json_schema` + is preferred for models that support it. + + - `class ResponseFormatText` + + Default response format. Used to generate text responses. + + - `type: :text` + + The type of response format being defined. Always `text`. + + - `:text` + + - `class ResponseFormatTextJSONSchemaConfig` + + JSON Schema response format. Used to generate structured JSON responses. + Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). + + - `name: String` + + The name of the response format. Must be a-z, A-Z, 0-9, or contain + underscores and dashes, with a maximum length of 64. + + - `schema: Hash[Symbol, untyped]` + + The schema for the response format, described as a JSON Schema object. + Learn how to build JSON schemas [here](https://json-schema.org/). + + - `type: :json_schema` + + The type of response format being defined. Always `json_schema`. + + - `:json_schema` + + - `description: String` + + A description of what the response format is for, used by the model to + determine how to respond in the format. + + - `strict: bool` + + Whether to enable strict schema adherence when generating the output. + If set to true, the model will always follow the exact schema defined + in the `schema` field. Only a subset of JSON Schema is supported when + `strict` is `true`. To learn more, read the [Structured Outputs + guide](https://platform.openai.com/docs/guides/structured-outputs). + + - `class ResponseFormatJSONObject` + + 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. + + - `type: :json_object` + + The type of response format being defined. Always `json_object`. + + - `:json_object` + + - `verbosity: :low | :medium | :high` + + Constrains the verbosity of the model's response. Lower values will result in + more concise responses, while higher values will result in more verbose responses. + Currently supported values are `low`, `medium`, and `high`. + + - `:low` + + - `:medium` + + - `:high` + +- `tool_choice: ToolChoiceOptions | ToolChoiceAllowed | ToolChoiceTypes | 5 more` + + How the model should select which tool (or tools) to use when generating + a response. See the `tools` parameter to see how to specify which tools + the model can call. + + - `ToolChoiceOptions = :none | :auto | :required` + + Controls which (if any) tool is called by the model. + + `none` means the model will not call any tool and instead generates a message. + + `auto` means the model can pick between generating a message or calling one or + more tools. + + `required` means the model must call one or more tools. + + - `:none` + + - `:auto` + + - `:required` + + - `class ToolChoiceAllowed` + + Constrains the tools available to the model to a pre-defined set. + + - `mode: :auto | :required` + + Constrains the tools available to the model to a pre-defined set. + + `auto` allows the model to pick from among the allowed tools and generate a + message. + + `required` requires the model to call one or more of the allowed tools. + + - `:auto` + + - `:required` + + - `tools: Array[Hash[Symbol, untyped]]` + + A list of tool definitions that the model should be allowed to call. + + For the Responses API, the list of tool definitions might look like: + + ```json + [ + { "type": "function", "name": "get_weather" }, + { "type": "mcp", "server_label": "deepwiki" }, + { "type": "image_generation" } + ] + ``` + + - `type: :allowed_tools` + + Allowed tool configuration type. Always `allowed_tools`. + + - `:allowed_tools` + + - `class ToolChoiceTypes` + + 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). + + - `type: :file_search | :web_search_preview | :computer | 5 more` + + The type of hosted tool the model should to use. Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + + Allowed values are: + + - `file_search` + - `web_search_preview` + - `computer` + - `computer_use_preview` + - `computer_use` + - `code_interpreter` + - `image_generation` + + - `:file_search` + + - `:web_search_preview` + + - `:computer` + + - `:computer_use_preview` + + - `:computer_use` + + - `:web_search_preview_2025_03_11` + + - `:image_generation` + + - `:code_interpreter` + + - `class ToolChoiceFunction` + + Use this option to force the model to call a specific function. + + - `name: String` + + The name of the function to call. + + - `type: :function` + + For function calling, the type is always `function`. + + - `:function` + + - `class ToolChoiceMcp` + + Use this option to force the model to call a specific tool on a remote MCP server. + + - `server_label: String` + + The label of the MCP server to use. + + - `type: :mcp` + + For MCP tools, the type is always `mcp`. + + - `:mcp` + + - `name: String` + + The name of the tool to call on the server. + + - `class ToolChoiceCustom` + + Use this option to force the model to call a specific custom tool. + + - `name: String` + + The name of the custom tool to call. + + - `type: :custom` + + For custom tool calling, the type is always `custom`. + + - `:custom` + + - `class ToolChoiceApplyPatch` + + Forces the model to call the apply_patch tool when executing a tool call. + + - `type: :apply_patch` + + The tool to call. Always `apply_patch`. + + - `:apply_patch` + + - `class ToolChoiceShell` + + Forces the model to call the shell tool when a tool call is required. + + - `type: :shell` + + The tool to call. Always `shell`. + + - `:shell` + +- `tools: Array[Tool]` + + An array of tools the model may call while generating a response. You + can specify which tool to use by setting the `tool_choice` parameter. + + We support the following categories of tools: + + - **Built-in tools**: Tools that are provided by OpenAI that extend the + model's capabilities, like [web search](https://platform.openai.com/docs/guides/tools-web-search) + or [file search](https://platform.openai.com/docs/guides/tools-file-search). Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + - **MCP Tools**: Integrations with third-party systems via custom MCP servers + or predefined connectors such as Google Drive and SharePoint. Learn more about + [MCP Tools](https://platform.openai.com/docs/guides/tools-connectors-mcp). + - **Function calls (custom tools)**: Functions that are defined by you, + enabling the model to call your own code with strongly typed arguments + and outputs. Learn more about + [function calling](https://platform.openai.com/docs/guides/function-calling). You can also use + custom tools to call your own code. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + +- `top_logprobs: Integer` + + An integer between 0 and 20 specifying the maximum number of most likely + tokens to return at each token position, each with an associated log + probability. In some cases, the number of returned tokens may be fewer than + requested. + +- `top_p: Float` + + 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: :auto | :disabled` + + The truncation strategy to use for the model response. + + - `auto`: If the input to this Response exceeds + the model's context window size, the model will truncate the + response to fit the context window by dropping items from the beginning of the conversation. + - `disabled` (default): If the input size will exceed the context window + size for a model, the request will fail with a 400 error. + + - `:auto` + + - `:disabled` + +- `user: String` + + This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. + A stable identifier for your end-users. + Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + +### Returns + +- `class Response` + + - `id: String` + + Unique identifier for this Response. + + - `created_at: Float` + + Unix timestamp (in seconds) of when this Response was created. + + - `error: ResponseError` + + An error object returned when the model fails to generate a Response. + + - `code: :server_error | :rate_limit_exceeded | :invalid_prompt | 15 more` + + The error code for the response. + + - `: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` + + - `message: String` + + A human-readable description of the error. + + - `incomplete_details: IncompleteDetails{ reason}` + + Details about why the response is incomplete. + + - `reason: :max_output_tokens | :content_filter` + + The reason why the response is incomplete. + + - `:max_output_tokens` + + - `:content_filter` + + - `instructions: String | Array[ResponseInputItem]` + + A system (or developer) message inserted into the model's context. + + When using along with `previous_response_id`, the instructions from a previous + response will not be carried over to the next response. This makes it simple + to swap out system (or developer) messages in new responses. + + - `String = String` + + A text input to the model, equivalent to a text input with the + `developer` role. + + - `InputItemList = Array[ResponseInputItem]` + + A list of one or many input items to the model, containing + different content types. + + - `class EasyInputMessage` + + 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. + + - `content: String | ResponseInputMessageContentList` + + Text, image, or audio input to the model, used to generate a response. + Can also contain previous assistant responses. + + - `String = String` + + A text input to the model. + + - `ResponseInputMessageContentList = Array[ResponseInputContent]` + + A list of one or many input items to the model, containing different content + types. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `role: :user | :assistant | :system | :developer` + + The role of the message input. One of `user`, `assistant`, `system`, or + `developer`. + + - `:user` + + - `:assistant` + + - `:system` + + - `:developer` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `type: :message` + + The type of the message input. Always `message`. + + - `:message` + + - `class Message` + + 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. + + - `content: ResponseInputMessageContentList` + + A list of one or many input items to the model, containing different content + types. + + - `role: :user | :system | :developer` + + The role of the message input. One of `user`, `system`, or `developer`. + + - `:user` + + - `:system` + + - `:developer` + + - `status: :in_progress | :completed | :incomplete` + + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the message input. Always set to `message`. + + - `:message` + + - `class ResponseOutputMessage` + + An output message from the model. + + - `id: String` + + The unique ID of the output message. + + - `content: Array[ResponseOutputText | ResponseOutputRefusal]` + + The content of the output message. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `role: :assistant` + + The role of the output message. Always `assistant`. + + - `:assistant` + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the output message. Always `message`. + + - `:message` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `class ResponseFileSearchToolCall` + + 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. + + - `id: String` + + The unique ID of the file search tool call. + + - `queries: Array[String]` + + The queries used to search for files. + + - `status: :in_progress | :searching | :completed | 2 more` + + The status of the file search tool call. One of `in_progress`, + `searching`, `incomplete` or `failed`, + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `type: :file_search_call` + + The type of the file search tool call. Always `file_search_call`. + + - `:file_search_call` + + - `results: Array[Result{ attributes, file_id, filename, 2 more}]` + + The results of the file search tool call. + + - `attributes: Hash[Symbol, String | Float | bool]` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. Keys are strings + with a maximum length of 64 characters. Values are strings with a maximum + length of 512 characters, booleans, or numbers. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `file_id: String` + + The unique ID of the file. + + - `filename: String` + + The name of the file. + + - `score: Float` + + The relevance score of the file - a value between 0 and 1. + + - `text: String` + + The text that was retrieved from the file. + + - `class ResponseComputerToolCall` + + 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. + + - `id: String` + + The unique ID of the computer call. + + - `call_id: String` + + An identifier used when responding to the tool call with output. + + - `pending_safety_checks: Array[PendingSafetyCheck{ id, code, message}]` + + The pending safety checks for the computer call. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :computer_call` + + The type of the computer call. Always `computer_call`. + + - `:computer_call` + + - `action: Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `actions: ComputerActionList` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `class ComputerCallOutput` + + The output of a computer tool call. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `id: String` + + The ID of the computer tool call output. + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionWebSearch` + + 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. + + - `id: String` + + The unique ID of the web search tool call. + + - `action: Search{ type, queries, query, sources} | OpenPage{ type, url} | FindInPage{ pattern, type, url}` + + An object describing the specific action taken in this web search call. + Includes details on how the model used the web (search, open_page, find_in_page). + + - `class Search` + + Action type "search" - Performs a web search query. + + - `type: :search` + + The action type. + + - `:search` + + - `queries: Array[String]` + + The search queries. + + - `query: String` + + The search query. + + - `sources: Array[Source{ type, url}]` + + The sources used in the search. + + - `type: :url` + + The type of source. Always `url`. + + - `:url` + + - `url: String` + + The URL of the source. + + - `class OpenPage` + + Action type "open_page" - Opens a specific URL from search results. + + - `type: :open_page` + + The action type. + + - `:open_page` + + - `url: String` + + The URL opened by the model. + + - `class FindInPage` + + Action type "find_in_page": Searches for a pattern within a loaded page. + + - `pattern: String` + + The pattern or text to search for within the page. + + - `type: :find_in_page` + + The action type. + + - `:find_in_page` + + - `url: String` + + The URL of the page searched for the pattern. + + - `status: :in_progress | :searching | :completed | :failed` + + The status of the web search tool call. + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:failed` + + - `type: :web_search_call` + + The type of the web search tool call. Always `web_search_call`. + + - `:web_search_call` + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `arguments: String` + + A JSON string of the arguments to pass to the function. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `name: String` + + The name of the function to run. + + - `type: :function_call` + + The type of the function tool call. Always `function_call`. + + - `:function_call` + + - `id: String` + + The unique ID of the function tool call. + + - `namespace: String` + + The namespace of the function to run. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class FunctionCallOutput` + + The output of a function tool call. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | ResponseFunctionCallOutputItemList` + + Text, image, or file output of the function tool call. + + - `String = String` + + A JSON string of the output of the function tool call. + + - `ResponseFunctionCallOutputItemList = Array[ResponseFunctionCallOutputItem]` + + An array of content outputs (text, image, file) for the function tool call. + + - `class ResponseInputTextContent` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImageContent` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision) + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFileContent` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The base64-encoded data of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `id: String` + + The unique ID of the function tool call output. Populated when this item is returned via API. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ToolSearchCall` + + - `arguments: untyped` + + The arguments supplied to the tool search call. + + - `type: :tool_search_call` + + The item type. Always `tool_search_call`. + + - `:tool_search_call` + + - `id: String` + + The unique ID of this tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseToolSearchOutputItemParam` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by the tool search output. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The item type. Always `tool_search_output`. + + - `:tool_search_output` + + - `id: String` + + The unique ID of this tool search output. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class AdditionalTools` + + - `role: :developer` + + The role that provided the additional tools. Only `developer` is supported. + + - `:developer` + + - `tools: Array[Tool]` + + A list of additional tools made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The item type. Always `additional_tools`. + + - `:additional_tools` + + - `id: String` + + The unique ID of this additional tools item. + + - `class ResponseReasoningItem` + + 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). + + - `id: String` + + The unique identifier of the reasoning content. + + - `summary: Array[Summary{ text, type}]` + + Reasoning summary content. + + - `text: String` + + A summary of the reasoning output from the model so far. + + - `type: :summary_text` + + The type of the object. Always `summary_text`. + + - `:summary_text` + + - `type: :reasoning` + + The type of the object. Always `reasoning`. + + - `:reasoning` + + - `content: Array[Content{ text, type}]` + + Reasoning text content. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `encrypted_content: String` + + The encrypted content of the reasoning item - populated when a response is + generated with `reasoning.encrypted_content` in the `include` parameter. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseCompactionItemParam` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `encrypted_content: String` + + The encrypted content of the compaction summary. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `id: String` + + The ID of the compaction item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `id: String` + + The unique ID of the code interpreter tool call. + + - `code: String` + + The code to run, or null if not available. + + - `container_id: String` + + The ID of the container used to run the code. + + - `outputs: Array[Logs{ logs, type} | Image{ type, url}]` + + The outputs generated by the code interpreter, such as logs or images. + Can be null if no outputs are available. + + - `class Logs` + + The logs output from the code interpreter. + + - `logs: String` + + The logs output from the code interpreter. + + - `type: :logs` + + The type of the output. Always `logs`. + + - `:logs` + + - `class Image` + + The image output from the code interpreter. + + - `type: :image` + + The type of the output. Always `image`. + + - `:image` + + - `url: String` + + The URL of the image output from the code interpreter. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:interpreting` + + - `:failed` + + - `type: :code_interpreter_call` + + The type of the code interpreter tool call. Always `code_interpreter_call`. + + - `:code_interpreter_call` + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCall` + + A tool representing a request to execute one or more shell commands. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + Ordered shell commands for the execution environment to run. + + - `max_output_length: Integer` + + Maximum number of UTF-8 characters to capture from combined stdout and stderr output. + + - `timeout_ms: Integer` + + Maximum wall-clock time in milliseconds to allow the shell commands to run. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `environment: LocalEnvironment | ContainerReference` + + The environment to execute the shell commands in. + + - `class LocalEnvironment` + + - `class ContainerReference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCallOutput` + + The streamed output items emitted by a shell tool call. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `output: Array[ResponseFunctionShellCallOutputContent]` + + Captured chunks of stdout and stderr output, along with their associated outcomes. + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + The exit or timeout outcome associated with this shell call. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + The exit code returned by the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + Captured stderr output for the shell call. + + - `stdout: String` + + Captured stdout output for the shell call. + + - `type: :shell_call_output` + + The type of the item. Always `shell_call_output`. + + - `:shell_call_output` + + - `id: String` + + The unique ID of the shell tool call output. Populated when this item is returned via API. + + - `max_output_length: Integer` + + The maximum number of UTF-8 characters captured for this shell call's combined output. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ApplyPatchCall` + + A tool call representing a request to create, delete, or update files using diff patches. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + The specific create, delete, or update instruction for the apply_patch tool call. + + - `class CreateFile` + + Instruction for creating a new file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply when creating the file. + + - `path: String` + + Path of the file to create relative to the workspace root. + + - `type: :create_file` + + The operation type. Always `create_file`. + + - `:create_file` + + - `class DeleteFile` + + Instruction for deleting an existing file via the apply_patch tool. + + - `path: String` + + Path of the file to delete relative to the workspace root. + + - `type: :delete_file` + + The operation type. Always `delete_file`. + + - `:delete_file` + + - `class UpdateFile` + + Instruction for updating an existing file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply to the existing file. + + - `path: String` + + Path of the file to update relative to the workspace root. + + - `type: :update_file` + + The operation type. Always `update_file`. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `class ApplyPatchCallOutput` + + The streamed output emitted by an apply patch tool call. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `output: String` + + Optional human-readable log text from the apply patch tool (e.g., patch results or errors). + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `id: String` + + The unique ID of the approval response + + - `reason: String` + + Optional reason for the decision. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class ResponseCustomToolCallOutput` + + The output of a custom tool call from your code, being sent back to the model. + + - `call_id: String` + + The call ID, used to map this custom tool call output to a custom tool call. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the custom tool call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the custom tool call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :custom_tool_call_output` + + The type of the custom tool call output. Always `custom_tool_call_output`. + + - `:custom_tool_call_output` + + - `id: String` + + The unique ID of the custom tool call output in the OpenAI platform. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `call_id: String` + + An identifier used to map this custom tool call to a tool call output. + + - `input: String` + + The input for the custom tool call generated by the model. + + - `name: String` + + The name of the custom tool being called. + + - `type: :custom_tool_call` + + The type of the custom tool call. Always `custom_tool_call`. + + - `:custom_tool_call` + + - `id: String` + + The unique ID of the custom tool call in the OpenAI platform. + + - `namespace: String` + + The namespace of the custom tool being called. + + - `class CompactionTrigger` + + Compacts the current context. Must be the final input item. + + - `type: :compaction_trigger` + + The type of the item. Always `compaction_trigger`. + + - `:compaction_trigger` + + - `class ItemReference` + + An internal identifier for an item to reference. + + - `id: String` + + The ID of the item to reference. + + - `type: :item_reference` + + The type of item to reference. Always `item_reference`. + + - `:item_reference` + + - `metadata: Metadata` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. + + Keys are strings with a maximum length of 64 characters. Values are strings + with a maximum length of 512 characters. + + - `model: ResponsesModel` + + Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI + offers a wide range of models with different capabilities, performance + characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) + to browse and compare available models. + + - `String = String` + + - `ChatModel = :"gpt-5.4" | :"gpt-5.4-mini" | :"gpt-5.4-nano" | 75 more` + + - `:"gpt-5.4"` + + - `:"gpt-5.4-mini"` + + - `:"gpt-5.4-nano"` + + - `:"gpt-5.4-mini-2026-03-17"` + + - `:"gpt-5.4-nano-2026-03-17"` + + - `:"gpt-5.3-chat-latest"` + + - `:"gpt-5.2"` + + - `:"gpt-5.2-2025-12-11"` + + - `:"gpt-5.2-chat-latest"` + + - `:"gpt-5.2-pro"` + + - `:"gpt-5.2-pro-2025-12-11"` + + - `:"gpt-5.1"` + + - `:"gpt-5.1-2025-11-13"` + + - `:"gpt-5.1-codex"` + + - `:"gpt-5.1-mini"` + + - `:"gpt-5.1-chat-latest"` + + - `:"gpt-5"` + + - `:"gpt-5-mini"` + + - `:"gpt-5-nano"` + + - `:"gpt-5-2025-08-07"` + + - `:"gpt-5-mini-2025-08-07"` + + - `:"gpt-5-nano-2025-08-07"` + + - `:"gpt-5-chat-latest"` + + - `:"gpt-4.1"` + + - `:"gpt-4.1-mini"` + + - `:"gpt-4.1-nano"` + + - `:"gpt-4.1-2025-04-14"` + + - `:"gpt-4.1-mini-2025-04-14"` + + - `:"gpt-4.1-nano-2025-04-14"` + + - `:"o4-mini"` + + - `:"o4-mini-2025-04-16"` + + - `:o3` + + - `:"o3-2025-04-16"` + + - `:"o3-mini"` + + - `:"o3-mini-2025-01-31"` + + - `:o1` + + - `:"o1-2024-12-17"` + + - `:"o1-preview"` + + - `:"o1-preview-2024-09-12"` + + - `:"o1-mini"` + + - `:"o1-mini-2024-09-12"` + + - `:"gpt-4o"` + + - `:"gpt-4o-2024-11-20"` + + - `:"gpt-4o-2024-08-06"` + + - `:"gpt-4o-2024-05-13"` + + - `:"gpt-4o-audio-preview"` + + - `:"gpt-4o-audio-preview-2024-10-01"` + + - `:"gpt-4o-audio-preview-2024-12-17"` + + - `:"gpt-4o-audio-preview-2025-06-03"` + + - `:"gpt-4o-mini-audio-preview"` + + - `:"gpt-4o-mini-audio-preview-2024-12-17"` + + - `:"gpt-4o-search-preview"` + + - `:"gpt-4o-mini-search-preview"` + + - `:"gpt-4o-search-preview-2025-03-11"` + + - `:"gpt-4o-mini-search-preview-2025-03-11"` + + - `:"chatgpt-4o-latest"` + + - `:"codex-mini-latest"` + + - `:"gpt-4o-mini"` + + - `:"gpt-4o-mini-2024-07-18"` + + - `:"gpt-4-turbo"` + + - `:"gpt-4-turbo-2024-04-09"` + + - `:"gpt-4-0125-preview"` + + - `:"gpt-4-turbo-preview"` + + - `:"gpt-4-1106-preview"` + + - `:"gpt-4-vision-preview"` + + - `:"gpt-4"` + + - `:"gpt-4-0314"` + + - `:"gpt-4-0613"` + + - `:"gpt-4-32k"` + + - `:"gpt-4-32k-0314"` + + - `:"gpt-4-32k-0613"` + + - `:"gpt-3.5-turbo"` + + - `:"gpt-3.5-turbo-16k"` + + - `:"gpt-3.5-turbo-0301"` + + - `:"gpt-3.5-turbo-0613"` + + - `:"gpt-3.5-turbo-1106"` + + - `:"gpt-3.5-turbo-0125"` + + - `:"gpt-3.5-turbo-16k-0613"` + + - `ResponsesOnlyModel = :"o1-pro" | :"o1-pro-2025-03-19" | :"o3-pro" | 11 more` + + - `:"o1-pro"` + + - `:"o1-pro-2025-03-19"` + + - `:"o3-pro"` + + - `:"o3-pro-2025-06-10"` + + - `:"o3-deep-research"` + + - `:"o3-deep-research-2025-06-26"` + + - `:"o4-mini-deep-research"` + + - `:"o4-mini-deep-research-2025-06-26"` + + - `:"computer-use-preview"` + + - `:"computer-use-preview-2025-03-11"` + + - `:"gpt-5-codex"` + + - `:"gpt-5-pro"` + + - `:"gpt-5-pro-2025-10-06"` + + - `:"gpt-5.1-codex-max"` + + - `object: :response` + + The object type of this resource - always set to `response`. + + - `:response` + + - `output: Array[ResponseOutputItem]` + + An array of content items generated by the model. + + - The length and order of items in the `output` array is dependent + on the model's response. + - Rather than accessing the first item in the `output` array and + assuming it's an `assistant` message with the content generated by + the model, you might consider using the `output_text` property where + supported in SDKs. + + - `class ResponseOutputMessage` + + An output message from the model. + + - `class ResponseFileSearchToolCall` + + 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. + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `class ResponseFunctionToolCallOutputItem` + + - `id: String` + + The unique ID of the function call tool output. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the function call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the function call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the function call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseFunctionWebSearch` + + 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. + + - `class ResponseComputerToolCall` + + 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. + + - `class ResponseComputerToolCallOutputItem` + + - `id: String` + + The unique ID of the computer call tool output. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `status: :completed | :incomplete | :failed | :in_progress` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `:in_progress` + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the + developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseReasoningItem` + + 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). + + - `class ResponseToolSearchCall` + + - `id: String` + + The unique ID of the tool search call item. + + - `arguments: untyped` + + Arguments used for the tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :tool_search_call` + + The type of the item. Always `tool_search_call`. + + - `:tool_search_call` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseToolSearchOutputItem` + + - `id: String` + + The unique ID of the tool search output item. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by tool search. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :tool_search_output` + + The type of the item. Always `tool_search_output`. + + - `:tool_search_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class AdditionalTools` + + - `id: String` + + The unique ID of the additional tools item. + + - `role: :unknown | :user | :assistant | 5 more` + + The role that provided the additional tools. + + - `:unknown` + + - `:user` + + - `:assistant` + + - `:system` + + - `:critic` + + - `:discriminator` + + - `:developer` + + - `:tool` + + - `tools: Array[Tool]` + + The additional tool definitions made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The type of the item. Always `additional_tools`. + + - `:additional_tools` + + - `class ResponseCompactionItem` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `id: String` + + The unique ID of the compaction item. + + - `encrypted_content: String` + + The encrypted content that was produced by compaction. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionShellToolCall` + + A tool call that executes one or more shell commands in a managed environment. + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + - `max_output_length: Integer` + + Optional maximum number of characters to return from each command. + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the commands. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `environment: ResponseLocalEnvironment | ResponseContainerReference` + + Represents the use of a local environment to perform shell actions. + + - `class ResponseLocalEnvironment` + + Represents the use of a local environment to perform shell actions. + + - `type: :local` + + The environment type. Always `local`. + + - `:local` + + - `class ResponseContainerReference` + + Represents a container created with /v1/containers. + + - `container_id: String` + + - `type: :container_reference` + + The environment type. Always `container_reference`. + + - `:container_reference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseFunctionShellToolCallOutput` + + The output of a shell tool call that was emitted. + + - `id: String` + + The unique ID of the shell call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `max_output_length: Integer` + + The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output. + + - `output: Array[Output{ outcome, stderr, stdout, created_by}]` + + An array of shell call output contents + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + Exit code from the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + The standard error output that was captured. + + - `stdout: String` + + The standard output that was captured. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call_output` + + The type of the shell call output. Always `shell_call_output`. + + - `:shell_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseApplyPatchToolCall` + + A tool call that applies file diffs by creating, deleting, or updating files. + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + One of the create_file, delete_file, or update_file operations applied via apply_patch. + + - `class CreateFile` + + Instruction describing how to create a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to create. + + - `type: :create_file` + + Create a new file with the provided diff. + + - `:create_file` + + - `class DeleteFile` + + Instruction describing how to delete a file via the apply_patch tool. + + - `path: String` + + Path of the file to delete. + + - `type: :delete_file` + + Delete the specified file. + + - `:delete_file` + + - `class UpdateFile` + + Instruction describing how to update a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to update. + + - `type: :update_file` + + Update an existing file with the provided diff. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseApplyPatchToolCallOutput` + + The output emitted by an apply patch tool call. + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `created_by: String` + + The ID of the entity that created this tool call output. + + - `output: String` + + Optional textual output returned by the apply patch tool. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `id: String` + + The unique ID of the approval response + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `reason: String` + + Optional reason for the decision. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `class ResponseCustomToolCallOutputItem` + + The output of a custom tool call from your code, being sent back to the model. + + - `id: String` + + The unique ID of the custom tool call output item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `parallel_tool_calls: bool` + + Whether to allow the model to run tool calls in parallel. + + - `temperature: Float` + + 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. + + - `tool_choice: ToolChoiceOptions | ToolChoiceAllowed | ToolChoiceTypes | 5 more` + + How the model should select which tool (or tools) to use when generating + a response. See the `tools` parameter to see how to specify which tools + the model can call. + + - `ToolChoiceOptions = :none | :auto | :required` + + Controls which (if any) tool is called by the model. + + `none` means the model will not call any tool and instead generates a message. + + `auto` means the model can pick between generating a message or calling one or + more tools. + + `required` means the model must call one or more tools. + + - `:none` + + - `:auto` + + - `:required` + + - `class ToolChoiceAllowed` + + Constrains the tools available to the model to a pre-defined set. + + - `mode: :auto | :required` + + Constrains the tools available to the model to a pre-defined set. + + `auto` allows the model to pick from among the allowed tools and generate a + message. + + `required` requires the model to call one or more of the allowed tools. + + - `:auto` + + - `:required` + + - `tools: Array[Hash[Symbol, untyped]]` + + A list of tool definitions that the model should be allowed to call. + + For the Responses API, the list of tool definitions might look like: + + ```json + [ + { "type": "function", "name": "get_weather" }, + { "type": "mcp", "server_label": "deepwiki" }, + { "type": "image_generation" } + ] + ``` + + - `type: :allowed_tools` + + Allowed tool configuration type. Always `allowed_tools`. + + - `:allowed_tools` + + - `class ToolChoiceTypes` + + 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). + + - `type: :file_search | :web_search_preview | :computer | 5 more` + + The type of hosted tool the model should to use. Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + + Allowed values are: + + - `file_search` + - `web_search_preview` + - `computer` + - `computer_use_preview` + - `computer_use` + - `code_interpreter` + - `image_generation` + + - `:file_search` + + - `:web_search_preview` + + - `:computer` + + - `:computer_use_preview` + + - `:computer_use` + + - `:web_search_preview_2025_03_11` + + - `:image_generation` + + - `:code_interpreter` + + - `class ToolChoiceFunction` + + Use this option to force the model to call a specific function. + + - `name: String` + + The name of the function to call. + + - `type: :function` + + For function calling, the type is always `function`. + + - `:function` + + - `class ToolChoiceMcp` + + Use this option to force the model to call a specific tool on a remote MCP server. + + - `server_label: String` + + The label of the MCP server to use. + + - `type: :mcp` + + For MCP tools, the type is always `mcp`. + + - `:mcp` + + - `name: String` + + The name of the tool to call on the server. + + - `class ToolChoiceCustom` + + Use this option to force the model to call a specific custom tool. + + - `name: String` + + The name of the custom tool to call. + + - `type: :custom` + + For custom tool calling, the type is always `custom`. + + - `:custom` + + - `class ToolChoiceApplyPatch` + + Forces the model to call the apply_patch tool when executing a tool call. + + - `type: :apply_patch` + + The tool to call. Always `apply_patch`. + + - `:apply_patch` + + - `class ToolChoiceShell` + + Forces the model to call the shell tool when a tool call is required. + + - `type: :shell` + + The tool to call. Always `shell`. + + - `:shell` + + - `tools: Array[Tool]` + + An array of tools the model may call while generating a response. You + can specify which tool to use by setting the `tool_choice` parameter. + + We support the following categories of tools: + + - **Built-in tools**: Tools that are provided by OpenAI that extend the + model's capabilities, like [web search](https://platform.openai.com/docs/guides/tools-web-search) + or [file search](https://platform.openai.com/docs/guides/tools-file-search). Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + - **MCP Tools**: Integrations with third-party systems via custom MCP servers + or predefined connectors such as Google Drive and SharePoint. Learn more about + [MCP Tools](https://platform.openai.com/docs/guides/tools-connectors-mcp). + - **Function calls (custom tools)**: Functions that are defined by you, + enabling the model to call your own code with strongly typed arguments + and outputs. Learn more about + [function calling](https://platform.openai.com/docs/guides/function-calling). You can also use + custom tools to call your own code. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `top_p: Float` + + 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. + + - `background: bool` + + Whether to run the model response in the background. + [Learn more](https://platform.openai.com/docs/guides/background). + + - `completed_at: Float` + + Unix timestamp (in seconds) of when this Response was completed. + Only present when the status is `completed`. + + - `conversation: Conversation{ id}` + + The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation. + + - `id: String` + + The unique ID of the conversation that this response was associated with. + + - `max_output_tokens: Integer` + + An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://platform.openai.com/docs/guides/reasoning). + + - `max_tool_calls: Integer` + + 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. + + - `moderation: Moderation{ input, output}` + + Moderation results for the response input and output, if moderated completions were requested. + + - `input: ModerationResult{ categories, category_applied_input_types, category_scores, 3 more} | Error{ code, message, type}` + + Moderation for the response input. + + - `class ModerationResult` + + A moderation result produced for the response input or output. + + - `categories: Hash[Symbol, bool]` + + A dictionary of moderation categories to booleans, True if the input is flagged under this category. + + - `category_applied_input_types: Hash[Symbol, Array[:text | :image]]` + + Which modalities of input are reflected by the score for each category. + + - `:text` + + - `:image` + + - `category_scores: Hash[Symbol, Float]` + + A dictionary of moderation categories to scores. + + - `flagged: bool` + + A boolean indicating whether the content was flagged by any category. + + - `model: String` + + The moderation model that produced this result. + + - `type: :moderation_result` + + The object type, which was always `moderation_result` for successful moderation results. + + - `:moderation_result` + + - `class Error` + + An error produced while attempting moderation for the response input or output. + + - `code: String` + + The error code. + + - `message: String` + + The error message. + + - `type: :error` + + The object type, which was always `error` for moderation failures. + + - `:error` + + - `output: ModerationResult{ categories, category_applied_input_types, category_scores, 3 more} | Error{ code, message, type}` + + Moderation for the response output. + + - `class ModerationResult` + + A moderation result produced for the response input or output. + + - `categories: Hash[Symbol, bool]` + + A dictionary of moderation categories to booleans, True if the input is flagged under this category. + + - `category_applied_input_types: Hash[Symbol, Array[:text | :image]]` + + Which modalities of input are reflected by the score for each category. + + - `:text` + + - `:image` + + - `category_scores: Hash[Symbol, Float]` + + A dictionary of moderation categories to scores. + + - `flagged: bool` + + A boolean indicating whether the content was flagged by any category. + + - `model: String` + + The moderation model that produced this result. + + - `type: :moderation_result` + + The object type, which was always `moderation_result` for successful moderation results. + + - `:moderation_result` + + - `class Error` + + An error produced while attempting moderation for the response input or output. + + - `code: String` + + The error code. + + - `message: String` + + The error message. + + - `type: :error` + + The object type, which was always `error` for moderation failures. + + - `:error` + + - `previous_response_id: String` + + The unique ID of the previous response to the model. Use this to + create multi-turn conversations. Learn more about + [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. + + - `prompt: ResponsePrompt` + + Reference to a prompt template and its variables. + [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts). + + - `id: String` + + The unique identifier of the prompt template to use. + + - `variables: Hash[Symbol, String | ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Optional map of values to substitute in for variables in your + prompt. The substitution values can either be strings, or other + Response input types like images or files. + + - `String = String` + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `version: String` + + Optional version of the prompt template. + + - `prompt_cache_key: String` + + Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://platform.openai.com/docs/guides/prompt-caching). + + - `prompt_cache_retention: :in_memory | :"24h"` + + The retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention). + For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported. + + For older models that support both `in_memory` and `24h`, the default depends on your organization's data retention policy: + + - Organizations without ZDR enabled default to `24h`. + - Organizations with ZDR enabled default to `in_memory` when `prompt_cache_retention` is not specified. + + - `:in_memory` + + - `:"24h"` + + - `reasoning: Reasoning` + + **gpt-5 and o-series models only** + + Configuration options for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + + - `effort: ReasoningEffort` + + Constrains effort on reasoning for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing + reasoning effort can result in faster responses and fewer tokens used + on reasoning in a response. + + - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1. + - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. + - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. + - `xhigh` is supported for all models after `gpt-5.1-codex-max`. + + - `:none` + + - `:minimal` + + - `:low` + + - `:medium` + + - `:high` + + - `:xhigh` + + - `generate_summary: :auto | :concise | :detailed` + + **Deprecated:** use `summary` instead. + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `summary: :auto | :concise | :detailed` + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + `concise` is supported for `computer-use-preview` models and all reasoning models after `gpt-5`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `safety_identifier: String` + + A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + + - `service_tier: :auto | :default | :flex | 2 more` + + Specifies the processing type used for serving the request. + + - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. + - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. + - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier. + - When not set, the default behavior is 'auto'. + + When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter. + + - `:auto` + + - `:default` + + - `:flex` + + - `:scale` + + - `:priority` + + - `status: ResponseStatus` + + The status of the response generation. One of `completed`, `failed`, + `in_progress`, `cancelled`, `queued`, or `incomplete`. + + - `:completed` + + - `:failed` + + - `:in_progress` + + - `:cancelled` + + - `:queued` + + - `:incomplete` + + - `text: ResponseTextConfig` + + 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) + + - `format_: ResponseFormatTextConfig` + + An object specifying the format that the model must output. + + Configuring `{ "type": "json_schema" }` enables Structured Outputs, + which ensures the model will match your supplied JSON schema. Learn more in the + [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). + + The default format is `{ "type": "text" }` with no additional options. + + **Not recommended for gpt-4o and newer models:** + + Setting to `{ "type": "json_object" }` enables the older JSON mode, which + ensures the message the model generates is valid JSON. Using `json_schema` + is preferred for models that support it. + + - `class ResponseFormatText` + + Default response format. Used to generate text responses. + + - `type: :text` + + The type of response format being defined. Always `text`. + + - `:text` + + - `class ResponseFormatTextJSONSchemaConfig` + + JSON Schema response format. Used to generate structured JSON responses. + Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). + + - `name: String` + + The name of the response format. Must be a-z, A-Z, 0-9, or contain + underscores and dashes, with a maximum length of 64. + + - `schema: Hash[Symbol, untyped]` + + The schema for the response format, described as a JSON Schema object. + Learn how to build JSON schemas [here](https://json-schema.org/). + + - `type: :json_schema` + + The type of response format being defined. Always `json_schema`. + + - `:json_schema` + + - `description: String` + + A description of what the response format is for, used by the model to + determine how to respond in the format. + + - `strict: bool` + + Whether to enable strict schema adherence when generating the output. + If set to true, the model will always follow the exact schema defined + in the `schema` field. Only a subset of JSON Schema is supported when + `strict` is `true`. To learn more, read the [Structured Outputs + guide](https://platform.openai.com/docs/guides/structured-outputs). + + - `class ResponseFormatJSONObject` + + 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. + + - `type: :json_object` + + The type of response format being defined. Always `json_object`. + + - `:json_object` + + - `verbosity: :low | :medium | :high` + + Constrains the verbosity of the model's response. Lower values will result in + more concise responses, while higher values will result in more verbose responses. + Currently supported values are `low`, `medium`, and `high`. + + - `:low` + + - `:medium` + + - `:high` + + - `top_logprobs: Integer` + + An integer between 0 and 20 specifying the maximum number of most likely + tokens to return at each token position, each with an associated log + probability. In some cases, the number of returned tokens may be fewer than + requested. + + - `truncation: :auto | :disabled` + + The truncation strategy to use for the model response. + + - `auto`: If the input to this Response exceeds + the model's context window size, the model will truncate the + response to fit the context window by dropping items from the beginning of the conversation. + - `disabled` (default): If the input size will exceed the context window + size for a model, the request will fail with a 400 error. + + - `:auto` + + - `:disabled` + + - `usage: ResponseUsage` + + Represents token usage details including input tokens, output tokens, + a breakdown of output tokens, and the total tokens used. + + - `input_tokens: Integer` + + The number of input tokens. + + - `input_tokens_details: InputTokensDetails{ cached_tokens}` + + A detailed breakdown of the input tokens. + + - `cached_tokens: Integer` + + The number of tokens that were retrieved from the cache. + [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching). + + - `output_tokens: Integer` + + The number of output tokens. + + - `output_tokens_details: OutputTokensDetails{ reasoning_tokens}` + + A detailed breakdown of the output tokens. + + - `reasoning_tokens: Integer` + + The number of reasoning tokens. + + - `total_tokens: Integer` + + The total number of tokens used. + + - `user: String` + + This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. + A stable identifier for your end-users. + Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + +### Example + +```ruby +require "openai" + +openai = OpenAI::Client.new(api_key: "My API Key") + +response = openai.responses.create + +puts(response) +``` + +#### Response + +```json +{ + "id": "id", + "created_at": 0, + "error": { + "code": "server_error", + "message": "message" + }, + "incomplete_details": { + "reason": "max_output_tokens" + }, + "instructions": "string", + "metadata": { + "foo": "string" + }, + "model": "gpt-5.1", + "object": "response", + "output": [ + { + "id": "id", + "content": [ + { + "annotations": [ + { + "file_id": "file_id", + "filename": "filename", + "index": 0, + "type": "file_citation" + } + ], + "text": "text", + "type": "output_text", + "logprobs": [ + { + "token": "token", + "bytes": [ + 0 + ], + "logprob": 0, + "top_logprobs": [ + { + "token": "token", + "bytes": [ + 0 + ], + "logprob": 0 + } + ] + } + ] + } + ], + "role": "assistant", + "status": "in_progress", + "type": "message", + "phase": "commentary" + } + ], + "parallel_tool_calls": true, + "temperature": 1, + "tool_choice": "none", + "tools": [ + { + "name": "name", + "parameters": { + "foo": "bar" + }, + "strict": true, + "type": "function", + "defer_loading": true, + "description": "description" + } + ], + "top_p": 1, + "background": true, + "completed_at": 0, + "conversation": { + "id": "id" + }, + "max_output_tokens": 0, + "max_tool_calls": 0, + "moderation": { + "input": { + "categories": { + "foo": true + }, + "category_applied_input_types": { + "foo": [ + "text" + ] + }, + "category_scores": { + "foo": 0 + }, + "flagged": true, + "model": "model", + "type": "moderation_result" + }, + "output": { + "categories": { + "foo": true + }, + "category_applied_input_types": { + "foo": [ + "text" + ] + }, + "category_scores": { + "foo": 0 + }, + "flagged": true, + "model": "model", + "type": "moderation_result" + } + }, + "output_text": "output_text", + "previous_response_id": "previous_response_id", + "prompt": { + "id": "id", + "variables": { + "foo": "string" + }, + "version": "version" + }, + "prompt_cache_key": "prompt-cache-key-1234", + "prompt_cache_retention": "in_memory", + "reasoning": { + "effort": "none", + "generate_summary": "auto", + "summary": "auto" + }, + "safety_identifier": "safety-identifier-1234", + "service_tier": "auto", + "status": "completed", + "text": { + "format": { + "type": "text" + }, + "verbosity": "low" + }, + "top_logprobs": 0, + "truncation": "auto", + "usage": { + "input_tokens": 0, + "input_tokens_details": { + "cached_tokens": 0 + }, + "output_tokens": 0, + "output_tokens_details": { + "reasoning_tokens": 0 + }, + "total_tokens": 0 + }, + "user": "user-1234" +} +``` + +## Get a model response + +`responses.retrieve(response_id, **kwargs) -> Response` + +**get** `/responses/{response_id}` + +Retrieves a model response with the given ID. + +### Parameters + +- `response_id: String` + +- `include: Array[ResponseIncludable]` + + Additional fields to include in the response. See the `include` + parameter for Response creation above for more information. + + - `:"file_search_call.results"` + + - `:"web_search_call.results"` + + - `:"web_search_call.action.sources"` + + - `:"message.input_image.image_url"` + + - `:"computer_call_output.output.image_url"` + + - `:"code_interpreter_call.outputs"` + + - `:"reasoning.encrypted_content"` + + - `:"message.output_text.logprobs"` + +- `include_obfuscation: bool` + + When true, stream obfuscation will be enabled. Stream obfuscation adds + random characters to an `obfuscation` field on streaming delta events + to normalize payload sizes as a mitigation to certain side-channel + attacks. These obfuscation fields are included by default, but add a + small amount of overhead to the data stream. You can set + `include_obfuscation` to false to optimize for bandwidth if you trust + the network links between your application and the OpenAI API. + +- `starting_after: Integer` + + The sequence number of the event after which to start streaming. + +- `stream: bool` + + If set to true, the model response data will be streamed to the client + as it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format). + See the [Streaming section below](https://platform.openai.com/docs/api-reference/responses-streaming) + for more information. + +### Returns + +- `class Response` + + - `id: String` + + Unique identifier for this Response. + + - `created_at: Float` + + Unix timestamp (in seconds) of when this Response was created. + + - `error: ResponseError` + + An error object returned when the model fails to generate a Response. + + - `code: :server_error | :rate_limit_exceeded | :invalid_prompt | 15 more` + + The error code for the response. + + - `: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` + + - `message: String` + + A human-readable description of the error. + + - `incomplete_details: IncompleteDetails{ reason}` + + Details about why the response is incomplete. + + - `reason: :max_output_tokens | :content_filter` + + The reason why the response is incomplete. + + - `:max_output_tokens` + + - `:content_filter` + + - `instructions: String | Array[ResponseInputItem]` + + A system (or developer) message inserted into the model's context. + + When using along with `previous_response_id`, the instructions from a previous + response will not be carried over to the next response. This makes it simple + to swap out system (or developer) messages in new responses. + + - `String = String` + + A text input to the model, equivalent to a text input with the + `developer` role. + + - `InputItemList = Array[ResponseInputItem]` + + A list of one or many input items to the model, containing + different content types. + + - `class EasyInputMessage` + + 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. + + - `content: String | ResponseInputMessageContentList` + + Text, image, or audio input to the model, used to generate a response. + Can also contain previous assistant responses. + + - `String = String` + + A text input to the model. + + - `ResponseInputMessageContentList = Array[ResponseInputContent]` + + A list of one or many input items to the model, containing different content + types. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `role: :user | :assistant | :system | :developer` + + The role of the message input. One of `user`, `assistant`, `system`, or + `developer`. + + - `:user` + + - `:assistant` + + - `:system` + + - `:developer` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `type: :message` + + The type of the message input. Always `message`. + + - `:message` + + - `class Message` + + 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. + + - `content: ResponseInputMessageContentList` + + A list of one or many input items to the model, containing different content + types. + + - `role: :user | :system | :developer` + + The role of the message input. One of `user`, `system`, or `developer`. + + - `:user` + + - `:system` + + - `:developer` + + - `status: :in_progress | :completed | :incomplete` + + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the message input. Always set to `message`. + + - `:message` + + - `class ResponseOutputMessage` + + An output message from the model. + + - `id: String` + + The unique ID of the output message. + + - `content: Array[ResponseOutputText | ResponseOutputRefusal]` + + The content of the output message. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `role: :assistant` + + The role of the output message. Always `assistant`. + + - `:assistant` + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the output message. Always `message`. + + - `:message` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `class ResponseFileSearchToolCall` + + 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. + + - `id: String` + + The unique ID of the file search tool call. + + - `queries: Array[String]` + + The queries used to search for files. + + - `status: :in_progress | :searching | :completed | 2 more` + + The status of the file search tool call. One of `in_progress`, + `searching`, `incomplete` or `failed`, + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `type: :file_search_call` + + The type of the file search tool call. Always `file_search_call`. + + - `:file_search_call` + + - `results: Array[Result{ attributes, file_id, filename, 2 more}]` + + The results of the file search tool call. + + - `attributes: Hash[Symbol, String | Float | bool]` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. Keys are strings + with a maximum length of 64 characters. Values are strings with a maximum + length of 512 characters, booleans, or numbers. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `file_id: String` + + The unique ID of the file. + + - `filename: String` + + The name of the file. + + - `score: Float` + + The relevance score of the file - a value between 0 and 1. + + - `text: String` + + The text that was retrieved from the file. + + - `class ResponseComputerToolCall` + + 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. + + - `id: String` + + The unique ID of the computer call. + + - `call_id: String` + + An identifier used when responding to the tool call with output. + + - `pending_safety_checks: Array[PendingSafetyCheck{ id, code, message}]` + + The pending safety checks for the computer call. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :computer_call` + + The type of the computer call. Always `computer_call`. + + - `:computer_call` + + - `action: Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `actions: ComputerActionList` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `class ComputerCallOutput` + + The output of a computer tool call. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `id: String` + + The ID of the computer tool call output. + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionWebSearch` + + 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. + + - `id: String` + + The unique ID of the web search tool call. + + - `action: Search{ type, queries, query, sources} | OpenPage{ type, url} | FindInPage{ pattern, type, url}` + + An object describing the specific action taken in this web search call. + Includes details on how the model used the web (search, open_page, find_in_page). + + - `class Search` + + Action type "search" - Performs a web search query. + + - `type: :search` + + The action type. + + - `:search` + + - `queries: Array[String]` + + The search queries. + + - `query: String` + + The search query. + + - `sources: Array[Source{ type, url}]` + + The sources used in the search. + + - `type: :url` + + The type of source. Always `url`. + + - `:url` + + - `url: String` + + The URL of the source. + + - `class OpenPage` + + Action type "open_page" - Opens a specific URL from search results. + + - `type: :open_page` + + The action type. + + - `:open_page` + + - `url: String` + + The URL opened by the model. + + - `class FindInPage` + + Action type "find_in_page": Searches for a pattern within a loaded page. + + - `pattern: String` + + The pattern or text to search for within the page. + + - `type: :find_in_page` + + The action type. + + - `:find_in_page` + + - `url: String` + + The URL of the page searched for the pattern. + + - `status: :in_progress | :searching | :completed | :failed` + + The status of the web search tool call. + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:failed` + + - `type: :web_search_call` + + The type of the web search tool call. Always `web_search_call`. + + - `:web_search_call` + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `arguments: String` + + A JSON string of the arguments to pass to the function. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `name: String` + + The name of the function to run. + + - `type: :function_call` + + The type of the function tool call. Always `function_call`. + + - `:function_call` + + - `id: String` + + The unique ID of the function tool call. + + - `namespace: String` + + The namespace of the function to run. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class FunctionCallOutput` + + The output of a function tool call. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | ResponseFunctionCallOutputItemList` + + Text, image, or file output of the function tool call. + + - `String = String` + + A JSON string of the output of the function tool call. + + - `ResponseFunctionCallOutputItemList = Array[ResponseFunctionCallOutputItem]` + + An array of content outputs (text, image, file) for the function tool call. + + - `class ResponseInputTextContent` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImageContent` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision) + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFileContent` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The base64-encoded data of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `id: String` + + The unique ID of the function tool call output. Populated when this item is returned via API. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ToolSearchCall` + + - `arguments: untyped` + + The arguments supplied to the tool search call. + + - `type: :tool_search_call` + + The item type. Always `tool_search_call`. + + - `:tool_search_call` + + - `id: String` + + The unique ID of this tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseToolSearchOutputItemParam` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by the tool search output. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The item type. Always `tool_search_output`. + + - `:tool_search_output` + + - `id: String` + + The unique ID of this tool search output. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class AdditionalTools` + + - `role: :developer` + + The role that provided the additional tools. Only `developer` is supported. + + - `:developer` + + - `tools: Array[Tool]` + + A list of additional tools made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The item type. Always `additional_tools`. + + - `:additional_tools` + + - `id: String` + + The unique ID of this additional tools item. + + - `class ResponseReasoningItem` + + 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). + + - `id: String` + + The unique identifier of the reasoning content. + + - `summary: Array[Summary{ text, type}]` + + Reasoning summary content. + + - `text: String` + + A summary of the reasoning output from the model so far. + + - `type: :summary_text` + + The type of the object. Always `summary_text`. + + - `:summary_text` + + - `type: :reasoning` + + The type of the object. Always `reasoning`. + + - `:reasoning` + + - `content: Array[Content{ text, type}]` + + Reasoning text content. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `encrypted_content: String` + + The encrypted content of the reasoning item - populated when a response is + generated with `reasoning.encrypted_content` in the `include` parameter. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseCompactionItemParam` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `encrypted_content: String` + + The encrypted content of the compaction summary. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `id: String` + + The ID of the compaction item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `id: String` + + The unique ID of the code interpreter tool call. + + - `code: String` + + The code to run, or null if not available. + + - `container_id: String` + + The ID of the container used to run the code. + + - `outputs: Array[Logs{ logs, type} | Image{ type, url}]` + + The outputs generated by the code interpreter, such as logs or images. + Can be null if no outputs are available. + + - `class Logs` + + The logs output from the code interpreter. + + - `logs: String` + + The logs output from the code interpreter. + + - `type: :logs` + + The type of the output. Always `logs`. + + - `:logs` + + - `class Image` + + The image output from the code interpreter. + + - `type: :image` + + The type of the output. Always `image`. + + - `:image` + + - `url: String` + + The URL of the image output from the code interpreter. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:interpreting` + + - `:failed` + + - `type: :code_interpreter_call` + + The type of the code interpreter tool call. Always `code_interpreter_call`. + + - `:code_interpreter_call` + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCall` + + A tool representing a request to execute one or more shell commands. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + Ordered shell commands for the execution environment to run. + + - `max_output_length: Integer` + + Maximum number of UTF-8 characters to capture from combined stdout and stderr output. + + - `timeout_ms: Integer` + + Maximum wall-clock time in milliseconds to allow the shell commands to run. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `environment: LocalEnvironment | ContainerReference` + + The environment to execute the shell commands in. + + - `class LocalEnvironment` + + - `class ContainerReference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCallOutput` + + The streamed output items emitted by a shell tool call. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `output: Array[ResponseFunctionShellCallOutputContent]` + + Captured chunks of stdout and stderr output, along with their associated outcomes. + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + The exit or timeout outcome associated with this shell call. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + The exit code returned by the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + Captured stderr output for the shell call. + + - `stdout: String` + + Captured stdout output for the shell call. + + - `type: :shell_call_output` + + The type of the item. Always `shell_call_output`. + + - `:shell_call_output` + + - `id: String` + + The unique ID of the shell tool call output. Populated when this item is returned via API. + + - `max_output_length: Integer` + + The maximum number of UTF-8 characters captured for this shell call's combined output. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ApplyPatchCall` + + A tool call representing a request to create, delete, or update files using diff patches. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + The specific create, delete, or update instruction for the apply_patch tool call. + + - `class CreateFile` + + Instruction for creating a new file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply when creating the file. + + - `path: String` + + Path of the file to create relative to the workspace root. + + - `type: :create_file` + + The operation type. Always `create_file`. + + - `:create_file` + + - `class DeleteFile` + + Instruction for deleting an existing file via the apply_patch tool. + + - `path: String` + + Path of the file to delete relative to the workspace root. + + - `type: :delete_file` + + The operation type. Always `delete_file`. + + - `:delete_file` + + - `class UpdateFile` + + Instruction for updating an existing file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply to the existing file. + + - `path: String` + + Path of the file to update relative to the workspace root. + + - `type: :update_file` + + The operation type. Always `update_file`. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `class ApplyPatchCallOutput` + + The streamed output emitted by an apply patch tool call. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `output: String` + + Optional human-readable log text from the apply patch tool (e.g., patch results or errors). + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `id: String` + + The unique ID of the approval response + + - `reason: String` + + Optional reason for the decision. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class ResponseCustomToolCallOutput` + + The output of a custom tool call from your code, being sent back to the model. + + - `call_id: String` + + The call ID, used to map this custom tool call output to a custom tool call. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the custom tool call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the custom tool call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :custom_tool_call_output` + + The type of the custom tool call output. Always `custom_tool_call_output`. + + - `:custom_tool_call_output` + + - `id: String` + + The unique ID of the custom tool call output in the OpenAI platform. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `call_id: String` + + An identifier used to map this custom tool call to a tool call output. + + - `input: String` + + The input for the custom tool call generated by the model. + + - `name: String` + + The name of the custom tool being called. + + - `type: :custom_tool_call` + + The type of the custom tool call. Always `custom_tool_call`. + + - `:custom_tool_call` + + - `id: String` + + The unique ID of the custom tool call in the OpenAI platform. + + - `namespace: String` + + The namespace of the custom tool being called. + + - `class CompactionTrigger` + + Compacts the current context. Must be the final input item. + + - `type: :compaction_trigger` + + The type of the item. Always `compaction_trigger`. + + - `:compaction_trigger` + + - `class ItemReference` + + An internal identifier for an item to reference. + + - `id: String` + + The ID of the item to reference. + + - `type: :item_reference` + + The type of item to reference. Always `item_reference`. + + - `:item_reference` + + - `metadata: Metadata` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. + + Keys are strings with a maximum length of 64 characters. Values are strings + with a maximum length of 512 characters. + + - `model: ResponsesModel` + + Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI + offers a wide range of models with different capabilities, performance + characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) + to browse and compare available models. + + - `String = String` + + - `ChatModel = :"gpt-5.4" | :"gpt-5.4-mini" | :"gpt-5.4-nano" | 75 more` + + - `:"gpt-5.4"` + + - `:"gpt-5.4-mini"` + + - `:"gpt-5.4-nano"` + + - `:"gpt-5.4-mini-2026-03-17"` + + - `:"gpt-5.4-nano-2026-03-17"` + + - `:"gpt-5.3-chat-latest"` + + - `:"gpt-5.2"` + + - `:"gpt-5.2-2025-12-11"` + + - `:"gpt-5.2-chat-latest"` + + - `:"gpt-5.2-pro"` + + - `:"gpt-5.2-pro-2025-12-11"` + + - `:"gpt-5.1"` + + - `:"gpt-5.1-2025-11-13"` + + - `:"gpt-5.1-codex"` + + - `:"gpt-5.1-mini"` + + - `:"gpt-5.1-chat-latest"` + + - `:"gpt-5"` + + - `:"gpt-5-mini"` + + - `:"gpt-5-nano"` + + - `:"gpt-5-2025-08-07"` + + - `:"gpt-5-mini-2025-08-07"` + + - `:"gpt-5-nano-2025-08-07"` + + - `:"gpt-5-chat-latest"` + + - `:"gpt-4.1"` + + - `:"gpt-4.1-mini"` + + - `:"gpt-4.1-nano"` + + - `:"gpt-4.1-2025-04-14"` + + - `:"gpt-4.1-mini-2025-04-14"` + + - `:"gpt-4.1-nano-2025-04-14"` + + - `:"o4-mini"` + + - `:"o4-mini-2025-04-16"` + + - `:o3` + + - `:"o3-2025-04-16"` + + - `:"o3-mini"` + + - `:"o3-mini-2025-01-31"` + + - `:o1` + + - `:"o1-2024-12-17"` + + - `:"o1-preview"` + + - `:"o1-preview-2024-09-12"` + + - `:"o1-mini"` + + - `:"o1-mini-2024-09-12"` + + - `:"gpt-4o"` + + - `:"gpt-4o-2024-11-20"` + + - `:"gpt-4o-2024-08-06"` + + - `:"gpt-4o-2024-05-13"` + + - `:"gpt-4o-audio-preview"` + + - `:"gpt-4o-audio-preview-2024-10-01"` + + - `:"gpt-4o-audio-preview-2024-12-17"` + + - `:"gpt-4o-audio-preview-2025-06-03"` + + - `:"gpt-4o-mini-audio-preview"` + + - `:"gpt-4o-mini-audio-preview-2024-12-17"` + + - `:"gpt-4o-search-preview"` + + - `:"gpt-4o-mini-search-preview"` + + - `:"gpt-4o-search-preview-2025-03-11"` + + - `:"gpt-4o-mini-search-preview-2025-03-11"` + + - `:"chatgpt-4o-latest"` + + - `:"codex-mini-latest"` + + - `:"gpt-4o-mini"` + + - `:"gpt-4o-mini-2024-07-18"` + + - `:"gpt-4-turbo"` + + - `:"gpt-4-turbo-2024-04-09"` + + - `:"gpt-4-0125-preview"` + + - `:"gpt-4-turbo-preview"` + + - `:"gpt-4-1106-preview"` + + - `:"gpt-4-vision-preview"` + + - `:"gpt-4"` + + - `:"gpt-4-0314"` + + - `:"gpt-4-0613"` + + - `:"gpt-4-32k"` + + - `:"gpt-4-32k-0314"` + + - `:"gpt-4-32k-0613"` + + - `:"gpt-3.5-turbo"` + + - `:"gpt-3.5-turbo-16k"` + + - `:"gpt-3.5-turbo-0301"` + + - `:"gpt-3.5-turbo-0613"` + + - `:"gpt-3.5-turbo-1106"` + + - `:"gpt-3.5-turbo-0125"` + + - `:"gpt-3.5-turbo-16k-0613"` + + - `ResponsesOnlyModel = :"o1-pro" | :"o1-pro-2025-03-19" | :"o3-pro" | 11 more` + + - `:"o1-pro"` + + - `:"o1-pro-2025-03-19"` + + - `:"o3-pro"` + + - `:"o3-pro-2025-06-10"` + + - `:"o3-deep-research"` + + - `:"o3-deep-research-2025-06-26"` + + - `:"o4-mini-deep-research"` + + - `:"o4-mini-deep-research-2025-06-26"` + + - `:"computer-use-preview"` + + - `:"computer-use-preview-2025-03-11"` + + - `:"gpt-5-codex"` + + - `:"gpt-5-pro"` + + - `:"gpt-5-pro-2025-10-06"` + + - `:"gpt-5.1-codex-max"` + + - `object: :response` + + The object type of this resource - always set to `response`. + + - `:response` + + - `output: Array[ResponseOutputItem]` + + An array of content items generated by the model. + + - The length and order of items in the `output` array is dependent + on the model's response. + - Rather than accessing the first item in the `output` array and + assuming it's an `assistant` message with the content generated by + the model, you might consider using the `output_text` property where + supported in SDKs. + + - `class ResponseOutputMessage` + + An output message from the model. + + - `class ResponseFileSearchToolCall` + + 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. + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `class ResponseFunctionToolCallOutputItem` + + - `id: String` + + The unique ID of the function call tool output. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the function call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the function call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the function call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseFunctionWebSearch` + + 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. + + - `class ResponseComputerToolCall` + + 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. + + - `class ResponseComputerToolCallOutputItem` + + - `id: String` + + The unique ID of the computer call tool output. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `status: :completed | :incomplete | :failed | :in_progress` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `:in_progress` + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the + developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseReasoningItem` + + 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). + + - `class ResponseToolSearchCall` + + - `id: String` + + The unique ID of the tool search call item. + + - `arguments: untyped` + + Arguments used for the tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :tool_search_call` + + The type of the item. Always `tool_search_call`. + + - `:tool_search_call` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseToolSearchOutputItem` + + - `id: String` + + The unique ID of the tool search output item. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by tool search. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :tool_search_output` + + The type of the item. Always `tool_search_output`. + + - `:tool_search_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class AdditionalTools` + + - `id: String` + + The unique ID of the additional tools item. + + - `role: :unknown | :user | :assistant | 5 more` + + The role that provided the additional tools. + + - `:unknown` + + - `:user` + + - `:assistant` + + - `:system` + + - `:critic` + + - `:discriminator` + + - `:developer` + + - `:tool` + + - `tools: Array[Tool]` + + The additional tool definitions made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The type of the item. Always `additional_tools`. + + - `:additional_tools` + + - `class ResponseCompactionItem` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `id: String` + + The unique ID of the compaction item. + + - `encrypted_content: String` + + The encrypted content that was produced by compaction. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionShellToolCall` + + A tool call that executes one or more shell commands in a managed environment. + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + - `max_output_length: Integer` + + Optional maximum number of characters to return from each command. + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the commands. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `environment: ResponseLocalEnvironment | ResponseContainerReference` + + Represents the use of a local environment to perform shell actions. + + - `class ResponseLocalEnvironment` + + Represents the use of a local environment to perform shell actions. + + - `type: :local` + + The environment type. Always `local`. + + - `:local` + + - `class ResponseContainerReference` + + Represents a container created with /v1/containers. + + - `container_id: String` + + - `type: :container_reference` + + The environment type. Always `container_reference`. + + - `:container_reference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseFunctionShellToolCallOutput` + + The output of a shell tool call that was emitted. + + - `id: String` + + The unique ID of the shell call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `max_output_length: Integer` + + The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output. + + - `output: Array[Output{ outcome, stderr, stdout, created_by}]` + + An array of shell call output contents + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + Exit code from the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + The standard error output that was captured. + + - `stdout: String` + + The standard output that was captured. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call_output` + + The type of the shell call output. Always `shell_call_output`. + + - `:shell_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseApplyPatchToolCall` + + A tool call that applies file diffs by creating, deleting, or updating files. + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + One of the create_file, delete_file, or update_file operations applied via apply_patch. + + - `class CreateFile` + + Instruction describing how to create a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to create. + + - `type: :create_file` + + Create a new file with the provided diff. + + - `:create_file` + + - `class DeleteFile` + + Instruction describing how to delete a file via the apply_patch tool. + + - `path: String` + + Path of the file to delete. + + - `type: :delete_file` + + Delete the specified file. + + - `:delete_file` + + - `class UpdateFile` + + Instruction describing how to update a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to update. + + - `type: :update_file` + + Update an existing file with the provided diff. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseApplyPatchToolCallOutput` + + The output emitted by an apply patch tool call. + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `created_by: String` + + The ID of the entity that created this tool call output. + + - `output: String` + + Optional textual output returned by the apply patch tool. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `id: String` + + The unique ID of the approval response + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `reason: String` + + Optional reason for the decision. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `class ResponseCustomToolCallOutputItem` + + The output of a custom tool call from your code, being sent back to the model. + + - `id: String` + + The unique ID of the custom tool call output item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `parallel_tool_calls: bool` + + Whether to allow the model to run tool calls in parallel. + + - `temperature: Float` + + 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. + + - `tool_choice: ToolChoiceOptions | ToolChoiceAllowed | ToolChoiceTypes | 5 more` + + How the model should select which tool (or tools) to use when generating + a response. See the `tools` parameter to see how to specify which tools + the model can call. + + - `ToolChoiceOptions = :none | :auto | :required` + + Controls which (if any) tool is called by the model. + + `none` means the model will not call any tool and instead generates a message. + + `auto` means the model can pick between generating a message or calling one or + more tools. + + `required` means the model must call one or more tools. + + - `:none` + + - `:auto` + + - `:required` + + - `class ToolChoiceAllowed` + + Constrains the tools available to the model to a pre-defined set. + + - `mode: :auto | :required` + + Constrains the tools available to the model to a pre-defined set. + + `auto` allows the model to pick from among the allowed tools and generate a + message. + + `required` requires the model to call one or more of the allowed tools. + + - `:auto` + + - `:required` + + - `tools: Array[Hash[Symbol, untyped]]` + + A list of tool definitions that the model should be allowed to call. + + For the Responses API, the list of tool definitions might look like: + + ```json + [ + { "type": "function", "name": "get_weather" }, + { "type": "mcp", "server_label": "deepwiki" }, + { "type": "image_generation" } + ] + ``` + + - `type: :allowed_tools` + + Allowed tool configuration type. Always `allowed_tools`. + + - `:allowed_tools` + + - `class ToolChoiceTypes` + + 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). + + - `type: :file_search | :web_search_preview | :computer | 5 more` + + The type of hosted tool the model should to use. Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + + Allowed values are: + + - `file_search` + - `web_search_preview` + - `computer` + - `computer_use_preview` + - `computer_use` + - `code_interpreter` + - `image_generation` + + - `:file_search` + + - `:web_search_preview` + + - `:computer` + + - `:computer_use_preview` + + - `:computer_use` + + - `:web_search_preview_2025_03_11` + + - `:image_generation` + + - `:code_interpreter` + + - `class ToolChoiceFunction` + + Use this option to force the model to call a specific function. + + - `name: String` + + The name of the function to call. + + - `type: :function` + + For function calling, the type is always `function`. + + - `:function` + + - `class ToolChoiceMcp` + + Use this option to force the model to call a specific tool on a remote MCP server. + + - `server_label: String` + + The label of the MCP server to use. + + - `type: :mcp` + + For MCP tools, the type is always `mcp`. + + - `:mcp` + + - `name: String` + + The name of the tool to call on the server. + + - `class ToolChoiceCustom` + + Use this option to force the model to call a specific custom tool. + + - `name: String` + + The name of the custom tool to call. + + - `type: :custom` + + For custom tool calling, the type is always `custom`. + + - `:custom` + + - `class ToolChoiceApplyPatch` + + Forces the model to call the apply_patch tool when executing a tool call. + + - `type: :apply_patch` + + The tool to call. Always `apply_patch`. + + - `:apply_patch` + + - `class ToolChoiceShell` + + Forces the model to call the shell tool when a tool call is required. + + - `type: :shell` + + The tool to call. Always `shell`. + + - `:shell` + + - `tools: Array[Tool]` + + An array of tools the model may call while generating a response. You + can specify which tool to use by setting the `tool_choice` parameter. + + We support the following categories of tools: + + - **Built-in tools**: Tools that are provided by OpenAI that extend the + model's capabilities, like [web search](https://platform.openai.com/docs/guides/tools-web-search) + or [file search](https://platform.openai.com/docs/guides/tools-file-search). Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + - **MCP Tools**: Integrations with third-party systems via custom MCP servers + or predefined connectors such as Google Drive and SharePoint. Learn more about + [MCP Tools](https://platform.openai.com/docs/guides/tools-connectors-mcp). + - **Function calls (custom tools)**: Functions that are defined by you, + enabling the model to call your own code with strongly typed arguments + and outputs. Learn more about + [function calling](https://platform.openai.com/docs/guides/function-calling). You can also use + custom tools to call your own code. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `top_p: Float` + + 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. + + - `background: bool` + + Whether to run the model response in the background. + [Learn more](https://platform.openai.com/docs/guides/background). + + - `completed_at: Float` + + Unix timestamp (in seconds) of when this Response was completed. + Only present when the status is `completed`. + + - `conversation: Conversation{ id}` + + The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation. + + - `id: String` + + The unique ID of the conversation that this response was associated with. + + - `max_output_tokens: Integer` + + An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://platform.openai.com/docs/guides/reasoning). + + - `max_tool_calls: Integer` + + 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. + + - `moderation: Moderation{ input, output}` + + Moderation results for the response input and output, if moderated completions were requested. + + - `input: ModerationResult{ categories, category_applied_input_types, category_scores, 3 more} | Error{ code, message, type}` + + Moderation for the response input. + + - `class ModerationResult` + + A moderation result produced for the response input or output. + + - `categories: Hash[Symbol, bool]` + + A dictionary of moderation categories to booleans, True if the input is flagged under this category. + + - `category_applied_input_types: Hash[Symbol, Array[:text | :image]]` + + Which modalities of input are reflected by the score for each category. + + - `:text` + + - `:image` + + - `category_scores: Hash[Symbol, Float]` + + A dictionary of moderation categories to scores. + + - `flagged: bool` + + A boolean indicating whether the content was flagged by any category. + + - `model: String` + + The moderation model that produced this result. + + - `type: :moderation_result` + + The object type, which was always `moderation_result` for successful moderation results. + + - `:moderation_result` + + - `class Error` + + An error produced while attempting moderation for the response input or output. + + - `code: String` + + The error code. + + - `message: String` + + The error message. + + - `type: :error` + + The object type, which was always `error` for moderation failures. + + - `:error` + + - `output: ModerationResult{ categories, category_applied_input_types, category_scores, 3 more} | Error{ code, message, type}` + + Moderation for the response output. + + - `class ModerationResult` + + A moderation result produced for the response input or output. + + - `categories: Hash[Symbol, bool]` + + A dictionary of moderation categories to booleans, True if the input is flagged under this category. + + - `category_applied_input_types: Hash[Symbol, Array[:text | :image]]` + + Which modalities of input are reflected by the score for each category. + + - `:text` + + - `:image` + + - `category_scores: Hash[Symbol, Float]` + + A dictionary of moderation categories to scores. + + - `flagged: bool` + + A boolean indicating whether the content was flagged by any category. + + - `model: String` + + The moderation model that produced this result. + + - `type: :moderation_result` + + The object type, which was always `moderation_result` for successful moderation results. + + - `:moderation_result` + + - `class Error` + + An error produced while attempting moderation for the response input or output. + + - `code: String` + + The error code. + + - `message: String` + + The error message. + + - `type: :error` + + The object type, which was always `error` for moderation failures. + + - `:error` + + - `previous_response_id: String` + + The unique ID of the previous response to the model. Use this to + create multi-turn conversations. Learn more about + [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. + + - `prompt: ResponsePrompt` + + Reference to a prompt template and its variables. + [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts). + + - `id: String` + + The unique identifier of the prompt template to use. + + - `variables: Hash[Symbol, String | ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Optional map of values to substitute in for variables in your + prompt. The substitution values can either be strings, or other + Response input types like images or files. + + - `String = String` + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `version: String` + + Optional version of the prompt template. + + - `prompt_cache_key: String` + + Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://platform.openai.com/docs/guides/prompt-caching). + + - `prompt_cache_retention: :in_memory | :"24h"` + + The retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention). + For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported. + + For older models that support both `in_memory` and `24h`, the default depends on your organization's data retention policy: + + - Organizations without ZDR enabled default to `24h`. + - Organizations with ZDR enabled default to `in_memory` when `prompt_cache_retention` is not specified. + + - `:in_memory` + + - `:"24h"` + + - `reasoning: Reasoning` + + **gpt-5 and o-series models only** + + Configuration options for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + + - `effort: ReasoningEffort` + + Constrains effort on reasoning for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing + reasoning effort can result in faster responses and fewer tokens used + on reasoning in a response. + + - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1. + - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. + - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. + - `xhigh` is supported for all models after `gpt-5.1-codex-max`. + + - `:none` + + - `:minimal` + + - `:low` + + - `:medium` + + - `:high` + + - `:xhigh` + + - `generate_summary: :auto | :concise | :detailed` + + **Deprecated:** use `summary` instead. + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `summary: :auto | :concise | :detailed` + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + `concise` is supported for `computer-use-preview` models and all reasoning models after `gpt-5`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `safety_identifier: String` + + A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + + - `service_tier: :auto | :default | :flex | 2 more` + + Specifies the processing type used for serving the request. + + - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. + - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. + - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier. + - When not set, the default behavior is 'auto'. + + When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter. + + - `:auto` + + - `:default` + + - `:flex` + + - `:scale` + + - `:priority` + + - `status: ResponseStatus` + + The status of the response generation. One of `completed`, `failed`, + `in_progress`, `cancelled`, `queued`, or `incomplete`. + + - `:completed` + + - `:failed` + + - `:in_progress` + + - `:cancelled` + + - `:queued` + + - `:incomplete` + + - `text: ResponseTextConfig` + + 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) + + - `format_: ResponseFormatTextConfig` + + An object specifying the format that the model must output. + + Configuring `{ "type": "json_schema" }` enables Structured Outputs, + which ensures the model will match your supplied JSON schema. Learn more in the + [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). + + The default format is `{ "type": "text" }` with no additional options. + + **Not recommended for gpt-4o and newer models:** + + Setting to `{ "type": "json_object" }` enables the older JSON mode, which + ensures the message the model generates is valid JSON. Using `json_schema` + is preferred for models that support it. + + - `class ResponseFormatText` + + Default response format. Used to generate text responses. + + - `type: :text` + + The type of response format being defined. Always `text`. + + - `:text` + + - `class ResponseFormatTextJSONSchemaConfig` + + JSON Schema response format. Used to generate structured JSON responses. + Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). + + - `name: String` + + The name of the response format. Must be a-z, A-Z, 0-9, or contain + underscores and dashes, with a maximum length of 64. + + - `schema: Hash[Symbol, untyped]` + + The schema for the response format, described as a JSON Schema object. + Learn how to build JSON schemas [here](https://json-schema.org/). + + - `type: :json_schema` + + The type of response format being defined. Always `json_schema`. + + - `:json_schema` + + - `description: String` + + A description of what the response format is for, used by the model to + determine how to respond in the format. + + - `strict: bool` + + Whether to enable strict schema adherence when generating the output. + If set to true, the model will always follow the exact schema defined + in the `schema` field. Only a subset of JSON Schema is supported when + `strict` is `true`. To learn more, read the [Structured Outputs + guide](https://platform.openai.com/docs/guides/structured-outputs). + + - `class ResponseFormatJSONObject` + + 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. + + - `type: :json_object` + + The type of response format being defined. Always `json_object`. + + - `:json_object` + + - `verbosity: :low | :medium | :high` + + Constrains the verbosity of the model's response. Lower values will result in + more concise responses, while higher values will result in more verbose responses. + Currently supported values are `low`, `medium`, and `high`. + + - `:low` + + - `:medium` + + - `:high` + + - `top_logprobs: Integer` + + An integer between 0 and 20 specifying the maximum number of most likely + tokens to return at each token position, each with an associated log + probability. In some cases, the number of returned tokens may be fewer than + requested. + + - `truncation: :auto | :disabled` + + The truncation strategy to use for the model response. + + - `auto`: If the input to this Response exceeds + the model's context window size, the model will truncate the + response to fit the context window by dropping items from the beginning of the conversation. + - `disabled` (default): If the input size will exceed the context window + size for a model, the request will fail with a 400 error. + + - `:auto` + + - `:disabled` + + - `usage: ResponseUsage` + + Represents token usage details including input tokens, output tokens, + a breakdown of output tokens, and the total tokens used. + + - `input_tokens: Integer` + + The number of input tokens. + + - `input_tokens_details: InputTokensDetails{ cached_tokens}` + + A detailed breakdown of the input tokens. + + - `cached_tokens: Integer` + + The number of tokens that were retrieved from the cache. + [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching). + + - `output_tokens: Integer` + + The number of output tokens. + + - `output_tokens_details: OutputTokensDetails{ reasoning_tokens}` + + A detailed breakdown of the output tokens. + + - `reasoning_tokens: Integer` + + The number of reasoning tokens. + + - `total_tokens: Integer` + + The total number of tokens used. + + - `user: String` + + This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. + A stable identifier for your end-users. + Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + +### Example + +```ruby +require "openai" + +openai = OpenAI::Client.new(api_key: "My API Key") + +response = openai.responses.retrieve("resp_677efb5139a88190b512bc3fef8e535d") + +puts(response) +``` + +#### Response + +```json +{ + "id": "id", + "created_at": 0, + "error": { + "code": "server_error", + "message": "message" + }, + "incomplete_details": { + "reason": "max_output_tokens" + }, + "instructions": "string", + "metadata": { + "foo": "string" + }, + "model": "gpt-5.1", + "object": "response", + "output": [ + { + "id": "id", + "content": [ + { + "annotations": [ + { + "file_id": "file_id", + "filename": "filename", + "index": 0, + "type": "file_citation" + } + ], + "text": "text", + "type": "output_text", + "logprobs": [ + { + "token": "token", + "bytes": [ + 0 + ], + "logprob": 0, + "top_logprobs": [ + { + "token": "token", + "bytes": [ + 0 + ], + "logprob": 0 + } + ] + } + ] + } + ], + "role": "assistant", + "status": "in_progress", + "type": "message", + "phase": "commentary" + } + ], + "parallel_tool_calls": true, + "temperature": 1, + "tool_choice": "none", + "tools": [ + { + "name": "name", + "parameters": { + "foo": "bar" + }, + "strict": true, + "type": "function", + "defer_loading": true, + "description": "description" + } + ], + "top_p": 1, + "background": true, + "completed_at": 0, + "conversation": { + "id": "id" + }, + "max_output_tokens": 0, + "max_tool_calls": 0, + "moderation": { + "input": { + "categories": { + "foo": true + }, + "category_applied_input_types": { + "foo": [ + "text" + ] + }, + "category_scores": { + "foo": 0 + }, + "flagged": true, + "model": "model", + "type": "moderation_result" + }, + "output": { + "categories": { + "foo": true + }, + "category_applied_input_types": { + "foo": [ + "text" + ] + }, + "category_scores": { + "foo": 0 + }, + "flagged": true, + "model": "model", + "type": "moderation_result" + } + }, + "output_text": "output_text", + "previous_response_id": "previous_response_id", + "prompt": { + "id": "id", + "variables": { + "foo": "string" + }, + "version": "version" + }, + "prompt_cache_key": "prompt-cache-key-1234", + "prompt_cache_retention": "in_memory", + "reasoning": { + "effort": "none", + "generate_summary": "auto", + "summary": "auto" + }, + "safety_identifier": "safety-identifier-1234", + "service_tier": "auto", + "status": "completed", + "text": { + "format": { + "type": "text" + }, + "verbosity": "low" + }, + "top_logprobs": 0, + "truncation": "auto", + "usage": { + "input_tokens": 0, + "input_tokens_details": { + "cached_tokens": 0 + }, + "output_tokens": 0, + "output_tokens_details": { + "reasoning_tokens": 0 + }, + "total_tokens": 0 + }, + "user": "user-1234" +} +``` + +## Delete a model response + +`responses.delete(response_id) -> void` + +**delete** `/responses/{response_id}` + +Deletes a model response with the given ID. + +### Parameters + +- `response_id: String` + +### Example + +```ruby +require "openai" + +openai = OpenAI::Client.new(api_key: "My API Key") + +result = openai.responses.delete("resp_677efb5139a88190b512bc3fef8e535d") + +puts(result) +``` + +## Cancel a response + +`responses.cancel(response_id) -> Response` + +**post** `/responses/{response_id}/cancel` + +Cancels a model response with the given ID. Only responses created with +the `background` parameter set to `true` can be cancelled. +[Learn more](https://platform.openai.com/docs/guides/background). + +### Parameters + +- `response_id: String` + +### Returns + +- `class Response` + + - `id: String` + + Unique identifier for this Response. + + - `created_at: Float` + + Unix timestamp (in seconds) of when this Response was created. + + - `error: ResponseError` + + An error object returned when the model fails to generate a Response. + + - `code: :server_error | :rate_limit_exceeded | :invalid_prompt | 15 more` + + The error code for the response. + + - `: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` + + - `message: String` + + A human-readable description of the error. + + - `incomplete_details: IncompleteDetails{ reason}` + + Details about why the response is incomplete. + + - `reason: :max_output_tokens | :content_filter` + + The reason why the response is incomplete. + + - `:max_output_tokens` + + - `:content_filter` + + - `instructions: String | Array[ResponseInputItem]` + + A system (or developer) message inserted into the model's context. + + When using along with `previous_response_id`, the instructions from a previous + response will not be carried over to the next response. This makes it simple + to swap out system (or developer) messages in new responses. + + - `String = String` + + A text input to the model, equivalent to a text input with the + `developer` role. + + - `InputItemList = Array[ResponseInputItem]` + + A list of one or many input items to the model, containing + different content types. + + - `class EasyInputMessage` + + 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. + + - `content: String | ResponseInputMessageContentList` + + Text, image, or audio input to the model, used to generate a response. + Can also contain previous assistant responses. + + - `String = String` + + A text input to the model. + + - `ResponseInputMessageContentList = Array[ResponseInputContent]` + + A list of one or many input items to the model, containing different content + types. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `role: :user | :assistant | :system | :developer` + + The role of the message input. One of `user`, `assistant`, `system`, or + `developer`. + + - `:user` + + - `:assistant` + + - `:system` + + - `:developer` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `type: :message` + + The type of the message input. Always `message`. + + - `:message` + + - `class Message` + + 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. + + - `content: ResponseInputMessageContentList` + + A list of one or many input items to the model, containing different content + types. + + - `role: :user | :system | :developer` + + The role of the message input. One of `user`, `system`, or `developer`. + + - `:user` + + - `:system` + + - `:developer` + + - `status: :in_progress | :completed | :incomplete` + + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the message input. Always set to `message`. + + - `:message` + + - `class ResponseOutputMessage` + + An output message from the model. + + - `id: String` + + The unique ID of the output message. + + - `content: Array[ResponseOutputText | ResponseOutputRefusal]` + + The content of the output message. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `role: :assistant` + + The role of the output message. Always `assistant`. + + - `:assistant` + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the output message. Always `message`. + + - `:message` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `class ResponseFileSearchToolCall` + + 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. + + - `id: String` + + The unique ID of the file search tool call. + + - `queries: Array[String]` + + The queries used to search for files. + + - `status: :in_progress | :searching | :completed | 2 more` + + The status of the file search tool call. One of `in_progress`, + `searching`, `incomplete` or `failed`, + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `type: :file_search_call` + + The type of the file search tool call. Always `file_search_call`. + + - `:file_search_call` + + - `results: Array[Result{ attributes, file_id, filename, 2 more}]` + + The results of the file search tool call. + + - `attributes: Hash[Symbol, String | Float | bool]` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. Keys are strings + with a maximum length of 64 characters. Values are strings with a maximum + length of 512 characters, booleans, or numbers. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `file_id: String` + + The unique ID of the file. + + - `filename: String` + + The name of the file. + + - `score: Float` + + The relevance score of the file - a value between 0 and 1. + + - `text: String` + + The text that was retrieved from the file. + + - `class ResponseComputerToolCall` + + 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. + + - `id: String` + + The unique ID of the computer call. + + - `call_id: String` + + An identifier used when responding to the tool call with output. + + - `pending_safety_checks: Array[PendingSafetyCheck{ id, code, message}]` + + The pending safety checks for the computer call. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :computer_call` + + The type of the computer call. Always `computer_call`. + + - `:computer_call` + + - `action: Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `actions: ComputerActionList` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `class ComputerCallOutput` + + The output of a computer tool call. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `id: String` + + The ID of the computer tool call output. + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionWebSearch` + + 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. + + - `id: String` + + The unique ID of the web search tool call. + + - `action: Search{ type, queries, query, sources} | OpenPage{ type, url} | FindInPage{ pattern, type, url}` + + An object describing the specific action taken in this web search call. + Includes details on how the model used the web (search, open_page, find_in_page). + + - `class Search` + + Action type "search" - Performs a web search query. + + - `type: :search` + + The action type. + + - `:search` + + - `queries: Array[String]` + + The search queries. + + - `query: String` + + The search query. + + - `sources: Array[Source{ type, url}]` + + The sources used in the search. + + - `type: :url` + + The type of source. Always `url`. + + - `:url` + + - `url: String` + + The URL of the source. + + - `class OpenPage` + + Action type "open_page" - Opens a specific URL from search results. + + - `type: :open_page` + + The action type. + + - `:open_page` + + - `url: String` + + The URL opened by the model. + + - `class FindInPage` + + Action type "find_in_page": Searches for a pattern within a loaded page. + + - `pattern: String` + + The pattern or text to search for within the page. + + - `type: :find_in_page` + + The action type. + + - `:find_in_page` + + - `url: String` + + The URL of the page searched for the pattern. + + - `status: :in_progress | :searching | :completed | :failed` + + The status of the web search tool call. + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:failed` + + - `type: :web_search_call` + + The type of the web search tool call. Always `web_search_call`. + + - `:web_search_call` + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `arguments: String` + + A JSON string of the arguments to pass to the function. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `name: String` + + The name of the function to run. + + - `type: :function_call` + + The type of the function tool call. Always `function_call`. + + - `:function_call` + + - `id: String` + + The unique ID of the function tool call. + + - `namespace: String` + + The namespace of the function to run. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class FunctionCallOutput` + + The output of a function tool call. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | ResponseFunctionCallOutputItemList` + + Text, image, or file output of the function tool call. + + - `String = String` + + A JSON string of the output of the function tool call. + + - `ResponseFunctionCallOutputItemList = Array[ResponseFunctionCallOutputItem]` + + An array of content outputs (text, image, file) for the function tool call. + + - `class ResponseInputTextContent` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImageContent` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision) + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFileContent` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The base64-encoded data of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `id: String` + + The unique ID of the function tool call output. Populated when this item is returned via API. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ToolSearchCall` + + - `arguments: untyped` + + The arguments supplied to the tool search call. + + - `type: :tool_search_call` + + The item type. Always `tool_search_call`. + + - `:tool_search_call` + + - `id: String` + + The unique ID of this tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseToolSearchOutputItemParam` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by the tool search output. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The item type. Always `tool_search_output`. + + - `:tool_search_output` + + - `id: String` + + The unique ID of this tool search output. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class AdditionalTools` + + - `role: :developer` + + The role that provided the additional tools. Only `developer` is supported. + + - `:developer` + + - `tools: Array[Tool]` + + A list of additional tools made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The item type. Always `additional_tools`. + + - `:additional_tools` + + - `id: String` + + The unique ID of this additional tools item. + + - `class ResponseReasoningItem` + + 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). + + - `id: String` + + The unique identifier of the reasoning content. + + - `summary: Array[Summary{ text, type}]` + + Reasoning summary content. + + - `text: String` + + A summary of the reasoning output from the model so far. + + - `type: :summary_text` + + The type of the object. Always `summary_text`. + + - `:summary_text` + + - `type: :reasoning` + + The type of the object. Always `reasoning`. + + - `:reasoning` + + - `content: Array[Content{ text, type}]` + + Reasoning text content. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `encrypted_content: String` + + The encrypted content of the reasoning item - populated when a response is + generated with `reasoning.encrypted_content` in the `include` parameter. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseCompactionItemParam` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `encrypted_content: String` + + The encrypted content of the compaction summary. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `id: String` + + The ID of the compaction item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `id: String` + + The unique ID of the code interpreter tool call. + + - `code: String` + + The code to run, or null if not available. + + - `container_id: String` + + The ID of the container used to run the code. + + - `outputs: Array[Logs{ logs, type} | Image{ type, url}]` + + The outputs generated by the code interpreter, such as logs or images. + Can be null if no outputs are available. + + - `class Logs` + + The logs output from the code interpreter. + + - `logs: String` + + The logs output from the code interpreter. + + - `type: :logs` + + The type of the output. Always `logs`. + + - `:logs` + + - `class Image` + + The image output from the code interpreter. + + - `type: :image` + + The type of the output. Always `image`. + + - `:image` + + - `url: String` + + The URL of the image output from the code interpreter. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:interpreting` + + - `:failed` + + - `type: :code_interpreter_call` + + The type of the code interpreter tool call. Always `code_interpreter_call`. + + - `:code_interpreter_call` + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCall` + + A tool representing a request to execute one or more shell commands. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + Ordered shell commands for the execution environment to run. + + - `max_output_length: Integer` + + Maximum number of UTF-8 characters to capture from combined stdout and stderr output. + + - `timeout_ms: Integer` + + Maximum wall-clock time in milliseconds to allow the shell commands to run. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `environment: LocalEnvironment | ContainerReference` + + The environment to execute the shell commands in. + + - `class LocalEnvironment` + + - `class ContainerReference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCallOutput` + + The streamed output items emitted by a shell tool call. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `output: Array[ResponseFunctionShellCallOutputContent]` + + Captured chunks of stdout and stderr output, along with their associated outcomes. + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + The exit or timeout outcome associated with this shell call. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + The exit code returned by the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + Captured stderr output for the shell call. + + - `stdout: String` + + Captured stdout output for the shell call. + + - `type: :shell_call_output` + + The type of the item. Always `shell_call_output`. + + - `:shell_call_output` + + - `id: String` + + The unique ID of the shell tool call output. Populated when this item is returned via API. + + - `max_output_length: Integer` + + The maximum number of UTF-8 characters captured for this shell call's combined output. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ApplyPatchCall` + + A tool call representing a request to create, delete, or update files using diff patches. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + The specific create, delete, or update instruction for the apply_patch tool call. + + - `class CreateFile` + + Instruction for creating a new file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply when creating the file. + + - `path: String` + + Path of the file to create relative to the workspace root. + + - `type: :create_file` + + The operation type. Always `create_file`. + + - `:create_file` + + - `class DeleteFile` + + Instruction for deleting an existing file via the apply_patch tool. + + - `path: String` + + Path of the file to delete relative to the workspace root. + + - `type: :delete_file` + + The operation type. Always `delete_file`. + + - `:delete_file` + + - `class UpdateFile` + + Instruction for updating an existing file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply to the existing file. + + - `path: String` + + Path of the file to update relative to the workspace root. + + - `type: :update_file` + + The operation type. Always `update_file`. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `class ApplyPatchCallOutput` + + The streamed output emitted by an apply patch tool call. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `output: String` + + Optional human-readable log text from the apply patch tool (e.g., patch results or errors). + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `id: String` + + The unique ID of the approval response + + - `reason: String` + + Optional reason for the decision. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class ResponseCustomToolCallOutput` + + The output of a custom tool call from your code, being sent back to the model. + + - `call_id: String` + + The call ID, used to map this custom tool call output to a custom tool call. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the custom tool call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the custom tool call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :custom_tool_call_output` + + The type of the custom tool call output. Always `custom_tool_call_output`. + + - `:custom_tool_call_output` + + - `id: String` + + The unique ID of the custom tool call output in the OpenAI platform. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `call_id: String` + + An identifier used to map this custom tool call to a tool call output. + + - `input: String` + + The input for the custom tool call generated by the model. + + - `name: String` + + The name of the custom tool being called. + + - `type: :custom_tool_call` + + The type of the custom tool call. Always `custom_tool_call`. + + - `:custom_tool_call` + + - `id: String` + + The unique ID of the custom tool call in the OpenAI platform. + + - `namespace: String` + + The namespace of the custom tool being called. + + - `class CompactionTrigger` + + Compacts the current context. Must be the final input item. + + - `type: :compaction_trigger` + + The type of the item. Always `compaction_trigger`. + + - `:compaction_trigger` + + - `class ItemReference` + + An internal identifier for an item to reference. + + - `id: String` + + The ID of the item to reference. + + - `type: :item_reference` + + The type of item to reference. Always `item_reference`. + + - `:item_reference` + + - `metadata: Metadata` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. + + Keys are strings with a maximum length of 64 characters. Values are strings + with a maximum length of 512 characters. + + - `model: ResponsesModel` + + Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI + offers a wide range of models with different capabilities, performance + characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) + to browse and compare available models. + + - `String = String` + + - `ChatModel = :"gpt-5.4" | :"gpt-5.4-mini" | :"gpt-5.4-nano" | 75 more` + + - `:"gpt-5.4"` + + - `:"gpt-5.4-mini"` + + - `:"gpt-5.4-nano"` + + - `:"gpt-5.4-mini-2026-03-17"` + + - `:"gpt-5.4-nano-2026-03-17"` + + - `:"gpt-5.3-chat-latest"` + + - `:"gpt-5.2"` + + - `:"gpt-5.2-2025-12-11"` + + - `:"gpt-5.2-chat-latest"` + + - `:"gpt-5.2-pro"` + + - `:"gpt-5.2-pro-2025-12-11"` + + - `:"gpt-5.1"` + + - `:"gpt-5.1-2025-11-13"` + + - `:"gpt-5.1-codex"` + + - `:"gpt-5.1-mini"` + + - `:"gpt-5.1-chat-latest"` + + - `:"gpt-5"` + + - `:"gpt-5-mini"` + + - `:"gpt-5-nano"` + + - `:"gpt-5-2025-08-07"` + + - `:"gpt-5-mini-2025-08-07"` + + - `:"gpt-5-nano-2025-08-07"` + + - `:"gpt-5-chat-latest"` + + - `:"gpt-4.1"` + + - `:"gpt-4.1-mini"` + + - `:"gpt-4.1-nano"` + + - `:"gpt-4.1-2025-04-14"` + + - `:"gpt-4.1-mini-2025-04-14"` + + - `:"gpt-4.1-nano-2025-04-14"` + + - `:"o4-mini"` + + - `:"o4-mini-2025-04-16"` + + - `:o3` + + - `:"o3-2025-04-16"` + + - `:"o3-mini"` + + - `:"o3-mini-2025-01-31"` + + - `:o1` + + - `:"o1-2024-12-17"` + + - `:"o1-preview"` + + - `:"o1-preview-2024-09-12"` + + - `:"o1-mini"` + + - `:"o1-mini-2024-09-12"` + + - `:"gpt-4o"` + + - `:"gpt-4o-2024-11-20"` + + - `:"gpt-4o-2024-08-06"` + + - `:"gpt-4o-2024-05-13"` + + - `:"gpt-4o-audio-preview"` + + - `:"gpt-4o-audio-preview-2024-10-01"` + + - `:"gpt-4o-audio-preview-2024-12-17"` + + - `:"gpt-4o-audio-preview-2025-06-03"` + + - `:"gpt-4o-mini-audio-preview"` + + - `:"gpt-4o-mini-audio-preview-2024-12-17"` + + - `:"gpt-4o-search-preview"` + + - `:"gpt-4o-mini-search-preview"` + + - `:"gpt-4o-search-preview-2025-03-11"` + + - `:"gpt-4o-mini-search-preview-2025-03-11"` + + - `:"chatgpt-4o-latest"` + + - `:"codex-mini-latest"` + + - `:"gpt-4o-mini"` + + - `:"gpt-4o-mini-2024-07-18"` + + - `:"gpt-4-turbo"` + + - `:"gpt-4-turbo-2024-04-09"` + + - `:"gpt-4-0125-preview"` + + - `:"gpt-4-turbo-preview"` + + - `:"gpt-4-1106-preview"` + + - `:"gpt-4-vision-preview"` + + - `:"gpt-4"` + + - `:"gpt-4-0314"` + + - `:"gpt-4-0613"` + + - `:"gpt-4-32k"` + + - `:"gpt-4-32k-0314"` + + - `:"gpt-4-32k-0613"` + + - `:"gpt-3.5-turbo"` + + - `:"gpt-3.5-turbo-16k"` + + - `:"gpt-3.5-turbo-0301"` + + - `:"gpt-3.5-turbo-0613"` + + - `:"gpt-3.5-turbo-1106"` + + - `:"gpt-3.5-turbo-0125"` + + - `:"gpt-3.5-turbo-16k-0613"` + + - `ResponsesOnlyModel = :"o1-pro" | :"o1-pro-2025-03-19" | :"o3-pro" | 11 more` + + - `:"o1-pro"` + + - `:"o1-pro-2025-03-19"` + + - `:"o3-pro"` + + - `:"o3-pro-2025-06-10"` + + - `:"o3-deep-research"` + + - `:"o3-deep-research-2025-06-26"` + + - `:"o4-mini-deep-research"` + + - `:"o4-mini-deep-research-2025-06-26"` + + - `:"computer-use-preview"` + + - `:"computer-use-preview-2025-03-11"` + + - `:"gpt-5-codex"` + + - `:"gpt-5-pro"` + + - `:"gpt-5-pro-2025-10-06"` + + - `:"gpt-5.1-codex-max"` + + - `object: :response` + + The object type of this resource - always set to `response`. + + - `:response` + + - `output: Array[ResponseOutputItem]` + + An array of content items generated by the model. + + - The length and order of items in the `output` array is dependent + on the model's response. + - Rather than accessing the first item in the `output` array and + assuming it's an `assistant` message with the content generated by + the model, you might consider using the `output_text` property where + supported in SDKs. + + - `class ResponseOutputMessage` + + An output message from the model. + + - `class ResponseFileSearchToolCall` + + 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. + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `class ResponseFunctionToolCallOutputItem` + + - `id: String` + + The unique ID of the function call tool output. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the function call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the function call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the function call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseFunctionWebSearch` + + 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. + + - `class ResponseComputerToolCall` + + 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. + + - `class ResponseComputerToolCallOutputItem` + + - `id: String` + + The unique ID of the computer call tool output. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `status: :completed | :incomplete | :failed | :in_progress` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `:in_progress` + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the + developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseReasoningItem` + + 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). + + - `class ResponseToolSearchCall` + + - `id: String` + + The unique ID of the tool search call item. + + - `arguments: untyped` + + Arguments used for the tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :tool_search_call` + + The type of the item. Always `tool_search_call`. + + - `:tool_search_call` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseToolSearchOutputItem` + + - `id: String` + + The unique ID of the tool search output item. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by tool search. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :tool_search_output` + + The type of the item. Always `tool_search_output`. + + - `:tool_search_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class AdditionalTools` + + - `id: String` + + The unique ID of the additional tools item. + + - `role: :unknown | :user | :assistant | 5 more` + + The role that provided the additional tools. + + - `:unknown` + + - `:user` + + - `:assistant` + + - `:system` + + - `:critic` + + - `:discriminator` + + - `:developer` + + - `:tool` + + - `tools: Array[Tool]` + + The additional tool definitions made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The type of the item. Always `additional_tools`. + + - `:additional_tools` + + - `class ResponseCompactionItem` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `id: String` + + The unique ID of the compaction item. + + - `encrypted_content: String` + + The encrypted content that was produced by compaction. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionShellToolCall` + + A tool call that executes one or more shell commands in a managed environment. + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + - `max_output_length: Integer` + + Optional maximum number of characters to return from each command. + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the commands. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `environment: ResponseLocalEnvironment | ResponseContainerReference` + + Represents the use of a local environment to perform shell actions. + + - `class ResponseLocalEnvironment` + + Represents the use of a local environment to perform shell actions. + + - `type: :local` + + The environment type. Always `local`. + + - `:local` + + - `class ResponseContainerReference` + + Represents a container created with /v1/containers. + + - `container_id: String` + + - `type: :container_reference` + + The environment type. Always `container_reference`. + + - `:container_reference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseFunctionShellToolCallOutput` + + The output of a shell tool call that was emitted. + + - `id: String` + + The unique ID of the shell call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `max_output_length: Integer` + + The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output. + + - `output: Array[Output{ outcome, stderr, stdout, created_by}]` + + An array of shell call output contents + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + Exit code from the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + The standard error output that was captured. + + - `stdout: String` + + The standard output that was captured. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call_output` + + The type of the shell call output. Always `shell_call_output`. + + - `:shell_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseApplyPatchToolCall` + + A tool call that applies file diffs by creating, deleting, or updating files. + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + One of the create_file, delete_file, or update_file operations applied via apply_patch. + + - `class CreateFile` + + Instruction describing how to create a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to create. + + - `type: :create_file` + + Create a new file with the provided diff. + + - `:create_file` + + - `class DeleteFile` + + Instruction describing how to delete a file via the apply_patch tool. + + - `path: String` + + Path of the file to delete. + + - `type: :delete_file` + + Delete the specified file. + + - `:delete_file` + + - `class UpdateFile` + + Instruction describing how to update a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to update. + + - `type: :update_file` + + Update an existing file with the provided diff. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseApplyPatchToolCallOutput` + + The output emitted by an apply patch tool call. + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `created_by: String` + + The ID of the entity that created this tool call output. + + - `output: String` + + Optional textual output returned by the apply patch tool. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `id: String` + + The unique ID of the approval response + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `reason: String` + + Optional reason for the decision. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `class ResponseCustomToolCallOutputItem` + + The output of a custom tool call from your code, being sent back to the model. + + - `id: String` + + The unique ID of the custom tool call output item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `parallel_tool_calls: bool` + + Whether to allow the model to run tool calls in parallel. + + - `temperature: Float` + + 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. + + - `tool_choice: ToolChoiceOptions | ToolChoiceAllowed | ToolChoiceTypes | 5 more` + + How the model should select which tool (or tools) to use when generating + a response. See the `tools` parameter to see how to specify which tools + the model can call. + + - `ToolChoiceOptions = :none | :auto | :required` + + Controls which (if any) tool is called by the model. + + `none` means the model will not call any tool and instead generates a message. + + `auto` means the model can pick between generating a message or calling one or + more tools. + + `required` means the model must call one or more tools. + + - `:none` + + - `:auto` + + - `:required` + + - `class ToolChoiceAllowed` + + Constrains the tools available to the model to a pre-defined set. + + - `mode: :auto | :required` + + Constrains the tools available to the model to a pre-defined set. + + `auto` allows the model to pick from among the allowed tools and generate a + message. + + `required` requires the model to call one or more of the allowed tools. + + - `:auto` + + - `:required` + + - `tools: Array[Hash[Symbol, untyped]]` + + A list of tool definitions that the model should be allowed to call. + + For the Responses API, the list of tool definitions might look like: + + ```json + [ + { "type": "function", "name": "get_weather" }, + { "type": "mcp", "server_label": "deepwiki" }, + { "type": "image_generation" } + ] + ``` + + - `type: :allowed_tools` + + Allowed tool configuration type. Always `allowed_tools`. + + - `:allowed_tools` + + - `class ToolChoiceTypes` + + 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). + + - `type: :file_search | :web_search_preview | :computer | 5 more` + + The type of hosted tool the model should to use. Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + + Allowed values are: + + - `file_search` + - `web_search_preview` + - `computer` + - `computer_use_preview` + - `computer_use` + - `code_interpreter` + - `image_generation` + + - `:file_search` + + - `:web_search_preview` + + - `:computer` + + - `:computer_use_preview` + + - `:computer_use` + + - `:web_search_preview_2025_03_11` + + - `:image_generation` + + - `:code_interpreter` + + - `class ToolChoiceFunction` + + Use this option to force the model to call a specific function. + + - `name: String` + + The name of the function to call. + + - `type: :function` + + For function calling, the type is always `function`. + + - `:function` + + - `class ToolChoiceMcp` + + Use this option to force the model to call a specific tool on a remote MCP server. + + - `server_label: String` + + The label of the MCP server to use. + + - `type: :mcp` + + For MCP tools, the type is always `mcp`. + + - `:mcp` + + - `name: String` + + The name of the tool to call on the server. + + - `class ToolChoiceCustom` + + Use this option to force the model to call a specific custom tool. + + - `name: String` + + The name of the custom tool to call. + + - `type: :custom` + + For custom tool calling, the type is always `custom`. + + - `:custom` + + - `class ToolChoiceApplyPatch` + + Forces the model to call the apply_patch tool when executing a tool call. + + - `type: :apply_patch` + + The tool to call. Always `apply_patch`. + + - `:apply_patch` + + - `class ToolChoiceShell` + + Forces the model to call the shell tool when a tool call is required. + + - `type: :shell` + + The tool to call. Always `shell`. + + - `:shell` + + - `tools: Array[Tool]` + + An array of tools the model may call while generating a response. You + can specify which tool to use by setting the `tool_choice` parameter. + + We support the following categories of tools: + + - **Built-in tools**: Tools that are provided by OpenAI that extend the + model's capabilities, like [web search](https://platform.openai.com/docs/guides/tools-web-search) + or [file search](https://platform.openai.com/docs/guides/tools-file-search). Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + - **MCP Tools**: Integrations with third-party systems via custom MCP servers + or predefined connectors such as Google Drive and SharePoint. Learn more about + [MCP Tools](https://platform.openai.com/docs/guides/tools-connectors-mcp). + - **Function calls (custom tools)**: Functions that are defined by you, + enabling the model to call your own code with strongly typed arguments + and outputs. Learn more about + [function calling](https://platform.openai.com/docs/guides/function-calling). You can also use + custom tools to call your own code. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `top_p: Float` + + 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. + + - `background: bool` + + Whether to run the model response in the background. + [Learn more](https://platform.openai.com/docs/guides/background). + + - `completed_at: Float` + + Unix timestamp (in seconds) of when this Response was completed. + Only present when the status is `completed`. + + - `conversation: Conversation{ id}` + + The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation. + + - `id: String` + + The unique ID of the conversation that this response was associated with. + + - `max_output_tokens: Integer` + + An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://platform.openai.com/docs/guides/reasoning). + + - `max_tool_calls: Integer` + + 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. + + - `moderation: Moderation{ input, output}` + + Moderation results for the response input and output, if moderated completions were requested. + + - `input: ModerationResult{ categories, category_applied_input_types, category_scores, 3 more} | Error{ code, message, type}` + + Moderation for the response input. + + - `class ModerationResult` + + A moderation result produced for the response input or output. + + - `categories: Hash[Symbol, bool]` + + A dictionary of moderation categories to booleans, True if the input is flagged under this category. + + - `category_applied_input_types: Hash[Symbol, Array[:text | :image]]` + + Which modalities of input are reflected by the score for each category. + + - `:text` + + - `:image` + + - `category_scores: Hash[Symbol, Float]` + + A dictionary of moderation categories to scores. + + - `flagged: bool` + + A boolean indicating whether the content was flagged by any category. + + - `model: String` + + The moderation model that produced this result. + + - `type: :moderation_result` + + The object type, which was always `moderation_result` for successful moderation results. + + - `:moderation_result` + + - `class Error` + + An error produced while attempting moderation for the response input or output. + + - `code: String` + + The error code. + + - `message: String` + + The error message. + + - `type: :error` + + The object type, which was always `error` for moderation failures. + + - `:error` + + - `output: ModerationResult{ categories, category_applied_input_types, category_scores, 3 more} | Error{ code, message, type}` + + Moderation for the response output. + + - `class ModerationResult` + + A moderation result produced for the response input or output. + + - `categories: Hash[Symbol, bool]` + + A dictionary of moderation categories to booleans, True if the input is flagged under this category. + + - `category_applied_input_types: Hash[Symbol, Array[:text | :image]]` + + Which modalities of input are reflected by the score for each category. + + - `:text` + + - `:image` + + - `category_scores: Hash[Symbol, Float]` + + A dictionary of moderation categories to scores. + + - `flagged: bool` + + A boolean indicating whether the content was flagged by any category. + + - `model: String` + + The moderation model that produced this result. + + - `type: :moderation_result` + + The object type, which was always `moderation_result` for successful moderation results. + + - `:moderation_result` + + - `class Error` + + An error produced while attempting moderation for the response input or output. + + - `code: String` + + The error code. + + - `message: String` + + The error message. + + - `type: :error` + + The object type, which was always `error` for moderation failures. + + - `:error` + + - `previous_response_id: String` + + The unique ID of the previous response to the model. Use this to + create multi-turn conversations. Learn more about + [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. + + - `prompt: ResponsePrompt` + + Reference to a prompt template and its variables. + [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts). + + - `id: String` + + The unique identifier of the prompt template to use. + + - `variables: Hash[Symbol, String | ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Optional map of values to substitute in for variables in your + prompt. The substitution values can either be strings, or other + Response input types like images or files. + + - `String = String` + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `version: String` + + Optional version of the prompt template. + + - `prompt_cache_key: String` + + Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://platform.openai.com/docs/guides/prompt-caching). + + - `prompt_cache_retention: :in_memory | :"24h"` + + The retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention). + For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported. + + For older models that support both `in_memory` and `24h`, the default depends on your organization's data retention policy: + + - Organizations without ZDR enabled default to `24h`. + - Organizations with ZDR enabled default to `in_memory` when `prompt_cache_retention` is not specified. + + - `:in_memory` + + - `:"24h"` + + - `reasoning: Reasoning` + + **gpt-5 and o-series models only** + + Configuration options for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + + - `effort: ReasoningEffort` + + Constrains effort on reasoning for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing + reasoning effort can result in faster responses and fewer tokens used + on reasoning in a response. + + - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1. + - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. + - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. + - `xhigh` is supported for all models after `gpt-5.1-codex-max`. + + - `:none` + + - `:minimal` + + - `:low` + + - `:medium` + + - `:high` + + - `:xhigh` + + - `generate_summary: :auto | :concise | :detailed` + + **Deprecated:** use `summary` instead. + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `summary: :auto | :concise | :detailed` + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + `concise` is supported for `computer-use-preview` models and all reasoning models after `gpt-5`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `safety_identifier: String` + + A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + + - `service_tier: :auto | :default | :flex | 2 more` + + Specifies the processing type used for serving the request. + + - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. + - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. + - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier. + - When not set, the default behavior is 'auto'. + + When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter. + + - `:auto` + + - `:default` + + - `:flex` + + - `:scale` + + - `:priority` + + - `status: ResponseStatus` + + The status of the response generation. One of `completed`, `failed`, + `in_progress`, `cancelled`, `queued`, or `incomplete`. + + - `:completed` + + - `:failed` + + - `:in_progress` + + - `:cancelled` + + - `:queued` + + - `:incomplete` + + - `text: ResponseTextConfig` + + 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) + + - `format_: ResponseFormatTextConfig` + + An object specifying the format that the model must output. + + Configuring `{ "type": "json_schema" }` enables Structured Outputs, + which ensures the model will match your supplied JSON schema. Learn more in the + [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). + + The default format is `{ "type": "text" }` with no additional options. + + **Not recommended for gpt-4o and newer models:** + + Setting to `{ "type": "json_object" }` enables the older JSON mode, which + ensures the message the model generates is valid JSON. Using `json_schema` + is preferred for models that support it. + + - `class ResponseFormatText` + + Default response format. Used to generate text responses. + + - `type: :text` + + The type of response format being defined. Always `text`. + + - `:text` + + - `class ResponseFormatTextJSONSchemaConfig` + + JSON Schema response format. Used to generate structured JSON responses. + Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). + + - `name: String` + + The name of the response format. Must be a-z, A-Z, 0-9, or contain + underscores and dashes, with a maximum length of 64. + + - `schema: Hash[Symbol, untyped]` + + The schema for the response format, described as a JSON Schema object. + Learn how to build JSON schemas [here](https://json-schema.org/). + + - `type: :json_schema` + + The type of response format being defined. Always `json_schema`. + + - `:json_schema` + + - `description: String` + + A description of what the response format is for, used by the model to + determine how to respond in the format. + + - `strict: bool` + + Whether to enable strict schema adherence when generating the output. + If set to true, the model will always follow the exact schema defined + in the `schema` field. Only a subset of JSON Schema is supported when + `strict` is `true`. To learn more, read the [Structured Outputs + guide](https://platform.openai.com/docs/guides/structured-outputs). + + - `class ResponseFormatJSONObject` + + 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. + + - `type: :json_object` + + The type of response format being defined. Always `json_object`. + + - `:json_object` + + - `verbosity: :low | :medium | :high` + + Constrains the verbosity of the model's response. Lower values will result in + more concise responses, while higher values will result in more verbose responses. + Currently supported values are `low`, `medium`, and `high`. + + - `:low` + + - `:medium` + + - `:high` + + - `top_logprobs: Integer` + + An integer between 0 and 20 specifying the maximum number of most likely + tokens to return at each token position, each with an associated log + probability. In some cases, the number of returned tokens may be fewer than + requested. + + - `truncation: :auto | :disabled` + + The truncation strategy to use for the model response. + + - `auto`: If the input to this Response exceeds + the model's context window size, the model will truncate the + response to fit the context window by dropping items from the beginning of the conversation. + - `disabled` (default): If the input size will exceed the context window + size for a model, the request will fail with a 400 error. + + - `:auto` + + - `:disabled` + + - `usage: ResponseUsage` + + Represents token usage details including input tokens, output tokens, + a breakdown of output tokens, and the total tokens used. + + - `input_tokens: Integer` + + The number of input tokens. + + - `input_tokens_details: InputTokensDetails{ cached_tokens}` + + A detailed breakdown of the input tokens. + + - `cached_tokens: Integer` + + The number of tokens that were retrieved from the cache. + [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching). + + - `output_tokens: Integer` + + The number of output tokens. + + - `output_tokens_details: OutputTokensDetails{ reasoning_tokens}` + + A detailed breakdown of the output tokens. + + - `reasoning_tokens: Integer` + + The number of reasoning tokens. + + - `total_tokens: Integer` + + The total number of tokens used. + + - `user: String` + + This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. + A stable identifier for your end-users. + Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + +### Example + +```ruby +require "openai" + +openai = OpenAI::Client.new(api_key: "My API Key") + +response = openai.responses.cancel("resp_677efb5139a88190b512bc3fef8e535d") + +puts(response) +``` + +#### Response + +```json +{ + "id": "id", + "created_at": 0, + "error": { + "code": "server_error", + "message": "message" + }, + "incomplete_details": { + "reason": "max_output_tokens" + }, + "instructions": "string", + "metadata": { + "foo": "string" + }, + "model": "gpt-5.1", + "object": "response", + "output": [ + { + "id": "id", + "content": [ + { + "annotations": [ + { + "file_id": "file_id", + "filename": "filename", + "index": 0, + "type": "file_citation" + } + ], + "text": "text", + "type": "output_text", + "logprobs": [ + { + "token": "token", + "bytes": [ + 0 + ], + "logprob": 0, + "top_logprobs": [ + { + "token": "token", + "bytes": [ + 0 + ], + "logprob": 0 + } + ] + } + ] + } + ], + "role": "assistant", + "status": "in_progress", + "type": "message", + "phase": "commentary" + } + ], + "parallel_tool_calls": true, + "temperature": 1, + "tool_choice": "none", + "tools": [ + { + "name": "name", + "parameters": { + "foo": "bar" + }, + "strict": true, + "type": "function", + "defer_loading": true, + "description": "description" + } + ], + "top_p": 1, + "background": true, + "completed_at": 0, + "conversation": { + "id": "id" + }, + "max_output_tokens": 0, + "max_tool_calls": 0, + "moderation": { + "input": { + "categories": { + "foo": true + }, + "category_applied_input_types": { + "foo": [ + "text" + ] + }, + "category_scores": { + "foo": 0 + }, + "flagged": true, + "model": "model", + "type": "moderation_result" + }, + "output": { + "categories": { + "foo": true + }, + "category_applied_input_types": { + "foo": [ + "text" + ] + }, + "category_scores": { + "foo": 0 + }, + "flagged": true, + "model": "model", + "type": "moderation_result" + } + }, + "output_text": "output_text", + "previous_response_id": "previous_response_id", + "prompt": { + "id": "id", + "variables": { + "foo": "string" + }, + "version": "version" + }, + "prompt_cache_key": "prompt-cache-key-1234", + "prompt_cache_retention": "in_memory", + "reasoning": { + "effort": "none", + "generate_summary": "auto", + "summary": "auto" + }, + "safety_identifier": "safety-identifier-1234", + "service_tier": "auto", + "status": "completed", + "text": { + "format": { + "type": "text" + }, + "verbosity": "low" + }, + "top_logprobs": 0, + "truncation": "auto", + "usage": { + "input_tokens": 0, + "input_tokens_details": { + "cached_tokens": 0 + }, + "output_tokens": 0, + "output_tokens_details": { + "reasoning_tokens": 0 + }, + "total_tokens": 0 + }, + "user": "user-1234" +} +``` + +## Compact a response + +`responses.compact(**kwargs) -> CompactedResponse` + +**post** `/responses/compact` + +Compact a conversation. Returns a compacted response object. + +Learn when and how to compact long-running conversations in the [conversation state guide](https://platform.openai.com/docs/guides/conversation-state#managing-the-context-window). For ZDR-compatible compaction details, see [Compaction (advanced)](https://platform.openai.com/docs/guides/conversation-state#compaction-advanced). + +### Parameters + +- `model: :"gpt-5.4" | :"gpt-5.4-mini" | :"gpt-5.4-nano" | 89 more | String` + + Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) to browse and compare available models. + + - `Model = :"gpt-5.4" | :"gpt-5.4-mini" | :"gpt-5.4-nano" | 89 more` + + Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) to browse and compare available models. + + - `:"gpt-5.4"` + + - `:"gpt-5.4-mini"` + + - `:"gpt-5.4-nano"` + + - `:"gpt-5.4-mini-2026-03-17"` + + - `:"gpt-5.4-nano-2026-03-17"` + + - `:"gpt-5.3-chat-latest"` + + - `:"gpt-5.2"` + + - `:"gpt-5.2-2025-12-11"` + + - `:"gpt-5.2-chat-latest"` + + - `:"gpt-5.2-pro"` + + - `:"gpt-5.2-pro-2025-12-11"` + + - `:"gpt-5.1"` + + - `:"gpt-5.1-2025-11-13"` + + - `:"gpt-5.1-codex"` + + - `:"gpt-5.1-mini"` + + - `:"gpt-5.1-chat-latest"` + + - `:"gpt-5"` + + - `:"gpt-5-mini"` + + - `:"gpt-5-nano"` + + - `:"gpt-5-2025-08-07"` + + - `:"gpt-5-mini-2025-08-07"` + + - `:"gpt-5-nano-2025-08-07"` + + - `:"gpt-5-chat-latest"` + + - `:"gpt-4.1"` + + - `:"gpt-4.1-mini"` + + - `:"gpt-4.1-nano"` + + - `:"gpt-4.1-2025-04-14"` + + - `:"gpt-4.1-mini-2025-04-14"` + + - `:"gpt-4.1-nano-2025-04-14"` + + - `:"o4-mini"` + + - `:"o4-mini-2025-04-16"` + + - `:o3` + + - `:"o3-2025-04-16"` + + - `:"o3-mini"` + + - `:"o3-mini-2025-01-31"` + + - `:o1` + + - `:"o1-2024-12-17"` + + - `:"o1-preview"` + + - `:"o1-preview-2024-09-12"` + + - `:"o1-mini"` + + - `:"o1-mini-2024-09-12"` + + - `:"gpt-4o"` + + - `:"gpt-4o-2024-11-20"` + + - `:"gpt-4o-2024-08-06"` + + - `:"gpt-4o-2024-05-13"` + + - `:"gpt-4o-audio-preview"` + + - `:"gpt-4o-audio-preview-2024-10-01"` + + - `:"gpt-4o-audio-preview-2024-12-17"` + + - `:"gpt-4o-audio-preview-2025-06-03"` + + - `:"gpt-4o-mini-audio-preview"` + + - `:"gpt-4o-mini-audio-preview-2024-12-17"` + + - `:"gpt-4o-search-preview"` + + - `:"gpt-4o-mini-search-preview"` + + - `:"gpt-4o-search-preview-2025-03-11"` + + - `:"gpt-4o-mini-search-preview-2025-03-11"` + + - `:"chatgpt-4o-latest"` + + - `:"codex-mini-latest"` + + - `:"gpt-4o-mini"` + + - `:"gpt-4o-mini-2024-07-18"` + + - `:"gpt-4-turbo"` + + - `:"gpt-4-turbo-2024-04-09"` + + - `:"gpt-4-0125-preview"` + + - `:"gpt-4-turbo-preview"` + + - `:"gpt-4-1106-preview"` + + - `:"gpt-4-vision-preview"` + + - `:"gpt-4"` + + - `:"gpt-4-0314"` + + - `:"gpt-4-0613"` + + - `:"gpt-4-32k"` + + - `:"gpt-4-32k-0314"` + + - `:"gpt-4-32k-0613"` + + - `:"gpt-3.5-turbo"` + + - `:"gpt-3.5-turbo-16k"` + + - `:"gpt-3.5-turbo-0301"` + + - `:"gpt-3.5-turbo-0613"` + + - `:"gpt-3.5-turbo-1106"` + + - `:"gpt-3.5-turbo-0125"` + + - `:"gpt-3.5-turbo-16k-0613"` + + - `:"o1-pro"` + + - `:"o1-pro-2025-03-19"` + + - `:"o3-pro"` + + - `:"o3-pro-2025-06-10"` + + - `:"o3-deep-research"` + + - `:"o3-deep-research-2025-06-26"` + + - `:"o4-mini-deep-research"` + + - `:"o4-mini-deep-research-2025-06-26"` + + - `:"computer-use-preview"` + + - `:"computer-use-preview-2025-03-11"` + + - `:"gpt-5-codex"` + + - `:"gpt-5-pro"` + + - `:"gpt-5-pro-2025-10-06"` + + - `:"gpt-5.1-codex-max"` + + - `String = String` + +- `input: String | Array[ResponseInputItem]` + + Text, image, or file inputs to the model, used to generate a response + + - `String = String` + + A text input to the model, equivalent to a text input with the `user` role. + + - `UnionMember1 = Array[ResponseInputItem]` + + A list of one or many input items to the model, containing different content types. + + - `class EasyInputMessage` + + 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. + + - `content: String | ResponseInputMessageContentList` + + Text, image, or audio input to the model, used to generate a response. + Can also contain previous assistant responses. + + - `String = String` + + A text input to the model. + + - `ResponseInputMessageContentList = Array[ResponseInputContent]` + + A list of one or many input items to the model, containing different content + types. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `role: :user | :assistant | :system | :developer` + + The role of the message input. One of `user`, `assistant`, `system`, or + `developer`. + + - `:user` + + - `:assistant` + + - `:system` + + - `:developer` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `type: :message` + + The type of the message input. Always `message`. + + - `:message` + + - `class Message` + + 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. + + - `content: ResponseInputMessageContentList` + + A list of one or many input items to the model, containing different content + types. + + - `role: :user | :system | :developer` + + The role of the message input. One of `user`, `system`, or `developer`. + + - `:user` + + - `:system` + + - `:developer` + + - `status: :in_progress | :completed | :incomplete` + + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the message input. Always set to `message`. + + - `:message` + + - `class ResponseOutputMessage` + + An output message from the model. + + - `id: String` + + The unique ID of the output message. + + - `content: Array[ResponseOutputText | ResponseOutputRefusal]` + + The content of the output message. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `role: :assistant` + + The role of the output message. Always `assistant`. + + - `:assistant` + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the output message. Always `message`. + + - `:message` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `class ResponseFileSearchToolCall` + + 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. + + - `id: String` + + The unique ID of the file search tool call. + + - `queries: Array[String]` + + The queries used to search for files. + + - `status: :in_progress | :searching | :completed | 2 more` + + The status of the file search tool call. One of `in_progress`, + `searching`, `incomplete` or `failed`, + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `type: :file_search_call` + + The type of the file search tool call. Always `file_search_call`. + + - `:file_search_call` + + - `results: Array[Result{ attributes, file_id, filename, 2 more}]` + + The results of the file search tool call. + + - `attributes: Hash[Symbol, String | Float | bool]` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. Keys are strings + with a maximum length of 64 characters. Values are strings with a maximum + length of 512 characters, booleans, or numbers. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `file_id: String` + + The unique ID of the file. + + - `filename: String` + + The name of the file. + + - `score: Float` + + The relevance score of the file - a value between 0 and 1. + + - `text: String` + + The text that was retrieved from the file. + + - `class ResponseComputerToolCall` + + 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. + + - `id: String` + + The unique ID of the computer call. + + - `call_id: String` + + An identifier used when responding to the tool call with output. + + - `pending_safety_checks: Array[PendingSafetyCheck{ id, code, message}]` + + The pending safety checks for the computer call. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :computer_call` + + The type of the computer call. Always `computer_call`. + + - `:computer_call` + + - `action: Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `actions: ComputerActionList` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `class ComputerCallOutput` + + The output of a computer tool call. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `id: String` + + The ID of the computer tool call output. + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionWebSearch` + + 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. + + - `id: String` + + The unique ID of the web search tool call. + + - `action: Search{ type, queries, query, sources} | OpenPage{ type, url} | FindInPage{ pattern, type, url}` + + An object describing the specific action taken in this web search call. + Includes details on how the model used the web (search, open_page, find_in_page). + + - `class Search` + + Action type "search" - Performs a web search query. + + - `type: :search` + + The action type. + + - `:search` + + - `queries: Array[String]` + + The search queries. + + - `query: String` + + The search query. + + - `sources: Array[Source{ type, url}]` + + The sources used in the search. + + - `type: :url` + + The type of source. Always `url`. + + - `:url` + + - `url: String` + + The URL of the source. + + - `class OpenPage` + + Action type "open_page" - Opens a specific URL from search results. + + - `type: :open_page` + + The action type. + + - `:open_page` + + - `url: String` + + The URL opened by the model. + + - `class FindInPage` + + Action type "find_in_page": Searches for a pattern within a loaded page. + + - `pattern: String` + + The pattern or text to search for within the page. + + - `type: :find_in_page` + + The action type. + + - `:find_in_page` + + - `url: String` + + The URL of the page searched for the pattern. + + - `status: :in_progress | :searching | :completed | :failed` + + The status of the web search tool call. + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:failed` + + - `type: :web_search_call` + + The type of the web search tool call. Always `web_search_call`. + + - `:web_search_call` + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `arguments: String` + + A JSON string of the arguments to pass to the function. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `name: String` + + The name of the function to run. + + - `type: :function_call` + + The type of the function tool call. Always `function_call`. + + - `:function_call` + + - `id: String` + + The unique ID of the function tool call. + + - `namespace: String` + + The namespace of the function to run. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class FunctionCallOutput` + + The output of a function tool call. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | ResponseFunctionCallOutputItemList` + + Text, image, or file output of the function tool call. + + - `String = String` + + A JSON string of the output of the function tool call. + + - `ResponseFunctionCallOutputItemList = Array[ResponseFunctionCallOutputItem]` + + An array of content outputs (text, image, file) for the function tool call. + + - `class ResponseInputTextContent` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImageContent` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision) + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFileContent` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The base64-encoded data of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `id: String` + + The unique ID of the function tool call output. Populated when this item is returned via API. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ToolSearchCall` + + - `arguments: untyped` + + The arguments supplied to the tool search call. + + - `type: :tool_search_call` + + The item type. Always `tool_search_call`. + + - `:tool_search_call` + + - `id: String` + + The unique ID of this tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseToolSearchOutputItemParam` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by the tool search output. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The item type. Always `tool_search_output`. + + - `:tool_search_output` + + - `id: String` + + The unique ID of this tool search output. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class AdditionalTools` + + - `role: :developer` + + The role that provided the additional tools. Only `developer` is supported. + + - `:developer` + + - `tools: Array[Tool]` + + A list of additional tools made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The item type. Always `additional_tools`. + + - `:additional_tools` + + - `id: String` + + The unique ID of this additional tools item. + + - `class ResponseReasoningItem` + + 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). + + - `id: String` + + The unique identifier of the reasoning content. + + - `summary: Array[Summary{ text, type}]` + + Reasoning summary content. + + - `text: String` + + A summary of the reasoning output from the model so far. + + - `type: :summary_text` + + The type of the object. Always `summary_text`. + + - `:summary_text` + + - `type: :reasoning` + + The type of the object. Always `reasoning`. + + - `:reasoning` + + - `content: Array[Content{ text, type}]` + + Reasoning text content. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `encrypted_content: String` + + The encrypted content of the reasoning item - populated when a response is + generated with `reasoning.encrypted_content` in the `include` parameter. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseCompactionItemParam` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `encrypted_content: String` + + The encrypted content of the compaction summary. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `id: String` + + The ID of the compaction item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `id: String` + + The unique ID of the code interpreter tool call. + + - `code: String` + + The code to run, or null if not available. + + - `container_id: String` + + The ID of the container used to run the code. + + - `outputs: Array[Logs{ logs, type} | Image{ type, url}]` + + The outputs generated by the code interpreter, such as logs or images. + Can be null if no outputs are available. + + - `class Logs` + + The logs output from the code interpreter. + + - `logs: String` + + The logs output from the code interpreter. + + - `type: :logs` + + The type of the output. Always `logs`. + + - `:logs` + + - `class Image` + + The image output from the code interpreter. + + - `type: :image` + + The type of the output. Always `image`. + + - `:image` + + - `url: String` + + The URL of the image output from the code interpreter. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:interpreting` + + - `:failed` + + - `type: :code_interpreter_call` + + The type of the code interpreter tool call. Always `code_interpreter_call`. + + - `:code_interpreter_call` + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCall` + + A tool representing a request to execute one or more shell commands. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + Ordered shell commands for the execution environment to run. + + - `max_output_length: Integer` + + Maximum number of UTF-8 characters to capture from combined stdout and stderr output. + + - `timeout_ms: Integer` + + Maximum wall-clock time in milliseconds to allow the shell commands to run. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `environment: LocalEnvironment | ContainerReference` + + The environment to execute the shell commands in. + + - `class LocalEnvironment` + + - `class ContainerReference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCallOutput` + + The streamed output items emitted by a shell tool call. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `output: Array[ResponseFunctionShellCallOutputContent]` + + Captured chunks of stdout and stderr output, along with their associated outcomes. + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + The exit or timeout outcome associated with this shell call. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + The exit code returned by the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + Captured stderr output for the shell call. + + - `stdout: String` + + Captured stdout output for the shell call. + + - `type: :shell_call_output` + + The type of the item. Always `shell_call_output`. + + - `:shell_call_output` + + - `id: String` + + The unique ID of the shell tool call output. Populated when this item is returned via API. + + - `max_output_length: Integer` + + The maximum number of UTF-8 characters captured for this shell call's combined output. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ApplyPatchCall` + + A tool call representing a request to create, delete, or update files using diff patches. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + The specific create, delete, or update instruction for the apply_patch tool call. + + - `class CreateFile` + + Instruction for creating a new file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply when creating the file. + + - `path: String` + + Path of the file to create relative to the workspace root. + + - `type: :create_file` + + The operation type. Always `create_file`. + + - `:create_file` + + - `class DeleteFile` + + Instruction for deleting an existing file via the apply_patch tool. + + - `path: String` + + Path of the file to delete relative to the workspace root. + + - `type: :delete_file` + + The operation type. Always `delete_file`. + + - `:delete_file` + + - `class UpdateFile` + + Instruction for updating an existing file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply to the existing file. + + - `path: String` + + Path of the file to update relative to the workspace root. + + - `type: :update_file` + + The operation type. Always `update_file`. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `class ApplyPatchCallOutput` + + The streamed output emitted by an apply patch tool call. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `output: String` + + Optional human-readable log text from the apply patch tool (e.g., patch results or errors). + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `id: String` + + The unique ID of the approval response + + - `reason: String` + + Optional reason for the decision. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class ResponseCustomToolCallOutput` + + The output of a custom tool call from your code, being sent back to the model. + + - `call_id: String` + + The call ID, used to map this custom tool call output to a custom tool call. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the custom tool call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the custom tool call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :custom_tool_call_output` + + The type of the custom tool call output. Always `custom_tool_call_output`. + + - `:custom_tool_call_output` + + - `id: String` + + The unique ID of the custom tool call output in the OpenAI platform. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `call_id: String` + + An identifier used to map this custom tool call to a tool call output. + + - `input: String` + + The input for the custom tool call generated by the model. + + - `name: String` + + The name of the custom tool being called. + + - `type: :custom_tool_call` + + The type of the custom tool call. Always `custom_tool_call`. + + - `:custom_tool_call` + + - `id: String` + + The unique ID of the custom tool call in the OpenAI platform. + + - `namespace: String` + + The namespace of the custom tool being called. + + - `class CompactionTrigger` + + Compacts the current context. Must be the final input item. + + - `type: :compaction_trigger` + + The type of the item. Always `compaction_trigger`. + + - `:compaction_trigger` + + - `class ItemReference` + + An internal identifier for an item to reference. + + - `id: String` + + The ID of the item to reference. + + - `type: :item_reference` + + The type of item to reference. Always `item_reference`. + + - `:item_reference` + +- `instructions: String` + + A system (or developer) message inserted into the model's context. + When used along with `previous_response_id`, the instructions from a previous response will not be carried over to the next response. This makes it simple to swap out system (or developer) messages in new responses. + +- `previous_response_id: String` + + The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. + +- `prompt_cache_key: String` + + A key to use when reading from or writing to the prompt cache. + +- `prompt_cache_retention: :in_memory | :"24h"` + + How long to retain a prompt cache entry created by this request. + + - `:in_memory` + + - `:"24h"` + +- `service_tier: :auto | :default | :flex | :priority` + + The service tier to use for this request. + + - `:auto` + + - `:default` + + - `:flex` + + - `:priority` + +### Returns + +- `class CompactedResponse` + + - `id: String` + + The unique identifier for the compacted response. + + - `created_at: Integer` + + Unix timestamp (in seconds) when the compacted conversation was created. + + - `object: :"response.compaction"` + + The object type. Always `response.compaction`. + + - `:"response.compaction"` + + - `output: Array[ResponseOutputItem]` + + The compacted list of output items. This is a list of all user messages, followed by a single compaction item. + + - `class ResponseOutputMessage` + + An output message from the model. + + - `id: String` + + The unique ID of the output message. + + - `content: Array[ResponseOutputText | ResponseOutputRefusal]` + + The content of the output message. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `role: :assistant` + + The role of the output message. Always `assistant`. + + - `:assistant` + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the output message. Always `message`. + + - `:message` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `class ResponseFileSearchToolCall` + + 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. + + - `id: String` + + The unique ID of the file search tool call. + + - `queries: Array[String]` + + The queries used to search for files. + + - `status: :in_progress | :searching | :completed | 2 more` + + The status of the file search tool call. One of `in_progress`, + `searching`, `incomplete` or `failed`, + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `type: :file_search_call` + + The type of the file search tool call. Always `file_search_call`. + + - `:file_search_call` + + - `results: Array[Result{ attributes, file_id, filename, 2 more}]` + + The results of the file search tool call. + + - `attributes: Hash[Symbol, String | Float | bool]` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. Keys are strings + with a maximum length of 64 characters. Values are strings with a maximum + length of 512 characters, booleans, or numbers. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `file_id: String` + + The unique ID of the file. + + - `filename: String` + + The name of the file. + + - `score: Float` + + The relevance score of the file - a value between 0 and 1. + + - `text: String` + + The text that was retrieved from the file. + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `arguments: String` + + A JSON string of the arguments to pass to the function. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `name: String` + + The name of the function to run. + + - `type: :function_call` + + The type of the function tool call. Always `function_call`. + + - `:function_call` + + - `id: String` + + The unique ID of the function tool call. + + - `namespace: String` + + The namespace of the function to run. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionToolCallOutputItem` + + - `id: String` + + The unique ID of the function call tool output. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the function call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the function call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the function call. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseFunctionWebSearch` + + 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. + + - `id: String` + + The unique ID of the web search tool call. + + - `action: Search{ type, queries, query, sources} | OpenPage{ type, url} | FindInPage{ pattern, type, url}` + + An object describing the specific action taken in this web search call. + Includes details on how the model used the web (search, open_page, find_in_page). + + - `class Search` + + Action type "search" - Performs a web search query. + + - `type: :search` + + The action type. + + - `:search` + + - `queries: Array[String]` + + The search queries. + + - `query: String` + + The search query. + + - `sources: Array[Source{ type, url}]` + + The sources used in the search. + + - `type: :url` + + The type of source. Always `url`. + + - `:url` + + - `url: String` + + The URL of the source. + + - `class OpenPage` + + Action type "open_page" - Opens a specific URL from search results. + + - `type: :open_page` + + The action type. + + - `:open_page` + + - `url: String` + + The URL opened by the model. + + - `class FindInPage` + + Action type "find_in_page": Searches for a pattern within a loaded page. + + - `pattern: String` + + The pattern or text to search for within the page. + + - `type: :find_in_page` + + The action type. + + - `:find_in_page` + + - `url: String` + + The URL of the page searched for the pattern. + + - `status: :in_progress | :searching | :completed | :failed` + + The status of the web search tool call. + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:failed` + + - `type: :web_search_call` + + The type of the web search tool call. Always `web_search_call`. + + - `:web_search_call` + + - `class ResponseComputerToolCall` + + 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. + + - `id: String` + + The unique ID of the computer call. + + - `call_id: String` + + An identifier used when responding to the tool call with output. + + - `pending_safety_checks: Array[PendingSafetyCheck{ id, code, message}]` + + The pending safety checks for the computer call. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :computer_call` + + The type of the computer call. Always `computer_call`. + + - `:computer_call` + + - `action: Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `actions: ComputerActionList` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `class ResponseComputerToolCallOutputItem` + + - `id: String` + + The unique ID of the computer call tool output. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + + - `status: :completed | :incomplete | :failed | :in_progress` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `:in_progress` + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the + developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseReasoningItem` + + 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). + + - `id: String` + + The unique identifier of the reasoning content. + + - `summary: Array[Summary{ text, type}]` + + Reasoning summary content. + + - `text: String` + + A summary of the reasoning output from the model so far. + + - `type: :summary_text` + + The type of the object. Always `summary_text`. + + - `:summary_text` + + - `type: :reasoning` + + The type of the object. Always `reasoning`. + + - `:reasoning` + + - `content: Array[Content{ text, type}]` + + Reasoning text content. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `encrypted_content: String` + + The encrypted content of the reasoning item - populated when a response is + generated with `reasoning.encrypted_content` in the `include` parameter. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseToolSearchCall` + + - `id: String` + + The unique ID of the tool search call item. + + - `arguments: untyped` + + Arguments used for the tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :tool_search_call` + + The type of the item. Always `tool_search_call`. + + - `:tool_search_call` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseToolSearchOutputItem` + + - `id: String` + + The unique ID of the tool search output item. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by tool search. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The type of the item. Always `tool_search_output`. + + - `:tool_search_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class AdditionalTools` + + - `id: String` + + The unique ID of the additional tools item. + + - `role: :unknown | :user | :assistant | 5 more` + + The role that provided the additional tools. + + - `:unknown` + + - `:user` + + - `:assistant` + + - `:system` + + - `:critic` + + - `:discriminator` + + - `:developer` + + - `:tool` + + - `tools: Array[Tool]` + + The additional tool definitions made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The type of the item. Always `additional_tools`. + + - `:additional_tools` + + - `class ResponseCompactionItem` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `id: String` + + The unique ID of the compaction item. + + - `encrypted_content: String` + + The encrypted content that was produced by compaction. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `id: String` + + The unique ID of the code interpreter tool call. + + - `code: String` + + The code to run, or null if not available. + + - `container_id: String` + + The ID of the container used to run the code. + + - `outputs: Array[Logs{ logs, type} | Image{ type, url}]` + + The outputs generated by the code interpreter, such as logs or images. + Can be null if no outputs are available. + + - `class Logs` + + The logs output from the code interpreter. + + - `logs: String` + + The logs output from the code interpreter. + + - `type: :logs` + + The type of the output. Always `logs`. + + - `:logs` + + - `class Image` + + The image output from the code interpreter. + + - `type: :image` + + The type of the output. Always `image`. + + - `:image` + + - `url: String` + + The URL of the image output from the code interpreter. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:interpreting` + + - `:failed` + + - `type: :code_interpreter_call` + + The type of the code interpreter tool call. Always `code_interpreter_call`. + + - `:code_interpreter_call` + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionShellToolCall` + + A tool call that executes one or more shell commands in a managed environment. + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + - `max_output_length: Integer` + + Optional maximum number of characters to return from each command. + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the commands. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `environment: ResponseLocalEnvironment | ResponseContainerReference` + + Represents the use of a local environment to perform shell actions. + + - `class ResponseLocalEnvironment` + + Represents the use of a local environment to perform shell actions. + + - `type: :local` + + The environment type. Always `local`. + + - `:local` + + - `class ResponseContainerReference` + + Represents a container created with /v1/containers. + + - `container_id: String` + + - `type: :container_reference` + + The environment type. Always `container_reference`. + + - `:container_reference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseFunctionShellToolCallOutput` + + The output of a shell tool call that was emitted. + + - `id: String` + + The unique ID of the shell call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `max_output_length: Integer` + + The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output. + + - `output: Array[Output{ outcome, stderr, stdout, created_by}]` + + An array of shell call output contents + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + Exit code from the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + The standard error output that was captured. + + - `stdout: String` + + The standard output that was captured. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call_output` + + The type of the shell call output. Always `shell_call_output`. + + - `:shell_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseApplyPatchToolCall` + + A tool call that applies file diffs by creating, deleting, or updating files. + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + One of the create_file, delete_file, or update_file operations applied via apply_patch. + + - `class CreateFile` + + Instruction describing how to create a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to create. + + - `type: :create_file` + + Create a new file with the provided diff. + + - `:create_file` + + - `class DeleteFile` + + Instruction describing how to delete a file via the apply_patch tool. + + - `path: String` + + Path of the file to delete. + + - `type: :delete_file` + + Delete the specified file. + + - `:delete_file` + + - `class UpdateFile` + + Instruction describing how to update a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to update. + + - `type: :update_file` + + Update an existing file with the provided diff. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseApplyPatchToolCallOutput` + + The output emitted by an apply patch tool call. + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `created_by: String` + + The ID of the entity that created this tool call output. + + - `output: String` + + Optional textual output returned by the apply patch tool. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `id: String` + + The unique ID of the approval response + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `reason: String` + + Optional reason for the decision. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `call_id: String` + + An identifier used to map this custom tool call to a tool call output. + + - `input: String` + + The input for the custom tool call generated by the model. + + - `name: String` + + The name of the custom tool being called. + + - `type: :custom_tool_call` + + The type of the custom tool call. Always `custom_tool_call`. + + - `:custom_tool_call` + + - `id: String` + + The unique ID of the custom tool call in the OpenAI platform. + + - `namespace: String` + + The namespace of the custom tool being called. + + - `class ResponseCustomToolCallOutputItem` + + The output of a custom tool call from your code, being sent back to the model. + + - `id: String` + + The unique ID of the custom tool call output item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `usage: ResponseUsage` + + Token accounting for the compaction pass, including cached, reasoning, and total tokens. + + - `input_tokens: Integer` + + The number of input tokens. + + - `input_tokens_details: InputTokensDetails{ cached_tokens}` + + A detailed breakdown of the input tokens. + + - `cached_tokens: Integer` + + The number of tokens that were retrieved from the cache. + [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching). + + - `output_tokens: Integer` + + The number of output tokens. + + - `output_tokens_details: OutputTokensDetails{ reasoning_tokens}` + + A detailed breakdown of the output tokens. + + - `reasoning_tokens: Integer` + + The number of reasoning tokens. + + - `total_tokens: Integer` + + The total number of tokens used. + +### Example + +```ruby +require "openai" + +openai = OpenAI::Client.new(api_key: "My API Key") + +compacted_response = openai.responses.compact(model: :"gpt-5.4") + +puts(compacted_response) +``` + +#### Response + +```json +{ + "id": "id", + "created_at": 0, + "object": "response.compaction", + "output": [ + { + "id": "id", + "content": [ + { + "annotations": [ + { + "file_id": "file_id", + "filename": "filename", + "index": 0, + "type": "file_citation" + } + ], + "text": "text", + "type": "output_text", + "logprobs": [ + { + "token": "token", + "bytes": [ + 0 + ], + "logprob": 0, + "top_logprobs": [ + { + "token": "token", + "bytes": [ + 0 + ], + "logprob": 0 + } + ] + } + ] + } + ], + "role": "assistant", + "status": "in_progress", + "type": "message", + "phase": "commentary" + } + ], + "usage": { + "input_tokens": 0, + "input_tokens_details": { + "cached_tokens": 0 + }, + "output_tokens": 0, + "output_tokens_details": { + "reasoning_tokens": 0 + }, + "total_tokens": 0 + } +} +``` + +## Domain Types + +### Apply Patch Tool + +- `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + +### Compacted Response + +- `class CompactedResponse` + + - `id: String` + + The unique identifier for the compacted response. + + - `created_at: Integer` + + Unix timestamp (in seconds) when the compacted conversation was created. + + - `object: :"response.compaction"` + + The object type. Always `response.compaction`. + + - `:"response.compaction"` + + - `output: Array[ResponseOutputItem]` + + The compacted list of output items. This is a list of all user messages, followed by a single compaction item. + + - `class ResponseOutputMessage` + + An output message from the model. + + - `id: String` + + The unique ID of the output message. + + - `content: Array[ResponseOutputText | ResponseOutputRefusal]` + + The content of the output message. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `role: :assistant` + + The role of the output message. Always `assistant`. + + - `:assistant` + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the output message. Always `message`. + + - `:message` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `class ResponseFileSearchToolCall` + + 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. + + - `id: String` + + The unique ID of the file search tool call. + + - `queries: Array[String]` + + The queries used to search for files. + + - `status: :in_progress | :searching | :completed | 2 more` + + The status of the file search tool call. One of `in_progress`, + `searching`, `incomplete` or `failed`, + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `type: :file_search_call` + + The type of the file search tool call. Always `file_search_call`. + + - `:file_search_call` + + - `results: Array[Result{ attributes, file_id, filename, 2 more}]` + + The results of the file search tool call. + + - `attributes: Hash[Symbol, String | Float | bool]` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. Keys are strings + with a maximum length of 64 characters. Values are strings with a maximum + length of 512 characters, booleans, or numbers. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `file_id: String` + + The unique ID of the file. + + - `filename: String` + + The name of the file. + + - `score: Float` + + The relevance score of the file - a value between 0 and 1. + + - `text: String` + + The text that was retrieved from the file. + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `arguments: String` + + A JSON string of the arguments to pass to the function. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `name: String` + + The name of the function to run. + + - `type: :function_call` + + The type of the function tool call. Always `function_call`. + + - `:function_call` + + - `id: String` + + The unique ID of the function tool call. + + - `namespace: String` + + The namespace of the function to run. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionToolCallOutputItem` + + - `id: String` + + The unique ID of the function call tool output. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the function call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the function call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the function call. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseFunctionWebSearch` + + 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. + + - `id: String` + + The unique ID of the web search tool call. + + - `action: Search{ type, queries, query, sources} | OpenPage{ type, url} | FindInPage{ pattern, type, url}` + + An object describing the specific action taken in this web search call. + Includes details on how the model used the web (search, open_page, find_in_page). + + - `class Search` + + Action type "search" - Performs a web search query. + + - `type: :search` + + The action type. + + - `:search` + + - `queries: Array[String]` + + The search queries. + + - `query: String` + + The search query. + + - `sources: Array[Source{ type, url}]` + + The sources used in the search. + + - `type: :url` + + The type of source. Always `url`. + + - `:url` + + - `url: String` + + The URL of the source. + + - `class OpenPage` + + Action type "open_page" - Opens a specific URL from search results. + + - `type: :open_page` + + The action type. + + - `:open_page` + + - `url: String` + + The URL opened by the model. + + - `class FindInPage` + + Action type "find_in_page": Searches for a pattern within a loaded page. + + - `pattern: String` + + The pattern or text to search for within the page. + + - `type: :find_in_page` + + The action type. + + - `:find_in_page` + + - `url: String` + + The URL of the page searched for the pattern. + + - `status: :in_progress | :searching | :completed | :failed` + + The status of the web search tool call. + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:failed` + + - `type: :web_search_call` + + The type of the web search tool call. Always `web_search_call`. + + - `:web_search_call` + + - `class ResponseComputerToolCall` + + 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. + + - `id: String` + + The unique ID of the computer call. + + - `call_id: String` + + An identifier used when responding to the tool call with output. + + - `pending_safety_checks: Array[PendingSafetyCheck{ id, code, message}]` + + The pending safety checks for the computer call. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :computer_call` + + The type of the computer call. Always `computer_call`. + + - `:computer_call` + + - `action: Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `actions: ComputerActionList` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `class ResponseComputerToolCallOutputItem` + + - `id: String` + + The unique ID of the computer call tool output. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + + - `status: :completed | :incomplete | :failed | :in_progress` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `:in_progress` + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the + developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseReasoningItem` + + 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). + + - `id: String` + + The unique identifier of the reasoning content. + + - `summary: Array[Summary{ text, type}]` + + Reasoning summary content. + + - `text: String` + + A summary of the reasoning output from the model so far. + + - `type: :summary_text` + + The type of the object. Always `summary_text`. + + - `:summary_text` + + - `type: :reasoning` + + The type of the object. Always `reasoning`. + + - `:reasoning` + + - `content: Array[Content{ text, type}]` + + Reasoning text content. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `encrypted_content: String` + + The encrypted content of the reasoning item - populated when a response is + generated with `reasoning.encrypted_content` in the `include` parameter. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseToolSearchCall` + + - `id: String` + + The unique ID of the tool search call item. + + - `arguments: untyped` + + Arguments used for the tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :tool_search_call` + + The type of the item. Always `tool_search_call`. + + - `:tool_search_call` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseToolSearchOutputItem` + + - `id: String` + + The unique ID of the tool search output item. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by tool search. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The type of the item. Always `tool_search_output`. + + - `:tool_search_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class AdditionalTools` + + - `id: String` + + The unique ID of the additional tools item. + + - `role: :unknown | :user | :assistant | 5 more` + + The role that provided the additional tools. + + - `:unknown` + + - `:user` + + - `:assistant` + + - `:system` + + - `:critic` + + - `:discriminator` + + - `:developer` + + - `:tool` + + - `tools: Array[Tool]` + + The additional tool definitions made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The type of the item. Always `additional_tools`. + + - `:additional_tools` + + - `class ResponseCompactionItem` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `id: String` + + The unique ID of the compaction item. + + - `encrypted_content: String` + + The encrypted content that was produced by compaction. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `id: String` + + The unique ID of the code interpreter tool call. + + - `code: String` + + The code to run, or null if not available. + + - `container_id: String` + + The ID of the container used to run the code. + + - `outputs: Array[Logs{ logs, type} | Image{ type, url}]` + + The outputs generated by the code interpreter, such as logs or images. + Can be null if no outputs are available. + + - `class Logs` + + The logs output from the code interpreter. + + - `logs: String` + + The logs output from the code interpreter. + + - `type: :logs` + + The type of the output. Always `logs`. + + - `:logs` + + - `class Image` + + The image output from the code interpreter. + + - `type: :image` + + The type of the output. Always `image`. + + - `:image` + + - `url: String` + + The URL of the image output from the code interpreter. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:interpreting` + + - `:failed` + + - `type: :code_interpreter_call` + + The type of the code interpreter tool call. Always `code_interpreter_call`. + + - `:code_interpreter_call` + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionShellToolCall` + + A tool call that executes one or more shell commands in a managed environment. + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + - `max_output_length: Integer` + + Optional maximum number of characters to return from each command. + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the commands. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `environment: ResponseLocalEnvironment | ResponseContainerReference` + + Represents the use of a local environment to perform shell actions. + + - `class ResponseLocalEnvironment` + + Represents the use of a local environment to perform shell actions. + + - `type: :local` + + The environment type. Always `local`. + + - `:local` + + - `class ResponseContainerReference` + + Represents a container created with /v1/containers. + + - `container_id: String` + + - `type: :container_reference` + + The environment type. Always `container_reference`. + + - `:container_reference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseFunctionShellToolCallOutput` + + The output of a shell tool call that was emitted. + + - `id: String` + + The unique ID of the shell call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `max_output_length: Integer` + + The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output. + + - `output: Array[Output{ outcome, stderr, stdout, created_by}]` + + An array of shell call output contents + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + Exit code from the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + The standard error output that was captured. + + - `stdout: String` + + The standard output that was captured. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call_output` + + The type of the shell call output. Always `shell_call_output`. + + - `:shell_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseApplyPatchToolCall` + + A tool call that applies file diffs by creating, deleting, or updating files. + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + One of the create_file, delete_file, or update_file operations applied via apply_patch. + + - `class CreateFile` + + Instruction describing how to create a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to create. + + - `type: :create_file` + + Create a new file with the provided diff. + + - `:create_file` + + - `class DeleteFile` + + Instruction describing how to delete a file via the apply_patch tool. + + - `path: String` + + Path of the file to delete. + + - `type: :delete_file` + + Delete the specified file. + + - `:delete_file` + + - `class UpdateFile` + + Instruction describing how to update a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to update. + + - `type: :update_file` + + Update an existing file with the provided diff. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseApplyPatchToolCallOutput` + + The output emitted by an apply patch tool call. + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `created_by: String` + + The ID of the entity that created this tool call output. + + - `output: String` + + Optional textual output returned by the apply patch tool. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `id: String` + + The unique ID of the approval response + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `reason: String` + + Optional reason for the decision. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `call_id: String` + + An identifier used to map this custom tool call to a tool call output. + + - `input: String` + + The input for the custom tool call generated by the model. + + - `name: String` + + The name of the custom tool being called. + + - `type: :custom_tool_call` + + The type of the custom tool call. Always `custom_tool_call`. + + - `:custom_tool_call` + + - `id: String` + + The unique ID of the custom tool call in the OpenAI platform. + + - `namespace: String` + + The namespace of the custom tool being called. + + - `class ResponseCustomToolCallOutputItem` + + The output of a custom tool call from your code, being sent back to the model. + + - `id: String` + + The unique ID of the custom tool call output item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `usage: ResponseUsage` + + Token accounting for the compaction pass, including cached, reasoning, and total tokens. + + - `input_tokens: Integer` + + The number of input tokens. + + - `input_tokens_details: InputTokensDetails{ cached_tokens}` + + A detailed breakdown of the input tokens. + + - `cached_tokens: Integer` + + The number of tokens that were retrieved from the cache. + [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching). + + - `output_tokens: Integer` + + The number of output tokens. + + - `output_tokens_details: OutputTokensDetails{ reasoning_tokens}` + + A detailed breakdown of the output tokens. + + - `reasoning_tokens: Integer` + + The number of reasoning tokens. + + - `total_tokens: Integer` + + The total number of tokens used. + +### Computer Action + +- `ComputerAction = Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + +### Computer Action List + +- `ComputerActionList = Array[ComputerAction]` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + +### Computer Tool + +- `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + +### Computer Use Preview Tool + +- `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + +### Container Auto + +- `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + +### Container Network Policy Allowlist + +- `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + +### Container Network Policy Disabled + +- `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + +### Container Network Policy Domain Secret + +- `class ContainerNetworkPolicyDomainSecret` + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + +### Container Reference + +- `class ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + +### Custom Tool + +- `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + +### Easy Input Message + +- `class EasyInputMessage` + + 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. + + - `content: String | ResponseInputMessageContentList` + + Text, image, or audio input to the model, used to generate a response. + Can also contain previous assistant responses. + + - `String = String` + + A text input to the model. + + - `ResponseInputMessageContentList = Array[ResponseInputContent]` + + A list of one or many input items to the model, containing different content + types. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `role: :user | :assistant | :system | :developer` + + The role of the message input. One of `user`, `assistant`, `system`, or + `developer`. + + - `:user` + + - `:assistant` + + - `:system` + + - `:developer` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `type: :message` + + The type of the message input. Always `message`. + + - `:message` + +### File Search Tool + +- `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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. + +### Function Shell Tool + +- `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + +### Function Tool + +- `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + +### Inline Skill + +- `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + +### Inline Skill Source + +- `class InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + +### Local Environment + +- `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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. + +### Local Skill + +- `class LocalSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `path: String` + + The path to the directory containing the skill. + +### Namespace Tool + +- `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + +### Response + +- `class Response` + + - `id: String` + + Unique identifier for this Response. + + - `created_at: Float` + + Unix timestamp (in seconds) of when this Response was created. + + - `error: ResponseError` + + An error object returned when the model fails to generate a Response. + + - `code: :server_error | :rate_limit_exceeded | :invalid_prompt | 15 more` + + The error code for the response. + + - `: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` + + - `message: String` + + A human-readable description of the error. + + - `incomplete_details: IncompleteDetails{ reason}` + + Details about why the response is incomplete. + + - `reason: :max_output_tokens | :content_filter` + + The reason why the response is incomplete. + + - `:max_output_tokens` + + - `:content_filter` + + - `instructions: String | Array[ResponseInputItem]` + + A system (or developer) message inserted into the model's context. + + When using along with `previous_response_id`, the instructions from a previous + response will not be carried over to the next response. This makes it simple + to swap out system (or developer) messages in new responses. + + - `String = String` + + A text input to the model, equivalent to a text input with the + `developer` role. + + - `InputItemList = Array[ResponseInputItem]` + + A list of one or many input items to the model, containing + different content types. + + - `class EasyInputMessage` + + 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. + + - `content: String | ResponseInputMessageContentList` + + Text, image, or audio input to the model, used to generate a response. + Can also contain previous assistant responses. + + - `String = String` + + A text input to the model. + + - `ResponseInputMessageContentList = Array[ResponseInputContent]` + + A list of one or many input items to the model, containing different content + types. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `role: :user | :assistant | :system | :developer` + + The role of the message input. One of `user`, `assistant`, `system`, or + `developer`. + + - `:user` + + - `:assistant` + + - `:system` + + - `:developer` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `type: :message` + + The type of the message input. Always `message`. + + - `:message` + + - `class Message` + + 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. + + - `content: ResponseInputMessageContentList` + + A list of one or many input items to the model, containing different content + types. + + - `role: :user | :system | :developer` + + The role of the message input. One of `user`, `system`, or `developer`. + + - `:user` + + - `:system` + + - `:developer` + + - `status: :in_progress | :completed | :incomplete` + + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the message input. Always set to `message`. + + - `:message` + + - `class ResponseOutputMessage` + + An output message from the model. + + - `id: String` + + The unique ID of the output message. + + - `content: Array[ResponseOutputText | ResponseOutputRefusal]` + + The content of the output message. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `role: :assistant` + + The role of the output message. Always `assistant`. + + - `:assistant` + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the output message. Always `message`. + + - `:message` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `class ResponseFileSearchToolCall` + + 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. + + - `id: String` + + The unique ID of the file search tool call. + + - `queries: Array[String]` + + The queries used to search for files. + + - `status: :in_progress | :searching | :completed | 2 more` + + The status of the file search tool call. One of `in_progress`, + `searching`, `incomplete` or `failed`, + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `type: :file_search_call` + + The type of the file search tool call. Always `file_search_call`. + + - `:file_search_call` + + - `results: Array[Result{ attributes, file_id, filename, 2 more}]` + + The results of the file search tool call. + + - `attributes: Hash[Symbol, String | Float | bool]` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. Keys are strings + with a maximum length of 64 characters. Values are strings with a maximum + length of 512 characters, booleans, or numbers. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `file_id: String` + + The unique ID of the file. + + - `filename: String` + + The name of the file. + + - `score: Float` + + The relevance score of the file - a value between 0 and 1. + + - `text: String` + + The text that was retrieved from the file. + + - `class ResponseComputerToolCall` + + 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. + + - `id: String` + + The unique ID of the computer call. + + - `call_id: String` + + An identifier used when responding to the tool call with output. + + - `pending_safety_checks: Array[PendingSafetyCheck{ id, code, message}]` + + The pending safety checks for the computer call. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :computer_call` + + The type of the computer call. Always `computer_call`. + + - `:computer_call` + + - `action: Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `actions: ComputerActionList` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `class ComputerCallOutput` + + The output of a computer tool call. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `id: String` + + The ID of the computer tool call output. + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionWebSearch` + + 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. + + - `id: String` + + The unique ID of the web search tool call. + + - `action: Search{ type, queries, query, sources} | OpenPage{ type, url} | FindInPage{ pattern, type, url}` + + An object describing the specific action taken in this web search call. + Includes details on how the model used the web (search, open_page, find_in_page). + + - `class Search` + + Action type "search" - Performs a web search query. + + - `type: :search` + + The action type. + + - `:search` + + - `queries: Array[String]` + + The search queries. + + - `query: String` + + The search query. + + - `sources: Array[Source{ type, url}]` + + The sources used in the search. + + - `type: :url` + + The type of source. Always `url`. + + - `:url` + + - `url: String` + + The URL of the source. + + - `class OpenPage` + + Action type "open_page" - Opens a specific URL from search results. + + - `type: :open_page` + + The action type. + + - `:open_page` + + - `url: String` + + The URL opened by the model. + + - `class FindInPage` + + Action type "find_in_page": Searches for a pattern within a loaded page. + + - `pattern: String` + + The pattern or text to search for within the page. + + - `type: :find_in_page` + + The action type. + + - `:find_in_page` + + - `url: String` + + The URL of the page searched for the pattern. + + - `status: :in_progress | :searching | :completed | :failed` + + The status of the web search tool call. + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:failed` + + - `type: :web_search_call` + + The type of the web search tool call. Always `web_search_call`. + + - `:web_search_call` + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `arguments: String` + + A JSON string of the arguments to pass to the function. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `name: String` + + The name of the function to run. + + - `type: :function_call` + + The type of the function tool call. Always `function_call`. + + - `:function_call` + + - `id: String` + + The unique ID of the function tool call. + + - `namespace: String` + + The namespace of the function to run. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class FunctionCallOutput` + + The output of a function tool call. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | ResponseFunctionCallOutputItemList` + + Text, image, or file output of the function tool call. + + - `String = String` + + A JSON string of the output of the function tool call. + + - `ResponseFunctionCallOutputItemList = Array[ResponseFunctionCallOutputItem]` + + An array of content outputs (text, image, file) for the function tool call. + + - `class ResponseInputTextContent` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImageContent` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision) + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFileContent` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The base64-encoded data of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `id: String` + + The unique ID of the function tool call output. Populated when this item is returned via API. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ToolSearchCall` + + - `arguments: untyped` + + The arguments supplied to the tool search call. + + - `type: :tool_search_call` + + The item type. Always `tool_search_call`. + + - `:tool_search_call` + + - `id: String` + + The unique ID of this tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseToolSearchOutputItemParam` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by the tool search output. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The item type. Always `tool_search_output`. + + - `:tool_search_output` + + - `id: String` + + The unique ID of this tool search output. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class AdditionalTools` + + - `role: :developer` + + The role that provided the additional tools. Only `developer` is supported. + + - `:developer` + + - `tools: Array[Tool]` + + A list of additional tools made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The item type. Always `additional_tools`. + + - `:additional_tools` + + - `id: String` + + The unique ID of this additional tools item. + + - `class ResponseReasoningItem` + + 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). + + - `id: String` + + The unique identifier of the reasoning content. + + - `summary: Array[Summary{ text, type}]` + + Reasoning summary content. + + - `text: String` + + A summary of the reasoning output from the model so far. + + - `type: :summary_text` + + The type of the object. Always `summary_text`. + + - `:summary_text` + + - `type: :reasoning` + + The type of the object. Always `reasoning`. + + - `:reasoning` + + - `content: Array[Content{ text, type}]` + + Reasoning text content. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `encrypted_content: String` + + The encrypted content of the reasoning item - populated when a response is + generated with `reasoning.encrypted_content` in the `include` parameter. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseCompactionItemParam` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `encrypted_content: String` + + The encrypted content of the compaction summary. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `id: String` + + The ID of the compaction item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `id: String` + + The unique ID of the code interpreter tool call. + + - `code: String` + + The code to run, or null if not available. + + - `container_id: String` + + The ID of the container used to run the code. + + - `outputs: Array[Logs{ logs, type} | Image{ type, url}]` + + The outputs generated by the code interpreter, such as logs or images. + Can be null if no outputs are available. + + - `class Logs` + + The logs output from the code interpreter. + + - `logs: String` + + The logs output from the code interpreter. + + - `type: :logs` + + The type of the output. Always `logs`. + + - `:logs` + + - `class Image` + + The image output from the code interpreter. + + - `type: :image` + + The type of the output. Always `image`. + + - `:image` + + - `url: String` + + The URL of the image output from the code interpreter. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:interpreting` + + - `:failed` + + - `type: :code_interpreter_call` + + The type of the code interpreter tool call. Always `code_interpreter_call`. + + - `:code_interpreter_call` + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCall` + + A tool representing a request to execute one or more shell commands. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + Ordered shell commands for the execution environment to run. + + - `max_output_length: Integer` + + Maximum number of UTF-8 characters to capture from combined stdout and stderr output. + + - `timeout_ms: Integer` + + Maximum wall-clock time in milliseconds to allow the shell commands to run. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `environment: LocalEnvironment | ContainerReference` + + The environment to execute the shell commands in. + + - `class LocalEnvironment` + + - `class ContainerReference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCallOutput` + + The streamed output items emitted by a shell tool call. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `output: Array[ResponseFunctionShellCallOutputContent]` + + Captured chunks of stdout and stderr output, along with their associated outcomes. + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + The exit or timeout outcome associated with this shell call. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + The exit code returned by the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + Captured stderr output for the shell call. + + - `stdout: String` + + Captured stdout output for the shell call. + + - `type: :shell_call_output` + + The type of the item. Always `shell_call_output`. + + - `:shell_call_output` + + - `id: String` + + The unique ID of the shell tool call output. Populated when this item is returned via API. + + - `max_output_length: Integer` + + The maximum number of UTF-8 characters captured for this shell call's combined output. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ApplyPatchCall` + + A tool call representing a request to create, delete, or update files using diff patches. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + The specific create, delete, or update instruction for the apply_patch tool call. + + - `class CreateFile` + + Instruction for creating a new file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply when creating the file. + + - `path: String` + + Path of the file to create relative to the workspace root. + + - `type: :create_file` + + The operation type. Always `create_file`. + + - `:create_file` + + - `class DeleteFile` + + Instruction for deleting an existing file via the apply_patch tool. + + - `path: String` + + Path of the file to delete relative to the workspace root. + + - `type: :delete_file` + + The operation type. Always `delete_file`. + + - `:delete_file` + + - `class UpdateFile` + + Instruction for updating an existing file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply to the existing file. + + - `path: String` + + Path of the file to update relative to the workspace root. + + - `type: :update_file` + + The operation type. Always `update_file`. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `class ApplyPatchCallOutput` + + The streamed output emitted by an apply patch tool call. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `output: String` + + Optional human-readable log text from the apply patch tool (e.g., patch results or errors). + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `id: String` + + The unique ID of the approval response + + - `reason: String` + + Optional reason for the decision. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class ResponseCustomToolCallOutput` + + The output of a custom tool call from your code, being sent back to the model. + + - `call_id: String` + + The call ID, used to map this custom tool call output to a custom tool call. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the custom tool call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the custom tool call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :custom_tool_call_output` + + The type of the custom tool call output. Always `custom_tool_call_output`. + + - `:custom_tool_call_output` + + - `id: String` + + The unique ID of the custom tool call output in the OpenAI platform. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `call_id: String` + + An identifier used to map this custom tool call to a tool call output. + + - `input: String` + + The input for the custom tool call generated by the model. + + - `name: String` + + The name of the custom tool being called. + + - `type: :custom_tool_call` + + The type of the custom tool call. Always `custom_tool_call`. + + - `:custom_tool_call` + + - `id: String` + + The unique ID of the custom tool call in the OpenAI platform. + + - `namespace: String` + + The namespace of the custom tool being called. + + - `class CompactionTrigger` + + Compacts the current context. Must be the final input item. + + - `type: :compaction_trigger` + + The type of the item. Always `compaction_trigger`. + + - `:compaction_trigger` + + - `class ItemReference` + + An internal identifier for an item to reference. + + - `id: String` + + The ID of the item to reference. + + - `type: :item_reference` + + The type of item to reference. Always `item_reference`. + + - `:item_reference` + + - `metadata: Metadata` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. + + Keys are strings with a maximum length of 64 characters. Values are strings + with a maximum length of 512 characters. + + - `model: ResponsesModel` + + Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI + offers a wide range of models with different capabilities, performance + characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) + to browse and compare available models. + + - `String = String` + + - `ChatModel = :"gpt-5.4" | :"gpt-5.4-mini" | :"gpt-5.4-nano" | 75 more` + + - `:"gpt-5.4"` + + - `:"gpt-5.4-mini"` + + - `:"gpt-5.4-nano"` + + - `:"gpt-5.4-mini-2026-03-17"` + + - `:"gpt-5.4-nano-2026-03-17"` + + - `:"gpt-5.3-chat-latest"` + + - `:"gpt-5.2"` + + - `:"gpt-5.2-2025-12-11"` + + - `:"gpt-5.2-chat-latest"` + + - `:"gpt-5.2-pro"` + + - `:"gpt-5.2-pro-2025-12-11"` + + - `:"gpt-5.1"` + + - `:"gpt-5.1-2025-11-13"` + + - `:"gpt-5.1-codex"` + + - `:"gpt-5.1-mini"` + + - `:"gpt-5.1-chat-latest"` + + - `:"gpt-5"` + + - `:"gpt-5-mini"` + + - `:"gpt-5-nano"` + + - `:"gpt-5-2025-08-07"` + + - `:"gpt-5-mini-2025-08-07"` + + - `:"gpt-5-nano-2025-08-07"` + + - `:"gpt-5-chat-latest"` + + - `:"gpt-4.1"` + + - `:"gpt-4.1-mini"` + + - `:"gpt-4.1-nano"` + + - `:"gpt-4.1-2025-04-14"` + + - `:"gpt-4.1-mini-2025-04-14"` + + - `:"gpt-4.1-nano-2025-04-14"` + + - `:"o4-mini"` + + - `:"o4-mini-2025-04-16"` + + - `:o3` + + - `:"o3-2025-04-16"` + + - `:"o3-mini"` + + - `:"o3-mini-2025-01-31"` + + - `:o1` + + - `:"o1-2024-12-17"` + + - `:"o1-preview"` + + - `:"o1-preview-2024-09-12"` + + - `:"o1-mini"` + + - `:"o1-mini-2024-09-12"` + + - `:"gpt-4o"` + + - `:"gpt-4o-2024-11-20"` + + - `:"gpt-4o-2024-08-06"` + + - `:"gpt-4o-2024-05-13"` + + - `:"gpt-4o-audio-preview"` + + - `:"gpt-4o-audio-preview-2024-10-01"` + + - `:"gpt-4o-audio-preview-2024-12-17"` + + - `:"gpt-4o-audio-preview-2025-06-03"` + + - `:"gpt-4o-mini-audio-preview"` + + - `:"gpt-4o-mini-audio-preview-2024-12-17"` + + - `:"gpt-4o-search-preview"` + + - `:"gpt-4o-mini-search-preview"` + + - `:"gpt-4o-search-preview-2025-03-11"` + + - `:"gpt-4o-mini-search-preview-2025-03-11"` + + - `:"chatgpt-4o-latest"` + + - `:"codex-mini-latest"` + + - `:"gpt-4o-mini"` + + - `:"gpt-4o-mini-2024-07-18"` + + - `:"gpt-4-turbo"` + + - `:"gpt-4-turbo-2024-04-09"` + + - `:"gpt-4-0125-preview"` + + - `:"gpt-4-turbo-preview"` + + - `:"gpt-4-1106-preview"` + + - `:"gpt-4-vision-preview"` + + - `:"gpt-4"` + + - `:"gpt-4-0314"` + + - `:"gpt-4-0613"` + + - `:"gpt-4-32k"` + + - `:"gpt-4-32k-0314"` + + - `:"gpt-4-32k-0613"` + + - `:"gpt-3.5-turbo"` + + - `:"gpt-3.5-turbo-16k"` + + - `:"gpt-3.5-turbo-0301"` + + - `:"gpt-3.5-turbo-0613"` + + - `:"gpt-3.5-turbo-1106"` + + - `:"gpt-3.5-turbo-0125"` + + - `:"gpt-3.5-turbo-16k-0613"` + + - `ResponsesOnlyModel = :"o1-pro" | :"o1-pro-2025-03-19" | :"o3-pro" | 11 more` + + - `:"o1-pro"` + + - `:"o1-pro-2025-03-19"` + + - `:"o3-pro"` + + - `:"o3-pro-2025-06-10"` + + - `:"o3-deep-research"` + + - `:"o3-deep-research-2025-06-26"` + + - `:"o4-mini-deep-research"` + + - `:"o4-mini-deep-research-2025-06-26"` + + - `:"computer-use-preview"` + + - `:"computer-use-preview-2025-03-11"` + + - `:"gpt-5-codex"` + + - `:"gpt-5-pro"` + + - `:"gpt-5-pro-2025-10-06"` + + - `:"gpt-5.1-codex-max"` + + - `object: :response` + + The object type of this resource - always set to `response`. + + - `:response` + + - `output: Array[ResponseOutputItem]` + + An array of content items generated by the model. + + - The length and order of items in the `output` array is dependent + on the model's response. + - Rather than accessing the first item in the `output` array and + assuming it's an `assistant` message with the content generated by + the model, you might consider using the `output_text` property where + supported in SDKs. + + - `class ResponseOutputMessage` + + An output message from the model. + + - `class ResponseFileSearchToolCall` + + 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. + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `class ResponseFunctionToolCallOutputItem` + + - `id: String` + + The unique ID of the function call tool output. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the function call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the function call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the function call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseFunctionWebSearch` + + 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. + + - `class ResponseComputerToolCall` + + 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. + + - `class ResponseComputerToolCallOutputItem` + + - `id: String` + + The unique ID of the computer call tool output. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `status: :completed | :incomplete | :failed | :in_progress` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `:in_progress` + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the + developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseReasoningItem` + + 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). + + - `class ResponseToolSearchCall` + + - `id: String` + + The unique ID of the tool search call item. + + - `arguments: untyped` + + Arguments used for the tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :tool_search_call` + + The type of the item. Always `tool_search_call`. + + - `:tool_search_call` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseToolSearchOutputItem` + + - `id: String` + + The unique ID of the tool search output item. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by tool search. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :tool_search_output` + + The type of the item. Always `tool_search_output`. + + - `:tool_search_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class AdditionalTools` + + - `id: String` + + The unique ID of the additional tools item. + + - `role: :unknown | :user | :assistant | 5 more` + + The role that provided the additional tools. + + - `:unknown` + + - `:user` + + - `:assistant` + + - `:system` + + - `:critic` + + - `:discriminator` + + - `:developer` + + - `:tool` + + - `tools: Array[Tool]` + + The additional tool definitions made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The type of the item. Always `additional_tools`. + + - `:additional_tools` + + - `class ResponseCompactionItem` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `id: String` + + The unique ID of the compaction item. + + - `encrypted_content: String` + + The encrypted content that was produced by compaction. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionShellToolCall` + + A tool call that executes one or more shell commands in a managed environment. + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + - `max_output_length: Integer` + + Optional maximum number of characters to return from each command. + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the commands. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `environment: ResponseLocalEnvironment | ResponseContainerReference` + + Represents the use of a local environment to perform shell actions. + + - `class ResponseLocalEnvironment` + + Represents the use of a local environment to perform shell actions. + + - `type: :local` + + The environment type. Always `local`. + + - `:local` + + - `class ResponseContainerReference` + + Represents a container created with /v1/containers. + + - `container_id: String` + + - `type: :container_reference` + + The environment type. Always `container_reference`. + + - `:container_reference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseFunctionShellToolCallOutput` + + The output of a shell tool call that was emitted. + + - `id: String` + + The unique ID of the shell call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `max_output_length: Integer` + + The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output. + + - `output: Array[Output{ outcome, stderr, stdout, created_by}]` + + An array of shell call output contents + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + Exit code from the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + The standard error output that was captured. + + - `stdout: String` + + The standard output that was captured. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call_output` + + The type of the shell call output. Always `shell_call_output`. + + - `:shell_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseApplyPatchToolCall` + + A tool call that applies file diffs by creating, deleting, or updating files. + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + One of the create_file, delete_file, or update_file operations applied via apply_patch. + + - `class CreateFile` + + Instruction describing how to create a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to create. + + - `type: :create_file` + + Create a new file with the provided diff. + + - `:create_file` + + - `class DeleteFile` + + Instruction describing how to delete a file via the apply_patch tool. + + - `path: String` + + Path of the file to delete. + + - `type: :delete_file` + + Delete the specified file. + + - `:delete_file` + + - `class UpdateFile` + + Instruction describing how to update a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to update. + + - `type: :update_file` + + Update an existing file with the provided diff. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseApplyPatchToolCallOutput` + + The output emitted by an apply patch tool call. + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `created_by: String` + + The ID of the entity that created this tool call output. + + - `output: String` + + Optional textual output returned by the apply patch tool. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `id: String` + + The unique ID of the approval response + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `reason: String` + + Optional reason for the decision. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `class ResponseCustomToolCallOutputItem` + + The output of a custom tool call from your code, being sent back to the model. + + - `id: String` + + The unique ID of the custom tool call output item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `parallel_tool_calls: bool` + + Whether to allow the model to run tool calls in parallel. + + - `temperature: Float` + + 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. + + - `tool_choice: ToolChoiceOptions | ToolChoiceAllowed | ToolChoiceTypes | 5 more` + + How the model should select which tool (or tools) to use when generating + a response. See the `tools` parameter to see how to specify which tools + the model can call. + + - `ToolChoiceOptions = :none | :auto | :required` + + Controls which (if any) tool is called by the model. + + `none` means the model will not call any tool and instead generates a message. + + `auto` means the model can pick between generating a message or calling one or + more tools. + + `required` means the model must call one or more tools. + + - `:none` + + - `:auto` + + - `:required` + + - `class ToolChoiceAllowed` + + Constrains the tools available to the model to a pre-defined set. + + - `mode: :auto | :required` + + Constrains the tools available to the model to a pre-defined set. + + `auto` allows the model to pick from among the allowed tools and generate a + message. + + `required` requires the model to call one or more of the allowed tools. + + - `:auto` + + - `:required` + + - `tools: Array[Hash[Symbol, untyped]]` + + A list of tool definitions that the model should be allowed to call. + + For the Responses API, the list of tool definitions might look like: + + ```json + [ + { "type": "function", "name": "get_weather" }, + { "type": "mcp", "server_label": "deepwiki" }, + { "type": "image_generation" } + ] + ``` + + - `type: :allowed_tools` + + Allowed tool configuration type. Always `allowed_tools`. + + - `:allowed_tools` + + - `class ToolChoiceTypes` + + 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). + + - `type: :file_search | :web_search_preview | :computer | 5 more` + + The type of hosted tool the model should to use. Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + + Allowed values are: + + - `file_search` + - `web_search_preview` + - `computer` + - `computer_use_preview` + - `computer_use` + - `code_interpreter` + - `image_generation` + + - `:file_search` + + - `:web_search_preview` + + - `:computer` + + - `:computer_use_preview` + + - `:computer_use` + + - `:web_search_preview_2025_03_11` + + - `:image_generation` + + - `:code_interpreter` + + - `class ToolChoiceFunction` + + Use this option to force the model to call a specific function. + + - `name: String` + + The name of the function to call. + + - `type: :function` + + For function calling, the type is always `function`. + + - `:function` + + - `class ToolChoiceMcp` + + Use this option to force the model to call a specific tool on a remote MCP server. + + - `server_label: String` + + The label of the MCP server to use. + + - `type: :mcp` + + For MCP tools, the type is always `mcp`. + + - `:mcp` + + - `name: String` + + The name of the tool to call on the server. + + - `class ToolChoiceCustom` + + Use this option to force the model to call a specific custom tool. + + - `name: String` + + The name of the custom tool to call. + + - `type: :custom` + + For custom tool calling, the type is always `custom`. + + - `:custom` + + - `class ToolChoiceApplyPatch` + + Forces the model to call the apply_patch tool when executing a tool call. + + - `type: :apply_patch` + + The tool to call. Always `apply_patch`. + + - `:apply_patch` + + - `class ToolChoiceShell` + + Forces the model to call the shell tool when a tool call is required. + + - `type: :shell` + + The tool to call. Always `shell`. + + - `:shell` + + - `tools: Array[Tool]` + + An array of tools the model may call while generating a response. You + can specify which tool to use by setting the `tool_choice` parameter. + + We support the following categories of tools: + + - **Built-in tools**: Tools that are provided by OpenAI that extend the + model's capabilities, like [web search](https://platform.openai.com/docs/guides/tools-web-search) + or [file search](https://platform.openai.com/docs/guides/tools-file-search). Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + - **MCP Tools**: Integrations with third-party systems via custom MCP servers + or predefined connectors such as Google Drive and SharePoint. Learn more about + [MCP Tools](https://platform.openai.com/docs/guides/tools-connectors-mcp). + - **Function calls (custom tools)**: Functions that are defined by you, + enabling the model to call your own code with strongly typed arguments + and outputs. Learn more about + [function calling](https://platform.openai.com/docs/guides/function-calling). You can also use + custom tools to call your own code. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `top_p: Float` + + 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. + + - `background: bool` + + Whether to run the model response in the background. + [Learn more](https://platform.openai.com/docs/guides/background). + + - `completed_at: Float` + + Unix timestamp (in seconds) of when this Response was completed. + Only present when the status is `completed`. + + - `conversation: Conversation{ id}` + + The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation. + + - `id: String` + + The unique ID of the conversation that this response was associated with. + + - `max_output_tokens: Integer` + + An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://platform.openai.com/docs/guides/reasoning). + + - `max_tool_calls: Integer` + + 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. + + - `moderation: Moderation{ input, output}` + + Moderation results for the response input and output, if moderated completions were requested. + + - `input: ModerationResult{ categories, category_applied_input_types, category_scores, 3 more} | Error{ code, message, type}` + + Moderation for the response input. + + - `class ModerationResult` + + A moderation result produced for the response input or output. + + - `categories: Hash[Symbol, bool]` + + A dictionary of moderation categories to booleans, True if the input is flagged under this category. + + - `category_applied_input_types: Hash[Symbol, Array[:text | :image]]` + + Which modalities of input are reflected by the score for each category. + + - `:text` + + - `:image` + + - `category_scores: Hash[Symbol, Float]` + + A dictionary of moderation categories to scores. + + - `flagged: bool` + + A boolean indicating whether the content was flagged by any category. + + - `model: String` + + The moderation model that produced this result. + + - `type: :moderation_result` + + The object type, which was always `moderation_result` for successful moderation results. + + - `:moderation_result` + + - `class Error` + + An error produced while attempting moderation for the response input or output. + + - `code: String` + + The error code. + + - `message: String` + + The error message. + + - `type: :error` + + The object type, which was always `error` for moderation failures. + + - `:error` + + - `output: ModerationResult{ categories, category_applied_input_types, category_scores, 3 more} | Error{ code, message, type}` + + Moderation for the response output. + + - `class ModerationResult` + + A moderation result produced for the response input or output. + + - `categories: Hash[Symbol, bool]` + + A dictionary of moderation categories to booleans, True if the input is flagged under this category. + + - `category_applied_input_types: Hash[Symbol, Array[:text | :image]]` + + Which modalities of input are reflected by the score for each category. + + - `:text` + + - `:image` + + - `category_scores: Hash[Symbol, Float]` + + A dictionary of moderation categories to scores. + + - `flagged: bool` + + A boolean indicating whether the content was flagged by any category. + + - `model: String` + + The moderation model that produced this result. + + - `type: :moderation_result` + + The object type, which was always `moderation_result` for successful moderation results. + + - `:moderation_result` + + - `class Error` + + An error produced while attempting moderation for the response input or output. + + - `code: String` + + The error code. + + - `message: String` + + The error message. + + - `type: :error` + + The object type, which was always `error` for moderation failures. + + - `:error` + + - `previous_response_id: String` + + The unique ID of the previous response to the model. Use this to + create multi-turn conversations. Learn more about + [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. + + - `prompt: ResponsePrompt` + + Reference to a prompt template and its variables. + [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts). + + - `id: String` + + The unique identifier of the prompt template to use. + + - `variables: Hash[Symbol, String | ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Optional map of values to substitute in for variables in your + prompt. The substitution values can either be strings, or other + Response input types like images or files. + + - `String = String` + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `version: String` + + Optional version of the prompt template. + + - `prompt_cache_key: String` + + Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://platform.openai.com/docs/guides/prompt-caching). + + - `prompt_cache_retention: :in_memory | :"24h"` + + The retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention). + For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported. + + For older models that support both `in_memory` and `24h`, the default depends on your organization's data retention policy: + + - Organizations without ZDR enabled default to `24h`. + - Organizations with ZDR enabled default to `in_memory` when `prompt_cache_retention` is not specified. + + - `:in_memory` + + - `:"24h"` + + - `reasoning: Reasoning` + + **gpt-5 and o-series models only** + + Configuration options for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + + - `effort: ReasoningEffort` + + Constrains effort on reasoning for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing + reasoning effort can result in faster responses and fewer tokens used + on reasoning in a response. + + - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1. + - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. + - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. + - `xhigh` is supported for all models after `gpt-5.1-codex-max`. + + - `:none` + + - `:minimal` + + - `:low` + + - `:medium` + + - `:high` + + - `:xhigh` + + - `generate_summary: :auto | :concise | :detailed` + + **Deprecated:** use `summary` instead. + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `summary: :auto | :concise | :detailed` + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + `concise` is supported for `computer-use-preview` models and all reasoning models after `gpt-5`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `safety_identifier: String` + + A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + + - `service_tier: :auto | :default | :flex | 2 more` + + Specifies the processing type used for serving the request. + + - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. + - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. + - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier. + - When not set, the default behavior is 'auto'. + + When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter. + + - `:auto` + + - `:default` + + - `:flex` + + - `:scale` + + - `:priority` + + - `status: ResponseStatus` + + The status of the response generation. One of `completed`, `failed`, + `in_progress`, `cancelled`, `queued`, or `incomplete`. + + - `:completed` + + - `:failed` + + - `:in_progress` + + - `:cancelled` + + - `:queued` + + - `:incomplete` + + - `text: ResponseTextConfig` + + 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) + + - `format_: ResponseFormatTextConfig` + + An object specifying the format that the model must output. + + Configuring `{ "type": "json_schema" }` enables Structured Outputs, + which ensures the model will match your supplied JSON schema. Learn more in the + [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). + + The default format is `{ "type": "text" }` with no additional options. + + **Not recommended for gpt-4o and newer models:** + + Setting to `{ "type": "json_object" }` enables the older JSON mode, which + ensures the message the model generates is valid JSON. Using `json_schema` + is preferred for models that support it. + + - `class ResponseFormatText` + + Default response format. Used to generate text responses. + + - `type: :text` + + The type of response format being defined. Always `text`. + + - `:text` + + - `class ResponseFormatTextJSONSchemaConfig` + + JSON Schema response format. Used to generate structured JSON responses. + Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). + + - `name: String` + + The name of the response format. Must be a-z, A-Z, 0-9, or contain + underscores and dashes, with a maximum length of 64. + + - `schema: Hash[Symbol, untyped]` + + The schema for the response format, described as a JSON Schema object. + Learn how to build JSON schemas [here](https://json-schema.org/). + + - `type: :json_schema` + + The type of response format being defined. Always `json_schema`. + + - `:json_schema` + + - `description: String` + + A description of what the response format is for, used by the model to + determine how to respond in the format. + + - `strict: bool` + + Whether to enable strict schema adherence when generating the output. + If set to true, the model will always follow the exact schema defined + in the `schema` field. Only a subset of JSON Schema is supported when + `strict` is `true`. To learn more, read the [Structured Outputs + guide](https://platform.openai.com/docs/guides/structured-outputs). + + - `class ResponseFormatJSONObject` + + 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. + + - `type: :json_object` + + The type of response format being defined. Always `json_object`. + + - `:json_object` + + - `verbosity: :low | :medium | :high` + + Constrains the verbosity of the model's response. Lower values will result in + more concise responses, while higher values will result in more verbose responses. + Currently supported values are `low`, `medium`, and `high`. + + - `:low` + + - `:medium` + + - `:high` + + - `top_logprobs: Integer` + + An integer between 0 and 20 specifying the maximum number of most likely + tokens to return at each token position, each with an associated log + probability. In some cases, the number of returned tokens may be fewer than + requested. + + - `truncation: :auto | :disabled` + + The truncation strategy to use for the model response. + + - `auto`: If the input to this Response exceeds + the model's context window size, the model will truncate the + response to fit the context window by dropping items from the beginning of the conversation. + - `disabled` (default): If the input size will exceed the context window + size for a model, the request will fail with a 400 error. + + - `:auto` + + - `:disabled` + + - `usage: ResponseUsage` + + Represents token usage details including input tokens, output tokens, + a breakdown of output tokens, and the total tokens used. + + - `input_tokens: Integer` + + The number of input tokens. + + - `input_tokens_details: InputTokensDetails{ cached_tokens}` + + A detailed breakdown of the input tokens. + + - `cached_tokens: Integer` + + The number of tokens that were retrieved from the cache. + [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching). + + - `output_tokens: Integer` + + The number of output tokens. + + - `output_tokens_details: OutputTokensDetails{ reasoning_tokens}` + + A detailed breakdown of the output tokens. + + - `reasoning_tokens: Integer` + + The number of reasoning tokens. + + - `total_tokens: Integer` + + The total number of tokens used. + + - `user: String` + + This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. + A stable identifier for your end-users. + Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + +### Response Apply Patch Tool Call + +- `class ResponseApplyPatchToolCall` + + A tool call that applies file diffs by creating, deleting, or updating files. + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + One of the create_file, delete_file, or update_file operations applied via apply_patch. + + - `class CreateFile` + + Instruction describing how to create a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to create. + + - `type: :create_file` + + Create a new file with the provided diff. + + - `:create_file` + + - `class DeleteFile` + + Instruction describing how to delete a file via the apply_patch tool. + + - `path: String` + + Path of the file to delete. + + - `type: :delete_file` + + Delete the specified file. + + - `:delete_file` + + - `class UpdateFile` + + Instruction describing how to update a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to update. + + - `type: :update_file` + + Update an existing file with the provided diff. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + +### Response Apply Patch Tool Call Output + +- `class ResponseApplyPatchToolCallOutput` + + The output emitted by an apply patch tool call. + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `created_by: String` + + The ID of the entity that created this tool call output. + + - `output: String` + + Optional textual output returned by the apply patch tool. + +### Response Audio Delta Event + +- `class ResponseAudioDeltaEvent` + + Emitted when there is a partial audio response. + + - `delta: String` + + A chunk of Base64 encoded response audio bytes. + + - `sequence_number: Integer` + + A sequence number for this chunk of the stream response. + + - `type: :"response.audio.delta"` + + The type of the event. Always `response.audio.delta`. + + - `:"response.audio.delta"` + +### Response Audio Done Event + +- `class ResponseAudioDoneEvent` + + Emitted when the audio response is complete. + + - `sequence_number: Integer` + + The sequence number of the delta. + + - `type: :"response.audio.done"` + + The type of the event. Always `response.audio.done`. + + - `:"response.audio.done"` + +### Response Audio Transcript Delta Event + +- `class ResponseAudioTranscriptDeltaEvent` + + Emitted when there is a partial transcript of audio. + + - `delta: String` + + The partial transcript of the audio response. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.audio.transcript.delta"` + + The type of the event. Always `response.audio.transcript.delta`. + + - `:"response.audio.transcript.delta"` + +### Response Audio Transcript Done Event + +- `class ResponseAudioTranscriptDoneEvent` + + Emitted when the full audio transcript is completed. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.audio.transcript.done"` + + The type of the event. Always `response.audio.transcript.done`. + + - `:"response.audio.transcript.done"` + +### Response Code Interpreter Call Code Delta Event + +- `class ResponseCodeInterpreterCallCodeDeltaEvent` + + Emitted when a partial code snippet is streamed by the code interpreter. + + - `delta: String` + + The partial code snippet being streamed by the code interpreter. + + - `item_id: String` + + The unique identifier of the code interpreter tool call item. + + - `output_index: Integer` + + The index of the output item in the response for which the code is being streamed. + + - `sequence_number: Integer` + + The sequence number of this event, used to order streaming events. + + - `type: :"response.code_interpreter_call_code.delta"` + + The type of the event. Always `response.code_interpreter_call_code.delta`. + + - `:"response.code_interpreter_call_code.delta"` + +### Response Code Interpreter Call Code Done Event + +- `class ResponseCodeInterpreterCallCodeDoneEvent` + + Emitted when the code snippet is finalized by the code interpreter. + + - `code: String` + + The final code snippet output by the code interpreter. + + - `item_id: String` + + The unique identifier of the code interpreter tool call item. + + - `output_index: Integer` + + The index of the output item in the response for which the code is finalized. + + - `sequence_number: Integer` + + The sequence number of this event, used to order streaming events. + + - `type: :"response.code_interpreter_call_code.done"` + + The type of the event. Always `response.code_interpreter_call_code.done`. + + - `:"response.code_interpreter_call_code.done"` + +### Response Code Interpreter Call Completed Event + +- `class ResponseCodeInterpreterCallCompletedEvent` + + Emitted when the code interpreter call is completed. + + - `item_id: String` + + The unique identifier of the code interpreter tool call item. + + - `output_index: Integer` + + The index of the output item in the response for which the code interpreter call is completed. + + - `sequence_number: Integer` + + The sequence number of this event, used to order streaming events. + + - `type: :"response.code_interpreter_call.completed"` + + The type of the event. Always `response.code_interpreter_call.completed`. + + - `:"response.code_interpreter_call.completed"` + +### Response Code Interpreter Call In Progress Event + +- `class ResponseCodeInterpreterCallInProgressEvent` + + Emitted when a code interpreter call is in progress. + + - `item_id: String` + + The unique identifier of the code interpreter tool call item. + + - `output_index: Integer` + + The index of the output item in the response for which the code interpreter call is in progress. + + - `sequence_number: Integer` + + The sequence number of this event, used to order streaming events. + + - `type: :"response.code_interpreter_call.in_progress"` + + The type of the event. Always `response.code_interpreter_call.in_progress`. + + - `:"response.code_interpreter_call.in_progress"` + +### Response Code Interpreter Call Interpreting Event + +- `class ResponseCodeInterpreterCallInterpretingEvent` + + Emitted when the code interpreter is actively interpreting the code snippet. + + - `item_id: String` + + The unique identifier of the code interpreter tool call item. + + - `output_index: Integer` + + The index of the output item in the response for which the code interpreter is interpreting code. + + - `sequence_number: Integer` + + The sequence number of this event, used to order streaming events. + + - `type: :"response.code_interpreter_call.interpreting"` + + The type of the event. Always `response.code_interpreter_call.interpreting`. + + - `:"response.code_interpreter_call.interpreting"` + +### Response Code Interpreter Tool Call + +- `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `id: String` + + The unique ID of the code interpreter tool call. + + - `code: String` + + The code to run, or null if not available. + + - `container_id: String` + + The ID of the container used to run the code. + + - `outputs: Array[Logs{ logs, type} | Image{ type, url}]` + + The outputs generated by the code interpreter, such as logs or images. + Can be null if no outputs are available. + + - `class Logs` + + The logs output from the code interpreter. + + - `logs: String` + + The logs output from the code interpreter. + + - `type: :logs` + + The type of the output. Always `logs`. + + - `:logs` + + - `class Image` + + The image output from the code interpreter. + + - `type: :image` + + The type of the output. Always `image`. + + - `:image` + + - `url: String` + + The URL of the image output from the code interpreter. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:interpreting` + + - `:failed` + + - `type: :code_interpreter_call` + + The type of the code interpreter tool call. Always `code_interpreter_call`. + + - `:code_interpreter_call` + +### Response Compaction Item + +- `class ResponseCompactionItem` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `id: String` + + The unique ID of the compaction item. + + - `encrypted_content: String` + + The encrypted content that was produced by compaction. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `created_by: String` + + The identifier of the actor that created the item. + +### Response Compaction Item Param + +- `class ResponseCompactionItemParam` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `encrypted_content: String` + + The encrypted content of the compaction summary. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `id: String` + + The ID of the compaction item. + +### Response Completed Event + +- `class ResponseCompletedEvent` + + Emitted when the model response is complete. + + - `response: Response` + + Properties of the completed response. + + - `id: String` + + Unique identifier for this Response. + + - `created_at: Float` + + Unix timestamp (in seconds) of when this Response was created. + + - `error: ResponseError` + + An error object returned when the model fails to generate a Response. + + - `code: :server_error | :rate_limit_exceeded | :invalid_prompt | 15 more` + + The error code for the response. + + - `: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` + + - `message: String` + + A human-readable description of the error. + + - `incomplete_details: IncompleteDetails{ reason}` + + Details about why the response is incomplete. + + - `reason: :max_output_tokens | :content_filter` + + The reason why the response is incomplete. + + - `:max_output_tokens` + + - `:content_filter` + + - `instructions: String | Array[ResponseInputItem]` + + A system (or developer) message inserted into the model's context. + + When using along with `previous_response_id`, the instructions from a previous + response will not be carried over to the next response. This makes it simple + to swap out system (or developer) messages in new responses. + + - `String = String` + + A text input to the model, equivalent to a text input with the + `developer` role. + + - `InputItemList = Array[ResponseInputItem]` + + A list of one or many input items to the model, containing + different content types. + + - `class EasyInputMessage` + + 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. + + - `content: String | ResponseInputMessageContentList` + + Text, image, or audio input to the model, used to generate a response. + Can also contain previous assistant responses. + + - `String = String` + + A text input to the model. + + - `ResponseInputMessageContentList = Array[ResponseInputContent]` + + A list of one or many input items to the model, containing different content + types. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `role: :user | :assistant | :system | :developer` + + The role of the message input. One of `user`, `assistant`, `system`, or + `developer`. + + - `:user` + + - `:assistant` + + - `:system` + + - `:developer` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `type: :message` + + The type of the message input. Always `message`. + + - `:message` + + - `class Message` + + 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. + + - `content: ResponseInputMessageContentList` + + A list of one or many input items to the model, containing different content + types. + + - `role: :user | :system | :developer` + + The role of the message input. One of `user`, `system`, or `developer`. + + - `:user` + + - `:system` + + - `:developer` + + - `status: :in_progress | :completed | :incomplete` + + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the message input. Always set to `message`. + + - `:message` + + - `class ResponseOutputMessage` + + An output message from the model. + + - `id: String` + + The unique ID of the output message. + + - `content: Array[ResponseOutputText | ResponseOutputRefusal]` + + The content of the output message. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `role: :assistant` + + The role of the output message. Always `assistant`. + + - `:assistant` + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the output message. Always `message`. + + - `:message` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `class ResponseFileSearchToolCall` + + 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. + + - `id: String` + + The unique ID of the file search tool call. + + - `queries: Array[String]` + + The queries used to search for files. + + - `status: :in_progress | :searching | :completed | 2 more` + + The status of the file search tool call. One of `in_progress`, + `searching`, `incomplete` or `failed`, + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `type: :file_search_call` + + The type of the file search tool call. Always `file_search_call`. + + - `:file_search_call` + + - `results: Array[Result{ attributes, file_id, filename, 2 more}]` + + The results of the file search tool call. + + - `attributes: Hash[Symbol, String | Float | bool]` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. Keys are strings + with a maximum length of 64 characters. Values are strings with a maximum + length of 512 characters, booleans, or numbers. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `file_id: String` + + The unique ID of the file. + + - `filename: String` + + The name of the file. + + - `score: Float` + + The relevance score of the file - a value between 0 and 1. + + - `text: String` + + The text that was retrieved from the file. + + - `class ResponseComputerToolCall` + + 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. + + - `id: String` + + The unique ID of the computer call. + + - `call_id: String` + + An identifier used when responding to the tool call with output. + + - `pending_safety_checks: Array[PendingSafetyCheck{ id, code, message}]` + + The pending safety checks for the computer call. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :computer_call` + + The type of the computer call. Always `computer_call`. + + - `:computer_call` + + - `action: Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `actions: ComputerActionList` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `class ComputerCallOutput` + + The output of a computer tool call. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `id: String` + + The ID of the computer tool call output. + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionWebSearch` + + 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. + + - `id: String` + + The unique ID of the web search tool call. + + - `action: Search{ type, queries, query, sources} | OpenPage{ type, url} | FindInPage{ pattern, type, url}` + + An object describing the specific action taken in this web search call. + Includes details on how the model used the web (search, open_page, find_in_page). + + - `class Search` + + Action type "search" - Performs a web search query. + + - `type: :search` + + The action type. + + - `:search` + + - `queries: Array[String]` + + The search queries. + + - `query: String` + + The search query. + + - `sources: Array[Source{ type, url}]` + + The sources used in the search. + + - `type: :url` + + The type of source. Always `url`. + + - `:url` + + - `url: String` + + The URL of the source. + + - `class OpenPage` + + Action type "open_page" - Opens a specific URL from search results. + + - `type: :open_page` + + The action type. + + - `:open_page` + + - `url: String` + + The URL opened by the model. + + - `class FindInPage` + + Action type "find_in_page": Searches for a pattern within a loaded page. + + - `pattern: String` + + The pattern or text to search for within the page. + + - `type: :find_in_page` + + The action type. + + - `:find_in_page` + + - `url: String` + + The URL of the page searched for the pattern. + + - `status: :in_progress | :searching | :completed | :failed` + + The status of the web search tool call. + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:failed` + + - `type: :web_search_call` + + The type of the web search tool call. Always `web_search_call`. + + - `:web_search_call` + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `arguments: String` + + A JSON string of the arguments to pass to the function. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `name: String` + + The name of the function to run. + + - `type: :function_call` + + The type of the function tool call. Always `function_call`. + + - `:function_call` + + - `id: String` + + The unique ID of the function tool call. + + - `namespace: String` + + The namespace of the function to run. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class FunctionCallOutput` + + The output of a function tool call. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | ResponseFunctionCallOutputItemList` + + Text, image, or file output of the function tool call. + + - `String = String` + + A JSON string of the output of the function tool call. + + - `ResponseFunctionCallOutputItemList = Array[ResponseFunctionCallOutputItem]` + + An array of content outputs (text, image, file) for the function tool call. + + - `class ResponseInputTextContent` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImageContent` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision) + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFileContent` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The base64-encoded data of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `id: String` + + The unique ID of the function tool call output. Populated when this item is returned via API. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ToolSearchCall` + + - `arguments: untyped` + + The arguments supplied to the tool search call. + + - `type: :tool_search_call` + + The item type. Always `tool_search_call`. + + - `:tool_search_call` + + - `id: String` + + The unique ID of this tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseToolSearchOutputItemParam` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by the tool search output. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The item type. Always `tool_search_output`. + + - `:tool_search_output` + + - `id: String` + + The unique ID of this tool search output. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class AdditionalTools` + + - `role: :developer` + + The role that provided the additional tools. Only `developer` is supported. + + - `:developer` + + - `tools: Array[Tool]` + + A list of additional tools made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The item type. Always `additional_tools`. + + - `:additional_tools` + + - `id: String` + + The unique ID of this additional tools item. + + - `class ResponseReasoningItem` + + 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). + + - `id: String` + + The unique identifier of the reasoning content. + + - `summary: Array[Summary{ text, type}]` + + Reasoning summary content. + + - `text: String` + + A summary of the reasoning output from the model so far. + + - `type: :summary_text` + + The type of the object. Always `summary_text`. + + - `:summary_text` + + - `type: :reasoning` + + The type of the object. Always `reasoning`. + + - `:reasoning` + + - `content: Array[Content{ text, type}]` + + Reasoning text content. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `encrypted_content: String` + + The encrypted content of the reasoning item - populated when a response is + generated with `reasoning.encrypted_content` in the `include` parameter. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseCompactionItemParam` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `encrypted_content: String` + + The encrypted content of the compaction summary. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `id: String` + + The ID of the compaction item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `id: String` + + The unique ID of the code interpreter tool call. + + - `code: String` + + The code to run, or null if not available. + + - `container_id: String` + + The ID of the container used to run the code. + + - `outputs: Array[Logs{ logs, type} | Image{ type, url}]` + + The outputs generated by the code interpreter, such as logs or images. + Can be null if no outputs are available. + + - `class Logs` + + The logs output from the code interpreter. + + - `logs: String` + + The logs output from the code interpreter. + + - `type: :logs` + + The type of the output. Always `logs`. + + - `:logs` + + - `class Image` + + The image output from the code interpreter. + + - `type: :image` + + The type of the output. Always `image`. + + - `:image` + + - `url: String` + + The URL of the image output from the code interpreter. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:interpreting` + + - `:failed` + + - `type: :code_interpreter_call` + + The type of the code interpreter tool call. Always `code_interpreter_call`. + + - `:code_interpreter_call` + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCall` + + A tool representing a request to execute one or more shell commands. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + Ordered shell commands for the execution environment to run. + + - `max_output_length: Integer` + + Maximum number of UTF-8 characters to capture from combined stdout and stderr output. + + - `timeout_ms: Integer` + + Maximum wall-clock time in milliseconds to allow the shell commands to run. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `environment: LocalEnvironment | ContainerReference` + + The environment to execute the shell commands in. + + - `class LocalEnvironment` + + - `class ContainerReference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCallOutput` + + The streamed output items emitted by a shell tool call. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `output: Array[ResponseFunctionShellCallOutputContent]` + + Captured chunks of stdout and stderr output, along with their associated outcomes. + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + The exit or timeout outcome associated with this shell call. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + The exit code returned by the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + Captured stderr output for the shell call. + + - `stdout: String` + + Captured stdout output for the shell call. + + - `type: :shell_call_output` + + The type of the item. Always `shell_call_output`. + + - `:shell_call_output` + + - `id: String` + + The unique ID of the shell tool call output. Populated when this item is returned via API. + + - `max_output_length: Integer` + + The maximum number of UTF-8 characters captured for this shell call's combined output. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ApplyPatchCall` + + A tool call representing a request to create, delete, or update files using diff patches. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + The specific create, delete, or update instruction for the apply_patch tool call. + + - `class CreateFile` + + Instruction for creating a new file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply when creating the file. + + - `path: String` + + Path of the file to create relative to the workspace root. + + - `type: :create_file` + + The operation type. Always `create_file`. + + - `:create_file` + + - `class DeleteFile` + + Instruction for deleting an existing file via the apply_patch tool. + + - `path: String` + + Path of the file to delete relative to the workspace root. + + - `type: :delete_file` + + The operation type. Always `delete_file`. + + - `:delete_file` + + - `class UpdateFile` + + Instruction for updating an existing file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply to the existing file. + + - `path: String` + + Path of the file to update relative to the workspace root. + + - `type: :update_file` + + The operation type. Always `update_file`. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `class ApplyPatchCallOutput` + + The streamed output emitted by an apply patch tool call. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `output: String` + + Optional human-readable log text from the apply patch tool (e.g., patch results or errors). + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `id: String` + + The unique ID of the approval response + + - `reason: String` + + Optional reason for the decision. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class ResponseCustomToolCallOutput` + + The output of a custom tool call from your code, being sent back to the model. + + - `call_id: String` + + The call ID, used to map this custom tool call output to a custom tool call. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the custom tool call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the custom tool call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :custom_tool_call_output` + + The type of the custom tool call output. Always `custom_tool_call_output`. + + - `:custom_tool_call_output` + + - `id: String` + + The unique ID of the custom tool call output in the OpenAI platform. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `call_id: String` + + An identifier used to map this custom tool call to a tool call output. + + - `input: String` + + The input for the custom tool call generated by the model. + + - `name: String` + + The name of the custom tool being called. + + - `type: :custom_tool_call` + + The type of the custom tool call. Always `custom_tool_call`. + + - `:custom_tool_call` + + - `id: String` + + The unique ID of the custom tool call in the OpenAI platform. + + - `namespace: String` + + The namespace of the custom tool being called. + + - `class CompactionTrigger` + + Compacts the current context. Must be the final input item. + + - `type: :compaction_trigger` + + The type of the item. Always `compaction_trigger`. + + - `:compaction_trigger` + + - `class ItemReference` + + An internal identifier for an item to reference. + + - `id: String` + + The ID of the item to reference. + + - `type: :item_reference` + + The type of item to reference. Always `item_reference`. + + - `:item_reference` + + - `metadata: Metadata` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. + + Keys are strings with a maximum length of 64 characters. Values are strings + with a maximum length of 512 characters. + + - `model: ResponsesModel` + + Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI + offers a wide range of models with different capabilities, performance + characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) + to browse and compare available models. + + - `String = String` + + - `ChatModel = :"gpt-5.4" | :"gpt-5.4-mini" | :"gpt-5.4-nano" | 75 more` + + - `:"gpt-5.4"` + + - `:"gpt-5.4-mini"` + + - `:"gpt-5.4-nano"` + + - `:"gpt-5.4-mini-2026-03-17"` + + - `:"gpt-5.4-nano-2026-03-17"` + + - `:"gpt-5.3-chat-latest"` + + - `:"gpt-5.2"` + + - `:"gpt-5.2-2025-12-11"` + + - `:"gpt-5.2-chat-latest"` + + - `:"gpt-5.2-pro"` + + - `:"gpt-5.2-pro-2025-12-11"` + + - `:"gpt-5.1"` + + - `:"gpt-5.1-2025-11-13"` + + - `:"gpt-5.1-codex"` + + - `:"gpt-5.1-mini"` + + - `:"gpt-5.1-chat-latest"` + + - `:"gpt-5"` + + - `:"gpt-5-mini"` + + - `:"gpt-5-nano"` + + - `:"gpt-5-2025-08-07"` + + - `:"gpt-5-mini-2025-08-07"` + + - `:"gpt-5-nano-2025-08-07"` + + - `:"gpt-5-chat-latest"` + + - `:"gpt-4.1"` + + - `:"gpt-4.1-mini"` + + - `:"gpt-4.1-nano"` + + - `:"gpt-4.1-2025-04-14"` + + - `:"gpt-4.1-mini-2025-04-14"` + + - `:"gpt-4.1-nano-2025-04-14"` + + - `:"o4-mini"` + + - `:"o4-mini-2025-04-16"` + + - `:o3` + + - `:"o3-2025-04-16"` + + - `:"o3-mini"` + + - `:"o3-mini-2025-01-31"` + + - `:o1` + + - `:"o1-2024-12-17"` + + - `:"o1-preview"` + + - `:"o1-preview-2024-09-12"` + + - `:"o1-mini"` + + - `:"o1-mini-2024-09-12"` + + - `:"gpt-4o"` + + - `:"gpt-4o-2024-11-20"` + + - `:"gpt-4o-2024-08-06"` + + - `:"gpt-4o-2024-05-13"` + + - `:"gpt-4o-audio-preview"` + + - `:"gpt-4o-audio-preview-2024-10-01"` + + - `:"gpt-4o-audio-preview-2024-12-17"` + + - `:"gpt-4o-audio-preview-2025-06-03"` + + - `:"gpt-4o-mini-audio-preview"` + + - `:"gpt-4o-mini-audio-preview-2024-12-17"` + + - `:"gpt-4o-search-preview"` + + - `:"gpt-4o-mini-search-preview"` + + - `:"gpt-4o-search-preview-2025-03-11"` + + - `:"gpt-4o-mini-search-preview-2025-03-11"` + + - `:"chatgpt-4o-latest"` + + - `:"codex-mini-latest"` + + - `:"gpt-4o-mini"` + + - `:"gpt-4o-mini-2024-07-18"` + + - `:"gpt-4-turbo"` + + - `:"gpt-4-turbo-2024-04-09"` + + - `:"gpt-4-0125-preview"` + + - `:"gpt-4-turbo-preview"` + + - `:"gpt-4-1106-preview"` + + - `:"gpt-4-vision-preview"` + + - `:"gpt-4"` + + - `:"gpt-4-0314"` + + - `:"gpt-4-0613"` + + - `:"gpt-4-32k"` + + - `:"gpt-4-32k-0314"` + + - `:"gpt-4-32k-0613"` + + - `:"gpt-3.5-turbo"` + + - `:"gpt-3.5-turbo-16k"` + + - `:"gpt-3.5-turbo-0301"` + + - `:"gpt-3.5-turbo-0613"` + + - `:"gpt-3.5-turbo-1106"` + + - `:"gpt-3.5-turbo-0125"` + + - `:"gpt-3.5-turbo-16k-0613"` + + - `ResponsesOnlyModel = :"o1-pro" | :"o1-pro-2025-03-19" | :"o3-pro" | 11 more` + + - `:"o1-pro"` + + - `:"o1-pro-2025-03-19"` + + - `:"o3-pro"` + + - `:"o3-pro-2025-06-10"` + + - `:"o3-deep-research"` + + - `:"o3-deep-research-2025-06-26"` + + - `:"o4-mini-deep-research"` + + - `:"o4-mini-deep-research-2025-06-26"` + + - `:"computer-use-preview"` + + - `:"computer-use-preview-2025-03-11"` + + - `:"gpt-5-codex"` + + - `:"gpt-5-pro"` + + - `:"gpt-5-pro-2025-10-06"` + + - `:"gpt-5.1-codex-max"` + + - `object: :response` + + The object type of this resource - always set to `response`. + + - `:response` + + - `output: Array[ResponseOutputItem]` + + An array of content items generated by the model. + + - The length and order of items in the `output` array is dependent + on the model's response. + - Rather than accessing the first item in the `output` array and + assuming it's an `assistant` message with the content generated by + the model, you might consider using the `output_text` property where + supported in SDKs. + + - `class ResponseOutputMessage` + + An output message from the model. + + - `class ResponseFileSearchToolCall` + + 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. + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `class ResponseFunctionToolCallOutputItem` + + - `id: String` + + The unique ID of the function call tool output. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the function call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the function call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the function call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseFunctionWebSearch` + + 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. + + - `class ResponseComputerToolCall` + + 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. + + - `class ResponseComputerToolCallOutputItem` + + - `id: String` + + The unique ID of the computer call tool output. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `status: :completed | :incomplete | :failed | :in_progress` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `:in_progress` + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the + developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseReasoningItem` + + 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). + + - `class ResponseToolSearchCall` + + - `id: String` + + The unique ID of the tool search call item. + + - `arguments: untyped` + + Arguments used for the tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :tool_search_call` + + The type of the item. Always `tool_search_call`. + + - `:tool_search_call` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseToolSearchOutputItem` + + - `id: String` + + The unique ID of the tool search output item. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by tool search. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :tool_search_output` + + The type of the item. Always `tool_search_output`. + + - `:tool_search_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class AdditionalTools` + + - `id: String` + + The unique ID of the additional tools item. + + - `role: :unknown | :user | :assistant | 5 more` + + The role that provided the additional tools. + + - `:unknown` + + - `:user` + + - `:assistant` + + - `:system` + + - `:critic` + + - `:discriminator` + + - `:developer` + + - `:tool` + + - `tools: Array[Tool]` + + The additional tool definitions made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The type of the item. Always `additional_tools`. + + - `:additional_tools` + + - `class ResponseCompactionItem` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `id: String` + + The unique ID of the compaction item. + + - `encrypted_content: String` + + The encrypted content that was produced by compaction. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionShellToolCall` + + A tool call that executes one or more shell commands in a managed environment. + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + - `max_output_length: Integer` + + Optional maximum number of characters to return from each command. + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the commands. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `environment: ResponseLocalEnvironment | ResponseContainerReference` + + Represents the use of a local environment to perform shell actions. + + - `class ResponseLocalEnvironment` + + Represents the use of a local environment to perform shell actions. + + - `type: :local` + + The environment type. Always `local`. + + - `:local` + + - `class ResponseContainerReference` + + Represents a container created with /v1/containers. + + - `container_id: String` + + - `type: :container_reference` + + The environment type. Always `container_reference`. + + - `:container_reference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseFunctionShellToolCallOutput` + + The output of a shell tool call that was emitted. + + - `id: String` + + The unique ID of the shell call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `max_output_length: Integer` + + The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output. + + - `output: Array[Output{ outcome, stderr, stdout, created_by}]` + + An array of shell call output contents + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + Exit code from the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + The standard error output that was captured. + + - `stdout: String` + + The standard output that was captured. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call_output` + + The type of the shell call output. Always `shell_call_output`. + + - `:shell_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseApplyPatchToolCall` + + A tool call that applies file diffs by creating, deleting, or updating files. + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + One of the create_file, delete_file, or update_file operations applied via apply_patch. + + - `class CreateFile` + + Instruction describing how to create a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to create. + + - `type: :create_file` + + Create a new file with the provided diff. + + - `:create_file` + + - `class DeleteFile` + + Instruction describing how to delete a file via the apply_patch tool. + + - `path: String` + + Path of the file to delete. + + - `type: :delete_file` + + Delete the specified file. + + - `:delete_file` + + - `class UpdateFile` + + Instruction describing how to update a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to update. + + - `type: :update_file` + + Update an existing file with the provided diff. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseApplyPatchToolCallOutput` + + The output emitted by an apply patch tool call. + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `created_by: String` + + The ID of the entity that created this tool call output. + + - `output: String` + + Optional textual output returned by the apply patch tool. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `id: String` + + The unique ID of the approval response + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `reason: String` + + Optional reason for the decision. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `class ResponseCustomToolCallOutputItem` + + The output of a custom tool call from your code, being sent back to the model. + + - `id: String` + + The unique ID of the custom tool call output item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `parallel_tool_calls: bool` + + Whether to allow the model to run tool calls in parallel. + + - `temperature: Float` + + 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. + + - `tool_choice: ToolChoiceOptions | ToolChoiceAllowed | ToolChoiceTypes | 5 more` + + How the model should select which tool (or tools) to use when generating + a response. See the `tools` parameter to see how to specify which tools + the model can call. + + - `ToolChoiceOptions = :none | :auto | :required` + + Controls which (if any) tool is called by the model. + + `none` means the model will not call any tool and instead generates a message. + + `auto` means the model can pick between generating a message or calling one or + more tools. + + `required` means the model must call one or more tools. + + - `:none` + + - `:auto` + + - `:required` + + - `class ToolChoiceAllowed` + + Constrains the tools available to the model to a pre-defined set. + + - `mode: :auto | :required` + + Constrains the tools available to the model to a pre-defined set. + + `auto` allows the model to pick from among the allowed tools and generate a + message. + + `required` requires the model to call one or more of the allowed tools. + + - `:auto` + + - `:required` + + - `tools: Array[Hash[Symbol, untyped]]` + + A list of tool definitions that the model should be allowed to call. + + For the Responses API, the list of tool definitions might look like: + + ```json + [ + { "type": "function", "name": "get_weather" }, + { "type": "mcp", "server_label": "deepwiki" }, + { "type": "image_generation" } + ] + ``` + + - `type: :allowed_tools` + + Allowed tool configuration type. Always `allowed_tools`. + + - `:allowed_tools` + + - `class ToolChoiceTypes` + + 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). + + - `type: :file_search | :web_search_preview | :computer | 5 more` + + The type of hosted tool the model should to use. Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + + Allowed values are: + + - `file_search` + - `web_search_preview` + - `computer` + - `computer_use_preview` + - `computer_use` + - `code_interpreter` + - `image_generation` + + - `:file_search` + + - `:web_search_preview` + + - `:computer` + + - `:computer_use_preview` + + - `:computer_use` + + - `:web_search_preview_2025_03_11` + + - `:image_generation` + + - `:code_interpreter` + + - `class ToolChoiceFunction` + + Use this option to force the model to call a specific function. + + - `name: String` + + The name of the function to call. + + - `type: :function` + + For function calling, the type is always `function`. + + - `:function` + + - `class ToolChoiceMcp` + + Use this option to force the model to call a specific tool on a remote MCP server. + + - `server_label: String` + + The label of the MCP server to use. + + - `type: :mcp` + + For MCP tools, the type is always `mcp`. + + - `:mcp` + + - `name: String` + + The name of the tool to call on the server. + + - `class ToolChoiceCustom` + + Use this option to force the model to call a specific custom tool. + + - `name: String` + + The name of the custom tool to call. + + - `type: :custom` + + For custom tool calling, the type is always `custom`. + + - `:custom` + + - `class ToolChoiceApplyPatch` + + Forces the model to call the apply_patch tool when executing a tool call. + + - `type: :apply_patch` + + The tool to call. Always `apply_patch`. + + - `:apply_patch` + + - `class ToolChoiceShell` + + Forces the model to call the shell tool when a tool call is required. + + - `type: :shell` + + The tool to call. Always `shell`. + + - `:shell` + + - `tools: Array[Tool]` + + An array of tools the model may call while generating a response. You + can specify which tool to use by setting the `tool_choice` parameter. + + We support the following categories of tools: + + - **Built-in tools**: Tools that are provided by OpenAI that extend the + model's capabilities, like [web search](https://platform.openai.com/docs/guides/tools-web-search) + or [file search](https://platform.openai.com/docs/guides/tools-file-search). Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + - **MCP Tools**: Integrations with third-party systems via custom MCP servers + or predefined connectors such as Google Drive and SharePoint. Learn more about + [MCP Tools](https://platform.openai.com/docs/guides/tools-connectors-mcp). + - **Function calls (custom tools)**: Functions that are defined by you, + enabling the model to call your own code with strongly typed arguments + and outputs. Learn more about + [function calling](https://platform.openai.com/docs/guides/function-calling). You can also use + custom tools to call your own code. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `top_p: Float` + + 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. + + - `background: bool` + + Whether to run the model response in the background. + [Learn more](https://platform.openai.com/docs/guides/background). + + - `completed_at: Float` + + Unix timestamp (in seconds) of when this Response was completed. + Only present when the status is `completed`. + + - `conversation: Conversation{ id}` + + The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation. + + - `id: String` + + The unique ID of the conversation that this response was associated with. + + - `max_output_tokens: Integer` + + An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://platform.openai.com/docs/guides/reasoning). + + - `max_tool_calls: Integer` + + 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. + + - `moderation: Moderation{ input, output}` + + Moderation results for the response input and output, if moderated completions were requested. + + - `input: ModerationResult{ categories, category_applied_input_types, category_scores, 3 more} | Error{ code, message, type}` + + Moderation for the response input. + + - `class ModerationResult` + + A moderation result produced for the response input or output. + + - `categories: Hash[Symbol, bool]` + + A dictionary of moderation categories to booleans, True if the input is flagged under this category. + + - `category_applied_input_types: Hash[Symbol, Array[:text | :image]]` + + Which modalities of input are reflected by the score for each category. + + - `:text` + + - `:image` + + - `category_scores: Hash[Symbol, Float]` + + A dictionary of moderation categories to scores. + + - `flagged: bool` + + A boolean indicating whether the content was flagged by any category. + + - `model: String` + + The moderation model that produced this result. + + - `type: :moderation_result` + + The object type, which was always `moderation_result` for successful moderation results. + + - `:moderation_result` + + - `class Error` + + An error produced while attempting moderation for the response input or output. + + - `code: String` + + The error code. + + - `message: String` + + The error message. + + - `type: :error` + + The object type, which was always `error` for moderation failures. + + - `:error` + + - `output: ModerationResult{ categories, category_applied_input_types, category_scores, 3 more} | Error{ code, message, type}` + + Moderation for the response output. + + - `class ModerationResult` + + A moderation result produced for the response input or output. + + - `categories: Hash[Symbol, bool]` + + A dictionary of moderation categories to booleans, True if the input is flagged under this category. + + - `category_applied_input_types: Hash[Symbol, Array[:text | :image]]` + + Which modalities of input are reflected by the score for each category. + + - `:text` + + - `:image` + + - `category_scores: Hash[Symbol, Float]` + + A dictionary of moderation categories to scores. + + - `flagged: bool` + + A boolean indicating whether the content was flagged by any category. + + - `model: String` + + The moderation model that produced this result. + + - `type: :moderation_result` + + The object type, which was always `moderation_result` for successful moderation results. + + - `:moderation_result` + + - `class Error` + + An error produced while attempting moderation for the response input or output. + + - `code: String` + + The error code. + + - `message: String` + + The error message. + + - `type: :error` + + The object type, which was always `error` for moderation failures. + + - `:error` + + - `previous_response_id: String` + + The unique ID of the previous response to the model. Use this to + create multi-turn conversations. Learn more about + [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. + + - `prompt: ResponsePrompt` + + Reference to a prompt template and its variables. + [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts). + + - `id: String` + + The unique identifier of the prompt template to use. + + - `variables: Hash[Symbol, String | ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Optional map of values to substitute in for variables in your + prompt. The substitution values can either be strings, or other + Response input types like images or files. + + - `String = String` + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `version: String` + + Optional version of the prompt template. + + - `prompt_cache_key: String` + + Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://platform.openai.com/docs/guides/prompt-caching). + + - `prompt_cache_retention: :in_memory | :"24h"` + + The retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention). + For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported. + + For older models that support both `in_memory` and `24h`, the default depends on your organization's data retention policy: + + - Organizations without ZDR enabled default to `24h`. + - Organizations with ZDR enabled default to `in_memory` when `prompt_cache_retention` is not specified. + + - `:in_memory` + + - `:"24h"` + + - `reasoning: Reasoning` + + **gpt-5 and o-series models only** + + Configuration options for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + + - `effort: ReasoningEffort` + + Constrains effort on reasoning for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing + reasoning effort can result in faster responses and fewer tokens used + on reasoning in a response. + + - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1. + - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. + - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. + - `xhigh` is supported for all models after `gpt-5.1-codex-max`. + + - `:none` + + - `:minimal` + + - `:low` + + - `:medium` + + - `:high` + + - `:xhigh` + + - `generate_summary: :auto | :concise | :detailed` + + **Deprecated:** use `summary` instead. + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `summary: :auto | :concise | :detailed` + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + `concise` is supported for `computer-use-preview` models and all reasoning models after `gpt-5`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `safety_identifier: String` + + A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + + - `service_tier: :auto | :default | :flex | 2 more` + + Specifies the processing type used for serving the request. + + - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. + - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. + - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier. + - When not set, the default behavior is 'auto'. + + When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter. + + - `:auto` + + - `:default` + + - `:flex` + + - `:scale` + + - `:priority` + + - `status: ResponseStatus` + + The status of the response generation. One of `completed`, `failed`, + `in_progress`, `cancelled`, `queued`, or `incomplete`. + + - `:completed` + + - `:failed` + + - `:in_progress` + + - `:cancelled` + + - `:queued` + + - `:incomplete` + + - `text: ResponseTextConfig` + + 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) + + - `format_: ResponseFormatTextConfig` + + An object specifying the format that the model must output. + + Configuring `{ "type": "json_schema" }` enables Structured Outputs, + which ensures the model will match your supplied JSON schema. Learn more in the + [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). + + The default format is `{ "type": "text" }` with no additional options. + + **Not recommended for gpt-4o and newer models:** + + Setting to `{ "type": "json_object" }` enables the older JSON mode, which + ensures the message the model generates is valid JSON. Using `json_schema` + is preferred for models that support it. + + - `class ResponseFormatText` + + Default response format. Used to generate text responses. + + - `type: :text` + + The type of response format being defined. Always `text`. + + - `:text` + + - `class ResponseFormatTextJSONSchemaConfig` + + JSON Schema response format. Used to generate structured JSON responses. + Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). + + - `name: String` + + The name of the response format. Must be a-z, A-Z, 0-9, or contain + underscores and dashes, with a maximum length of 64. + + - `schema: Hash[Symbol, untyped]` + + The schema for the response format, described as a JSON Schema object. + Learn how to build JSON schemas [here](https://json-schema.org/). + + - `type: :json_schema` + + The type of response format being defined. Always `json_schema`. + + - `:json_schema` + + - `description: String` + + A description of what the response format is for, used by the model to + determine how to respond in the format. + + - `strict: bool` + + Whether to enable strict schema adherence when generating the output. + If set to true, the model will always follow the exact schema defined + in the `schema` field. Only a subset of JSON Schema is supported when + `strict` is `true`. To learn more, read the [Structured Outputs + guide](https://platform.openai.com/docs/guides/structured-outputs). + + - `class ResponseFormatJSONObject` + + 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. + + - `type: :json_object` + + The type of response format being defined. Always `json_object`. + + - `:json_object` + + - `verbosity: :low | :medium | :high` + + Constrains the verbosity of the model's response. Lower values will result in + more concise responses, while higher values will result in more verbose responses. + Currently supported values are `low`, `medium`, and `high`. + + - `:low` + + - `:medium` + + - `:high` + + - `top_logprobs: Integer` + + An integer between 0 and 20 specifying the maximum number of most likely + tokens to return at each token position, each with an associated log + probability. In some cases, the number of returned tokens may be fewer than + requested. + + - `truncation: :auto | :disabled` + + The truncation strategy to use for the model response. + + - `auto`: If the input to this Response exceeds + the model's context window size, the model will truncate the + response to fit the context window by dropping items from the beginning of the conversation. + - `disabled` (default): If the input size will exceed the context window + size for a model, the request will fail with a 400 error. + + - `:auto` + + - `:disabled` + + - `usage: ResponseUsage` + + Represents token usage details including input tokens, output tokens, + a breakdown of output tokens, and the total tokens used. + + - `input_tokens: Integer` + + The number of input tokens. + + - `input_tokens_details: InputTokensDetails{ cached_tokens}` + + A detailed breakdown of the input tokens. + + - `cached_tokens: Integer` + + The number of tokens that were retrieved from the cache. + [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching). + + - `output_tokens: Integer` + + The number of output tokens. + + - `output_tokens_details: OutputTokensDetails{ reasoning_tokens}` + + A detailed breakdown of the output tokens. + + - `reasoning_tokens: Integer` + + The number of reasoning tokens. + + - `total_tokens: Integer` + + The total number of tokens used. + + - `user: String` + + This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. + A stable identifier for your end-users. + Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + + - `sequence_number: Integer` + + The sequence number for this event. + + - `type: :"response.completed"` + + The type of the event. Always `response.completed`. + + - `:"response.completed"` + +### Response Computer Tool Call + +- `class ResponseComputerToolCall` + + 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. + + - `id: String` + + The unique ID of the computer call. + + - `call_id: String` + + An identifier used when responding to the tool call with output. + + - `pending_safety_checks: Array[PendingSafetyCheck{ id, code, message}]` + + The pending safety checks for the computer call. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :computer_call` + + The type of the computer call. Always `computer_call`. + + - `:computer_call` + + - `action: Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `actions: ComputerActionList` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + +### Response Computer Tool Call Output Item + +- `class ResponseComputerToolCallOutputItem` + + - `id: String` + + The unique ID of the computer call tool output. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + + - `status: :completed | :incomplete | :failed | :in_progress` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `:in_progress` + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the + developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `created_by: String` + + The identifier of the actor that created the item. + +### Response Computer Tool Call Output Screenshot + +- `class ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + +### Response Container Reference + +- `class ResponseContainerReference` + + Represents a container created with /v1/containers. + + - `container_id: String` + + - `type: :container_reference` + + The environment type. Always `container_reference`. + + - `:container_reference` + +### Response Content + +- `ResponseContent = ResponseInputText | ResponseInputImage | ResponseInputFile | 3 more` + + Multi-modal input and output contents. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `class ReasoningTextContent` + + Reasoning text from the model. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + +### Response Content Part Added Event + +- `class ResponseContentPartAddedEvent` + + Emitted when a new content part is added. + + - `content_index: Integer` + + The index of the content part that was added. + + - `item_id: String` + + The ID of the output item that the content part was added to. + + - `output_index: Integer` + + The index of the output item that the content part was added to. + + - `part: ResponseOutputText | ResponseOutputRefusal | ReasoningText{ text, type}` + + The content part that was added. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `class ReasoningText` + + Reasoning text from the model. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.content_part.added"` + + The type of the event. Always `response.content_part.added`. + + - `:"response.content_part.added"` + +### Response Content Part Done Event + +- `class ResponseContentPartDoneEvent` + + Emitted when a content part is done. + + - `content_index: Integer` + + The index of the content part that is done. + + - `item_id: String` + + The ID of the output item that the content part was added to. + + - `output_index: Integer` + + The index of the output item that the content part was added to. + + - `part: ResponseOutputText | ResponseOutputRefusal | ReasoningText{ text, type}` + + The content part that is done. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `class ReasoningText` + + Reasoning text from the model. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.content_part.done"` + + The type of the event. Always `response.content_part.done`. + + - `:"response.content_part.done"` + +### Response Conversation Param + +- `class ResponseConversationParam` + + The conversation that this response belongs to. + + - `id: String` + + The unique ID of the conversation. + +### Response Created Event + +- `class ResponseCreatedEvent` + + An event that is emitted when a response is created. + + - `response: Response` + + The response that was created. + + - `id: String` + + Unique identifier for this Response. + + - `created_at: Float` + + Unix timestamp (in seconds) of when this Response was created. + + - `error: ResponseError` + + An error object returned when the model fails to generate a Response. + + - `code: :server_error | :rate_limit_exceeded | :invalid_prompt | 15 more` + + The error code for the response. + + - `: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` + + - `message: String` + + A human-readable description of the error. + + - `incomplete_details: IncompleteDetails{ reason}` + + Details about why the response is incomplete. + + - `reason: :max_output_tokens | :content_filter` + + The reason why the response is incomplete. + + - `:max_output_tokens` + + - `:content_filter` + + - `instructions: String | Array[ResponseInputItem]` + + A system (or developer) message inserted into the model's context. + + When using along with `previous_response_id`, the instructions from a previous + response will not be carried over to the next response. This makes it simple + to swap out system (or developer) messages in new responses. + + - `String = String` + + A text input to the model, equivalent to a text input with the + `developer` role. + + - `InputItemList = Array[ResponseInputItem]` + + A list of one or many input items to the model, containing + different content types. + + - `class EasyInputMessage` + + 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. + + - `content: String | ResponseInputMessageContentList` + + Text, image, or audio input to the model, used to generate a response. + Can also contain previous assistant responses. + + - `String = String` + + A text input to the model. + + - `ResponseInputMessageContentList = Array[ResponseInputContent]` + + A list of one or many input items to the model, containing different content + types. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `role: :user | :assistant | :system | :developer` + + The role of the message input. One of `user`, `assistant`, `system`, or + `developer`. + + - `:user` + + - `:assistant` + + - `:system` + + - `:developer` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `type: :message` + + The type of the message input. Always `message`. + + - `:message` + + - `class Message` + + 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. + + - `content: ResponseInputMessageContentList` + + A list of one or many input items to the model, containing different content + types. + + - `role: :user | :system | :developer` + + The role of the message input. One of `user`, `system`, or `developer`. + + - `:user` + + - `:system` + + - `:developer` + + - `status: :in_progress | :completed | :incomplete` + + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the message input. Always set to `message`. + + - `:message` + + - `class ResponseOutputMessage` + + An output message from the model. + + - `id: String` + + The unique ID of the output message. + + - `content: Array[ResponseOutputText | ResponseOutputRefusal]` + + The content of the output message. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `role: :assistant` + + The role of the output message. Always `assistant`. + + - `:assistant` + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the output message. Always `message`. + + - `:message` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `class ResponseFileSearchToolCall` + + 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. + + - `id: String` + + The unique ID of the file search tool call. + + - `queries: Array[String]` + + The queries used to search for files. + + - `status: :in_progress | :searching | :completed | 2 more` + + The status of the file search tool call. One of `in_progress`, + `searching`, `incomplete` or `failed`, + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `type: :file_search_call` + + The type of the file search tool call. Always `file_search_call`. + + - `:file_search_call` + + - `results: Array[Result{ attributes, file_id, filename, 2 more}]` + + The results of the file search tool call. + + - `attributes: Hash[Symbol, String | Float | bool]` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. Keys are strings + with a maximum length of 64 characters. Values are strings with a maximum + length of 512 characters, booleans, or numbers. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `file_id: String` + + The unique ID of the file. + + - `filename: String` + + The name of the file. + + - `score: Float` + + The relevance score of the file - a value between 0 and 1. + + - `text: String` + + The text that was retrieved from the file. + + - `class ResponseComputerToolCall` + + 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. + + - `id: String` + + The unique ID of the computer call. + + - `call_id: String` + + An identifier used when responding to the tool call with output. + + - `pending_safety_checks: Array[PendingSafetyCheck{ id, code, message}]` + + The pending safety checks for the computer call. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :computer_call` + + The type of the computer call. Always `computer_call`. + + - `:computer_call` + + - `action: Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `actions: ComputerActionList` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `class ComputerCallOutput` + + The output of a computer tool call. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `id: String` + + The ID of the computer tool call output. + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionWebSearch` + + 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. + + - `id: String` + + The unique ID of the web search tool call. + + - `action: Search{ type, queries, query, sources} | OpenPage{ type, url} | FindInPage{ pattern, type, url}` + + An object describing the specific action taken in this web search call. + Includes details on how the model used the web (search, open_page, find_in_page). + + - `class Search` + + Action type "search" - Performs a web search query. + + - `type: :search` + + The action type. + + - `:search` + + - `queries: Array[String]` + + The search queries. + + - `query: String` + + The search query. + + - `sources: Array[Source{ type, url}]` + + The sources used in the search. + + - `type: :url` + + The type of source. Always `url`. + + - `:url` + + - `url: String` + + The URL of the source. + + - `class OpenPage` + + Action type "open_page" - Opens a specific URL from search results. + + - `type: :open_page` + + The action type. + + - `:open_page` + + - `url: String` + + The URL opened by the model. + + - `class FindInPage` + + Action type "find_in_page": Searches for a pattern within a loaded page. + + - `pattern: String` + + The pattern or text to search for within the page. + + - `type: :find_in_page` + + The action type. + + - `:find_in_page` + + - `url: String` + + The URL of the page searched for the pattern. + + - `status: :in_progress | :searching | :completed | :failed` + + The status of the web search tool call. + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:failed` + + - `type: :web_search_call` + + The type of the web search tool call. Always `web_search_call`. + + - `:web_search_call` + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `arguments: String` + + A JSON string of the arguments to pass to the function. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `name: String` + + The name of the function to run. + + - `type: :function_call` + + The type of the function tool call. Always `function_call`. + + - `:function_call` + + - `id: String` + + The unique ID of the function tool call. + + - `namespace: String` + + The namespace of the function to run. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class FunctionCallOutput` + + The output of a function tool call. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | ResponseFunctionCallOutputItemList` + + Text, image, or file output of the function tool call. + + - `String = String` + + A JSON string of the output of the function tool call. + + - `ResponseFunctionCallOutputItemList = Array[ResponseFunctionCallOutputItem]` + + An array of content outputs (text, image, file) for the function tool call. + + - `class ResponseInputTextContent` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImageContent` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision) + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFileContent` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The base64-encoded data of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `id: String` + + The unique ID of the function tool call output. Populated when this item is returned via API. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ToolSearchCall` + + - `arguments: untyped` + + The arguments supplied to the tool search call. + + - `type: :tool_search_call` + + The item type. Always `tool_search_call`. + + - `:tool_search_call` + + - `id: String` + + The unique ID of this tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseToolSearchOutputItemParam` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by the tool search output. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The item type. Always `tool_search_output`. + + - `:tool_search_output` + + - `id: String` + + The unique ID of this tool search output. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class AdditionalTools` + + - `role: :developer` + + The role that provided the additional tools. Only `developer` is supported. + + - `:developer` + + - `tools: Array[Tool]` + + A list of additional tools made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The item type. Always `additional_tools`. + + - `:additional_tools` + + - `id: String` + + The unique ID of this additional tools item. + + - `class ResponseReasoningItem` + + 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). + + - `id: String` + + The unique identifier of the reasoning content. + + - `summary: Array[Summary{ text, type}]` + + Reasoning summary content. + + - `text: String` + + A summary of the reasoning output from the model so far. + + - `type: :summary_text` + + The type of the object. Always `summary_text`. + + - `:summary_text` + + - `type: :reasoning` + + The type of the object. Always `reasoning`. + + - `:reasoning` + + - `content: Array[Content{ text, type}]` + + Reasoning text content. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `encrypted_content: String` + + The encrypted content of the reasoning item - populated when a response is + generated with `reasoning.encrypted_content` in the `include` parameter. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseCompactionItemParam` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `encrypted_content: String` + + The encrypted content of the compaction summary. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `id: String` + + The ID of the compaction item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `id: String` + + The unique ID of the code interpreter tool call. + + - `code: String` + + The code to run, or null if not available. + + - `container_id: String` + + The ID of the container used to run the code. + + - `outputs: Array[Logs{ logs, type} | Image{ type, url}]` + + The outputs generated by the code interpreter, such as logs or images. + Can be null if no outputs are available. + + - `class Logs` + + The logs output from the code interpreter. + + - `logs: String` + + The logs output from the code interpreter. + + - `type: :logs` + + The type of the output. Always `logs`. + + - `:logs` + + - `class Image` + + The image output from the code interpreter. + + - `type: :image` + + The type of the output. Always `image`. + + - `:image` + + - `url: String` + + The URL of the image output from the code interpreter. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:interpreting` + + - `:failed` + + - `type: :code_interpreter_call` + + The type of the code interpreter tool call. Always `code_interpreter_call`. + + - `:code_interpreter_call` + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCall` + + A tool representing a request to execute one or more shell commands. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + Ordered shell commands for the execution environment to run. + + - `max_output_length: Integer` + + Maximum number of UTF-8 characters to capture from combined stdout and stderr output. + + - `timeout_ms: Integer` + + Maximum wall-clock time in milliseconds to allow the shell commands to run. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `environment: LocalEnvironment | ContainerReference` + + The environment to execute the shell commands in. + + - `class LocalEnvironment` + + - `class ContainerReference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCallOutput` + + The streamed output items emitted by a shell tool call. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `output: Array[ResponseFunctionShellCallOutputContent]` + + Captured chunks of stdout and stderr output, along with their associated outcomes. + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + The exit or timeout outcome associated with this shell call. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + The exit code returned by the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + Captured stderr output for the shell call. + + - `stdout: String` + + Captured stdout output for the shell call. + + - `type: :shell_call_output` + + The type of the item. Always `shell_call_output`. + + - `:shell_call_output` + + - `id: String` + + The unique ID of the shell tool call output. Populated when this item is returned via API. + + - `max_output_length: Integer` + + The maximum number of UTF-8 characters captured for this shell call's combined output. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ApplyPatchCall` + + A tool call representing a request to create, delete, or update files using diff patches. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + The specific create, delete, or update instruction for the apply_patch tool call. + + - `class CreateFile` + + Instruction for creating a new file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply when creating the file. + + - `path: String` + + Path of the file to create relative to the workspace root. + + - `type: :create_file` + + The operation type. Always `create_file`. + + - `:create_file` + + - `class DeleteFile` + + Instruction for deleting an existing file via the apply_patch tool. + + - `path: String` + + Path of the file to delete relative to the workspace root. + + - `type: :delete_file` + + The operation type. Always `delete_file`. + + - `:delete_file` + + - `class UpdateFile` + + Instruction for updating an existing file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply to the existing file. + + - `path: String` + + Path of the file to update relative to the workspace root. + + - `type: :update_file` + + The operation type. Always `update_file`. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `class ApplyPatchCallOutput` + + The streamed output emitted by an apply patch tool call. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `output: String` + + Optional human-readable log text from the apply patch tool (e.g., patch results or errors). + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `id: String` + + The unique ID of the approval response + + - `reason: String` + + Optional reason for the decision. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class ResponseCustomToolCallOutput` + + The output of a custom tool call from your code, being sent back to the model. + + - `call_id: String` + + The call ID, used to map this custom tool call output to a custom tool call. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the custom tool call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the custom tool call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :custom_tool_call_output` + + The type of the custom tool call output. Always `custom_tool_call_output`. + + - `:custom_tool_call_output` + + - `id: String` + + The unique ID of the custom tool call output in the OpenAI platform. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `call_id: String` + + An identifier used to map this custom tool call to a tool call output. + + - `input: String` + + The input for the custom tool call generated by the model. + + - `name: String` + + The name of the custom tool being called. + + - `type: :custom_tool_call` + + The type of the custom tool call. Always `custom_tool_call`. + + - `:custom_tool_call` + + - `id: String` + + The unique ID of the custom tool call in the OpenAI platform. + + - `namespace: String` + + The namespace of the custom tool being called. + + - `class CompactionTrigger` + + Compacts the current context. Must be the final input item. + + - `type: :compaction_trigger` + + The type of the item. Always `compaction_trigger`. + + - `:compaction_trigger` + + - `class ItemReference` + + An internal identifier for an item to reference. + + - `id: String` + + The ID of the item to reference. + + - `type: :item_reference` + + The type of item to reference. Always `item_reference`. + + - `:item_reference` + + - `metadata: Metadata` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. + + Keys are strings with a maximum length of 64 characters. Values are strings + with a maximum length of 512 characters. + + - `model: ResponsesModel` + + Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI + offers a wide range of models with different capabilities, performance + characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) + to browse and compare available models. + + - `String = String` + + - `ChatModel = :"gpt-5.4" | :"gpt-5.4-mini" | :"gpt-5.4-nano" | 75 more` + + - `:"gpt-5.4"` + + - `:"gpt-5.4-mini"` + + - `:"gpt-5.4-nano"` + + - `:"gpt-5.4-mini-2026-03-17"` + + - `:"gpt-5.4-nano-2026-03-17"` + + - `:"gpt-5.3-chat-latest"` + + - `:"gpt-5.2"` + + - `:"gpt-5.2-2025-12-11"` + + - `:"gpt-5.2-chat-latest"` + + - `:"gpt-5.2-pro"` + + - `:"gpt-5.2-pro-2025-12-11"` + + - `:"gpt-5.1"` + + - `:"gpt-5.1-2025-11-13"` + + - `:"gpt-5.1-codex"` + + - `:"gpt-5.1-mini"` + + - `:"gpt-5.1-chat-latest"` + + - `:"gpt-5"` + + - `:"gpt-5-mini"` + + - `:"gpt-5-nano"` + + - `:"gpt-5-2025-08-07"` + + - `:"gpt-5-mini-2025-08-07"` + + - `:"gpt-5-nano-2025-08-07"` + + - `:"gpt-5-chat-latest"` + + - `:"gpt-4.1"` + + - `:"gpt-4.1-mini"` + + - `:"gpt-4.1-nano"` + + - `:"gpt-4.1-2025-04-14"` + + - `:"gpt-4.1-mini-2025-04-14"` + + - `:"gpt-4.1-nano-2025-04-14"` + + - `:"o4-mini"` + + - `:"o4-mini-2025-04-16"` + + - `:o3` + + - `:"o3-2025-04-16"` + + - `:"o3-mini"` + + - `:"o3-mini-2025-01-31"` + + - `:o1` + + - `:"o1-2024-12-17"` + + - `:"o1-preview"` + + - `:"o1-preview-2024-09-12"` + + - `:"o1-mini"` + + - `:"o1-mini-2024-09-12"` + + - `:"gpt-4o"` + + - `:"gpt-4o-2024-11-20"` + + - `:"gpt-4o-2024-08-06"` + + - `:"gpt-4o-2024-05-13"` + + - `:"gpt-4o-audio-preview"` + + - `:"gpt-4o-audio-preview-2024-10-01"` + + - `:"gpt-4o-audio-preview-2024-12-17"` + + - `:"gpt-4o-audio-preview-2025-06-03"` + + - `:"gpt-4o-mini-audio-preview"` + + - `:"gpt-4o-mini-audio-preview-2024-12-17"` + + - `:"gpt-4o-search-preview"` + + - `:"gpt-4o-mini-search-preview"` + + - `:"gpt-4o-search-preview-2025-03-11"` + + - `:"gpt-4o-mini-search-preview-2025-03-11"` + + - `:"chatgpt-4o-latest"` + + - `:"codex-mini-latest"` + + - `:"gpt-4o-mini"` + + - `:"gpt-4o-mini-2024-07-18"` + + - `:"gpt-4-turbo"` + + - `:"gpt-4-turbo-2024-04-09"` + + - `:"gpt-4-0125-preview"` + + - `:"gpt-4-turbo-preview"` + + - `:"gpt-4-1106-preview"` + + - `:"gpt-4-vision-preview"` + + - `:"gpt-4"` + + - `:"gpt-4-0314"` + + - `:"gpt-4-0613"` + + - `:"gpt-4-32k"` + + - `:"gpt-4-32k-0314"` + + - `:"gpt-4-32k-0613"` + + - `:"gpt-3.5-turbo"` + + - `:"gpt-3.5-turbo-16k"` + + - `:"gpt-3.5-turbo-0301"` + + - `:"gpt-3.5-turbo-0613"` + + - `:"gpt-3.5-turbo-1106"` + + - `:"gpt-3.5-turbo-0125"` + + - `:"gpt-3.5-turbo-16k-0613"` + + - `ResponsesOnlyModel = :"o1-pro" | :"o1-pro-2025-03-19" | :"o3-pro" | 11 more` + + - `:"o1-pro"` + + - `:"o1-pro-2025-03-19"` + + - `:"o3-pro"` + + - `:"o3-pro-2025-06-10"` + + - `:"o3-deep-research"` + + - `:"o3-deep-research-2025-06-26"` + + - `:"o4-mini-deep-research"` + + - `:"o4-mini-deep-research-2025-06-26"` + + - `:"computer-use-preview"` + + - `:"computer-use-preview-2025-03-11"` + + - `:"gpt-5-codex"` + + - `:"gpt-5-pro"` + + - `:"gpt-5-pro-2025-10-06"` + + - `:"gpt-5.1-codex-max"` + + - `object: :response` + + The object type of this resource - always set to `response`. + + - `:response` + + - `output: Array[ResponseOutputItem]` + + An array of content items generated by the model. + + - The length and order of items in the `output` array is dependent + on the model's response. + - Rather than accessing the first item in the `output` array and + assuming it's an `assistant` message with the content generated by + the model, you might consider using the `output_text` property where + supported in SDKs. + + - `class ResponseOutputMessage` + + An output message from the model. + + - `class ResponseFileSearchToolCall` + + 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. + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `class ResponseFunctionToolCallOutputItem` + + - `id: String` + + The unique ID of the function call tool output. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the function call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the function call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the function call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseFunctionWebSearch` + + 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. + + - `class ResponseComputerToolCall` + + 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. + + - `class ResponseComputerToolCallOutputItem` + + - `id: String` + + The unique ID of the computer call tool output. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `status: :completed | :incomplete | :failed | :in_progress` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `:in_progress` + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the + developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseReasoningItem` + + 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). + + - `class ResponseToolSearchCall` + + - `id: String` + + The unique ID of the tool search call item. + + - `arguments: untyped` + + Arguments used for the tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :tool_search_call` + + The type of the item. Always `tool_search_call`. + + - `:tool_search_call` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseToolSearchOutputItem` + + - `id: String` + + The unique ID of the tool search output item. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by tool search. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :tool_search_output` + + The type of the item. Always `tool_search_output`. + + - `:tool_search_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class AdditionalTools` + + - `id: String` + + The unique ID of the additional tools item. + + - `role: :unknown | :user | :assistant | 5 more` + + The role that provided the additional tools. + + - `:unknown` + + - `:user` + + - `:assistant` + + - `:system` + + - `:critic` + + - `:discriminator` + + - `:developer` + + - `:tool` + + - `tools: Array[Tool]` + + The additional tool definitions made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The type of the item. Always `additional_tools`. + + - `:additional_tools` + + - `class ResponseCompactionItem` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `id: String` + + The unique ID of the compaction item. + + - `encrypted_content: String` + + The encrypted content that was produced by compaction. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionShellToolCall` + + A tool call that executes one or more shell commands in a managed environment. + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + - `max_output_length: Integer` + + Optional maximum number of characters to return from each command. + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the commands. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `environment: ResponseLocalEnvironment | ResponseContainerReference` + + Represents the use of a local environment to perform shell actions. + + - `class ResponseLocalEnvironment` + + Represents the use of a local environment to perform shell actions. + + - `type: :local` + + The environment type. Always `local`. + + - `:local` + + - `class ResponseContainerReference` + + Represents a container created with /v1/containers. + + - `container_id: String` + + - `type: :container_reference` + + The environment type. Always `container_reference`. + + - `:container_reference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseFunctionShellToolCallOutput` + + The output of a shell tool call that was emitted. + + - `id: String` + + The unique ID of the shell call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `max_output_length: Integer` + + The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output. + + - `output: Array[Output{ outcome, stderr, stdout, created_by}]` + + An array of shell call output contents + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + Exit code from the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + The standard error output that was captured. + + - `stdout: String` + + The standard output that was captured. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call_output` + + The type of the shell call output. Always `shell_call_output`. + + - `:shell_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseApplyPatchToolCall` + + A tool call that applies file diffs by creating, deleting, or updating files. + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + One of the create_file, delete_file, or update_file operations applied via apply_patch. + + - `class CreateFile` + + Instruction describing how to create a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to create. + + - `type: :create_file` + + Create a new file with the provided diff. + + - `:create_file` + + - `class DeleteFile` + + Instruction describing how to delete a file via the apply_patch tool. + + - `path: String` + + Path of the file to delete. + + - `type: :delete_file` + + Delete the specified file. + + - `:delete_file` + + - `class UpdateFile` + + Instruction describing how to update a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to update. + + - `type: :update_file` + + Update an existing file with the provided diff. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseApplyPatchToolCallOutput` + + The output emitted by an apply patch tool call. + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `created_by: String` + + The ID of the entity that created this tool call output. + + - `output: String` + + Optional textual output returned by the apply patch tool. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `id: String` + + The unique ID of the approval response + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `reason: String` + + Optional reason for the decision. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `class ResponseCustomToolCallOutputItem` + + The output of a custom tool call from your code, being sent back to the model. + + - `id: String` + + The unique ID of the custom tool call output item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `parallel_tool_calls: bool` + + Whether to allow the model to run tool calls in parallel. + + - `temperature: Float` + + 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. + + - `tool_choice: ToolChoiceOptions | ToolChoiceAllowed | ToolChoiceTypes | 5 more` + + How the model should select which tool (or tools) to use when generating + a response. See the `tools` parameter to see how to specify which tools + the model can call. + + - `ToolChoiceOptions = :none | :auto | :required` + + Controls which (if any) tool is called by the model. + + `none` means the model will not call any tool and instead generates a message. + + `auto` means the model can pick between generating a message or calling one or + more tools. + + `required` means the model must call one or more tools. + + - `:none` + + - `:auto` + + - `:required` + + - `class ToolChoiceAllowed` + + Constrains the tools available to the model to a pre-defined set. + + - `mode: :auto | :required` + + Constrains the tools available to the model to a pre-defined set. + + `auto` allows the model to pick from among the allowed tools and generate a + message. + + `required` requires the model to call one or more of the allowed tools. + + - `:auto` + + - `:required` + + - `tools: Array[Hash[Symbol, untyped]]` + + A list of tool definitions that the model should be allowed to call. + + For the Responses API, the list of tool definitions might look like: + + ```json + [ + { "type": "function", "name": "get_weather" }, + { "type": "mcp", "server_label": "deepwiki" }, + { "type": "image_generation" } + ] + ``` + + - `type: :allowed_tools` + + Allowed tool configuration type. Always `allowed_tools`. + + - `:allowed_tools` + + - `class ToolChoiceTypes` + + 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). + + - `type: :file_search | :web_search_preview | :computer | 5 more` + + The type of hosted tool the model should to use. Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + + Allowed values are: + + - `file_search` + - `web_search_preview` + - `computer` + - `computer_use_preview` + - `computer_use` + - `code_interpreter` + - `image_generation` + + - `:file_search` + + - `:web_search_preview` + + - `:computer` + + - `:computer_use_preview` + + - `:computer_use` + + - `:web_search_preview_2025_03_11` + + - `:image_generation` + + - `:code_interpreter` + + - `class ToolChoiceFunction` + + Use this option to force the model to call a specific function. + + - `name: String` + + The name of the function to call. + + - `type: :function` + + For function calling, the type is always `function`. + + - `:function` + + - `class ToolChoiceMcp` + + Use this option to force the model to call a specific tool on a remote MCP server. + + - `server_label: String` + + The label of the MCP server to use. + + - `type: :mcp` + + For MCP tools, the type is always `mcp`. + + - `:mcp` + + - `name: String` + + The name of the tool to call on the server. + + - `class ToolChoiceCustom` + + Use this option to force the model to call a specific custom tool. + + - `name: String` + + The name of the custom tool to call. + + - `type: :custom` + + For custom tool calling, the type is always `custom`. + + - `:custom` + + - `class ToolChoiceApplyPatch` + + Forces the model to call the apply_patch tool when executing a tool call. + + - `type: :apply_patch` + + The tool to call. Always `apply_patch`. + + - `:apply_patch` + + - `class ToolChoiceShell` + + Forces the model to call the shell tool when a tool call is required. + + - `type: :shell` + + The tool to call. Always `shell`. + + - `:shell` + + - `tools: Array[Tool]` + + An array of tools the model may call while generating a response. You + can specify which tool to use by setting the `tool_choice` parameter. + + We support the following categories of tools: + + - **Built-in tools**: Tools that are provided by OpenAI that extend the + model's capabilities, like [web search](https://platform.openai.com/docs/guides/tools-web-search) + or [file search](https://platform.openai.com/docs/guides/tools-file-search). Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + - **MCP Tools**: Integrations with third-party systems via custom MCP servers + or predefined connectors such as Google Drive and SharePoint. Learn more about + [MCP Tools](https://platform.openai.com/docs/guides/tools-connectors-mcp). + - **Function calls (custom tools)**: Functions that are defined by you, + enabling the model to call your own code with strongly typed arguments + and outputs. Learn more about + [function calling](https://platform.openai.com/docs/guides/function-calling). You can also use + custom tools to call your own code. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `top_p: Float` + + 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. + + - `background: bool` + + Whether to run the model response in the background. + [Learn more](https://platform.openai.com/docs/guides/background). + + - `completed_at: Float` + + Unix timestamp (in seconds) of when this Response was completed. + Only present when the status is `completed`. + + - `conversation: Conversation{ id}` + + The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation. + + - `id: String` + + The unique ID of the conversation that this response was associated with. + + - `max_output_tokens: Integer` + + An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://platform.openai.com/docs/guides/reasoning). + + - `max_tool_calls: Integer` + + 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. + + - `moderation: Moderation{ input, output}` + + Moderation results for the response input and output, if moderated completions were requested. + + - `input: ModerationResult{ categories, category_applied_input_types, category_scores, 3 more} | Error{ code, message, type}` + + Moderation for the response input. + + - `class ModerationResult` + + A moderation result produced for the response input or output. + + - `categories: Hash[Symbol, bool]` + + A dictionary of moderation categories to booleans, True if the input is flagged under this category. + + - `category_applied_input_types: Hash[Symbol, Array[:text | :image]]` + + Which modalities of input are reflected by the score for each category. + + - `:text` + + - `:image` + + - `category_scores: Hash[Symbol, Float]` + + A dictionary of moderation categories to scores. + + - `flagged: bool` + + A boolean indicating whether the content was flagged by any category. + + - `model: String` + + The moderation model that produced this result. + + - `type: :moderation_result` + + The object type, which was always `moderation_result` for successful moderation results. + + - `:moderation_result` + + - `class Error` + + An error produced while attempting moderation for the response input or output. + + - `code: String` + + The error code. + + - `message: String` + + The error message. + + - `type: :error` + + The object type, which was always `error` for moderation failures. + + - `:error` + + - `output: ModerationResult{ categories, category_applied_input_types, category_scores, 3 more} | Error{ code, message, type}` + + Moderation for the response output. + + - `class ModerationResult` + + A moderation result produced for the response input or output. + + - `categories: Hash[Symbol, bool]` + + A dictionary of moderation categories to booleans, True if the input is flagged under this category. + + - `category_applied_input_types: Hash[Symbol, Array[:text | :image]]` + + Which modalities of input are reflected by the score for each category. + + - `:text` + + - `:image` + + - `category_scores: Hash[Symbol, Float]` + + A dictionary of moderation categories to scores. + + - `flagged: bool` + + A boolean indicating whether the content was flagged by any category. + + - `model: String` + + The moderation model that produced this result. + + - `type: :moderation_result` + + The object type, which was always `moderation_result` for successful moderation results. + + - `:moderation_result` + + - `class Error` + + An error produced while attempting moderation for the response input or output. + + - `code: String` + + The error code. + + - `message: String` + + The error message. + + - `type: :error` + + The object type, which was always `error` for moderation failures. + + - `:error` + + - `previous_response_id: String` + + The unique ID of the previous response to the model. Use this to + create multi-turn conversations. Learn more about + [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. + + - `prompt: ResponsePrompt` + + Reference to a prompt template and its variables. + [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts). + + - `id: String` + + The unique identifier of the prompt template to use. + + - `variables: Hash[Symbol, String | ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Optional map of values to substitute in for variables in your + prompt. The substitution values can either be strings, or other + Response input types like images or files. + + - `String = String` + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `version: String` + + Optional version of the prompt template. + + - `prompt_cache_key: String` + + Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://platform.openai.com/docs/guides/prompt-caching). + + - `prompt_cache_retention: :in_memory | :"24h"` + + The retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention). + For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported. + + For older models that support both `in_memory` and `24h`, the default depends on your organization's data retention policy: + + - Organizations without ZDR enabled default to `24h`. + - Organizations with ZDR enabled default to `in_memory` when `prompt_cache_retention` is not specified. + + - `:in_memory` + + - `:"24h"` + + - `reasoning: Reasoning` + + **gpt-5 and o-series models only** + + Configuration options for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + + - `effort: ReasoningEffort` + + Constrains effort on reasoning for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing + reasoning effort can result in faster responses and fewer tokens used + on reasoning in a response. + + - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1. + - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. + - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. + - `xhigh` is supported for all models after `gpt-5.1-codex-max`. + + - `:none` + + - `:minimal` + + - `:low` + + - `:medium` + + - `:high` + + - `:xhigh` + + - `generate_summary: :auto | :concise | :detailed` + + **Deprecated:** use `summary` instead. + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `summary: :auto | :concise | :detailed` + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + `concise` is supported for `computer-use-preview` models and all reasoning models after `gpt-5`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `safety_identifier: String` + + A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + + - `service_tier: :auto | :default | :flex | 2 more` + + Specifies the processing type used for serving the request. + + - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. + - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. + - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier. + - When not set, the default behavior is 'auto'. + + When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter. + + - `:auto` + + - `:default` + + - `:flex` + + - `:scale` + + - `:priority` + + - `status: ResponseStatus` + + The status of the response generation. One of `completed`, `failed`, + `in_progress`, `cancelled`, `queued`, or `incomplete`. + + - `:completed` + + - `:failed` + + - `:in_progress` + + - `:cancelled` + + - `:queued` + + - `:incomplete` + + - `text: ResponseTextConfig` + + 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) + + - `format_: ResponseFormatTextConfig` + + An object specifying the format that the model must output. + + Configuring `{ "type": "json_schema" }` enables Structured Outputs, + which ensures the model will match your supplied JSON schema. Learn more in the + [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). + + The default format is `{ "type": "text" }` with no additional options. + + **Not recommended for gpt-4o and newer models:** + + Setting to `{ "type": "json_object" }` enables the older JSON mode, which + ensures the message the model generates is valid JSON. Using `json_schema` + is preferred for models that support it. + + - `class ResponseFormatText` + + Default response format. Used to generate text responses. + + - `type: :text` + + The type of response format being defined. Always `text`. + + - `:text` + + - `class ResponseFormatTextJSONSchemaConfig` + + JSON Schema response format. Used to generate structured JSON responses. + Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). + + - `name: String` + + The name of the response format. Must be a-z, A-Z, 0-9, or contain + underscores and dashes, with a maximum length of 64. + + - `schema: Hash[Symbol, untyped]` + + The schema for the response format, described as a JSON Schema object. + Learn how to build JSON schemas [here](https://json-schema.org/). + + - `type: :json_schema` + + The type of response format being defined. Always `json_schema`. + + - `:json_schema` + + - `description: String` + + A description of what the response format is for, used by the model to + determine how to respond in the format. + + - `strict: bool` + + Whether to enable strict schema adherence when generating the output. + If set to true, the model will always follow the exact schema defined + in the `schema` field. Only a subset of JSON Schema is supported when + `strict` is `true`. To learn more, read the [Structured Outputs + guide](https://platform.openai.com/docs/guides/structured-outputs). + + - `class ResponseFormatJSONObject` + + 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. + + - `type: :json_object` + + The type of response format being defined. Always `json_object`. + + - `:json_object` + + - `verbosity: :low | :medium | :high` + + Constrains the verbosity of the model's response. Lower values will result in + more concise responses, while higher values will result in more verbose responses. + Currently supported values are `low`, `medium`, and `high`. + + - `:low` + + - `:medium` + + - `:high` + + - `top_logprobs: Integer` + + An integer between 0 and 20 specifying the maximum number of most likely + tokens to return at each token position, each with an associated log + probability. In some cases, the number of returned tokens may be fewer than + requested. + + - `truncation: :auto | :disabled` + + The truncation strategy to use for the model response. + + - `auto`: If the input to this Response exceeds + the model's context window size, the model will truncate the + response to fit the context window by dropping items from the beginning of the conversation. + - `disabled` (default): If the input size will exceed the context window + size for a model, the request will fail with a 400 error. + + - `:auto` + + - `:disabled` + + - `usage: ResponseUsage` + + Represents token usage details including input tokens, output tokens, + a breakdown of output tokens, and the total tokens used. + + - `input_tokens: Integer` + + The number of input tokens. + + - `input_tokens_details: InputTokensDetails{ cached_tokens}` + + A detailed breakdown of the input tokens. + + - `cached_tokens: Integer` + + The number of tokens that were retrieved from the cache. + [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching). + + - `output_tokens: Integer` + + The number of output tokens. + + - `output_tokens_details: OutputTokensDetails{ reasoning_tokens}` + + A detailed breakdown of the output tokens. + + - `reasoning_tokens: Integer` + + The number of reasoning tokens. + + - `total_tokens: Integer` + + The total number of tokens used. + + - `user: String` + + This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. + A stable identifier for your end-users. + Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + + - `sequence_number: Integer` + + The sequence number for this event. + + - `type: :"response.created"` + + The type of the event. Always `response.created`. + + - `:"response.created"` + +### Response Custom Tool Call + +- `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `call_id: String` + + An identifier used to map this custom tool call to a tool call output. + + - `input: String` + + The input for the custom tool call generated by the model. + + - `name: String` + + The name of the custom tool being called. + + - `type: :custom_tool_call` + + The type of the custom tool call. Always `custom_tool_call`. + + - `:custom_tool_call` + + - `id: String` + + The unique ID of the custom tool call in the OpenAI platform. + + - `namespace: String` + + The namespace of the custom tool being called. + +### Response Custom Tool Call Input Delta Event + +- `class ResponseCustomToolCallInputDeltaEvent` + + Event representing a delta (partial update) to the input of a custom tool call. + + - `delta: String` + + The incremental input data (delta) for the custom tool call. + + - `item_id: String` + + Unique identifier for the API item associated with this event. + + - `output_index: Integer` + + The index of the output this delta applies to. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.custom_tool_call_input.delta"` + + The event type identifier. + + - `:"response.custom_tool_call_input.delta"` + +### Response Custom Tool Call Input Done Event + +- `class ResponseCustomToolCallInputDoneEvent` + + Event indicating that input for a custom tool call is complete. + + - `input: String` + + The complete input data for the custom tool call. + + - `item_id: String` + + Unique identifier for the API item associated with this event. + + - `output_index: Integer` + + The index of the output this event applies to. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.custom_tool_call_input.done"` + + The event type identifier. + + - `:"response.custom_tool_call_input.done"` + +### Response Custom Tool Call Item + +- `class ResponseCustomToolCallItem` + + A call to a custom tool created by the model. + + - `id: String` + + The unique ID of the custom tool call item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + +### Response Custom Tool Call Output + +- `class ResponseCustomToolCallOutput` + + The output of a custom tool call from your code, being sent back to the model. + + - `call_id: String` + + The call ID, used to map this custom tool call output to a custom tool call. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the custom tool call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the custom tool call. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `type: :custom_tool_call_output` + + The type of the custom tool call output. Always `custom_tool_call_output`. + + - `:custom_tool_call_output` + + - `id: String` + + The unique ID of the custom tool call output in the OpenAI platform. + +### Response Custom Tool Call Output Item + +- `class ResponseCustomToolCallOutputItem` + + The output of a custom tool call from your code, being sent back to the model. + + - `id: String` + + The unique ID of the custom tool call output item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + +### Response Error + +- `class ResponseError` + + An error object returned when the model fails to generate a Response. + + - `code: :server_error | :rate_limit_exceeded | :invalid_prompt | 15 more` + + The error code for the response. + + - `: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` + + - `message: String` + + A human-readable description of the error. + +### Response Error Event + +- `class ResponseErrorEvent` + + Emitted when an error occurs. + + - `code: String` + + The error code. + + - `message: String` + + The error message. + + - `param: String` + + The error parameter. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :error` + + The type of the event. Always `error`. + + - `:error` + +### Response Failed Event + +- `class ResponseFailedEvent` + + An event that is emitted when a response fails. + + - `response: Response` + + The response that failed. + + - `id: String` + + Unique identifier for this Response. + + - `created_at: Float` + + Unix timestamp (in seconds) of when this Response was created. + + - `error: ResponseError` + + An error object returned when the model fails to generate a Response. + + - `code: :server_error | :rate_limit_exceeded | :invalid_prompt | 15 more` + + The error code for the response. + + - `: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` + + - `message: String` + + A human-readable description of the error. + + - `incomplete_details: IncompleteDetails{ reason}` + + Details about why the response is incomplete. + + - `reason: :max_output_tokens | :content_filter` + + The reason why the response is incomplete. + + - `:max_output_tokens` + + - `:content_filter` + + - `instructions: String | Array[ResponseInputItem]` + + A system (or developer) message inserted into the model's context. + + When using along with `previous_response_id`, the instructions from a previous + response will not be carried over to the next response. This makes it simple + to swap out system (or developer) messages in new responses. + + - `String = String` + + A text input to the model, equivalent to a text input with the + `developer` role. + + - `InputItemList = Array[ResponseInputItem]` + + A list of one or many input items to the model, containing + different content types. + + - `class EasyInputMessage` + + 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. + + - `content: String | ResponseInputMessageContentList` + + Text, image, or audio input to the model, used to generate a response. + Can also contain previous assistant responses. + + - `String = String` + + A text input to the model. + + - `ResponseInputMessageContentList = Array[ResponseInputContent]` + + A list of one or many input items to the model, containing different content + types. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `role: :user | :assistant | :system | :developer` + + The role of the message input. One of `user`, `assistant`, `system`, or + `developer`. + + - `:user` + + - `:assistant` + + - `:system` + + - `:developer` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `type: :message` + + The type of the message input. Always `message`. + + - `:message` + + - `class Message` + + 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. + + - `content: ResponseInputMessageContentList` + + A list of one or many input items to the model, containing different content + types. + + - `role: :user | :system | :developer` + + The role of the message input. One of `user`, `system`, or `developer`. + + - `:user` + + - `:system` + + - `:developer` + + - `status: :in_progress | :completed | :incomplete` + + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the message input. Always set to `message`. + + - `:message` + + - `class ResponseOutputMessage` + + An output message from the model. + + - `id: String` + + The unique ID of the output message. + + - `content: Array[ResponseOutputText | ResponseOutputRefusal]` + + The content of the output message. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `role: :assistant` + + The role of the output message. Always `assistant`. + + - `:assistant` + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the output message. Always `message`. + + - `:message` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `class ResponseFileSearchToolCall` + + 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. + + - `id: String` + + The unique ID of the file search tool call. + + - `queries: Array[String]` + + The queries used to search for files. + + - `status: :in_progress | :searching | :completed | 2 more` + + The status of the file search tool call. One of `in_progress`, + `searching`, `incomplete` or `failed`, + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `type: :file_search_call` + + The type of the file search tool call. Always `file_search_call`. + + - `:file_search_call` + + - `results: Array[Result{ attributes, file_id, filename, 2 more}]` + + The results of the file search tool call. + + - `attributes: Hash[Symbol, String | Float | bool]` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. Keys are strings + with a maximum length of 64 characters. Values are strings with a maximum + length of 512 characters, booleans, or numbers. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `file_id: String` + + The unique ID of the file. + + - `filename: String` + + The name of the file. + + - `score: Float` + + The relevance score of the file - a value between 0 and 1. + + - `text: String` + + The text that was retrieved from the file. + + - `class ResponseComputerToolCall` + + 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. + + - `id: String` + + The unique ID of the computer call. + + - `call_id: String` + + An identifier used when responding to the tool call with output. + + - `pending_safety_checks: Array[PendingSafetyCheck{ id, code, message}]` + + The pending safety checks for the computer call. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :computer_call` + + The type of the computer call. Always `computer_call`. + + - `:computer_call` + + - `action: Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `actions: ComputerActionList` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `class ComputerCallOutput` + + The output of a computer tool call. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `id: String` + + The ID of the computer tool call output. + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionWebSearch` + + 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. + + - `id: String` + + The unique ID of the web search tool call. + + - `action: Search{ type, queries, query, sources} | OpenPage{ type, url} | FindInPage{ pattern, type, url}` + + An object describing the specific action taken in this web search call. + Includes details on how the model used the web (search, open_page, find_in_page). + + - `class Search` + + Action type "search" - Performs a web search query. + + - `type: :search` + + The action type. + + - `:search` + + - `queries: Array[String]` + + The search queries. + + - `query: String` + + The search query. + + - `sources: Array[Source{ type, url}]` + + The sources used in the search. + + - `type: :url` + + The type of source. Always `url`. + + - `:url` + + - `url: String` + + The URL of the source. + + - `class OpenPage` + + Action type "open_page" - Opens a specific URL from search results. + + - `type: :open_page` + + The action type. + + - `:open_page` + + - `url: String` + + The URL opened by the model. + + - `class FindInPage` + + Action type "find_in_page": Searches for a pattern within a loaded page. + + - `pattern: String` + + The pattern or text to search for within the page. + + - `type: :find_in_page` + + The action type. + + - `:find_in_page` + + - `url: String` + + The URL of the page searched for the pattern. + + - `status: :in_progress | :searching | :completed | :failed` + + The status of the web search tool call. + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:failed` + + - `type: :web_search_call` + + The type of the web search tool call. Always `web_search_call`. + + - `:web_search_call` + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `arguments: String` + + A JSON string of the arguments to pass to the function. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `name: String` + + The name of the function to run. + + - `type: :function_call` + + The type of the function tool call. Always `function_call`. + + - `:function_call` + + - `id: String` + + The unique ID of the function tool call. + + - `namespace: String` + + The namespace of the function to run. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class FunctionCallOutput` + + The output of a function tool call. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | ResponseFunctionCallOutputItemList` + + Text, image, or file output of the function tool call. + + - `String = String` + + A JSON string of the output of the function tool call. + + - `ResponseFunctionCallOutputItemList = Array[ResponseFunctionCallOutputItem]` + + An array of content outputs (text, image, file) for the function tool call. + + - `class ResponseInputTextContent` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImageContent` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision) + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFileContent` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The base64-encoded data of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `id: String` + + The unique ID of the function tool call output. Populated when this item is returned via API. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ToolSearchCall` + + - `arguments: untyped` + + The arguments supplied to the tool search call. + + - `type: :tool_search_call` + + The item type. Always `tool_search_call`. + + - `:tool_search_call` + + - `id: String` + + The unique ID of this tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseToolSearchOutputItemParam` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by the tool search output. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The item type. Always `tool_search_output`. + + - `:tool_search_output` + + - `id: String` + + The unique ID of this tool search output. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class AdditionalTools` + + - `role: :developer` + + The role that provided the additional tools. Only `developer` is supported. + + - `:developer` + + - `tools: Array[Tool]` + + A list of additional tools made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The item type. Always `additional_tools`. + + - `:additional_tools` + + - `id: String` + + The unique ID of this additional tools item. + + - `class ResponseReasoningItem` + + 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). + + - `id: String` + + The unique identifier of the reasoning content. + + - `summary: Array[Summary{ text, type}]` + + Reasoning summary content. + + - `text: String` + + A summary of the reasoning output from the model so far. + + - `type: :summary_text` + + The type of the object. Always `summary_text`. + + - `:summary_text` + + - `type: :reasoning` + + The type of the object. Always `reasoning`. + + - `:reasoning` + + - `content: Array[Content{ text, type}]` + + Reasoning text content. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `encrypted_content: String` + + The encrypted content of the reasoning item - populated when a response is + generated with `reasoning.encrypted_content` in the `include` parameter. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseCompactionItemParam` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `encrypted_content: String` + + The encrypted content of the compaction summary. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `id: String` + + The ID of the compaction item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `id: String` + + The unique ID of the code interpreter tool call. + + - `code: String` + + The code to run, or null if not available. + + - `container_id: String` + + The ID of the container used to run the code. + + - `outputs: Array[Logs{ logs, type} | Image{ type, url}]` + + The outputs generated by the code interpreter, such as logs or images. + Can be null if no outputs are available. + + - `class Logs` + + The logs output from the code interpreter. + + - `logs: String` + + The logs output from the code interpreter. + + - `type: :logs` + + The type of the output. Always `logs`. + + - `:logs` + + - `class Image` + + The image output from the code interpreter. + + - `type: :image` + + The type of the output. Always `image`. + + - `:image` + + - `url: String` + + The URL of the image output from the code interpreter. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:interpreting` + + - `:failed` + + - `type: :code_interpreter_call` + + The type of the code interpreter tool call. Always `code_interpreter_call`. + + - `:code_interpreter_call` + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCall` + + A tool representing a request to execute one or more shell commands. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + Ordered shell commands for the execution environment to run. + + - `max_output_length: Integer` + + Maximum number of UTF-8 characters to capture from combined stdout and stderr output. + + - `timeout_ms: Integer` + + Maximum wall-clock time in milliseconds to allow the shell commands to run. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `environment: LocalEnvironment | ContainerReference` + + The environment to execute the shell commands in. + + - `class LocalEnvironment` + + - `class ContainerReference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCallOutput` + + The streamed output items emitted by a shell tool call. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `output: Array[ResponseFunctionShellCallOutputContent]` + + Captured chunks of stdout and stderr output, along with their associated outcomes. + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + The exit or timeout outcome associated with this shell call. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + The exit code returned by the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + Captured stderr output for the shell call. + + - `stdout: String` + + Captured stdout output for the shell call. + + - `type: :shell_call_output` + + The type of the item. Always `shell_call_output`. + + - `:shell_call_output` + + - `id: String` + + The unique ID of the shell tool call output. Populated when this item is returned via API. + + - `max_output_length: Integer` + + The maximum number of UTF-8 characters captured for this shell call's combined output. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ApplyPatchCall` + + A tool call representing a request to create, delete, or update files using diff patches. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + The specific create, delete, or update instruction for the apply_patch tool call. + + - `class CreateFile` + + Instruction for creating a new file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply when creating the file. + + - `path: String` + + Path of the file to create relative to the workspace root. + + - `type: :create_file` + + The operation type. Always `create_file`. + + - `:create_file` + + - `class DeleteFile` + + Instruction for deleting an existing file via the apply_patch tool. + + - `path: String` + + Path of the file to delete relative to the workspace root. + + - `type: :delete_file` + + The operation type. Always `delete_file`. + + - `:delete_file` + + - `class UpdateFile` + + Instruction for updating an existing file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply to the existing file. + + - `path: String` + + Path of the file to update relative to the workspace root. + + - `type: :update_file` + + The operation type. Always `update_file`. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `class ApplyPatchCallOutput` + + The streamed output emitted by an apply patch tool call. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `output: String` + + Optional human-readable log text from the apply patch tool (e.g., patch results or errors). + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `id: String` + + The unique ID of the approval response + + - `reason: String` + + Optional reason for the decision. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class ResponseCustomToolCallOutput` + + The output of a custom tool call from your code, being sent back to the model. + + - `call_id: String` + + The call ID, used to map this custom tool call output to a custom tool call. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the custom tool call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the custom tool call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :custom_tool_call_output` + + The type of the custom tool call output. Always `custom_tool_call_output`. + + - `:custom_tool_call_output` + + - `id: String` + + The unique ID of the custom tool call output in the OpenAI platform. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `call_id: String` + + An identifier used to map this custom tool call to a tool call output. + + - `input: String` + + The input for the custom tool call generated by the model. + + - `name: String` + + The name of the custom tool being called. + + - `type: :custom_tool_call` + + The type of the custom tool call. Always `custom_tool_call`. + + - `:custom_tool_call` + + - `id: String` + + The unique ID of the custom tool call in the OpenAI platform. + + - `namespace: String` + + The namespace of the custom tool being called. + + - `class CompactionTrigger` + + Compacts the current context. Must be the final input item. + + - `type: :compaction_trigger` + + The type of the item. Always `compaction_trigger`. + + - `:compaction_trigger` + + - `class ItemReference` + + An internal identifier for an item to reference. + + - `id: String` + + The ID of the item to reference. + + - `type: :item_reference` + + The type of item to reference. Always `item_reference`. + + - `:item_reference` + + - `metadata: Metadata` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. + + Keys are strings with a maximum length of 64 characters. Values are strings + with a maximum length of 512 characters. + + - `model: ResponsesModel` + + Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI + offers a wide range of models with different capabilities, performance + characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) + to browse and compare available models. + + - `String = String` + + - `ChatModel = :"gpt-5.4" | :"gpt-5.4-mini" | :"gpt-5.4-nano" | 75 more` + + - `:"gpt-5.4"` + + - `:"gpt-5.4-mini"` + + - `:"gpt-5.4-nano"` + + - `:"gpt-5.4-mini-2026-03-17"` + + - `:"gpt-5.4-nano-2026-03-17"` + + - `:"gpt-5.3-chat-latest"` + + - `:"gpt-5.2"` + + - `:"gpt-5.2-2025-12-11"` + + - `:"gpt-5.2-chat-latest"` + + - `:"gpt-5.2-pro"` + + - `:"gpt-5.2-pro-2025-12-11"` + + - `:"gpt-5.1"` + + - `:"gpt-5.1-2025-11-13"` + + - `:"gpt-5.1-codex"` + + - `:"gpt-5.1-mini"` + + - `:"gpt-5.1-chat-latest"` + + - `:"gpt-5"` + + - `:"gpt-5-mini"` + + - `:"gpt-5-nano"` + + - `:"gpt-5-2025-08-07"` + + - `:"gpt-5-mini-2025-08-07"` + + - `:"gpt-5-nano-2025-08-07"` + + - `:"gpt-5-chat-latest"` + + - `:"gpt-4.1"` + + - `:"gpt-4.1-mini"` + + - `:"gpt-4.1-nano"` + + - `:"gpt-4.1-2025-04-14"` + + - `:"gpt-4.1-mini-2025-04-14"` + + - `:"gpt-4.1-nano-2025-04-14"` + + - `:"o4-mini"` + + - `:"o4-mini-2025-04-16"` + + - `:o3` + + - `:"o3-2025-04-16"` + + - `:"o3-mini"` + + - `:"o3-mini-2025-01-31"` + + - `:o1` + + - `:"o1-2024-12-17"` + + - `:"o1-preview"` + + - `:"o1-preview-2024-09-12"` + + - `:"o1-mini"` + + - `:"o1-mini-2024-09-12"` + + - `:"gpt-4o"` + + - `:"gpt-4o-2024-11-20"` + + - `:"gpt-4o-2024-08-06"` + + - `:"gpt-4o-2024-05-13"` + + - `:"gpt-4o-audio-preview"` + + - `:"gpt-4o-audio-preview-2024-10-01"` + + - `:"gpt-4o-audio-preview-2024-12-17"` + + - `:"gpt-4o-audio-preview-2025-06-03"` + + - `:"gpt-4o-mini-audio-preview"` + + - `:"gpt-4o-mini-audio-preview-2024-12-17"` + + - `:"gpt-4o-search-preview"` + + - `:"gpt-4o-mini-search-preview"` + + - `:"gpt-4o-search-preview-2025-03-11"` + + - `:"gpt-4o-mini-search-preview-2025-03-11"` + + - `:"chatgpt-4o-latest"` + + - `:"codex-mini-latest"` + + - `:"gpt-4o-mini"` + + - `:"gpt-4o-mini-2024-07-18"` + + - `:"gpt-4-turbo"` + + - `:"gpt-4-turbo-2024-04-09"` + + - `:"gpt-4-0125-preview"` + + - `:"gpt-4-turbo-preview"` + + - `:"gpt-4-1106-preview"` + + - `:"gpt-4-vision-preview"` + + - `:"gpt-4"` + + - `:"gpt-4-0314"` + + - `:"gpt-4-0613"` + + - `:"gpt-4-32k"` + + - `:"gpt-4-32k-0314"` + + - `:"gpt-4-32k-0613"` + + - `:"gpt-3.5-turbo"` + + - `:"gpt-3.5-turbo-16k"` + + - `:"gpt-3.5-turbo-0301"` + + - `:"gpt-3.5-turbo-0613"` + + - `:"gpt-3.5-turbo-1106"` + + - `:"gpt-3.5-turbo-0125"` + + - `:"gpt-3.5-turbo-16k-0613"` + + - `ResponsesOnlyModel = :"o1-pro" | :"o1-pro-2025-03-19" | :"o3-pro" | 11 more` + + - `:"o1-pro"` + + - `:"o1-pro-2025-03-19"` + + - `:"o3-pro"` + + - `:"o3-pro-2025-06-10"` + + - `:"o3-deep-research"` + + - `:"o3-deep-research-2025-06-26"` + + - `:"o4-mini-deep-research"` + + - `:"o4-mini-deep-research-2025-06-26"` + + - `:"computer-use-preview"` + + - `:"computer-use-preview-2025-03-11"` + + - `:"gpt-5-codex"` + + - `:"gpt-5-pro"` + + - `:"gpt-5-pro-2025-10-06"` + + - `:"gpt-5.1-codex-max"` + + - `object: :response` + + The object type of this resource - always set to `response`. + + - `:response` + + - `output: Array[ResponseOutputItem]` + + An array of content items generated by the model. + + - The length and order of items in the `output` array is dependent + on the model's response. + - Rather than accessing the first item in the `output` array and + assuming it's an `assistant` message with the content generated by + the model, you might consider using the `output_text` property where + supported in SDKs. + + - `class ResponseOutputMessage` + + An output message from the model. + + - `class ResponseFileSearchToolCall` + + 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. + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `class ResponseFunctionToolCallOutputItem` + + - `id: String` + + The unique ID of the function call tool output. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the function call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the function call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the function call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseFunctionWebSearch` + + 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. + + - `class ResponseComputerToolCall` + + 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. + + - `class ResponseComputerToolCallOutputItem` + + - `id: String` + + The unique ID of the computer call tool output. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `status: :completed | :incomplete | :failed | :in_progress` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `:in_progress` + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the + developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseReasoningItem` + + 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). + + - `class ResponseToolSearchCall` + + - `id: String` + + The unique ID of the tool search call item. + + - `arguments: untyped` + + Arguments used for the tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :tool_search_call` + + The type of the item. Always `tool_search_call`. + + - `:tool_search_call` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseToolSearchOutputItem` + + - `id: String` + + The unique ID of the tool search output item. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by tool search. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :tool_search_output` + + The type of the item. Always `tool_search_output`. + + - `:tool_search_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class AdditionalTools` + + - `id: String` + + The unique ID of the additional tools item. + + - `role: :unknown | :user | :assistant | 5 more` + + The role that provided the additional tools. + + - `:unknown` + + - `:user` + + - `:assistant` + + - `:system` + + - `:critic` + + - `:discriminator` + + - `:developer` + + - `:tool` + + - `tools: Array[Tool]` + + The additional tool definitions made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The type of the item. Always `additional_tools`. + + - `:additional_tools` + + - `class ResponseCompactionItem` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `id: String` + + The unique ID of the compaction item. + + - `encrypted_content: String` + + The encrypted content that was produced by compaction. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionShellToolCall` + + A tool call that executes one or more shell commands in a managed environment. + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + - `max_output_length: Integer` + + Optional maximum number of characters to return from each command. + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the commands. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `environment: ResponseLocalEnvironment | ResponseContainerReference` + + Represents the use of a local environment to perform shell actions. + + - `class ResponseLocalEnvironment` + + Represents the use of a local environment to perform shell actions. + + - `type: :local` + + The environment type. Always `local`. + + - `:local` + + - `class ResponseContainerReference` + + Represents a container created with /v1/containers. + + - `container_id: String` + + - `type: :container_reference` + + The environment type. Always `container_reference`. + + - `:container_reference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseFunctionShellToolCallOutput` + + The output of a shell tool call that was emitted. + + - `id: String` + + The unique ID of the shell call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `max_output_length: Integer` + + The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output. + + - `output: Array[Output{ outcome, stderr, stdout, created_by}]` + + An array of shell call output contents + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + Exit code from the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + The standard error output that was captured. + + - `stdout: String` + + The standard output that was captured. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call_output` + + The type of the shell call output. Always `shell_call_output`. + + - `:shell_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseApplyPatchToolCall` + + A tool call that applies file diffs by creating, deleting, or updating files. + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + One of the create_file, delete_file, or update_file operations applied via apply_patch. + + - `class CreateFile` + + Instruction describing how to create a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to create. + + - `type: :create_file` + + Create a new file with the provided diff. + + - `:create_file` + + - `class DeleteFile` + + Instruction describing how to delete a file via the apply_patch tool. + + - `path: String` + + Path of the file to delete. + + - `type: :delete_file` + + Delete the specified file. + + - `:delete_file` + + - `class UpdateFile` + + Instruction describing how to update a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to update. + + - `type: :update_file` + + Update an existing file with the provided diff. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseApplyPatchToolCallOutput` + + The output emitted by an apply patch tool call. + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `created_by: String` + + The ID of the entity that created this tool call output. + + - `output: String` + + Optional textual output returned by the apply patch tool. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `id: String` + + The unique ID of the approval response + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `reason: String` + + Optional reason for the decision. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `class ResponseCustomToolCallOutputItem` + + The output of a custom tool call from your code, being sent back to the model. + + - `id: String` + + The unique ID of the custom tool call output item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `parallel_tool_calls: bool` + + Whether to allow the model to run tool calls in parallel. + + - `temperature: Float` + + 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. + + - `tool_choice: ToolChoiceOptions | ToolChoiceAllowed | ToolChoiceTypes | 5 more` + + How the model should select which tool (or tools) to use when generating + a response. See the `tools` parameter to see how to specify which tools + the model can call. + + - `ToolChoiceOptions = :none | :auto | :required` + + Controls which (if any) tool is called by the model. + + `none` means the model will not call any tool and instead generates a message. + + `auto` means the model can pick between generating a message or calling one or + more tools. + + `required` means the model must call one or more tools. + + - `:none` + + - `:auto` + + - `:required` + + - `class ToolChoiceAllowed` + + Constrains the tools available to the model to a pre-defined set. + + - `mode: :auto | :required` + + Constrains the tools available to the model to a pre-defined set. + + `auto` allows the model to pick from among the allowed tools and generate a + message. + + `required` requires the model to call one or more of the allowed tools. + + - `:auto` + + - `:required` + + - `tools: Array[Hash[Symbol, untyped]]` + + A list of tool definitions that the model should be allowed to call. + + For the Responses API, the list of tool definitions might look like: + + ```json + [ + { "type": "function", "name": "get_weather" }, + { "type": "mcp", "server_label": "deepwiki" }, + { "type": "image_generation" } + ] + ``` + + - `type: :allowed_tools` + + Allowed tool configuration type. Always `allowed_tools`. + + - `:allowed_tools` + + - `class ToolChoiceTypes` + + 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). + + - `type: :file_search | :web_search_preview | :computer | 5 more` + + The type of hosted tool the model should to use. Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + + Allowed values are: + + - `file_search` + - `web_search_preview` + - `computer` + - `computer_use_preview` + - `computer_use` + - `code_interpreter` + - `image_generation` + + - `:file_search` + + - `:web_search_preview` + + - `:computer` + + - `:computer_use_preview` + + - `:computer_use` + + - `:web_search_preview_2025_03_11` + + - `:image_generation` + + - `:code_interpreter` + + - `class ToolChoiceFunction` + + Use this option to force the model to call a specific function. + + - `name: String` + + The name of the function to call. + + - `type: :function` + + For function calling, the type is always `function`. + + - `:function` + + - `class ToolChoiceMcp` + + Use this option to force the model to call a specific tool on a remote MCP server. + + - `server_label: String` + + The label of the MCP server to use. + + - `type: :mcp` + + For MCP tools, the type is always `mcp`. + + - `:mcp` + + - `name: String` + + The name of the tool to call on the server. + + - `class ToolChoiceCustom` + + Use this option to force the model to call a specific custom tool. + + - `name: String` + + The name of the custom tool to call. + + - `type: :custom` + + For custom tool calling, the type is always `custom`. + + - `:custom` + + - `class ToolChoiceApplyPatch` + + Forces the model to call the apply_patch tool when executing a tool call. + + - `type: :apply_patch` + + The tool to call. Always `apply_patch`. + + - `:apply_patch` + + - `class ToolChoiceShell` + + Forces the model to call the shell tool when a tool call is required. + + - `type: :shell` + + The tool to call. Always `shell`. + + - `:shell` + + - `tools: Array[Tool]` + + An array of tools the model may call while generating a response. You + can specify which tool to use by setting the `tool_choice` parameter. + + We support the following categories of tools: + + - **Built-in tools**: Tools that are provided by OpenAI that extend the + model's capabilities, like [web search](https://platform.openai.com/docs/guides/tools-web-search) + or [file search](https://platform.openai.com/docs/guides/tools-file-search). Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + - **MCP Tools**: Integrations with third-party systems via custom MCP servers + or predefined connectors such as Google Drive and SharePoint. Learn more about + [MCP Tools](https://platform.openai.com/docs/guides/tools-connectors-mcp). + - **Function calls (custom tools)**: Functions that are defined by you, + enabling the model to call your own code with strongly typed arguments + and outputs. Learn more about + [function calling](https://platform.openai.com/docs/guides/function-calling). You can also use + custom tools to call your own code. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `top_p: Float` + + 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. + + - `background: bool` + + Whether to run the model response in the background. + [Learn more](https://platform.openai.com/docs/guides/background). + + - `completed_at: Float` + + Unix timestamp (in seconds) of when this Response was completed. + Only present when the status is `completed`. + + - `conversation: Conversation{ id}` + + The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation. + + - `id: String` + + The unique ID of the conversation that this response was associated with. + + - `max_output_tokens: Integer` + + An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://platform.openai.com/docs/guides/reasoning). + + - `max_tool_calls: Integer` + + 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. + + - `moderation: Moderation{ input, output}` + + Moderation results for the response input and output, if moderated completions were requested. + + - `input: ModerationResult{ categories, category_applied_input_types, category_scores, 3 more} | Error{ code, message, type}` + + Moderation for the response input. + + - `class ModerationResult` + + A moderation result produced for the response input or output. + + - `categories: Hash[Symbol, bool]` + + A dictionary of moderation categories to booleans, True if the input is flagged under this category. + + - `category_applied_input_types: Hash[Symbol, Array[:text | :image]]` + + Which modalities of input are reflected by the score for each category. + + - `:text` + + - `:image` + + - `category_scores: Hash[Symbol, Float]` + + A dictionary of moderation categories to scores. + + - `flagged: bool` + + A boolean indicating whether the content was flagged by any category. + + - `model: String` + + The moderation model that produced this result. + + - `type: :moderation_result` + + The object type, which was always `moderation_result` for successful moderation results. + + - `:moderation_result` + + - `class Error` + + An error produced while attempting moderation for the response input or output. + + - `code: String` + + The error code. + + - `message: String` + + The error message. + + - `type: :error` + + The object type, which was always `error` for moderation failures. + + - `:error` + + - `output: ModerationResult{ categories, category_applied_input_types, category_scores, 3 more} | Error{ code, message, type}` + + Moderation for the response output. + + - `class ModerationResult` + + A moderation result produced for the response input or output. + + - `categories: Hash[Symbol, bool]` + + A dictionary of moderation categories to booleans, True if the input is flagged under this category. + + - `category_applied_input_types: Hash[Symbol, Array[:text | :image]]` + + Which modalities of input are reflected by the score for each category. + + - `:text` + + - `:image` + + - `category_scores: Hash[Symbol, Float]` + + A dictionary of moderation categories to scores. + + - `flagged: bool` + + A boolean indicating whether the content was flagged by any category. + + - `model: String` + + The moderation model that produced this result. + + - `type: :moderation_result` + + The object type, which was always `moderation_result` for successful moderation results. + + - `:moderation_result` + + - `class Error` + + An error produced while attempting moderation for the response input or output. + + - `code: String` + + The error code. + + - `message: String` + + The error message. + + - `type: :error` + + The object type, which was always `error` for moderation failures. + + - `:error` + + - `previous_response_id: String` + + The unique ID of the previous response to the model. Use this to + create multi-turn conversations. Learn more about + [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. + + - `prompt: ResponsePrompt` + + Reference to a prompt template and its variables. + [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts). + + - `id: String` + + The unique identifier of the prompt template to use. + + - `variables: Hash[Symbol, String | ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Optional map of values to substitute in for variables in your + prompt. The substitution values can either be strings, or other + Response input types like images or files. + + - `String = String` + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `version: String` + + Optional version of the prompt template. + + - `prompt_cache_key: String` + + Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://platform.openai.com/docs/guides/prompt-caching). + + - `prompt_cache_retention: :in_memory | :"24h"` + + The retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention). + For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported. + + For older models that support both `in_memory` and `24h`, the default depends on your organization's data retention policy: + + - Organizations without ZDR enabled default to `24h`. + - Organizations with ZDR enabled default to `in_memory` when `prompt_cache_retention` is not specified. + + - `:in_memory` + + - `:"24h"` + + - `reasoning: Reasoning` + + **gpt-5 and o-series models only** + + Configuration options for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + + - `effort: ReasoningEffort` + + Constrains effort on reasoning for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing + reasoning effort can result in faster responses and fewer tokens used + on reasoning in a response. + + - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1. + - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. + - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. + - `xhigh` is supported for all models after `gpt-5.1-codex-max`. + + - `:none` + + - `:minimal` + + - `:low` + + - `:medium` + + - `:high` + + - `:xhigh` + + - `generate_summary: :auto | :concise | :detailed` + + **Deprecated:** use `summary` instead. + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `summary: :auto | :concise | :detailed` + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + `concise` is supported for `computer-use-preview` models and all reasoning models after `gpt-5`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `safety_identifier: String` + + A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + + - `service_tier: :auto | :default | :flex | 2 more` + + Specifies the processing type used for serving the request. + + - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. + - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. + - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier. + - When not set, the default behavior is 'auto'. + + When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter. + + - `:auto` + + - `:default` + + - `:flex` + + - `:scale` + + - `:priority` + + - `status: ResponseStatus` + + The status of the response generation. One of `completed`, `failed`, + `in_progress`, `cancelled`, `queued`, or `incomplete`. + + - `:completed` + + - `:failed` + + - `:in_progress` + + - `:cancelled` + + - `:queued` + + - `:incomplete` + + - `text: ResponseTextConfig` + + 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) + + - `format_: ResponseFormatTextConfig` + + An object specifying the format that the model must output. + + Configuring `{ "type": "json_schema" }` enables Structured Outputs, + which ensures the model will match your supplied JSON schema. Learn more in the + [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). + + The default format is `{ "type": "text" }` with no additional options. + + **Not recommended for gpt-4o and newer models:** + + Setting to `{ "type": "json_object" }` enables the older JSON mode, which + ensures the message the model generates is valid JSON. Using `json_schema` + is preferred for models that support it. + + - `class ResponseFormatText` + + Default response format. Used to generate text responses. + + - `type: :text` + + The type of response format being defined. Always `text`. + + - `:text` + + - `class ResponseFormatTextJSONSchemaConfig` + + JSON Schema response format. Used to generate structured JSON responses. + Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). + + - `name: String` + + The name of the response format. Must be a-z, A-Z, 0-9, or contain + underscores and dashes, with a maximum length of 64. + + - `schema: Hash[Symbol, untyped]` + + The schema for the response format, described as a JSON Schema object. + Learn how to build JSON schemas [here](https://json-schema.org/). + + - `type: :json_schema` + + The type of response format being defined. Always `json_schema`. + + - `:json_schema` + + - `description: String` + + A description of what the response format is for, used by the model to + determine how to respond in the format. + + - `strict: bool` + + Whether to enable strict schema adherence when generating the output. + If set to true, the model will always follow the exact schema defined + in the `schema` field. Only a subset of JSON Schema is supported when + `strict` is `true`. To learn more, read the [Structured Outputs + guide](https://platform.openai.com/docs/guides/structured-outputs). + + - `class ResponseFormatJSONObject` + + 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. + + - `type: :json_object` + + The type of response format being defined. Always `json_object`. + + - `:json_object` + + - `verbosity: :low | :medium | :high` + + Constrains the verbosity of the model's response. Lower values will result in + more concise responses, while higher values will result in more verbose responses. + Currently supported values are `low`, `medium`, and `high`. + + - `:low` + + - `:medium` + + - `:high` + + - `top_logprobs: Integer` + + An integer between 0 and 20 specifying the maximum number of most likely + tokens to return at each token position, each with an associated log + probability. In some cases, the number of returned tokens may be fewer than + requested. + + - `truncation: :auto | :disabled` + + The truncation strategy to use for the model response. + + - `auto`: If the input to this Response exceeds + the model's context window size, the model will truncate the + response to fit the context window by dropping items from the beginning of the conversation. + - `disabled` (default): If the input size will exceed the context window + size for a model, the request will fail with a 400 error. + + - `:auto` + + - `:disabled` + + - `usage: ResponseUsage` + + Represents token usage details including input tokens, output tokens, + a breakdown of output tokens, and the total tokens used. + + - `input_tokens: Integer` + + The number of input tokens. + + - `input_tokens_details: InputTokensDetails{ cached_tokens}` + + A detailed breakdown of the input tokens. + + - `cached_tokens: Integer` + + The number of tokens that were retrieved from the cache. + [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching). + + - `output_tokens: Integer` + + The number of output tokens. + + - `output_tokens_details: OutputTokensDetails{ reasoning_tokens}` + + A detailed breakdown of the output tokens. + + - `reasoning_tokens: Integer` + + The number of reasoning tokens. + + - `total_tokens: Integer` + + The total number of tokens used. + + - `user: String` + + This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. + A stable identifier for your end-users. + Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.failed"` + + The type of the event. Always `response.failed`. + + - `:"response.failed"` + +### Response File Search Call Completed Event + +- `class ResponseFileSearchCallCompletedEvent` + + Emitted when a file search call is completed (results found). + + - `item_id: String` + + The ID of the output item that the file search call is initiated. + + - `output_index: Integer` + + The index of the output item that the file search call is initiated. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.file_search_call.completed"` + + The type of the event. Always `response.file_search_call.completed`. + + - `:"response.file_search_call.completed"` + +### Response File Search Call In Progress Event + +- `class ResponseFileSearchCallInProgressEvent` + + Emitted when a file search call is initiated. + + - `item_id: String` + + The ID of the output item that the file search call is initiated. + + - `output_index: Integer` + + The index of the output item that the file search call is initiated. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.file_search_call.in_progress"` + + The type of the event. Always `response.file_search_call.in_progress`. + + - `:"response.file_search_call.in_progress"` + +### Response File Search Call Searching Event + +- `class ResponseFileSearchCallSearchingEvent` + + Emitted when a file search is currently searching. + + - `item_id: String` + + The ID of the output item that the file search call is initiated. + + - `output_index: Integer` + + The index of the output item that the file search call is searching. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.file_search_call.searching"` + + The type of the event. Always `response.file_search_call.searching`. + + - `:"response.file_search_call.searching"` + +### Response File Search Tool Call + +- `class ResponseFileSearchToolCall` + + 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. + + - `id: String` + + The unique ID of the file search tool call. + + - `queries: Array[String]` + + The queries used to search for files. + + - `status: :in_progress | :searching | :completed | 2 more` + + The status of the file search tool call. One of `in_progress`, + `searching`, `incomplete` or `failed`, + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `type: :file_search_call` + + The type of the file search tool call. Always `file_search_call`. + + - `:file_search_call` + + - `results: Array[Result{ attributes, file_id, filename, 2 more}]` + + The results of the file search tool call. + + - `attributes: Hash[Symbol, String | Float | bool]` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. Keys are strings + with a maximum length of 64 characters. Values are strings with a maximum + length of 512 characters, booleans, or numbers. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `file_id: String` + + The unique ID of the file. + + - `filename: String` + + The name of the file. + + - `score: Float` + + The relevance score of the file - a value between 0 and 1. + + - `text: String` + + The text that was retrieved from the file. + +### Response Format Text Config + +- `ResponseFormatTextConfig = ResponseFormatText | ResponseFormatTextJSONSchemaConfig | ResponseFormatJSONObject` + + An object specifying the format that the model must output. + + Configuring `{ "type": "json_schema" }` enables Structured Outputs, + which ensures the model will match your supplied JSON schema. Learn more in the + [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). + + The default format is `{ "type": "text" }` with no additional options. + + **Not recommended for gpt-4o and newer models:** + + Setting to `{ "type": "json_object" }` enables the older JSON mode, which + ensures the message the model generates is valid JSON. Using `json_schema` + is preferred for models that support it. + + - `class ResponseFormatText` + + Default response format. Used to generate text responses. + + - `type: :text` + + The type of response format being defined. Always `text`. + + - `:text` + + - `class ResponseFormatTextJSONSchemaConfig` + + JSON Schema response format. Used to generate structured JSON responses. + Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). + + - `name: String` + + The name of the response format. Must be a-z, A-Z, 0-9, or contain + underscores and dashes, with a maximum length of 64. + + - `schema: Hash[Symbol, untyped]` + + The schema for the response format, described as a JSON Schema object. + Learn how to build JSON schemas [here](https://json-schema.org/). + + - `type: :json_schema` + + The type of response format being defined. Always `json_schema`. + + - `:json_schema` + + - `description: String` + + A description of what the response format is for, used by the model to + determine how to respond in the format. + + - `strict: bool` + + Whether to enable strict schema adherence when generating the output. + If set to true, the model will always follow the exact schema defined + in the `schema` field. Only a subset of JSON Schema is supported when + `strict` is `true`. To learn more, read the [Structured Outputs + guide](https://platform.openai.com/docs/guides/structured-outputs). + + - `class ResponseFormatJSONObject` + + 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. + + - `type: :json_object` + + The type of response format being defined. Always `json_object`. + + - `:json_object` + +### Response Format Text JSON Schema Config + +- `class ResponseFormatTextJSONSchemaConfig` + + JSON Schema response format. Used to generate structured JSON responses. + Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). + + - `name: String` + + The name of the response format. Must be a-z, A-Z, 0-9, or contain + underscores and dashes, with a maximum length of 64. + + - `schema: Hash[Symbol, untyped]` + + The schema for the response format, described as a JSON Schema object. + Learn how to build JSON schemas [here](https://json-schema.org/). + + - `type: :json_schema` + + The type of response format being defined. Always `json_schema`. + + - `:json_schema` + + - `description: String` + + A description of what the response format is for, used by the model to + determine how to respond in the format. + + - `strict: bool` + + Whether to enable strict schema adherence when generating the output. + If set to true, the model will always follow the exact schema defined + in the `schema` field. Only a subset of JSON Schema is supported when + `strict` is `true`. To learn more, read the [Structured Outputs + guide](https://platform.openai.com/docs/guides/structured-outputs). + +### Response Function Call Arguments Delta Event + +- `class ResponseFunctionCallArgumentsDeltaEvent` + + Emitted when there is a partial function-call arguments delta. + + - `delta: String` + + The function-call arguments delta that is added. + + - `item_id: String` + + The ID of the output item that the function-call arguments delta is added to. + + - `output_index: Integer` + + The index of the output item that the function-call arguments delta is added to. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.function_call_arguments.delta"` + + The type of the event. Always `response.function_call_arguments.delta`. + + - `:"response.function_call_arguments.delta"` + +### Response Function Call Arguments Done Event + +- `class ResponseFunctionCallArgumentsDoneEvent` + + Emitted when function-call arguments are finalized. + + - `arguments: String` + + The function-call arguments. + + - `item_id: String` + + The ID of the item. + + - `name: String` + + The name of the function that was called. + + - `output_index: Integer` + + The index of the output item. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.function_call_arguments.done"` + + - `:"response.function_call_arguments.done"` + +### Response Function Call Output Item + +- `ResponseFunctionCallOutputItem = ResponseInputTextContent | ResponseInputImageContent | ResponseInputFileContent` + + A piece of message content, such as text, an image, or a file. + + - `class ResponseInputTextContent` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImageContent` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision) + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFileContent` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The base64-encoded data of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + +### Response Function Call Output Item List + +- `ResponseFunctionCallOutputItemList = Array[ResponseFunctionCallOutputItem]` + + An array of content outputs (text, image, file) for the function tool call. + + - `class ResponseInputTextContent` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImageContent` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision) + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFileContent` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The base64-encoded data of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + +### Response Function Shell Call Output Content + +- `class ResponseFunctionShellCallOutputContent` + + Captured stdout and stderr for a portion of a shell tool call output. + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + The exit or timeout outcome associated with this shell call. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + The exit code returned by the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + Captured stderr output for the shell call. + + - `stdout: String` + + Captured stdout output for the shell call. + +### Response Function Shell Tool Call + +- `class ResponseFunctionShellToolCall` + + A tool call that executes one or more shell commands in a managed environment. + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + - `max_output_length: Integer` + + Optional maximum number of characters to return from each command. + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the commands. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `environment: ResponseLocalEnvironment | ResponseContainerReference` + + Represents the use of a local environment to perform shell actions. + + - `class ResponseLocalEnvironment` + + Represents the use of a local environment to perform shell actions. + + - `type: :local` + + The environment type. Always `local`. + + - `:local` + + - `class ResponseContainerReference` + + Represents a container created with /v1/containers. + + - `container_id: String` + + - `type: :container_reference` + + The environment type. Always `container_reference`. + + - `:container_reference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + +### Response Function Shell Tool Call Output + +- `class ResponseFunctionShellToolCallOutput` + + The output of a shell tool call that was emitted. + + - `id: String` + + The unique ID of the shell call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `max_output_length: Integer` + + The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output. + + - `output: Array[Output{ outcome, stderr, stdout, created_by}]` + + An array of shell call output contents + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + Exit code from the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + The standard error output that was captured. + + - `stdout: String` + + The standard output that was captured. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call_output` + + The type of the shell call output. Always `shell_call_output`. + + - `:shell_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + +### Response Function Tool Call + +- `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `arguments: String` + + A JSON string of the arguments to pass to the function. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `name: String` + + The name of the function to run. + + - `type: :function_call` + + The type of the function tool call. Always `function_call`. + + - `:function_call` + + - `id: String` + + The unique ID of the function tool call. + + - `namespace: String` + + The namespace of the function to run. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + +### Response Function Tool Call Item + +- `class ResponseFunctionToolCallItem` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `id: String` + + The unique ID of the function tool call. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + +### Response Function Tool Call Output Item + +- `class ResponseFunctionToolCallOutputItem` + + - `id: String` + + The unique ID of the function call tool output. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the function call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the function call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the function call. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + +### Response Function Web Search + +- `class ResponseFunctionWebSearch` + + 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. + + - `id: String` + + The unique ID of the web search tool call. + + - `action: Search{ type, queries, query, sources} | OpenPage{ type, url} | FindInPage{ pattern, type, url}` + + An object describing the specific action taken in this web search call. + Includes details on how the model used the web (search, open_page, find_in_page). + + - `class Search` + + Action type "search" - Performs a web search query. + + - `type: :search` + + The action type. + + - `:search` + + - `queries: Array[String]` + + The search queries. + + - `query: String` + + The search query. + + - `sources: Array[Source{ type, url}]` + + The sources used in the search. + + - `type: :url` + + The type of source. Always `url`. + + - `:url` + + - `url: String` + + The URL of the source. + + - `class OpenPage` + + Action type "open_page" - Opens a specific URL from search results. + + - `type: :open_page` + + The action type. + + - `:open_page` + + - `url: String` + + The URL opened by the model. + + - `class FindInPage` + + Action type "find_in_page": Searches for a pattern within a loaded page. + + - `pattern: String` + + The pattern or text to search for within the page. + + - `type: :find_in_page` + + The action type. + + - `:find_in_page` + + - `url: String` + + The URL of the page searched for the pattern. + + - `status: :in_progress | :searching | :completed | :failed` + + The status of the web search tool call. + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:failed` + + - `type: :web_search_call` + + The type of the web search tool call. Always `web_search_call`. + + - `:web_search_call` + +### Response Image Gen Call Completed Event + +- `class ResponseImageGenCallCompletedEvent` + + Emitted when an image generation tool call has completed and the final image is available. + + - `item_id: String` + + The unique identifier of the image generation item being processed. + + - `output_index: Integer` + + The index of the output item in the response's output array. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.image_generation_call.completed"` + + The type of the event. Always 'response.image_generation_call.completed'. + + - `:"response.image_generation_call.completed"` + +### Response Image Gen Call Generating Event + +- `class ResponseImageGenCallGeneratingEvent` + + Emitted when an image generation tool call is actively generating an image (intermediate state). + + - `item_id: String` + + The unique identifier of the image generation item being processed. + + - `output_index: Integer` + + The index of the output item in the response's output array. + + - `sequence_number: Integer` + + The sequence number of the image generation item being processed. + + - `type: :"response.image_generation_call.generating"` + + The type of the event. Always 'response.image_generation_call.generating'. + + - `:"response.image_generation_call.generating"` + +### Response Image Gen Call In Progress Event + +- `class ResponseImageGenCallInProgressEvent` + + Emitted when an image generation tool call is in progress. + + - `item_id: String` + + The unique identifier of the image generation item being processed. + + - `output_index: Integer` + + The index of the output item in the response's output array. + + - `sequence_number: Integer` + + The sequence number of the image generation item being processed. + + - `type: :"response.image_generation_call.in_progress"` + + The type of the event. Always 'response.image_generation_call.in_progress'. + + - `:"response.image_generation_call.in_progress"` + +### Response Image Gen Call Partial Image Event + +- `class ResponseImageGenCallPartialImageEvent` + + Emitted when a partial image is available during image generation streaming. + + - `item_id: String` + + The unique identifier of the image generation item being processed. + + - `output_index: Integer` + + The index of the output item in the response's output array. + + - `partial_image_b64: String` + + Base64-encoded partial image data, suitable for rendering as an image. + + - `partial_image_index: Integer` + + 0-based index for the partial image (backend is 1-based, but this is 0-based for the user). + + - `sequence_number: Integer` + + The sequence number of the image generation item being processed. + + - `type: :"response.image_generation_call.partial_image"` + + The type of the event. Always 'response.image_generation_call.partial_image'. + + - `:"response.image_generation_call.partial_image"` + +### Response In Progress Event + +- `class ResponseInProgressEvent` + + Emitted when the response is in progress. + + - `response: Response` + + The response that is in progress. + + - `id: String` + + Unique identifier for this Response. + + - `created_at: Float` + + Unix timestamp (in seconds) of when this Response was created. + + - `error: ResponseError` + + An error object returned when the model fails to generate a Response. + + - `code: :server_error | :rate_limit_exceeded | :invalid_prompt | 15 more` + + The error code for the response. + + - `: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` + + - `message: String` + + A human-readable description of the error. + + - `incomplete_details: IncompleteDetails{ reason}` + + Details about why the response is incomplete. + + - `reason: :max_output_tokens | :content_filter` + + The reason why the response is incomplete. + + - `:max_output_tokens` + + - `:content_filter` + + - `instructions: String | Array[ResponseInputItem]` + + A system (or developer) message inserted into the model's context. + + When using along with `previous_response_id`, the instructions from a previous + response will not be carried over to the next response. This makes it simple + to swap out system (or developer) messages in new responses. + + - `String = String` + + A text input to the model, equivalent to a text input with the + `developer` role. + + - `InputItemList = Array[ResponseInputItem]` + + A list of one or many input items to the model, containing + different content types. + + - `class EasyInputMessage` + + 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. + + - `content: String | ResponseInputMessageContentList` + + Text, image, or audio input to the model, used to generate a response. + Can also contain previous assistant responses. + + - `String = String` + + A text input to the model. + + - `ResponseInputMessageContentList = Array[ResponseInputContent]` + + A list of one or many input items to the model, containing different content + types. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `role: :user | :assistant | :system | :developer` + + The role of the message input. One of `user`, `assistant`, `system`, or + `developer`. + + - `:user` + + - `:assistant` + + - `:system` + + - `:developer` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `type: :message` + + The type of the message input. Always `message`. + + - `:message` + + - `class Message` + + 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. + + - `content: ResponseInputMessageContentList` + + A list of one or many input items to the model, containing different content + types. + + - `role: :user | :system | :developer` + + The role of the message input. One of `user`, `system`, or `developer`. + + - `:user` + + - `:system` + + - `:developer` + + - `status: :in_progress | :completed | :incomplete` + + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the message input. Always set to `message`. + + - `:message` + + - `class ResponseOutputMessage` + + An output message from the model. + + - `id: String` + + The unique ID of the output message. + + - `content: Array[ResponseOutputText | ResponseOutputRefusal]` + + The content of the output message. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `role: :assistant` + + The role of the output message. Always `assistant`. + + - `:assistant` + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the output message. Always `message`. + + - `:message` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `class ResponseFileSearchToolCall` + + 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. + + - `id: String` + + The unique ID of the file search tool call. + + - `queries: Array[String]` + + The queries used to search for files. + + - `status: :in_progress | :searching | :completed | 2 more` + + The status of the file search tool call. One of `in_progress`, + `searching`, `incomplete` or `failed`, + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `type: :file_search_call` + + The type of the file search tool call. Always `file_search_call`. + + - `:file_search_call` + + - `results: Array[Result{ attributes, file_id, filename, 2 more}]` + + The results of the file search tool call. + + - `attributes: Hash[Symbol, String | Float | bool]` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. Keys are strings + with a maximum length of 64 characters. Values are strings with a maximum + length of 512 characters, booleans, or numbers. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `file_id: String` + + The unique ID of the file. + + - `filename: String` + + The name of the file. + + - `score: Float` + + The relevance score of the file - a value between 0 and 1. + + - `text: String` + + The text that was retrieved from the file. + + - `class ResponseComputerToolCall` + + 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. + + - `id: String` + + The unique ID of the computer call. + + - `call_id: String` + + An identifier used when responding to the tool call with output. + + - `pending_safety_checks: Array[PendingSafetyCheck{ id, code, message}]` + + The pending safety checks for the computer call. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :computer_call` + + The type of the computer call. Always `computer_call`. + + - `:computer_call` + + - `action: Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `actions: ComputerActionList` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `class ComputerCallOutput` + + The output of a computer tool call. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `id: String` + + The ID of the computer tool call output. + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionWebSearch` + + 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. + + - `id: String` + + The unique ID of the web search tool call. + + - `action: Search{ type, queries, query, sources} | OpenPage{ type, url} | FindInPage{ pattern, type, url}` + + An object describing the specific action taken in this web search call. + Includes details on how the model used the web (search, open_page, find_in_page). + + - `class Search` + + Action type "search" - Performs a web search query. + + - `type: :search` + + The action type. + + - `:search` + + - `queries: Array[String]` + + The search queries. + + - `query: String` + + The search query. + + - `sources: Array[Source{ type, url}]` + + The sources used in the search. + + - `type: :url` + + The type of source. Always `url`. + + - `:url` + + - `url: String` + + The URL of the source. + + - `class OpenPage` + + Action type "open_page" - Opens a specific URL from search results. + + - `type: :open_page` + + The action type. + + - `:open_page` + + - `url: String` + + The URL opened by the model. + + - `class FindInPage` + + Action type "find_in_page": Searches for a pattern within a loaded page. + + - `pattern: String` + + The pattern or text to search for within the page. + + - `type: :find_in_page` + + The action type. + + - `:find_in_page` + + - `url: String` + + The URL of the page searched for the pattern. + + - `status: :in_progress | :searching | :completed | :failed` + + The status of the web search tool call. + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:failed` + + - `type: :web_search_call` + + The type of the web search tool call. Always `web_search_call`. + + - `:web_search_call` + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `arguments: String` + + A JSON string of the arguments to pass to the function. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `name: String` + + The name of the function to run. + + - `type: :function_call` + + The type of the function tool call. Always `function_call`. + + - `:function_call` + + - `id: String` + + The unique ID of the function tool call. + + - `namespace: String` + + The namespace of the function to run. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class FunctionCallOutput` + + The output of a function tool call. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | ResponseFunctionCallOutputItemList` + + Text, image, or file output of the function tool call. + + - `String = String` + + A JSON string of the output of the function tool call. + + - `ResponseFunctionCallOutputItemList = Array[ResponseFunctionCallOutputItem]` + + An array of content outputs (text, image, file) for the function tool call. + + - `class ResponseInputTextContent` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImageContent` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision) + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFileContent` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The base64-encoded data of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `id: String` + + The unique ID of the function tool call output. Populated when this item is returned via API. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ToolSearchCall` + + - `arguments: untyped` + + The arguments supplied to the tool search call. + + - `type: :tool_search_call` + + The item type. Always `tool_search_call`. + + - `:tool_search_call` + + - `id: String` + + The unique ID of this tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseToolSearchOutputItemParam` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by the tool search output. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The item type. Always `tool_search_output`. + + - `:tool_search_output` + + - `id: String` + + The unique ID of this tool search output. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class AdditionalTools` + + - `role: :developer` + + The role that provided the additional tools. Only `developer` is supported. + + - `:developer` + + - `tools: Array[Tool]` + + A list of additional tools made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The item type. Always `additional_tools`. + + - `:additional_tools` + + - `id: String` + + The unique ID of this additional tools item. + + - `class ResponseReasoningItem` + + 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). + + - `id: String` + + The unique identifier of the reasoning content. + + - `summary: Array[Summary{ text, type}]` + + Reasoning summary content. + + - `text: String` + + A summary of the reasoning output from the model so far. + + - `type: :summary_text` + + The type of the object. Always `summary_text`. + + - `:summary_text` + + - `type: :reasoning` + + The type of the object. Always `reasoning`. + + - `:reasoning` + + - `content: Array[Content{ text, type}]` + + Reasoning text content. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `encrypted_content: String` + + The encrypted content of the reasoning item - populated when a response is + generated with `reasoning.encrypted_content` in the `include` parameter. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseCompactionItemParam` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `encrypted_content: String` + + The encrypted content of the compaction summary. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `id: String` + + The ID of the compaction item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `id: String` + + The unique ID of the code interpreter tool call. + + - `code: String` + + The code to run, or null if not available. + + - `container_id: String` + + The ID of the container used to run the code. + + - `outputs: Array[Logs{ logs, type} | Image{ type, url}]` + + The outputs generated by the code interpreter, such as logs or images. + Can be null if no outputs are available. + + - `class Logs` + + The logs output from the code interpreter. + + - `logs: String` + + The logs output from the code interpreter. + + - `type: :logs` + + The type of the output. Always `logs`. + + - `:logs` + + - `class Image` + + The image output from the code interpreter. + + - `type: :image` + + The type of the output. Always `image`. + + - `:image` + + - `url: String` + + The URL of the image output from the code interpreter. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:interpreting` + + - `:failed` + + - `type: :code_interpreter_call` + + The type of the code interpreter tool call. Always `code_interpreter_call`. + + - `:code_interpreter_call` + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCall` + + A tool representing a request to execute one or more shell commands. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + Ordered shell commands for the execution environment to run. + + - `max_output_length: Integer` + + Maximum number of UTF-8 characters to capture from combined stdout and stderr output. + + - `timeout_ms: Integer` + + Maximum wall-clock time in milliseconds to allow the shell commands to run. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `environment: LocalEnvironment | ContainerReference` + + The environment to execute the shell commands in. + + - `class LocalEnvironment` + + - `class ContainerReference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCallOutput` + + The streamed output items emitted by a shell tool call. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `output: Array[ResponseFunctionShellCallOutputContent]` + + Captured chunks of stdout and stderr output, along with their associated outcomes. + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + The exit or timeout outcome associated with this shell call. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + The exit code returned by the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + Captured stderr output for the shell call. + + - `stdout: String` + + Captured stdout output for the shell call. + + - `type: :shell_call_output` + + The type of the item. Always `shell_call_output`. + + - `:shell_call_output` + + - `id: String` + + The unique ID of the shell tool call output. Populated when this item is returned via API. + + - `max_output_length: Integer` + + The maximum number of UTF-8 characters captured for this shell call's combined output. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ApplyPatchCall` + + A tool call representing a request to create, delete, or update files using diff patches. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + The specific create, delete, or update instruction for the apply_patch tool call. + + - `class CreateFile` + + Instruction for creating a new file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply when creating the file. + + - `path: String` + + Path of the file to create relative to the workspace root. + + - `type: :create_file` + + The operation type. Always `create_file`. + + - `:create_file` + + - `class DeleteFile` + + Instruction for deleting an existing file via the apply_patch tool. + + - `path: String` + + Path of the file to delete relative to the workspace root. + + - `type: :delete_file` + + The operation type. Always `delete_file`. + + - `:delete_file` + + - `class UpdateFile` + + Instruction for updating an existing file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply to the existing file. + + - `path: String` + + Path of the file to update relative to the workspace root. + + - `type: :update_file` + + The operation type. Always `update_file`. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `class ApplyPatchCallOutput` + + The streamed output emitted by an apply patch tool call. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `output: String` + + Optional human-readable log text from the apply patch tool (e.g., patch results or errors). + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `id: String` + + The unique ID of the approval response + + - `reason: String` + + Optional reason for the decision. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class ResponseCustomToolCallOutput` + + The output of a custom tool call from your code, being sent back to the model. + + - `call_id: String` + + The call ID, used to map this custom tool call output to a custom tool call. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the custom tool call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the custom tool call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :custom_tool_call_output` + + The type of the custom tool call output. Always `custom_tool_call_output`. + + - `:custom_tool_call_output` + + - `id: String` + + The unique ID of the custom tool call output in the OpenAI platform. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `call_id: String` + + An identifier used to map this custom tool call to a tool call output. + + - `input: String` + + The input for the custom tool call generated by the model. + + - `name: String` + + The name of the custom tool being called. + + - `type: :custom_tool_call` + + The type of the custom tool call. Always `custom_tool_call`. + + - `:custom_tool_call` + + - `id: String` + + The unique ID of the custom tool call in the OpenAI platform. + + - `namespace: String` + + The namespace of the custom tool being called. + + - `class CompactionTrigger` + + Compacts the current context. Must be the final input item. + + - `type: :compaction_trigger` + + The type of the item. Always `compaction_trigger`. + + - `:compaction_trigger` + + - `class ItemReference` + + An internal identifier for an item to reference. + + - `id: String` + + The ID of the item to reference. + + - `type: :item_reference` + + The type of item to reference. Always `item_reference`. + + - `:item_reference` + + - `metadata: Metadata` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. + + Keys are strings with a maximum length of 64 characters. Values are strings + with a maximum length of 512 characters. + + - `model: ResponsesModel` + + Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI + offers a wide range of models with different capabilities, performance + characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) + to browse and compare available models. + + - `String = String` + + - `ChatModel = :"gpt-5.4" | :"gpt-5.4-mini" | :"gpt-5.4-nano" | 75 more` + + - `:"gpt-5.4"` + + - `:"gpt-5.4-mini"` + + - `:"gpt-5.4-nano"` + + - `:"gpt-5.4-mini-2026-03-17"` + + - `:"gpt-5.4-nano-2026-03-17"` + + - `:"gpt-5.3-chat-latest"` + + - `:"gpt-5.2"` + + - `:"gpt-5.2-2025-12-11"` + + - `:"gpt-5.2-chat-latest"` + + - `:"gpt-5.2-pro"` + + - `:"gpt-5.2-pro-2025-12-11"` + + - `:"gpt-5.1"` + + - `:"gpt-5.1-2025-11-13"` + + - `:"gpt-5.1-codex"` + + - `:"gpt-5.1-mini"` + + - `:"gpt-5.1-chat-latest"` + + - `:"gpt-5"` + + - `:"gpt-5-mini"` + + - `:"gpt-5-nano"` + + - `:"gpt-5-2025-08-07"` + + - `:"gpt-5-mini-2025-08-07"` + + - `:"gpt-5-nano-2025-08-07"` + + - `:"gpt-5-chat-latest"` + + - `:"gpt-4.1"` + + - `:"gpt-4.1-mini"` + + - `:"gpt-4.1-nano"` + + - `:"gpt-4.1-2025-04-14"` + + - `:"gpt-4.1-mini-2025-04-14"` + + - `:"gpt-4.1-nano-2025-04-14"` + + - `:"o4-mini"` + + - `:"o4-mini-2025-04-16"` + + - `:o3` + + - `:"o3-2025-04-16"` + + - `:"o3-mini"` + + - `:"o3-mini-2025-01-31"` + + - `:o1` + + - `:"o1-2024-12-17"` + + - `:"o1-preview"` + + - `:"o1-preview-2024-09-12"` + + - `:"o1-mini"` + + - `:"o1-mini-2024-09-12"` + + - `:"gpt-4o"` + + - `:"gpt-4o-2024-11-20"` + + - `:"gpt-4o-2024-08-06"` + + - `:"gpt-4o-2024-05-13"` + + - `:"gpt-4o-audio-preview"` + + - `:"gpt-4o-audio-preview-2024-10-01"` + + - `:"gpt-4o-audio-preview-2024-12-17"` + + - `:"gpt-4o-audio-preview-2025-06-03"` + + - `:"gpt-4o-mini-audio-preview"` + + - `:"gpt-4o-mini-audio-preview-2024-12-17"` + + - `:"gpt-4o-search-preview"` + + - `:"gpt-4o-mini-search-preview"` + + - `:"gpt-4o-search-preview-2025-03-11"` + + - `:"gpt-4o-mini-search-preview-2025-03-11"` + + - `:"chatgpt-4o-latest"` + + - `:"codex-mini-latest"` + + - `:"gpt-4o-mini"` + + - `:"gpt-4o-mini-2024-07-18"` + + - `:"gpt-4-turbo"` + + - `:"gpt-4-turbo-2024-04-09"` + + - `:"gpt-4-0125-preview"` + + - `:"gpt-4-turbo-preview"` + + - `:"gpt-4-1106-preview"` + + - `:"gpt-4-vision-preview"` + + - `:"gpt-4"` + + - `:"gpt-4-0314"` + + - `:"gpt-4-0613"` + + - `:"gpt-4-32k"` + + - `:"gpt-4-32k-0314"` + + - `:"gpt-4-32k-0613"` + + - `:"gpt-3.5-turbo"` + + - `:"gpt-3.5-turbo-16k"` + + - `:"gpt-3.5-turbo-0301"` + + - `:"gpt-3.5-turbo-0613"` + + - `:"gpt-3.5-turbo-1106"` + + - `:"gpt-3.5-turbo-0125"` + + - `:"gpt-3.5-turbo-16k-0613"` + + - `ResponsesOnlyModel = :"o1-pro" | :"o1-pro-2025-03-19" | :"o3-pro" | 11 more` + + - `:"o1-pro"` + + - `:"o1-pro-2025-03-19"` + + - `:"o3-pro"` + + - `:"o3-pro-2025-06-10"` + + - `:"o3-deep-research"` + + - `:"o3-deep-research-2025-06-26"` + + - `:"o4-mini-deep-research"` + + - `:"o4-mini-deep-research-2025-06-26"` + + - `:"computer-use-preview"` + + - `:"computer-use-preview-2025-03-11"` + + - `:"gpt-5-codex"` + + - `:"gpt-5-pro"` + + - `:"gpt-5-pro-2025-10-06"` + + - `:"gpt-5.1-codex-max"` + + - `object: :response` + + The object type of this resource - always set to `response`. + + - `:response` + + - `output: Array[ResponseOutputItem]` + + An array of content items generated by the model. + + - The length and order of items in the `output` array is dependent + on the model's response. + - Rather than accessing the first item in the `output` array and + assuming it's an `assistant` message with the content generated by + the model, you might consider using the `output_text` property where + supported in SDKs. + + - `class ResponseOutputMessage` + + An output message from the model. + + - `class ResponseFileSearchToolCall` + + 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. + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `class ResponseFunctionToolCallOutputItem` + + - `id: String` + + The unique ID of the function call tool output. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the function call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the function call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the function call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseFunctionWebSearch` + + 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. + + - `class ResponseComputerToolCall` + + 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. + + - `class ResponseComputerToolCallOutputItem` + + - `id: String` + + The unique ID of the computer call tool output. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `status: :completed | :incomplete | :failed | :in_progress` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `:in_progress` + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the + developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseReasoningItem` + + 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). + + - `class ResponseToolSearchCall` + + - `id: String` + + The unique ID of the tool search call item. + + - `arguments: untyped` + + Arguments used for the tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :tool_search_call` + + The type of the item. Always `tool_search_call`. + + - `:tool_search_call` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseToolSearchOutputItem` + + - `id: String` + + The unique ID of the tool search output item. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by tool search. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :tool_search_output` + + The type of the item. Always `tool_search_output`. + + - `:tool_search_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class AdditionalTools` + + - `id: String` + + The unique ID of the additional tools item. + + - `role: :unknown | :user | :assistant | 5 more` + + The role that provided the additional tools. + + - `:unknown` + + - `:user` + + - `:assistant` + + - `:system` + + - `:critic` + + - `:discriminator` + + - `:developer` + + - `:tool` + + - `tools: Array[Tool]` + + The additional tool definitions made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The type of the item. Always `additional_tools`. + + - `:additional_tools` + + - `class ResponseCompactionItem` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `id: String` + + The unique ID of the compaction item. + + - `encrypted_content: String` + + The encrypted content that was produced by compaction. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionShellToolCall` + + A tool call that executes one or more shell commands in a managed environment. + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + - `max_output_length: Integer` + + Optional maximum number of characters to return from each command. + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the commands. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `environment: ResponseLocalEnvironment | ResponseContainerReference` + + Represents the use of a local environment to perform shell actions. + + - `class ResponseLocalEnvironment` + + Represents the use of a local environment to perform shell actions. + + - `type: :local` + + The environment type. Always `local`. + + - `:local` + + - `class ResponseContainerReference` + + Represents a container created with /v1/containers. + + - `container_id: String` + + - `type: :container_reference` + + The environment type. Always `container_reference`. + + - `:container_reference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseFunctionShellToolCallOutput` + + The output of a shell tool call that was emitted. + + - `id: String` + + The unique ID of the shell call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `max_output_length: Integer` + + The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output. + + - `output: Array[Output{ outcome, stderr, stdout, created_by}]` + + An array of shell call output contents + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + Exit code from the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + The standard error output that was captured. + + - `stdout: String` + + The standard output that was captured. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call_output` + + The type of the shell call output. Always `shell_call_output`. + + - `:shell_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseApplyPatchToolCall` + + A tool call that applies file diffs by creating, deleting, or updating files. + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + One of the create_file, delete_file, or update_file operations applied via apply_patch. + + - `class CreateFile` + + Instruction describing how to create a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to create. + + - `type: :create_file` + + Create a new file with the provided diff. + + - `:create_file` + + - `class DeleteFile` + + Instruction describing how to delete a file via the apply_patch tool. + + - `path: String` + + Path of the file to delete. + + - `type: :delete_file` + + Delete the specified file. + + - `:delete_file` + + - `class UpdateFile` + + Instruction describing how to update a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to update. + + - `type: :update_file` + + Update an existing file with the provided diff. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseApplyPatchToolCallOutput` + + The output emitted by an apply patch tool call. + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `created_by: String` + + The ID of the entity that created this tool call output. + + - `output: String` + + Optional textual output returned by the apply patch tool. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `id: String` + + The unique ID of the approval response + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `reason: String` + + Optional reason for the decision. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `class ResponseCustomToolCallOutputItem` + + The output of a custom tool call from your code, being sent back to the model. + + - `id: String` + + The unique ID of the custom tool call output item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `parallel_tool_calls: bool` + + Whether to allow the model to run tool calls in parallel. + + - `temperature: Float` + + 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. + + - `tool_choice: ToolChoiceOptions | ToolChoiceAllowed | ToolChoiceTypes | 5 more` + + How the model should select which tool (or tools) to use when generating + a response. See the `tools` parameter to see how to specify which tools + the model can call. + + - `ToolChoiceOptions = :none | :auto | :required` + + Controls which (if any) tool is called by the model. + + `none` means the model will not call any tool and instead generates a message. + + `auto` means the model can pick between generating a message or calling one or + more tools. + + `required` means the model must call one or more tools. + + - `:none` + + - `:auto` + + - `:required` + + - `class ToolChoiceAllowed` + + Constrains the tools available to the model to a pre-defined set. + + - `mode: :auto | :required` + + Constrains the tools available to the model to a pre-defined set. + + `auto` allows the model to pick from among the allowed tools and generate a + message. + + `required` requires the model to call one or more of the allowed tools. + + - `:auto` + + - `:required` + + - `tools: Array[Hash[Symbol, untyped]]` + + A list of tool definitions that the model should be allowed to call. + + For the Responses API, the list of tool definitions might look like: + + ```json + [ + { "type": "function", "name": "get_weather" }, + { "type": "mcp", "server_label": "deepwiki" }, + { "type": "image_generation" } + ] + ``` + + - `type: :allowed_tools` + + Allowed tool configuration type. Always `allowed_tools`. + + - `:allowed_tools` + + - `class ToolChoiceTypes` + + 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). + + - `type: :file_search | :web_search_preview | :computer | 5 more` + + The type of hosted tool the model should to use. Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + + Allowed values are: + + - `file_search` + - `web_search_preview` + - `computer` + - `computer_use_preview` + - `computer_use` + - `code_interpreter` + - `image_generation` + + - `:file_search` + + - `:web_search_preview` + + - `:computer` + + - `:computer_use_preview` + + - `:computer_use` + + - `:web_search_preview_2025_03_11` + + - `:image_generation` + + - `:code_interpreter` + + - `class ToolChoiceFunction` + + Use this option to force the model to call a specific function. + + - `name: String` + + The name of the function to call. + + - `type: :function` + + For function calling, the type is always `function`. + + - `:function` + + - `class ToolChoiceMcp` + + Use this option to force the model to call a specific tool on a remote MCP server. + + - `server_label: String` + + The label of the MCP server to use. + + - `type: :mcp` + + For MCP tools, the type is always `mcp`. + + - `:mcp` + + - `name: String` + + The name of the tool to call on the server. + + - `class ToolChoiceCustom` + + Use this option to force the model to call a specific custom tool. + + - `name: String` + + The name of the custom tool to call. + + - `type: :custom` + + For custom tool calling, the type is always `custom`. + + - `:custom` + + - `class ToolChoiceApplyPatch` + + Forces the model to call the apply_patch tool when executing a tool call. + + - `type: :apply_patch` + + The tool to call. Always `apply_patch`. + + - `:apply_patch` + + - `class ToolChoiceShell` + + Forces the model to call the shell tool when a tool call is required. + + - `type: :shell` + + The tool to call. Always `shell`. + + - `:shell` + + - `tools: Array[Tool]` + + An array of tools the model may call while generating a response. You + can specify which tool to use by setting the `tool_choice` parameter. + + We support the following categories of tools: + + - **Built-in tools**: Tools that are provided by OpenAI that extend the + model's capabilities, like [web search](https://platform.openai.com/docs/guides/tools-web-search) + or [file search](https://platform.openai.com/docs/guides/tools-file-search). Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + - **MCP Tools**: Integrations with third-party systems via custom MCP servers + or predefined connectors such as Google Drive and SharePoint. Learn more about + [MCP Tools](https://platform.openai.com/docs/guides/tools-connectors-mcp). + - **Function calls (custom tools)**: Functions that are defined by you, + enabling the model to call your own code with strongly typed arguments + and outputs. Learn more about + [function calling](https://platform.openai.com/docs/guides/function-calling). You can also use + custom tools to call your own code. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `top_p: Float` + + 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. + + - `background: bool` + + Whether to run the model response in the background. + [Learn more](https://platform.openai.com/docs/guides/background). + + - `completed_at: Float` + + Unix timestamp (in seconds) of when this Response was completed. + Only present when the status is `completed`. + + - `conversation: Conversation{ id}` + + The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation. + + - `id: String` + + The unique ID of the conversation that this response was associated with. + + - `max_output_tokens: Integer` + + An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://platform.openai.com/docs/guides/reasoning). + + - `max_tool_calls: Integer` + + 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. + + - `moderation: Moderation{ input, output}` + + Moderation results for the response input and output, if moderated completions were requested. + + - `input: ModerationResult{ categories, category_applied_input_types, category_scores, 3 more} | Error{ code, message, type}` + + Moderation for the response input. + + - `class ModerationResult` + + A moderation result produced for the response input or output. + + - `categories: Hash[Symbol, bool]` + + A dictionary of moderation categories to booleans, True if the input is flagged under this category. + + - `category_applied_input_types: Hash[Symbol, Array[:text | :image]]` + + Which modalities of input are reflected by the score for each category. + + - `:text` + + - `:image` + + - `category_scores: Hash[Symbol, Float]` + + A dictionary of moderation categories to scores. + + - `flagged: bool` + + A boolean indicating whether the content was flagged by any category. + + - `model: String` + + The moderation model that produced this result. + + - `type: :moderation_result` + + The object type, which was always `moderation_result` for successful moderation results. + + - `:moderation_result` + + - `class Error` + + An error produced while attempting moderation for the response input or output. + + - `code: String` + + The error code. + + - `message: String` + + The error message. + + - `type: :error` + + The object type, which was always `error` for moderation failures. + + - `:error` + + - `output: ModerationResult{ categories, category_applied_input_types, category_scores, 3 more} | Error{ code, message, type}` + + Moderation for the response output. + + - `class ModerationResult` + + A moderation result produced for the response input or output. + + - `categories: Hash[Symbol, bool]` + + A dictionary of moderation categories to booleans, True if the input is flagged under this category. + + - `category_applied_input_types: Hash[Symbol, Array[:text | :image]]` + + Which modalities of input are reflected by the score for each category. + + - `:text` + + - `:image` + + - `category_scores: Hash[Symbol, Float]` + + A dictionary of moderation categories to scores. + + - `flagged: bool` + + A boolean indicating whether the content was flagged by any category. + + - `model: String` + + The moderation model that produced this result. + + - `type: :moderation_result` + + The object type, which was always `moderation_result` for successful moderation results. + + - `:moderation_result` + + - `class Error` + + An error produced while attempting moderation for the response input or output. + + - `code: String` + + The error code. + + - `message: String` + + The error message. + + - `type: :error` + + The object type, which was always `error` for moderation failures. + + - `:error` + + - `previous_response_id: String` + + The unique ID of the previous response to the model. Use this to + create multi-turn conversations. Learn more about + [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. + + - `prompt: ResponsePrompt` + + Reference to a prompt template and its variables. + [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts). + + - `id: String` + + The unique identifier of the prompt template to use. + + - `variables: Hash[Symbol, String | ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Optional map of values to substitute in for variables in your + prompt. The substitution values can either be strings, or other + Response input types like images or files. + + - `String = String` + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `version: String` + + Optional version of the prompt template. + + - `prompt_cache_key: String` + + Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://platform.openai.com/docs/guides/prompt-caching). + + - `prompt_cache_retention: :in_memory | :"24h"` + + The retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention). + For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported. + + For older models that support both `in_memory` and `24h`, the default depends on your organization's data retention policy: + + - Organizations without ZDR enabled default to `24h`. + - Organizations with ZDR enabled default to `in_memory` when `prompt_cache_retention` is not specified. + + - `:in_memory` + + - `:"24h"` + + - `reasoning: Reasoning` + + **gpt-5 and o-series models only** + + Configuration options for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + + - `effort: ReasoningEffort` + + Constrains effort on reasoning for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing + reasoning effort can result in faster responses and fewer tokens used + on reasoning in a response. + + - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1. + - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. + - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. + - `xhigh` is supported for all models after `gpt-5.1-codex-max`. + + - `:none` + + - `:minimal` + + - `:low` + + - `:medium` + + - `:high` + + - `:xhigh` + + - `generate_summary: :auto | :concise | :detailed` + + **Deprecated:** use `summary` instead. + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `summary: :auto | :concise | :detailed` + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + `concise` is supported for `computer-use-preview` models and all reasoning models after `gpt-5`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `safety_identifier: String` + + A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + + - `service_tier: :auto | :default | :flex | 2 more` + + Specifies the processing type used for serving the request. + + - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. + - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. + - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier. + - When not set, the default behavior is 'auto'. + + When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter. + + - `:auto` + + - `:default` + + - `:flex` + + - `:scale` + + - `:priority` + + - `status: ResponseStatus` + + The status of the response generation. One of `completed`, `failed`, + `in_progress`, `cancelled`, `queued`, or `incomplete`. + + - `:completed` + + - `:failed` + + - `:in_progress` + + - `:cancelled` + + - `:queued` + + - `:incomplete` + + - `text: ResponseTextConfig` + + 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) + + - `format_: ResponseFormatTextConfig` + + An object specifying the format that the model must output. + + Configuring `{ "type": "json_schema" }` enables Structured Outputs, + which ensures the model will match your supplied JSON schema. Learn more in the + [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). + + The default format is `{ "type": "text" }` with no additional options. + + **Not recommended for gpt-4o and newer models:** + + Setting to `{ "type": "json_object" }` enables the older JSON mode, which + ensures the message the model generates is valid JSON. Using `json_schema` + is preferred for models that support it. + + - `class ResponseFormatText` + + Default response format. Used to generate text responses. + + - `type: :text` + + The type of response format being defined. Always `text`. + + - `:text` + + - `class ResponseFormatTextJSONSchemaConfig` + + JSON Schema response format. Used to generate structured JSON responses. + Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). + + - `name: String` + + The name of the response format. Must be a-z, A-Z, 0-9, or contain + underscores and dashes, with a maximum length of 64. + + - `schema: Hash[Symbol, untyped]` + + The schema for the response format, described as a JSON Schema object. + Learn how to build JSON schemas [here](https://json-schema.org/). + + - `type: :json_schema` + + The type of response format being defined. Always `json_schema`. + + - `:json_schema` + + - `description: String` + + A description of what the response format is for, used by the model to + determine how to respond in the format. + + - `strict: bool` + + Whether to enable strict schema adherence when generating the output. + If set to true, the model will always follow the exact schema defined + in the `schema` field. Only a subset of JSON Schema is supported when + `strict` is `true`. To learn more, read the [Structured Outputs + guide](https://platform.openai.com/docs/guides/structured-outputs). + + - `class ResponseFormatJSONObject` + + 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. + + - `type: :json_object` + + The type of response format being defined. Always `json_object`. + + - `:json_object` + + - `verbosity: :low | :medium | :high` + + Constrains the verbosity of the model's response. Lower values will result in + more concise responses, while higher values will result in more verbose responses. + Currently supported values are `low`, `medium`, and `high`. + + - `:low` + + - `:medium` + + - `:high` + + - `top_logprobs: Integer` + + An integer between 0 and 20 specifying the maximum number of most likely + tokens to return at each token position, each with an associated log + probability. In some cases, the number of returned tokens may be fewer than + requested. + + - `truncation: :auto | :disabled` + + The truncation strategy to use for the model response. + + - `auto`: If the input to this Response exceeds + the model's context window size, the model will truncate the + response to fit the context window by dropping items from the beginning of the conversation. + - `disabled` (default): If the input size will exceed the context window + size for a model, the request will fail with a 400 error. + + - `:auto` + + - `:disabled` + + - `usage: ResponseUsage` + + Represents token usage details including input tokens, output tokens, + a breakdown of output tokens, and the total tokens used. + + - `input_tokens: Integer` + + The number of input tokens. + + - `input_tokens_details: InputTokensDetails{ cached_tokens}` + + A detailed breakdown of the input tokens. + + - `cached_tokens: Integer` + + The number of tokens that were retrieved from the cache. + [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching). + + - `output_tokens: Integer` + + The number of output tokens. + + - `output_tokens_details: OutputTokensDetails{ reasoning_tokens}` + + A detailed breakdown of the output tokens. + + - `reasoning_tokens: Integer` + + The number of reasoning tokens. + + - `total_tokens: Integer` + + The total number of tokens used. + + - `user: String` + + This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. + A stable identifier for your end-users. + Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.in_progress"` + + The type of the event. Always `response.in_progress`. + + - `:"response.in_progress"` + +### Response Includable + +- `ResponseIncludable = :"file_search_call.results" | :"web_search_call.results" | :"web_search_call.action.sources" | 5 more` + + Specify additional output data to include in the model response. Currently supported values are: + + - `web_search_call.results`: Include the search results of the web search tool call. + - `web_search_call.action.sources`: Include the sources of the web search tool call. + - `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items. + - `computer_call_output.output.image_url`: Include image urls from the computer call output. + - `file_search_call.results`: Include the search results of the file search tool call. + - `message.input_image.image_url`: Include image urls from the input message. + - `message.output_text.logprobs`: Include logprobs with assistant messages. + - `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program). + + - `:"file_search_call.results"` + + - `:"web_search_call.results"` + + - `:"web_search_call.action.sources"` + + - `:"message.input_image.image_url"` + + - `:"computer_call_output.output.image_url"` + + - `:"code_interpreter_call.outputs"` + + - `:"reasoning.encrypted_content"` + + - `:"message.output_text.logprobs"` + +### Response Incomplete Event + +- `class ResponseIncompleteEvent` + + An event that is emitted when a response finishes as incomplete. + + - `response: Response` + + The response that was incomplete. + + - `id: String` + + Unique identifier for this Response. + + - `created_at: Float` + + Unix timestamp (in seconds) of when this Response was created. + + - `error: ResponseError` + + An error object returned when the model fails to generate a Response. + + - `code: :server_error | :rate_limit_exceeded | :invalid_prompt | 15 more` + + The error code for the response. + + - `: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` + + - `message: String` + + A human-readable description of the error. + + - `incomplete_details: IncompleteDetails{ reason}` + + Details about why the response is incomplete. + + - `reason: :max_output_tokens | :content_filter` + + The reason why the response is incomplete. + + - `:max_output_tokens` + + - `:content_filter` + + - `instructions: String | Array[ResponseInputItem]` + + A system (or developer) message inserted into the model's context. + + When using along with `previous_response_id`, the instructions from a previous + response will not be carried over to the next response. This makes it simple + to swap out system (or developer) messages in new responses. + + - `String = String` + + A text input to the model, equivalent to a text input with the + `developer` role. + + - `InputItemList = Array[ResponseInputItem]` + + A list of one or many input items to the model, containing + different content types. + + - `class EasyInputMessage` + + 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. + + - `content: String | ResponseInputMessageContentList` + + Text, image, or audio input to the model, used to generate a response. + Can also contain previous assistant responses. + + - `String = String` + + A text input to the model. + + - `ResponseInputMessageContentList = Array[ResponseInputContent]` + + A list of one or many input items to the model, containing different content + types. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `role: :user | :assistant | :system | :developer` + + The role of the message input. One of `user`, `assistant`, `system`, or + `developer`. + + - `:user` + + - `:assistant` + + - `:system` + + - `:developer` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `type: :message` + + The type of the message input. Always `message`. + + - `:message` + + - `class Message` + + 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. + + - `content: ResponseInputMessageContentList` + + A list of one or many input items to the model, containing different content + types. + + - `role: :user | :system | :developer` + + The role of the message input. One of `user`, `system`, or `developer`. + + - `:user` + + - `:system` + + - `:developer` + + - `status: :in_progress | :completed | :incomplete` + + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the message input. Always set to `message`. + + - `:message` + + - `class ResponseOutputMessage` + + An output message from the model. + + - `id: String` + + The unique ID of the output message. + + - `content: Array[ResponseOutputText | ResponseOutputRefusal]` + + The content of the output message. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `role: :assistant` + + The role of the output message. Always `assistant`. + + - `:assistant` + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the output message. Always `message`. + + - `:message` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `class ResponseFileSearchToolCall` + + 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. + + - `id: String` + + The unique ID of the file search tool call. + + - `queries: Array[String]` + + The queries used to search for files. + + - `status: :in_progress | :searching | :completed | 2 more` + + The status of the file search tool call. One of `in_progress`, + `searching`, `incomplete` or `failed`, + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `type: :file_search_call` + + The type of the file search tool call. Always `file_search_call`. + + - `:file_search_call` + + - `results: Array[Result{ attributes, file_id, filename, 2 more}]` + + The results of the file search tool call. + + - `attributes: Hash[Symbol, String | Float | bool]` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. Keys are strings + with a maximum length of 64 characters. Values are strings with a maximum + length of 512 characters, booleans, or numbers. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `file_id: String` + + The unique ID of the file. + + - `filename: String` + + The name of the file. + + - `score: Float` + + The relevance score of the file - a value between 0 and 1. + + - `text: String` + + The text that was retrieved from the file. + + - `class ResponseComputerToolCall` + + 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. + + - `id: String` + + The unique ID of the computer call. + + - `call_id: String` + + An identifier used when responding to the tool call with output. + + - `pending_safety_checks: Array[PendingSafetyCheck{ id, code, message}]` + + The pending safety checks for the computer call. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :computer_call` + + The type of the computer call. Always `computer_call`. + + - `:computer_call` + + - `action: Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `actions: ComputerActionList` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `class ComputerCallOutput` + + The output of a computer tool call. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `id: String` + + The ID of the computer tool call output. + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionWebSearch` + + 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. + + - `id: String` + + The unique ID of the web search tool call. + + - `action: Search{ type, queries, query, sources} | OpenPage{ type, url} | FindInPage{ pattern, type, url}` + + An object describing the specific action taken in this web search call. + Includes details on how the model used the web (search, open_page, find_in_page). + + - `class Search` + + Action type "search" - Performs a web search query. + + - `type: :search` + + The action type. + + - `:search` + + - `queries: Array[String]` + + The search queries. + + - `query: String` + + The search query. + + - `sources: Array[Source{ type, url}]` + + The sources used in the search. + + - `type: :url` + + The type of source. Always `url`. + + - `:url` + + - `url: String` + + The URL of the source. + + - `class OpenPage` + + Action type "open_page" - Opens a specific URL from search results. + + - `type: :open_page` + + The action type. + + - `:open_page` + + - `url: String` + + The URL opened by the model. + + - `class FindInPage` + + Action type "find_in_page": Searches for a pattern within a loaded page. + + - `pattern: String` + + The pattern or text to search for within the page. + + - `type: :find_in_page` + + The action type. + + - `:find_in_page` + + - `url: String` + + The URL of the page searched for the pattern. + + - `status: :in_progress | :searching | :completed | :failed` + + The status of the web search tool call. + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:failed` + + - `type: :web_search_call` + + The type of the web search tool call. Always `web_search_call`. + + - `:web_search_call` + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `arguments: String` + + A JSON string of the arguments to pass to the function. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `name: String` + + The name of the function to run. + + - `type: :function_call` + + The type of the function tool call. Always `function_call`. + + - `:function_call` + + - `id: String` + + The unique ID of the function tool call. + + - `namespace: String` + + The namespace of the function to run. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class FunctionCallOutput` + + The output of a function tool call. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | ResponseFunctionCallOutputItemList` + + Text, image, or file output of the function tool call. + + - `String = String` + + A JSON string of the output of the function tool call. + + - `ResponseFunctionCallOutputItemList = Array[ResponseFunctionCallOutputItem]` + + An array of content outputs (text, image, file) for the function tool call. + + - `class ResponseInputTextContent` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImageContent` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision) + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFileContent` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The base64-encoded data of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `id: String` + + The unique ID of the function tool call output. Populated when this item is returned via API. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ToolSearchCall` + + - `arguments: untyped` + + The arguments supplied to the tool search call. + + - `type: :tool_search_call` + + The item type. Always `tool_search_call`. + + - `:tool_search_call` + + - `id: String` + + The unique ID of this tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseToolSearchOutputItemParam` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by the tool search output. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The item type. Always `tool_search_output`. + + - `:tool_search_output` + + - `id: String` + + The unique ID of this tool search output. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class AdditionalTools` + + - `role: :developer` + + The role that provided the additional tools. Only `developer` is supported. + + - `:developer` + + - `tools: Array[Tool]` + + A list of additional tools made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The item type. Always `additional_tools`. + + - `:additional_tools` + + - `id: String` + + The unique ID of this additional tools item. + + - `class ResponseReasoningItem` + + 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). + + - `id: String` + + The unique identifier of the reasoning content. + + - `summary: Array[Summary{ text, type}]` + + Reasoning summary content. + + - `text: String` + + A summary of the reasoning output from the model so far. + + - `type: :summary_text` + + The type of the object. Always `summary_text`. + + - `:summary_text` + + - `type: :reasoning` + + The type of the object. Always `reasoning`. + + - `:reasoning` + + - `content: Array[Content{ text, type}]` + + Reasoning text content. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `encrypted_content: String` + + The encrypted content of the reasoning item - populated when a response is + generated with `reasoning.encrypted_content` in the `include` parameter. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseCompactionItemParam` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `encrypted_content: String` + + The encrypted content of the compaction summary. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `id: String` + + The ID of the compaction item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `id: String` + + The unique ID of the code interpreter tool call. + + - `code: String` + + The code to run, or null if not available. + + - `container_id: String` + + The ID of the container used to run the code. + + - `outputs: Array[Logs{ logs, type} | Image{ type, url}]` + + The outputs generated by the code interpreter, such as logs or images. + Can be null if no outputs are available. + + - `class Logs` + + The logs output from the code interpreter. + + - `logs: String` + + The logs output from the code interpreter. + + - `type: :logs` + + The type of the output. Always `logs`. + + - `:logs` + + - `class Image` + + The image output from the code interpreter. + + - `type: :image` + + The type of the output. Always `image`. + + - `:image` + + - `url: String` + + The URL of the image output from the code interpreter. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:interpreting` + + - `:failed` + + - `type: :code_interpreter_call` + + The type of the code interpreter tool call. Always `code_interpreter_call`. + + - `:code_interpreter_call` + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCall` + + A tool representing a request to execute one or more shell commands. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + Ordered shell commands for the execution environment to run. + + - `max_output_length: Integer` + + Maximum number of UTF-8 characters to capture from combined stdout and stderr output. + + - `timeout_ms: Integer` + + Maximum wall-clock time in milliseconds to allow the shell commands to run. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `environment: LocalEnvironment | ContainerReference` + + The environment to execute the shell commands in. + + - `class LocalEnvironment` + + - `class ContainerReference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCallOutput` + + The streamed output items emitted by a shell tool call. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `output: Array[ResponseFunctionShellCallOutputContent]` + + Captured chunks of stdout and stderr output, along with their associated outcomes. + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + The exit or timeout outcome associated with this shell call. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + The exit code returned by the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + Captured stderr output for the shell call. + + - `stdout: String` + + Captured stdout output for the shell call. + + - `type: :shell_call_output` + + The type of the item. Always `shell_call_output`. + + - `:shell_call_output` + + - `id: String` + + The unique ID of the shell tool call output. Populated when this item is returned via API. + + - `max_output_length: Integer` + + The maximum number of UTF-8 characters captured for this shell call's combined output. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ApplyPatchCall` + + A tool call representing a request to create, delete, or update files using diff patches. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + The specific create, delete, or update instruction for the apply_patch tool call. + + - `class CreateFile` + + Instruction for creating a new file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply when creating the file. + + - `path: String` + + Path of the file to create relative to the workspace root. + + - `type: :create_file` + + The operation type. Always `create_file`. + + - `:create_file` + + - `class DeleteFile` + + Instruction for deleting an existing file via the apply_patch tool. + + - `path: String` + + Path of the file to delete relative to the workspace root. + + - `type: :delete_file` + + The operation type. Always `delete_file`. + + - `:delete_file` + + - `class UpdateFile` + + Instruction for updating an existing file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply to the existing file. + + - `path: String` + + Path of the file to update relative to the workspace root. + + - `type: :update_file` + + The operation type. Always `update_file`. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `class ApplyPatchCallOutput` + + The streamed output emitted by an apply patch tool call. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `output: String` + + Optional human-readable log text from the apply patch tool (e.g., patch results or errors). + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `id: String` + + The unique ID of the approval response + + - `reason: String` + + Optional reason for the decision. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class ResponseCustomToolCallOutput` + + The output of a custom tool call from your code, being sent back to the model. + + - `call_id: String` + + The call ID, used to map this custom tool call output to a custom tool call. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the custom tool call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the custom tool call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :custom_tool_call_output` + + The type of the custom tool call output. Always `custom_tool_call_output`. + + - `:custom_tool_call_output` + + - `id: String` + + The unique ID of the custom tool call output in the OpenAI platform. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `call_id: String` + + An identifier used to map this custom tool call to a tool call output. + + - `input: String` + + The input for the custom tool call generated by the model. + + - `name: String` + + The name of the custom tool being called. + + - `type: :custom_tool_call` + + The type of the custom tool call. Always `custom_tool_call`. + + - `:custom_tool_call` + + - `id: String` + + The unique ID of the custom tool call in the OpenAI platform. + + - `namespace: String` + + The namespace of the custom tool being called. + + - `class CompactionTrigger` + + Compacts the current context. Must be the final input item. + + - `type: :compaction_trigger` + + The type of the item. Always `compaction_trigger`. + + - `:compaction_trigger` + + - `class ItemReference` + + An internal identifier for an item to reference. + + - `id: String` + + The ID of the item to reference. + + - `type: :item_reference` + + The type of item to reference. Always `item_reference`. + + - `:item_reference` + + - `metadata: Metadata` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. + + Keys are strings with a maximum length of 64 characters. Values are strings + with a maximum length of 512 characters. + + - `model: ResponsesModel` + + Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI + offers a wide range of models with different capabilities, performance + characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) + to browse and compare available models. + + - `String = String` + + - `ChatModel = :"gpt-5.4" | :"gpt-5.4-mini" | :"gpt-5.4-nano" | 75 more` + + - `:"gpt-5.4"` + + - `:"gpt-5.4-mini"` + + - `:"gpt-5.4-nano"` + + - `:"gpt-5.4-mini-2026-03-17"` + + - `:"gpt-5.4-nano-2026-03-17"` + + - `:"gpt-5.3-chat-latest"` + + - `:"gpt-5.2"` + + - `:"gpt-5.2-2025-12-11"` + + - `:"gpt-5.2-chat-latest"` + + - `:"gpt-5.2-pro"` + + - `:"gpt-5.2-pro-2025-12-11"` + + - `:"gpt-5.1"` + + - `:"gpt-5.1-2025-11-13"` + + - `:"gpt-5.1-codex"` + + - `:"gpt-5.1-mini"` + + - `:"gpt-5.1-chat-latest"` + + - `:"gpt-5"` + + - `:"gpt-5-mini"` + + - `:"gpt-5-nano"` + + - `:"gpt-5-2025-08-07"` + + - `:"gpt-5-mini-2025-08-07"` + + - `:"gpt-5-nano-2025-08-07"` + + - `:"gpt-5-chat-latest"` + + - `:"gpt-4.1"` + + - `:"gpt-4.1-mini"` + + - `:"gpt-4.1-nano"` + + - `:"gpt-4.1-2025-04-14"` + + - `:"gpt-4.1-mini-2025-04-14"` + + - `:"gpt-4.1-nano-2025-04-14"` + + - `:"o4-mini"` + + - `:"o4-mini-2025-04-16"` + + - `:o3` + + - `:"o3-2025-04-16"` + + - `:"o3-mini"` + + - `:"o3-mini-2025-01-31"` + + - `:o1` + + - `:"o1-2024-12-17"` + + - `:"o1-preview"` + + - `:"o1-preview-2024-09-12"` + + - `:"o1-mini"` + + - `:"o1-mini-2024-09-12"` + + - `:"gpt-4o"` + + - `:"gpt-4o-2024-11-20"` + + - `:"gpt-4o-2024-08-06"` + + - `:"gpt-4o-2024-05-13"` + + - `:"gpt-4o-audio-preview"` + + - `:"gpt-4o-audio-preview-2024-10-01"` + + - `:"gpt-4o-audio-preview-2024-12-17"` + + - `:"gpt-4o-audio-preview-2025-06-03"` + + - `:"gpt-4o-mini-audio-preview"` + + - `:"gpt-4o-mini-audio-preview-2024-12-17"` + + - `:"gpt-4o-search-preview"` + + - `:"gpt-4o-mini-search-preview"` + + - `:"gpt-4o-search-preview-2025-03-11"` + + - `:"gpt-4o-mini-search-preview-2025-03-11"` + + - `:"chatgpt-4o-latest"` + + - `:"codex-mini-latest"` + + - `:"gpt-4o-mini"` + + - `:"gpt-4o-mini-2024-07-18"` + + - `:"gpt-4-turbo"` + + - `:"gpt-4-turbo-2024-04-09"` + + - `:"gpt-4-0125-preview"` + + - `:"gpt-4-turbo-preview"` + + - `:"gpt-4-1106-preview"` + + - `:"gpt-4-vision-preview"` + + - `:"gpt-4"` + + - `:"gpt-4-0314"` + + - `:"gpt-4-0613"` + + - `:"gpt-4-32k"` + + - `:"gpt-4-32k-0314"` + + - `:"gpt-4-32k-0613"` + + - `:"gpt-3.5-turbo"` + + - `:"gpt-3.5-turbo-16k"` + + - `:"gpt-3.5-turbo-0301"` + + - `:"gpt-3.5-turbo-0613"` + + - `:"gpt-3.5-turbo-1106"` + + - `:"gpt-3.5-turbo-0125"` + + - `:"gpt-3.5-turbo-16k-0613"` + + - `ResponsesOnlyModel = :"o1-pro" | :"o1-pro-2025-03-19" | :"o3-pro" | 11 more` + + - `:"o1-pro"` + + - `:"o1-pro-2025-03-19"` + + - `:"o3-pro"` + + - `:"o3-pro-2025-06-10"` + + - `:"o3-deep-research"` + + - `:"o3-deep-research-2025-06-26"` + + - `:"o4-mini-deep-research"` + + - `:"o4-mini-deep-research-2025-06-26"` + + - `:"computer-use-preview"` + + - `:"computer-use-preview-2025-03-11"` + + - `:"gpt-5-codex"` + + - `:"gpt-5-pro"` + + - `:"gpt-5-pro-2025-10-06"` + + - `:"gpt-5.1-codex-max"` + + - `object: :response` + + The object type of this resource - always set to `response`. + + - `:response` + + - `output: Array[ResponseOutputItem]` + + An array of content items generated by the model. + + - The length and order of items in the `output` array is dependent + on the model's response. + - Rather than accessing the first item in the `output` array and + assuming it's an `assistant` message with the content generated by + the model, you might consider using the `output_text` property where + supported in SDKs. + + - `class ResponseOutputMessage` + + An output message from the model. + + - `class ResponseFileSearchToolCall` + + 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. + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `class ResponseFunctionToolCallOutputItem` + + - `id: String` + + The unique ID of the function call tool output. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the function call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the function call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the function call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseFunctionWebSearch` + + 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. + + - `class ResponseComputerToolCall` + + 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. + + - `class ResponseComputerToolCallOutputItem` + + - `id: String` + + The unique ID of the computer call tool output. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `status: :completed | :incomplete | :failed | :in_progress` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `:in_progress` + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the + developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseReasoningItem` + + 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). + + - `class ResponseToolSearchCall` + + - `id: String` + + The unique ID of the tool search call item. + + - `arguments: untyped` + + Arguments used for the tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :tool_search_call` + + The type of the item. Always `tool_search_call`. + + - `:tool_search_call` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseToolSearchOutputItem` + + - `id: String` + + The unique ID of the tool search output item. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by tool search. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :tool_search_output` + + The type of the item. Always `tool_search_output`. + + - `:tool_search_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class AdditionalTools` + + - `id: String` + + The unique ID of the additional tools item. + + - `role: :unknown | :user | :assistant | 5 more` + + The role that provided the additional tools. + + - `:unknown` + + - `:user` + + - `:assistant` + + - `:system` + + - `:critic` + + - `:discriminator` + + - `:developer` + + - `:tool` + + - `tools: Array[Tool]` + + The additional tool definitions made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The type of the item. Always `additional_tools`. + + - `:additional_tools` + + - `class ResponseCompactionItem` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `id: String` + + The unique ID of the compaction item. + + - `encrypted_content: String` + + The encrypted content that was produced by compaction. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionShellToolCall` + + A tool call that executes one or more shell commands in a managed environment. + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + - `max_output_length: Integer` + + Optional maximum number of characters to return from each command. + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the commands. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `environment: ResponseLocalEnvironment | ResponseContainerReference` + + Represents the use of a local environment to perform shell actions. + + - `class ResponseLocalEnvironment` + + Represents the use of a local environment to perform shell actions. + + - `type: :local` + + The environment type. Always `local`. + + - `:local` + + - `class ResponseContainerReference` + + Represents a container created with /v1/containers. + + - `container_id: String` + + - `type: :container_reference` + + The environment type. Always `container_reference`. + + - `:container_reference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseFunctionShellToolCallOutput` + + The output of a shell tool call that was emitted. + + - `id: String` + + The unique ID of the shell call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `max_output_length: Integer` + + The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output. + + - `output: Array[Output{ outcome, stderr, stdout, created_by}]` + + An array of shell call output contents + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + Exit code from the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + The standard error output that was captured. + + - `stdout: String` + + The standard output that was captured. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call_output` + + The type of the shell call output. Always `shell_call_output`. + + - `:shell_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseApplyPatchToolCall` + + A tool call that applies file diffs by creating, deleting, or updating files. + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + One of the create_file, delete_file, or update_file operations applied via apply_patch. + + - `class CreateFile` + + Instruction describing how to create a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to create. + + - `type: :create_file` + + Create a new file with the provided diff. + + - `:create_file` + + - `class DeleteFile` + + Instruction describing how to delete a file via the apply_patch tool. + + - `path: String` + + Path of the file to delete. + + - `type: :delete_file` + + Delete the specified file. + + - `:delete_file` + + - `class UpdateFile` + + Instruction describing how to update a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to update. + + - `type: :update_file` + + Update an existing file with the provided diff. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseApplyPatchToolCallOutput` + + The output emitted by an apply patch tool call. + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `created_by: String` + + The ID of the entity that created this tool call output. + + - `output: String` + + Optional textual output returned by the apply patch tool. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `id: String` + + The unique ID of the approval response + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `reason: String` + + Optional reason for the decision. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `class ResponseCustomToolCallOutputItem` + + The output of a custom tool call from your code, being sent back to the model. + + - `id: String` + + The unique ID of the custom tool call output item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `parallel_tool_calls: bool` + + Whether to allow the model to run tool calls in parallel. + + - `temperature: Float` + + 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. + + - `tool_choice: ToolChoiceOptions | ToolChoiceAllowed | ToolChoiceTypes | 5 more` + + How the model should select which tool (or tools) to use when generating + a response. See the `tools` parameter to see how to specify which tools + the model can call. + + - `ToolChoiceOptions = :none | :auto | :required` + + Controls which (if any) tool is called by the model. + + `none` means the model will not call any tool and instead generates a message. + + `auto` means the model can pick between generating a message or calling one or + more tools. + + `required` means the model must call one or more tools. + + - `:none` + + - `:auto` + + - `:required` + + - `class ToolChoiceAllowed` + + Constrains the tools available to the model to a pre-defined set. + + - `mode: :auto | :required` + + Constrains the tools available to the model to a pre-defined set. + + `auto` allows the model to pick from among the allowed tools and generate a + message. + + `required` requires the model to call one or more of the allowed tools. + + - `:auto` + + - `:required` + + - `tools: Array[Hash[Symbol, untyped]]` + + A list of tool definitions that the model should be allowed to call. + + For the Responses API, the list of tool definitions might look like: + + ```json + [ + { "type": "function", "name": "get_weather" }, + { "type": "mcp", "server_label": "deepwiki" }, + { "type": "image_generation" } + ] + ``` + + - `type: :allowed_tools` + + Allowed tool configuration type. Always `allowed_tools`. + + - `:allowed_tools` + + - `class ToolChoiceTypes` + + 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). + + - `type: :file_search | :web_search_preview | :computer | 5 more` + + The type of hosted tool the model should to use. Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + + Allowed values are: + + - `file_search` + - `web_search_preview` + - `computer` + - `computer_use_preview` + - `computer_use` + - `code_interpreter` + - `image_generation` + + - `:file_search` + + - `:web_search_preview` + + - `:computer` + + - `:computer_use_preview` + + - `:computer_use` + + - `:web_search_preview_2025_03_11` + + - `:image_generation` + + - `:code_interpreter` + + - `class ToolChoiceFunction` + + Use this option to force the model to call a specific function. + + - `name: String` + + The name of the function to call. + + - `type: :function` + + For function calling, the type is always `function`. + + - `:function` + + - `class ToolChoiceMcp` + + Use this option to force the model to call a specific tool on a remote MCP server. + + - `server_label: String` + + The label of the MCP server to use. + + - `type: :mcp` + + For MCP tools, the type is always `mcp`. + + - `:mcp` + + - `name: String` + + The name of the tool to call on the server. + + - `class ToolChoiceCustom` + + Use this option to force the model to call a specific custom tool. + + - `name: String` + + The name of the custom tool to call. + + - `type: :custom` + + For custom tool calling, the type is always `custom`. + + - `:custom` + + - `class ToolChoiceApplyPatch` + + Forces the model to call the apply_patch tool when executing a tool call. + + - `type: :apply_patch` + + The tool to call. Always `apply_patch`. + + - `:apply_patch` + + - `class ToolChoiceShell` + + Forces the model to call the shell tool when a tool call is required. + + - `type: :shell` + + The tool to call. Always `shell`. + + - `:shell` + + - `tools: Array[Tool]` + + An array of tools the model may call while generating a response. You + can specify which tool to use by setting the `tool_choice` parameter. + + We support the following categories of tools: + + - **Built-in tools**: Tools that are provided by OpenAI that extend the + model's capabilities, like [web search](https://platform.openai.com/docs/guides/tools-web-search) + or [file search](https://platform.openai.com/docs/guides/tools-file-search). Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + - **MCP Tools**: Integrations with third-party systems via custom MCP servers + or predefined connectors such as Google Drive and SharePoint. Learn more about + [MCP Tools](https://platform.openai.com/docs/guides/tools-connectors-mcp). + - **Function calls (custom tools)**: Functions that are defined by you, + enabling the model to call your own code with strongly typed arguments + and outputs. Learn more about + [function calling](https://platform.openai.com/docs/guides/function-calling). You can also use + custom tools to call your own code. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `top_p: Float` + + 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. + + - `background: bool` + + Whether to run the model response in the background. + [Learn more](https://platform.openai.com/docs/guides/background). + + - `completed_at: Float` + + Unix timestamp (in seconds) of when this Response was completed. + Only present when the status is `completed`. + + - `conversation: Conversation{ id}` + + The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation. + + - `id: String` + + The unique ID of the conversation that this response was associated with. + + - `max_output_tokens: Integer` + + An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://platform.openai.com/docs/guides/reasoning). + + - `max_tool_calls: Integer` + + 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. + + - `moderation: Moderation{ input, output}` + + Moderation results for the response input and output, if moderated completions were requested. + + - `input: ModerationResult{ categories, category_applied_input_types, category_scores, 3 more} | Error{ code, message, type}` + + Moderation for the response input. + + - `class ModerationResult` + + A moderation result produced for the response input or output. + + - `categories: Hash[Symbol, bool]` + + A dictionary of moderation categories to booleans, True if the input is flagged under this category. + + - `category_applied_input_types: Hash[Symbol, Array[:text | :image]]` + + Which modalities of input are reflected by the score for each category. + + - `:text` + + - `:image` + + - `category_scores: Hash[Symbol, Float]` + + A dictionary of moderation categories to scores. + + - `flagged: bool` + + A boolean indicating whether the content was flagged by any category. + + - `model: String` + + The moderation model that produced this result. + + - `type: :moderation_result` + + The object type, which was always `moderation_result` for successful moderation results. + + - `:moderation_result` + + - `class Error` + + An error produced while attempting moderation for the response input or output. + + - `code: String` + + The error code. + + - `message: String` + + The error message. + + - `type: :error` + + The object type, which was always `error` for moderation failures. + + - `:error` + + - `output: ModerationResult{ categories, category_applied_input_types, category_scores, 3 more} | Error{ code, message, type}` + + Moderation for the response output. + + - `class ModerationResult` + + A moderation result produced for the response input or output. + + - `categories: Hash[Symbol, bool]` + + A dictionary of moderation categories to booleans, True if the input is flagged under this category. + + - `category_applied_input_types: Hash[Symbol, Array[:text | :image]]` + + Which modalities of input are reflected by the score for each category. + + - `:text` + + - `:image` + + - `category_scores: Hash[Symbol, Float]` + + A dictionary of moderation categories to scores. + + - `flagged: bool` + + A boolean indicating whether the content was flagged by any category. + + - `model: String` + + The moderation model that produced this result. + + - `type: :moderation_result` + + The object type, which was always `moderation_result` for successful moderation results. + + - `:moderation_result` + + - `class Error` + + An error produced while attempting moderation for the response input or output. + + - `code: String` + + The error code. + + - `message: String` + + The error message. + + - `type: :error` + + The object type, which was always `error` for moderation failures. + + - `:error` + + - `previous_response_id: String` + + The unique ID of the previous response to the model. Use this to + create multi-turn conversations. Learn more about + [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. + + - `prompt: ResponsePrompt` + + Reference to a prompt template and its variables. + [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts). + + - `id: String` + + The unique identifier of the prompt template to use. + + - `variables: Hash[Symbol, String | ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Optional map of values to substitute in for variables in your + prompt. The substitution values can either be strings, or other + Response input types like images or files. + + - `String = String` + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `version: String` + + Optional version of the prompt template. + + - `prompt_cache_key: String` + + Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://platform.openai.com/docs/guides/prompt-caching). + + - `prompt_cache_retention: :in_memory | :"24h"` + + The retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention). + For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported. + + For older models that support both `in_memory` and `24h`, the default depends on your organization's data retention policy: + + - Organizations without ZDR enabled default to `24h`. + - Organizations with ZDR enabled default to `in_memory` when `prompt_cache_retention` is not specified. + + - `:in_memory` + + - `:"24h"` + + - `reasoning: Reasoning` + + **gpt-5 and o-series models only** + + Configuration options for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + + - `effort: ReasoningEffort` + + Constrains effort on reasoning for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing + reasoning effort can result in faster responses and fewer tokens used + on reasoning in a response. + + - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1. + - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. + - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. + - `xhigh` is supported for all models after `gpt-5.1-codex-max`. + + - `:none` + + - `:minimal` + + - `:low` + + - `:medium` + + - `:high` + + - `:xhigh` + + - `generate_summary: :auto | :concise | :detailed` + + **Deprecated:** use `summary` instead. + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `summary: :auto | :concise | :detailed` + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + `concise` is supported for `computer-use-preview` models and all reasoning models after `gpt-5`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `safety_identifier: String` + + A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + + - `service_tier: :auto | :default | :flex | 2 more` + + Specifies the processing type used for serving the request. + + - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. + - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. + - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier. + - When not set, the default behavior is 'auto'. + + When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter. + + - `:auto` + + - `:default` + + - `:flex` + + - `:scale` + + - `:priority` + + - `status: ResponseStatus` + + The status of the response generation. One of `completed`, `failed`, + `in_progress`, `cancelled`, `queued`, or `incomplete`. + + - `:completed` + + - `:failed` + + - `:in_progress` + + - `:cancelled` + + - `:queued` + + - `:incomplete` + + - `text: ResponseTextConfig` + + 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) + + - `format_: ResponseFormatTextConfig` + + An object specifying the format that the model must output. + + Configuring `{ "type": "json_schema" }` enables Structured Outputs, + which ensures the model will match your supplied JSON schema. Learn more in the + [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). + + The default format is `{ "type": "text" }` with no additional options. + + **Not recommended for gpt-4o and newer models:** + + Setting to `{ "type": "json_object" }` enables the older JSON mode, which + ensures the message the model generates is valid JSON. Using `json_schema` + is preferred for models that support it. + + - `class ResponseFormatText` + + Default response format. Used to generate text responses. + + - `type: :text` + + The type of response format being defined. Always `text`. + + - `:text` + + - `class ResponseFormatTextJSONSchemaConfig` + + JSON Schema response format. Used to generate structured JSON responses. + Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). + + - `name: String` + + The name of the response format. Must be a-z, A-Z, 0-9, or contain + underscores and dashes, with a maximum length of 64. + + - `schema: Hash[Symbol, untyped]` + + The schema for the response format, described as a JSON Schema object. + Learn how to build JSON schemas [here](https://json-schema.org/). + + - `type: :json_schema` + + The type of response format being defined. Always `json_schema`. + + - `:json_schema` + + - `description: String` + + A description of what the response format is for, used by the model to + determine how to respond in the format. + + - `strict: bool` + + Whether to enable strict schema adherence when generating the output. + If set to true, the model will always follow the exact schema defined + in the `schema` field. Only a subset of JSON Schema is supported when + `strict` is `true`. To learn more, read the [Structured Outputs + guide](https://platform.openai.com/docs/guides/structured-outputs). + + - `class ResponseFormatJSONObject` + + 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. + + - `type: :json_object` + + The type of response format being defined. Always `json_object`. + + - `:json_object` + + - `verbosity: :low | :medium | :high` + + Constrains the verbosity of the model's response. Lower values will result in + more concise responses, while higher values will result in more verbose responses. + Currently supported values are `low`, `medium`, and `high`. + + - `:low` + + - `:medium` + + - `:high` + + - `top_logprobs: Integer` + + An integer between 0 and 20 specifying the maximum number of most likely + tokens to return at each token position, each with an associated log + probability. In some cases, the number of returned tokens may be fewer than + requested. + + - `truncation: :auto | :disabled` + + The truncation strategy to use for the model response. + + - `auto`: If the input to this Response exceeds + the model's context window size, the model will truncate the + response to fit the context window by dropping items from the beginning of the conversation. + - `disabled` (default): If the input size will exceed the context window + size for a model, the request will fail with a 400 error. + + - `:auto` + + - `:disabled` + + - `usage: ResponseUsage` + + Represents token usage details including input tokens, output tokens, + a breakdown of output tokens, and the total tokens used. + + - `input_tokens: Integer` + + The number of input tokens. + + - `input_tokens_details: InputTokensDetails{ cached_tokens}` + + A detailed breakdown of the input tokens. + + - `cached_tokens: Integer` + + The number of tokens that were retrieved from the cache. + [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching). + + - `output_tokens: Integer` + + The number of output tokens. + + - `output_tokens_details: OutputTokensDetails{ reasoning_tokens}` + + A detailed breakdown of the output tokens. + + - `reasoning_tokens: Integer` + + The number of reasoning tokens. + + - `total_tokens: Integer` + + The total number of tokens used. + + - `user: String` + + This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. + A stable identifier for your end-users. + Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.incomplete"` + + The type of the event. Always `response.incomplete`. + + - `:"response.incomplete"` + +### Response Input + +- `ResponseInput = Array[ResponseInputItem]` + + A list of one or many input items to the model, containing + different content types. + + - `class EasyInputMessage` + + 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. + + - `content: String | ResponseInputMessageContentList` + + Text, image, or audio input to the model, used to generate a response. + Can also contain previous assistant responses. + + - `String = String` + + A text input to the model. + + - `ResponseInputMessageContentList = Array[ResponseInputContent]` + + A list of one or many input items to the model, containing different content + types. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `role: :user | :assistant | :system | :developer` + + The role of the message input. One of `user`, `assistant`, `system`, or + `developer`. + + - `:user` + + - `:assistant` + + - `:system` + + - `:developer` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `type: :message` + + The type of the message input. Always `message`. + + - `:message` + + - `class Message` + + 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. + + - `content: ResponseInputMessageContentList` + + A list of one or many input items to the model, containing different content + types. + + - `role: :user | :system | :developer` + + The role of the message input. One of `user`, `system`, or `developer`. + + - `:user` + + - `:system` + + - `:developer` + + - `status: :in_progress | :completed | :incomplete` + + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the message input. Always set to `message`. + + - `:message` + + - `class ResponseOutputMessage` + + An output message from the model. + + - `id: String` + + The unique ID of the output message. + + - `content: Array[ResponseOutputText | ResponseOutputRefusal]` + + The content of the output message. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `role: :assistant` + + The role of the output message. Always `assistant`. + + - `:assistant` + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the output message. Always `message`. + + - `:message` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `class ResponseFileSearchToolCall` + + 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. + + - `id: String` + + The unique ID of the file search tool call. + + - `queries: Array[String]` + + The queries used to search for files. + + - `status: :in_progress | :searching | :completed | 2 more` + + The status of the file search tool call. One of `in_progress`, + `searching`, `incomplete` or `failed`, + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `type: :file_search_call` + + The type of the file search tool call. Always `file_search_call`. + + - `:file_search_call` + + - `results: Array[Result{ attributes, file_id, filename, 2 more}]` + + The results of the file search tool call. + + - `attributes: Hash[Symbol, String | Float | bool]` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. Keys are strings + with a maximum length of 64 characters. Values are strings with a maximum + length of 512 characters, booleans, or numbers. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `file_id: String` + + The unique ID of the file. + + - `filename: String` + + The name of the file. + + - `score: Float` + + The relevance score of the file - a value between 0 and 1. + + - `text: String` + + The text that was retrieved from the file. + + - `class ResponseComputerToolCall` + + 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. + + - `id: String` + + The unique ID of the computer call. + + - `call_id: String` + + An identifier used when responding to the tool call with output. + + - `pending_safety_checks: Array[PendingSafetyCheck{ id, code, message}]` + + The pending safety checks for the computer call. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :computer_call` + + The type of the computer call. Always `computer_call`. + + - `:computer_call` + + - `action: Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `actions: ComputerActionList` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `class ComputerCallOutput` + + The output of a computer tool call. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `id: String` + + The ID of the computer tool call output. + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionWebSearch` + + 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. + + - `id: String` + + The unique ID of the web search tool call. + + - `action: Search{ type, queries, query, sources} | OpenPage{ type, url} | FindInPage{ pattern, type, url}` + + An object describing the specific action taken in this web search call. + Includes details on how the model used the web (search, open_page, find_in_page). + + - `class Search` + + Action type "search" - Performs a web search query. + + - `type: :search` + + The action type. + + - `:search` + + - `queries: Array[String]` + + The search queries. + + - `query: String` + + The search query. + + - `sources: Array[Source{ type, url}]` + + The sources used in the search. + + - `type: :url` + + The type of source. Always `url`. + + - `:url` + + - `url: String` + + The URL of the source. + + - `class OpenPage` + + Action type "open_page" - Opens a specific URL from search results. + + - `type: :open_page` + + The action type. + + - `:open_page` + + - `url: String` + + The URL opened by the model. + + - `class FindInPage` + + Action type "find_in_page": Searches for a pattern within a loaded page. + + - `pattern: String` + + The pattern or text to search for within the page. + + - `type: :find_in_page` + + The action type. + + - `:find_in_page` + + - `url: String` + + The URL of the page searched for the pattern. + + - `status: :in_progress | :searching | :completed | :failed` + + The status of the web search tool call. + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:failed` + + - `type: :web_search_call` + + The type of the web search tool call. Always `web_search_call`. + + - `:web_search_call` + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `arguments: String` + + A JSON string of the arguments to pass to the function. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `name: String` + + The name of the function to run. + + - `type: :function_call` + + The type of the function tool call. Always `function_call`. + + - `:function_call` + + - `id: String` + + The unique ID of the function tool call. + + - `namespace: String` + + The namespace of the function to run. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class FunctionCallOutput` + + The output of a function tool call. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | ResponseFunctionCallOutputItemList` + + Text, image, or file output of the function tool call. + + - `String = String` + + A JSON string of the output of the function tool call. + + - `ResponseFunctionCallOutputItemList = Array[ResponseFunctionCallOutputItem]` + + An array of content outputs (text, image, file) for the function tool call. + + - `class ResponseInputTextContent` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImageContent` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision) + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFileContent` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The base64-encoded data of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `id: String` + + The unique ID of the function tool call output. Populated when this item is returned via API. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ToolSearchCall` + + - `arguments: untyped` + + The arguments supplied to the tool search call. + + - `type: :tool_search_call` + + The item type. Always `tool_search_call`. + + - `:tool_search_call` + + - `id: String` + + The unique ID of this tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseToolSearchOutputItemParam` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by the tool search output. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The item type. Always `tool_search_output`. + + - `:tool_search_output` + + - `id: String` + + The unique ID of this tool search output. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class AdditionalTools` + + - `role: :developer` + + The role that provided the additional tools. Only `developer` is supported. + + - `:developer` + + - `tools: Array[Tool]` + + A list of additional tools made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The item type. Always `additional_tools`. + + - `:additional_tools` + + - `id: String` + + The unique ID of this additional tools item. + + - `class ResponseReasoningItem` + + 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). + + - `id: String` + + The unique identifier of the reasoning content. + + - `summary: Array[Summary{ text, type}]` + + Reasoning summary content. + + - `text: String` + + A summary of the reasoning output from the model so far. + + - `type: :summary_text` + + The type of the object. Always `summary_text`. + + - `:summary_text` + + - `type: :reasoning` + + The type of the object. Always `reasoning`. + + - `:reasoning` + + - `content: Array[Content{ text, type}]` + + Reasoning text content. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `encrypted_content: String` + + The encrypted content of the reasoning item - populated when a response is + generated with `reasoning.encrypted_content` in the `include` parameter. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseCompactionItemParam` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `encrypted_content: String` + + The encrypted content of the compaction summary. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `id: String` + + The ID of the compaction item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `id: String` + + The unique ID of the code interpreter tool call. + + - `code: String` + + The code to run, or null if not available. + + - `container_id: String` + + The ID of the container used to run the code. + + - `outputs: Array[Logs{ logs, type} | Image{ type, url}]` + + The outputs generated by the code interpreter, such as logs or images. + Can be null if no outputs are available. + + - `class Logs` + + The logs output from the code interpreter. + + - `logs: String` + + The logs output from the code interpreter. + + - `type: :logs` + + The type of the output. Always `logs`. + + - `:logs` + + - `class Image` + + The image output from the code interpreter. + + - `type: :image` + + The type of the output. Always `image`. + + - `:image` + + - `url: String` + + The URL of the image output from the code interpreter. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:interpreting` + + - `:failed` + + - `type: :code_interpreter_call` + + The type of the code interpreter tool call. Always `code_interpreter_call`. + + - `:code_interpreter_call` + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCall` + + A tool representing a request to execute one or more shell commands. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + Ordered shell commands for the execution environment to run. + + - `max_output_length: Integer` + + Maximum number of UTF-8 characters to capture from combined stdout and stderr output. + + - `timeout_ms: Integer` + + Maximum wall-clock time in milliseconds to allow the shell commands to run. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `environment: LocalEnvironment | ContainerReference` + + The environment to execute the shell commands in. + + - `class LocalEnvironment` + + - `class ContainerReference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCallOutput` + + The streamed output items emitted by a shell tool call. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `output: Array[ResponseFunctionShellCallOutputContent]` + + Captured chunks of stdout and stderr output, along with their associated outcomes. + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + The exit or timeout outcome associated with this shell call. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + The exit code returned by the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + Captured stderr output for the shell call. + + - `stdout: String` + + Captured stdout output for the shell call. + + - `type: :shell_call_output` + + The type of the item. Always `shell_call_output`. + + - `:shell_call_output` + + - `id: String` + + The unique ID of the shell tool call output. Populated when this item is returned via API. + + - `max_output_length: Integer` + + The maximum number of UTF-8 characters captured for this shell call's combined output. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ApplyPatchCall` + + A tool call representing a request to create, delete, or update files using diff patches. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + The specific create, delete, or update instruction for the apply_patch tool call. + + - `class CreateFile` + + Instruction for creating a new file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply when creating the file. + + - `path: String` + + Path of the file to create relative to the workspace root. + + - `type: :create_file` + + The operation type. Always `create_file`. + + - `:create_file` + + - `class DeleteFile` + + Instruction for deleting an existing file via the apply_patch tool. + + - `path: String` + + Path of the file to delete relative to the workspace root. + + - `type: :delete_file` + + The operation type. Always `delete_file`. + + - `:delete_file` + + - `class UpdateFile` + + Instruction for updating an existing file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply to the existing file. + + - `path: String` + + Path of the file to update relative to the workspace root. + + - `type: :update_file` + + The operation type. Always `update_file`. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `class ApplyPatchCallOutput` + + The streamed output emitted by an apply patch tool call. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `output: String` + + Optional human-readable log text from the apply patch tool (e.g., patch results or errors). + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `id: String` + + The unique ID of the approval response + + - `reason: String` + + Optional reason for the decision. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class ResponseCustomToolCallOutput` + + The output of a custom tool call from your code, being sent back to the model. + + - `call_id: String` + + The call ID, used to map this custom tool call output to a custom tool call. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the custom tool call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the custom tool call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :custom_tool_call_output` + + The type of the custom tool call output. Always `custom_tool_call_output`. + + - `:custom_tool_call_output` + + - `id: String` + + The unique ID of the custom tool call output in the OpenAI platform. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `call_id: String` + + An identifier used to map this custom tool call to a tool call output. + + - `input: String` + + The input for the custom tool call generated by the model. + + - `name: String` + + The name of the custom tool being called. + + - `type: :custom_tool_call` + + The type of the custom tool call. Always `custom_tool_call`. + + - `:custom_tool_call` + + - `id: String` + + The unique ID of the custom tool call in the OpenAI platform. + + - `namespace: String` + + The namespace of the custom tool being called. + + - `class CompactionTrigger` + + Compacts the current context. Must be the final input item. + + - `type: :compaction_trigger` + + The type of the item. Always `compaction_trigger`. + + - `:compaction_trigger` + + - `class ItemReference` + + An internal identifier for an item to reference. + + - `id: String` + + The ID of the item to reference. + + - `type: :item_reference` + + The type of item to reference. Always `item_reference`. + + - `:item_reference` + +### Response Input Audio + +- `class ResponseInputAudio` + + An audio input to the model. + + - `input_audio: InputAudio{ data, format_}` + + - `data: String` + + Base64-encoded audio data. + + - `format_: :mp3 | :wav` + + The format of the audio data. Currently supported formats are `mp3` and + `wav`. + + - `:mp3` + + - `:wav` + + - `type: :input_audio` + + The type of the input item. Always `input_audio`. + + - `:input_audio` + +### Response Input Content + +- `ResponseInputContent = ResponseInputText | ResponseInputImage | ResponseInputFile` + + A text input to the model. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + +### Response Input File + +- `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + +### Response Input File Content + +- `class ResponseInputFileContent` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The base64-encoded data of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + +### Response Input Image + +- `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + +### Response Input Image Content + +- `class ResponseInputImageContent` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision) + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + +### Response Input Item + +- `ResponseInputItem = EasyInputMessage | Message{ content, role, status, type} | ResponseOutputMessage | 27 more` + + 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. + + - `class EasyInputMessage` + + 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. + + - `content: String | ResponseInputMessageContentList` + + Text, image, or audio input to the model, used to generate a response. + Can also contain previous assistant responses. + + - `String = String` + + A text input to the model. + + - `ResponseInputMessageContentList = Array[ResponseInputContent]` + + A list of one or many input items to the model, containing different content + types. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `role: :user | :assistant | :system | :developer` + + The role of the message input. One of `user`, `assistant`, `system`, or + `developer`. + + - `:user` + + - `:assistant` + + - `:system` + + - `:developer` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `type: :message` + + The type of the message input. Always `message`. + + - `:message` + + - `class Message` + + 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. + + - `content: ResponseInputMessageContentList` + + A list of one or many input items to the model, containing different content + types. + + - `role: :user | :system | :developer` + + The role of the message input. One of `user`, `system`, or `developer`. + + - `:user` + + - `:system` + + - `:developer` + + - `status: :in_progress | :completed | :incomplete` + + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the message input. Always set to `message`. + + - `:message` + + - `class ResponseOutputMessage` + + An output message from the model. + + - `id: String` + + The unique ID of the output message. + + - `content: Array[ResponseOutputText | ResponseOutputRefusal]` + + The content of the output message. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `role: :assistant` + + The role of the output message. Always `assistant`. + + - `:assistant` + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the output message. Always `message`. + + - `:message` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `class ResponseFileSearchToolCall` + + 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. + + - `id: String` + + The unique ID of the file search tool call. + + - `queries: Array[String]` + + The queries used to search for files. + + - `status: :in_progress | :searching | :completed | 2 more` + + The status of the file search tool call. One of `in_progress`, + `searching`, `incomplete` or `failed`, + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `type: :file_search_call` + + The type of the file search tool call. Always `file_search_call`. + + - `:file_search_call` + + - `results: Array[Result{ attributes, file_id, filename, 2 more}]` + + The results of the file search tool call. + + - `attributes: Hash[Symbol, String | Float | bool]` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. Keys are strings + with a maximum length of 64 characters. Values are strings with a maximum + length of 512 characters, booleans, or numbers. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `file_id: String` + + The unique ID of the file. + + - `filename: String` + + The name of the file. + + - `score: Float` + + The relevance score of the file - a value between 0 and 1. + + - `text: String` + + The text that was retrieved from the file. + + - `class ResponseComputerToolCall` + + 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. + + - `id: String` + + The unique ID of the computer call. + + - `call_id: String` + + An identifier used when responding to the tool call with output. + + - `pending_safety_checks: Array[PendingSafetyCheck{ id, code, message}]` + + The pending safety checks for the computer call. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :computer_call` + + The type of the computer call. Always `computer_call`. + + - `:computer_call` + + - `action: Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `actions: ComputerActionList` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `class ComputerCallOutput` + + The output of a computer tool call. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `id: String` + + The ID of the computer tool call output. + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionWebSearch` + + 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. + + - `id: String` + + The unique ID of the web search tool call. + + - `action: Search{ type, queries, query, sources} | OpenPage{ type, url} | FindInPage{ pattern, type, url}` + + An object describing the specific action taken in this web search call. + Includes details on how the model used the web (search, open_page, find_in_page). + + - `class Search` + + Action type "search" - Performs a web search query. + + - `type: :search` + + The action type. + + - `:search` + + - `queries: Array[String]` + + The search queries. + + - `query: String` + + The search query. + + - `sources: Array[Source{ type, url}]` + + The sources used in the search. + + - `type: :url` + + The type of source. Always `url`. + + - `:url` + + - `url: String` + + The URL of the source. + + - `class OpenPage` + + Action type "open_page" - Opens a specific URL from search results. + + - `type: :open_page` + + The action type. + + - `:open_page` + + - `url: String` + + The URL opened by the model. + + - `class FindInPage` + + Action type "find_in_page": Searches for a pattern within a loaded page. + + - `pattern: String` + + The pattern or text to search for within the page. + + - `type: :find_in_page` + + The action type. + + - `:find_in_page` + + - `url: String` + + The URL of the page searched for the pattern. + + - `status: :in_progress | :searching | :completed | :failed` + + The status of the web search tool call. + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:failed` + + - `type: :web_search_call` + + The type of the web search tool call. Always `web_search_call`. + + - `:web_search_call` + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `arguments: String` + + A JSON string of the arguments to pass to the function. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `name: String` + + The name of the function to run. + + - `type: :function_call` + + The type of the function tool call. Always `function_call`. + + - `:function_call` + + - `id: String` + + The unique ID of the function tool call. + + - `namespace: String` + + The namespace of the function to run. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class FunctionCallOutput` + + The output of a function tool call. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | ResponseFunctionCallOutputItemList` + + Text, image, or file output of the function tool call. + + - `String = String` + + A JSON string of the output of the function tool call. + + - `ResponseFunctionCallOutputItemList = Array[ResponseFunctionCallOutputItem]` + + An array of content outputs (text, image, file) for the function tool call. + + - `class ResponseInputTextContent` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImageContent` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision) + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFileContent` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The base64-encoded data of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `id: String` + + The unique ID of the function tool call output. Populated when this item is returned via API. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ToolSearchCall` + + - `arguments: untyped` + + The arguments supplied to the tool search call. + + - `type: :tool_search_call` + + The item type. Always `tool_search_call`. + + - `:tool_search_call` + + - `id: String` + + The unique ID of this tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseToolSearchOutputItemParam` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by the tool search output. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The item type. Always `tool_search_output`. + + - `:tool_search_output` + + - `id: String` + + The unique ID of this tool search output. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class AdditionalTools` + + - `role: :developer` + + The role that provided the additional tools. Only `developer` is supported. + + - `:developer` + + - `tools: Array[Tool]` + + A list of additional tools made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The item type. Always `additional_tools`. + + - `:additional_tools` + + - `id: String` + + The unique ID of this additional tools item. + + - `class ResponseReasoningItem` + + 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). + + - `id: String` + + The unique identifier of the reasoning content. + + - `summary: Array[Summary{ text, type}]` + + Reasoning summary content. + + - `text: String` + + A summary of the reasoning output from the model so far. + + - `type: :summary_text` + + The type of the object. Always `summary_text`. + + - `:summary_text` + + - `type: :reasoning` + + The type of the object. Always `reasoning`. + + - `:reasoning` + + - `content: Array[Content{ text, type}]` + + Reasoning text content. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `encrypted_content: String` + + The encrypted content of the reasoning item - populated when a response is + generated with `reasoning.encrypted_content` in the `include` parameter. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseCompactionItemParam` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `encrypted_content: String` + + The encrypted content of the compaction summary. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `id: String` + + The ID of the compaction item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `id: String` + + The unique ID of the code interpreter tool call. + + - `code: String` + + The code to run, or null if not available. + + - `container_id: String` + + The ID of the container used to run the code. + + - `outputs: Array[Logs{ logs, type} | Image{ type, url}]` + + The outputs generated by the code interpreter, such as logs or images. + Can be null if no outputs are available. + + - `class Logs` + + The logs output from the code interpreter. + + - `logs: String` + + The logs output from the code interpreter. + + - `type: :logs` + + The type of the output. Always `logs`. + + - `:logs` + + - `class Image` + + The image output from the code interpreter. + + - `type: :image` + + The type of the output. Always `image`. + + - `:image` + + - `url: String` + + The URL of the image output from the code interpreter. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:interpreting` + + - `:failed` + + - `type: :code_interpreter_call` + + The type of the code interpreter tool call. Always `code_interpreter_call`. + + - `:code_interpreter_call` + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCall` + + A tool representing a request to execute one or more shell commands. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + Ordered shell commands for the execution environment to run. + + - `max_output_length: Integer` + + Maximum number of UTF-8 characters to capture from combined stdout and stderr output. + + - `timeout_ms: Integer` + + Maximum wall-clock time in milliseconds to allow the shell commands to run. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `environment: LocalEnvironment | ContainerReference` + + The environment to execute the shell commands in. + + - `class LocalEnvironment` + + - `class ContainerReference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCallOutput` + + The streamed output items emitted by a shell tool call. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `output: Array[ResponseFunctionShellCallOutputContent]` + + Captured chunks of stdout and stderr output, along with their associated outcomes. + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + The exit or timeout outcome associated with this shell call. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + The exit code returned by the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + Captured stderr output for the shell call. + + - `stdout: String` + + Captured stdout output for the shell call. + + - `type: :shell_call_output` + + The type of the item. Always `shell_call_output`. + + - `:shell_call_output` + + - `id: String` + + The unique ID of the shell tool call output. Populated when this item is returned via API. + + - `max_output_length: Integer` + + The maximum number of UTF-8 characters captured for this shell call's combined output. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ApplyPatchCall` + + A tool call representing a request to create, delete, or update files using diff patches. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + The specific create, delete, or update instruction for the apply_patch tool call. + + - `class CreateFile` + + Instruction for creating a new file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply when creating the file. + + - `path: String` + + Path of the file to create relative to the workspace root. + + - `type: :create_file` + + The operation type. Always `create_file`. + + - `:create_file` + + - `class DeleteFile` + + Instruction for deleting an existing file via the apply_patch tool. + + - `path: String` + + Path of the file to delete relative to the workspace root. + + - `type: :delete_file` + + The operation type. Always `delete_file`. + + - `:delete_file` + + - `class UpdateFile` + + Instruction for updating an existing file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply to the existing file. + + - `path: String` + + Path of the file to update relative to the workspace root. + + - `type: :update_file` + + The operation type. Always `update_file`. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `class ApplyPatchCallOutput` + + The streamed output emitted by an apply patch tool call. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `output: String` + + Optional human-readable log text from the apply patch tool (e.g., patch results or errors). + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `id: String` + + The unique ID of the approval response + + - `reason: String` + + Optional reason for the decision. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class ResponseCustomToolCallOutput` + + The output of a custom tool call from your code, being sent back to the model. + + - `call_id: String` + + The call ID, used to map this custom tool call output to a custom tool call. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the custom tool call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the custom tool call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :custom_tool_call_output` + + The type of the custom tool call output. Always `custom_tool_call_output`. + + - `:custom_tool_call_output` + + - `id: String` + + The unique ID of the custom tool call output in the OpenAI platform. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `call_id: String` + + An identifier used to map this custom tool call to a tool call output. + + - `input: String` + + The input for the custom tool call generated by the model. + + - `name: String` + + The name of the custom tool being called. + + - `type: :custom_tool_call` + + The type of the custom tool call. Always `custom_tool_call`. + + - `:custom_tool_call` + + - `id: String` + + The unique ID of the custom tool call in the OpenAI platform. + + - `namespace: String` + + The namespace of the custom tool being called. + + - `class CompactionTrigger` + + Compacts the current context. Must be the final input item. + + - `type: :compaction_trigger` + + The type of the item. Always `compaction_trigger`. + + - `:compaction_trigger` + + - `class ItemReference` + + An internal identifier for an item to reference. + + - `id: String` + + The ID of the item to reference. + + - `type: :item_reference` + + The type of item to reference. Always `item_reference`. + + - `:item_reference` + +### Response Input Message Content List + +- `ResponseInputMessageContentList = Array[ResponseInputContent]` + + A list of one or many input items to the model, containing different content + types. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + +### Response Input Message Item + +- `class ResponseInputMessageItem` + + - `id: String` + + The unique ID of the message input. + + - `content: ResponseInputMessageContentList` + + A list of one or many input items to the model, containing different content + types. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `role: :user | :system | :developer` + + The role of the message input. One of `user`, `system`, or `developer`. + + - `:user` + + - `:system` + + - `:developer` + + - `type: :message` + + The type of the message input. Always set to `message`. + + - `:message` + + - `status: :in_progress | :completed | :incomplete` + + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + +### Response Input Text + +- `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + +### Response Input Text Content + +- `class ResponseInputTextContent` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + +### Response Item + +- `ResponseItem = ResponseInputMessageItem | ResponseOutputMessage | ResponseFileSearchToolCall | 24 more` + + Content item used to generate a response. + + - `class ResponseInputMessageItem` + + - `id: String` + + The unique ID of the message input. + + - `content: ResponseInputMessageContentList` + + A list of one or many input items to the model, containing different content + types. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `role: :user | :system | :developer` + + The role of the message input. One of `user`, `system`, or `developer`. + + - `:user` + + - `:system` + + - `:developer` + + - `type: :message` + + The type of the message input. Always set to `message`. + + - `:message` + + - `status: :in_progress | :completed | :incomplete` + + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseOutputMessage` + + An output message from the model. + + - `id: String` + + The unique ID of the output message. + + - `content: Array[ResponseOutputText | ResponseOutputRefusal]` + + The content of the output message. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `role: :assistant` + + The role of the output message. Always `assistant`. + + - `:assistant` + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the output message. Always `message`. + + - `:message` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `class ResponseFileSearchToolCall` + + 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. + + - `id: String` + + The unique ID of the file search tool call. + + - `queries: Array[String]` + + The queries used to search for files. + + - `status: :in_progress | :searching | :completed | 2 more` + + The status of the file search tool call. One of `in_progress`, + `searching`, `incomplete` or `failed`, + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `type: :file_search_call` + + The type of the file search tool call. Always `file_search_call`. + + - `:file_search_call` + + - `results: Array[Result{ attributes, file_id, filename, 2 more}]` + + The results of the file search tool call. + + - `attributes: Hash[Symbol, String | Float | bool]` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. Keys are strings + with a maximum length of 64 characters. Values are strings with a maximum + length of 512 characters, booleans, or numbers. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `file_id: String` + + The unique ID of the file. + + - `filename: String` + + The name of the file. + + - `score: Float` + + The relevance score of the file - a value between 0 and 1. + + - `text: String` + + The text that was retrieved from the file. + + - `class ResponseComputerToolCall` + + 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. + + - `id: String` + + The unique ID of the computer call. + + - `call_id: String` + + An identifier used when responding to the tool call with output. + + - `pending_safety_checks: Array[PendingSafetyCheck{ id, code, message}]` + + The pending safety checks for the computer call. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :computer_call` + + The type of the computer call. Always `computer_call`. + + - `:computer_call` + + - `action: Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `actions: ComputerActionList` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `class ResponseComputerToolCallOutputItem` + + - `id: String` + + The unique ID of the computer call tool output. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + + - `status: :completed | :incomplete | :failed | :in_progress` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `:in_progress` + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the + developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseFunctionWebSearch` + + 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. + + - `id: String` + + The unique ID of the web search tool call. + + - `action: Search{ type, queries, query, sources} | OpenPage{ type, url} | FindInPage{ pattern, type, url}` + + An object describing the specific action taken in this web search call. + Includes details on how the model used the web (search, open_page, find_in_page). + + - `class Search` + + Action type "search" - Performs a web search query. + + - `type: :search` + + The action type. + + - `:search` + + - `queries: Array[String]` + + The search queries. + + - `query: String` + + The search query. + + - `sources: Array[Source{ type, url}]` + + The sources used in the search. + + - `type: :url` + + The type of source. Always `url`. + + - `:url` + + - `url: String` + + The URL of the source. + + - `class OpenPage` + + Action type "open_page" - Opens a specific URL from search results. + + - `type: :open_page` + + The action type. + + - `:open_page` + + - `url: String` + + The URL opened by the model. + + - `class FindInPage` + + Action type "find_in_page": Searches for a pattern within a loaded page. + + - `pattern: String` + + The pattern or text to search for within the page. + + - `type: :find_in_page` + + The action type. + + - `:find_in_page` + + - `url: String` + + The URL of the page searched for the pattern. + + - `status: :in_progress | :searching | :completed | :failed` + + The status of the web search tool call. + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:failed` + + - `type: :web_search_call` + + The type of the web search tool call. Always `web_search_call`. + + - `:web_search_call` + + - `class ResponseFunctionToolCallItem` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `id: String` + + The unique ID of the function tool call. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseFunctionToolCallOutputItem` + + - `id: String` + + The unique ID of the function call tool output. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the function call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the function call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the function call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseToolSearchCall` + + - `id: String` + + The unique ID of the tool search call item. + + - `arguments: untyped` + + Arguments used for the tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :tool_search_call` + + The type of the item. Always `tool_search_call`. + + - `:tool_search_call` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseToolSearchOutputItem` + + - `id: String` + + The unique ID of the tool search output item. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by tool search. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The type of the item. Always `tool_search_output`. + + - `:tool_search_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class AdditionalTools` + + - `id: String` + + The unique ID of the additional tools item. + + - `role: :unknown | :user | :assistant | 5 more` + + The role that provided the additional tools. + + - `:unknown` + + - `:user` + + - `:assistant` + + - `:system` + + - `:critic` + + - `:discriminator` + + - `:developer` + + - `:tool` + + - `tools: Array[Tool]` + + The additional tool definitions made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The type of the item. Always `additional_tools`. + + - `:additional_tools` + + - `class ResponseReasoningItem` + + 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). + + - `id: String` + + The unique identifier of the reasoning content. + + - `summary: Array[Summary{ text, type}]` + + Reasoning summary content. + + - `text: String` + + A summary of the reasoning output from the model so far. + + - `type: :summary_text` + + The type of the object. Always `summary_text`. + + - `:summary_text` + + - `type: :reasoning` + + The type of the object. Always `reasoning`. + + - `:reasoning` + + - `content: Array[Content{ text, type}]` + + Reasoning text content. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `encrypted_content: String` + + The encrypted content of the reasoning item - populated when a response is + generated with `reasoning.encrypted_content` in the `include` parameter. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseCompactionItem` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `id: String` + + The unique ID of the compaction item. + + - `encrypted_content: String` + + The encrypted content that was produced by compaction. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `id: String` + + The unique ID of the code interpreter tool call. + + - `code: String` + + The code to run, or null if not available. + + - `container_id: String` + + The ID of the container used to run the code. + + - `outputs: Array[Logs{ logs, type} | Image{ type, url}]` + + The outputs generated by the code interpreter, such as logs or images. + Can be null if no outputs are available. + + - `class Logs` + + The logs output from the code interpreter. + + - `logs: String` + + The logs output from the code interpreter. + + - `type: :logs` + + The type of the output. Always `logs`. + + - `:logs` + + - `class Image` + + The image output from the code interpreter. + + - `type: :image` + + The type of the output. Always `image`. + + - `:image` + + - `url: String` + + The URL of the image output from the code interpreter. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:interpreting` + + - `:failed` + + - `type: :code_interpreter_call` + + The type of the code interpreter tool call. Always `code_interpreter_call`. + + - `:code_interpreter_call` + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionShellToolCall` + + A tool call that executes one or more shell commands in a managed environment. + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + - `max_output_length: Integer` + + Optional maximum number of characters to return from each command. + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the commands. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `environment: ResponseLocalEnvironment | ResponseContainerReference` + + Represents the use of a local environment to perform shell actions. + + - `class ResponseLocalEnvironment` + + Represents the use of a local environment to perform shell actions. + + - `type: :local` + + The environment type. Always `local`. + + - `:local` + + - `class ResponseContainerReference` + + Represents a container created with /v1/containers. + + - `container_id: String` + + - `type: :container_reference` + + The environment type. Always `container_reference`. + + - `:container_reference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseFunctionShellToolCallOutput` + + The output of a shell tool call that was emitted. + + - `id: String` + + The unique ID of the shell call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `max_output_length: Integer` + + The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output. + + - `output: Array[Output{ outcome, stderr, stdout, created_by}]` + + An array of shell call output contents + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + Exit code from the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + The standard error output that was captured. + + - `stdout: String` + + The standard output that was captured. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call_output` + + The type of the shell call output. Always `shell_call_output`. + + - `:shell_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseApplyPatchToolCall` + + A tool call that applies file diffs by creating, deleting, or updating files. + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + One of the create_file, delete_file, or update_file operations applied via apply_patch. + + - `class CreateFile` + + Instruction describing how to create a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to create. + + - `type: :create_file` + + Create a new file with the provided diff. + + - `:create_file` + + - `class DeleteFile` + + Instruction describing how to delete a file via the apply_patch tool. + + - `path: String` + + Path of the file to delete. + + - `type: :delete_file` + + Delete the specified file. + + - `:delete_file` + + - `class UpdateFile` + + Instruction describing how to update a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to update. + + - `type: :update_file` + + Update an existing file with the provided diff. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseApplyPatchToolCallOutput` + + The output emitted by an apply patch tool call. + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `created_by: String` + + The ID of the entity that created this tool call output. + + - `output: String` + + Optional textual output returned by the apply patch tool. + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `id: String` + + The unique ID of the approval response + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `reason: String` + + Optional reason for the decision. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class ResponseCustomToolCallItem` + + A call to a custom tool created by the model. + + - `id: String` + + The unique ID of the custom tool call item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseCustomToolCallOutputItem` + + The output of a custom tool call from your code, being sent back to the model. + + - `id: String` + + The unique ID of the custom tool call output item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + +### Response Local Environment + +- `class ResponseLocalEnvironment` + + Represents the use of a local environment to perform shell actions. + + - `type: :local` + + The environment type. Always `local`. + + - `:local` + +### Response Mcp Call Arguments Delta Event + +- `class ResponseMcpCallArgumentsDeltaEvent` + + Emitted when there is a delta (partial update) to the arguments of an MCP tool call. + + - `delta: String` + + A JSON string containing the partial update to the arguments for the MCP tool call. + + - `item_id: String` + + The unique identifier of the MCP tool call item being processed. + + - `output_index: Integer` + + The index of the output item in the response's output array. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.mcp_call_arguments.delta"` + + The type of the event. Always 'response.mcp_call_arguments.delta'. + + - `:"response.mcp_call_arguments.delta"` + +### Response Mcp Call Arguments Done Event + +- `class ResponseMcpCallArgumentsDoneEvent` + + Emitted when the arguments for an MCP tool call are finalized. + + - `arguments: String` + + A JSON string containing the finalized arguments for the MCP tool call. + + - `item_id: String` + + The unique identifier of the MCP tool call item being processed. + + - `output_index: Integer` + + The index of the output item in the response's output array. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.mcp_call_arguments.done"` + + The type of the event. Always 'response.mcp_call_arguments.done'. + + - `:"response.mcp_call_arguments.done"` + +### Response Mcp Call Completed Event + +- `class ResponseMcpCallCompletedEvent` + + Emitted when an MCP tool call has completed successfully. + + - `item_id: String` + + The ID of the MCP tool call item that completed. + + - `output_index: Integer` + + The index of the output item that completed. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.mcp_call.completed"` + + The type of the event. Always 'response.mcp_call.completed'. + + - `:"response.mcp_call.completed"` + +### Response Mcp Call Failed Event + +- `class ResponseMcpCallFailedEvent` + + Emitted when an MCP tool call has failed. + + - `item_id: String` + + The ID of the MCP tool call item that failed. + + - `output_index: Integer` + + The index of the output item that failed. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.mcp_call.failed"` + + The type of the event. Always 'response.mcp_call.failed'. + + - `:"response.mcp_call.failed"` + +### Response Mcp Call In Progress Event + +- `class ResponseMcpCallInProgressEvent` + + Emitted when an MCP tool call is in progress. + + - `item_id: String` + + The unique identifier of the MCP tool call item being processed. + + - `output_index: Integer` + + The index of the output item in the response's output array. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.mcp_call.in_progress"` + + The type of the event. Always 'response.mcp_call.in_progress'. + + - `:"response.mcp_call.in_progress"` + +### Response Mcp List Tools Completed Event + +- `class ResponseMcpListToolsCompletedEvent` + + Emitted when the list of available MCP tools has been successfully retrieved. + + - `item_id: String` + + The ID of the MCP tool call item that produced this output. + + - `output_index: Integer` + + The index of the output item that was processed. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.mcp_list_tools.completed"` + + The type of the event. Always 'response.mcp_list_tools.completed'. + + - `:"response.mcp_list_tools.completed"` + +### Response Mcp List Tools Failed Event + +- `class ResponseMcpListToolsFailedEvent` + + Emitted when the attempt to list available MCP tools has failed. + + - `item_id: String` + + The ID of the MCP tool call item that failed. + + - `output_index: Integer` + + The index of the output item that failed. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.mcp_list_tools.failed"` + + The type of the event. Always 'response.mcp_list_tools.failed'. + + - `:"response.mcp_list_tools.failed"` + +### Response Mcp List Tools In Progress Event + +- `class ResponseMcpListToolsInProgressEvent` + + Emitted when the system is in the process of retrieving the list of available MCP tools. + + - `item_id: String` + + The ID of the MCP tool call item that is being processed. + + - `output_index: Integer` + + The index of the output item that is being processed. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.mcp_list_tools.in_progress"` + + The type of the event. Always 'response.mcp_list_tools.in_progress'. + + - `:"response.mcp_list_tools.in_progress"` + +### Response Output Audio + +- `class ResponseOutputAudio` + + An audio output from the model. + + - `data: String` + + Base64-encoded audio data from the model. + + - `transcript: String` + + The transcript of the audio data from the model. + + - `type: :output_audio` + + The type of the output audio. Always `output_audio`. + + - `:output_audio` + +### Response Output Item + +- `ResponseOutputItem = ResponseOutputMessage | ResponseFileSearchToolCall | ResponseFunctionToolCall | 23 more` + + An output message from the model. + + - `class ResponseOutputMessage` + + An output message from the model. + + - `id: String` + + The unique ID of the output message. + + - `content: Array[ResponseOutputText | ResponseOutputRefusal]` + + The content of the output message. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `role: :assistant` + + The role of the output message. Always `assistant`. + + - `:assistant` + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the output message. Always `message`. + + - `:message` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `class ResponseFileSearchToolCall` + + 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. + + - `id: String` + + The unique ID of the file search tool call. + + - `queries: Array[String]` + + The queries used to search for files. + + - `status: :in_progress | :searching | :completed | 2 more` + + The status of the file search tool call. One of `in_progress`, + `searching`, `incomplete` or `failed`, + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `type: :file_search_call` + + The type of the file search tool call. Always `file_search_call`. + + - `:file_search_call` + + - `results: Array[Result{ attributes, file_id, filename, 2 more}]` + + The results of the file search tool call. + + - `attributes: Hash[Symbol, String | Float | bool]` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. Keys are strings + with a maximum length of 64 characters. Values are strings with a maximum + length of 512 characters, booleans, or numbers. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `file_id: String` + + The unique ID of the file. + + - `filename: String` + + The name of the file. + + - `score: Float` + + The relevance score of the file - a value between 0 and 1. + + - `text: String` + + The text that was retrieved from the file. + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `arguments: String` + + A JSON string of the arguments to pass to the function. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `name: String` + + The name of the function to run. + + - `type: :function_call` + + The type of the function tool call. Always `function_call`. + + - `:function_call` + + - `id: String` + + The unique ID of the function tool call. + + - `namespace: String` + + The namespace of the function to run. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionToolCallOutputItem` + + - `id: String` + + The unique ID of the function call tool output. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the function call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the function call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the function call. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseFunctionWebSearch` + + 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. + + - `id: String` + + The unique ID of the web search tool call. + + - `action: Search{ type, queries, query, sources} | OpenPage{ type, url} | FindInPage{ pattern, type, url}` + + An object describing the specific action taken in this web search call. + Includes details on how the model used the web (search, open_page, find_in_page). + + - `class Search` + + Action type "search" - Performs a web search query. + + - `type: :search` + + The action type. + + - `:search` + + - `queries: Array[String]` + + The search queries. + + - `query: String` + + The search query. + + - `sources: Array[Source{ type, url}]` + + The sources used in the search. + + - `type: :url` + + The type of source. Always `url`. + + - `:url` + + - `url: String` + + The URL of the source. + + - `class OpenPage` + + Action type "open_page" - Opens a specific URL from search results. + + - `type: :open_page` + + The action type. + + - `:open_page` + + - `url: String` + + The URL opened by the model. + + - `class FindInPage` + + Action type "find_in_page": Searches for a pattern within a loaded page. + + - `pattern: String` + + The pattern or text to search for within the page. + + - `type: :find_in_page` + + The action type. + + - `:find_in_page` + + - `url: String` + + The URL of the page searched for the pattern. + + - `status: :in_progress | :searching | :completed | :failed` + + The status of the web search tool call. + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:failed` + + - `type: :web_search_call` + + The type of the web search tool call. Always `web_search_call`. + + - `:web_search_call` + + - `class ResponseComputerToolCall` + + 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. + + - `id: String` + + The unique ID of the computer call. + + - `call_id: String` + + An identifier used when responding to the tool call with output. + + - `pending_safety_checks: Array[PendingSafetyCheck{ id, code, message}]` + + The pending safety checks for the computer call. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :computer_call` + + The type of the computer call. Always `computer_call`. + + - `:computer_call` + + - `action: Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `actions: ComputerActionList` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `class ResponseComputerToolCallOutputItem` + + - `id: String` + + The unique ID of the computer call tool output. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + + - `status: :completed | :incomplete | :failed | :in_progress` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `:in_progress` + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the + developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseReasoningItem` + + 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). + + - `id: String` + + The unique identifier of the reasoning content. + + - `summary: Array[Summary{ text, type}]` + + Reasoning summary content. + + - `text: String` + + A summary of the reasoning output from the model so far. + + - `type: :summary_text` + + The type of the object. Always `summary_text`. + + - `:summary_text` + + - `type: :reasoning` + + The type of the object. Always `reasoning`. + + - `:reasoning` + + - `content: Array[Content{ text, type}]` + + Reasoning text content. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `encrypted_content: String` + + The encrypted content of the reasoning item - populated when a response is + generated with `reasoning.encrypted_content` in the `include` parameter. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseToolSearchCall` + + - `id: String` + + The unique ID of the tool search call item. + + - `arguments: untyped` + + Arguments used for the tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :tool_search_call` + + The type of the item. Always `tool_search_call`. + + - `:tool_search_call` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseToolSearchOutputItem` + + - `id: String` + + The unique ID of the tool search output item. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by tool search. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The type of the item. Always `tool_search_output`. + + - `:tool_search_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class AdditionalTools` + + - `id: String` + + The unique ID of the additional tools item. + + - `role: :unknown | :user | :assistant | 5 more` + + The role that provided the additional tools. + + - `:unknown` + + - `:user` + + - `:assistant` + + - `:system` + + - `:critic` + + - `:discriminator` + + - `:developer` + + - `:tool` + + - `tools: Array[Tool]` + + The additional tool definitions made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The type of the item. Always `additional_tools`. + + - `:additional_tools` + + - `class ResponseCompactionItem` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `id: String` + + The unique ID of the compaction item. + + - `encrypted_content: String` + + The encrypted content that was produced by compaction. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `id: String` + + The unique ID of the code interpreter tool call. + + - `code: String` + + The code to run, or null if not available. + + - `container_id: String` + + The ID of the container used to run the code. + + - `outputs: Array[Logs{ logs, type} | Image{ type, url}]` + + The outputs generated by the code interpreter, such as logs or images. + Can be null if no outputs are available. + + - `class Logs` + + The logs output from the code interpreter. + + - `logs: String` + + The logs output from the code interpreter. + + - `type: :logs` + + The type of the output. Always `logs`. + + - `:logs` + + - `class Image` + + The image output from the code interpreter. + + - `type: :image` + + The type of the output. Always `image`. + + - `:image` + + - `url: String` + + The URL of the image output from the code interpreter. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:interpreting` + + - `:failed` + + - `type: :code_interpreter_call` + + The type of the code interpreter tool call. Always `code_interpreter_call`. + + - `:code_interpreter_call` + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionShellToolCall` + + A tool call that executes one or more shell commands in a managed environment. + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + - `max_output_length: Integer` + + Optional maximum number of characters to return from each command. + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the commands. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `environment: ResponseLocalEnvironment | ResponseContainerReference` + + Represents the use of a local environment to perform shell actions. + + - `class ResponseLocalEnvironment` + + Represents the use of a local environment to perform shell actions. + + - `type: :local` + + The environment type. Always `local`. + + - `:local` + + - `class ResponseContainerReference` + + Represents a container created with /v1/containers. + + - `container_id: String` + + - `type: :container_reference` + + The environment type. Always `container_reference`. + + - `:container_reference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseFunctionShellToolCallOutput` + + The output of a shell tool call that was emitted. + + - `id: String` + + The unique ID of the shell call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `max_output_length: Integer` + + The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output. + + - `output: Array[Output{ outcome, stderr, stdout, created_by}]` + + An array of shell call output contents + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + Exit code from the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + The standard error output that was captured. + + - `stdout: String` + + The standard output that was captured. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call_output` + + The type of the shell call output. Always `shell_call_output`. + + - `:shell_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseApplyPatchToolCall` + + A tool call that applies file diffs by creating, deleting, or updating files. + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + One of the create_file, delete_file, or update_file operations applied via apply_patch. + + - `class CreateFile` + + Instruction describing how to create a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to create. + + - `type: :create_file` + + Create a new file with the provided diff. + + - `:create_file` + + - `class DeleteFile` + + Instruction describing how to delete a file via the apply_patch tool. + + - `path: String` + + Path of the file to delete. + + - `type: :delete_file` + + Delete the specified file. + + - `:delete_file` + + - `class UpdateFile` + + Instruction describing how to update a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to update. + + - `type: :update_file` + + Update an existing file with the provided diff. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseApplyPatchToolCallOutput` + + The output emitted by an apply patch tool call. + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `created_by: String` + + The ID of the entity that created this tool call output. + + - `output: String` + + Optional textual output returned by the apply patch tool. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `id: String` + + The unique ID of the approval response + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `reason: String` + + Optional reason for the decision. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `call_id: String` + + An identifier used to map this custom tool call to a tool call output. + + - `input: String` + + The input for the custom tool call generated by the model. + + - `name: String` + + The name of the custom tool being called. + + - `type: :custom_tool_call` + + The type of the custom tool call. Always `custom_tool_call`. + + - `:custom_tool_call` + + - `id: String` + + The unique ID of the custom tool call in the OpenAI platform. + + - `namespace: String` + + The namespace of the custom tool being called. + + - `class ResponseCustomToolCallOutputItem` + + The output of a custom tool call from your code, being sent back to the model. + + - `id: String` + + The unique ID of the custom tool call output item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + +### Response Output Item Added Event + +- `class ResponseOutputItemAddedEvent` + + Emitted when a new output item is added. + + - `item: ResponseOutputItem` + + The output item that was added. + + - `class ResponseOutputMessage` + + An output message from the model. + + - `id: String` + + The unique ID of the output message. + + - `content: Array[ResponseOutputText | ResponseOutputRefusal]` + + The content of the output message. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `role: :assistant` + + The role of the output message. Always `assistant`. + + - `:assistant` + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the output message. Always `message`. + + - `:message` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `class ResponseFileSearchToolCall` + + 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. + + - `id: String` + + The unique ID of the file search tool call. + + - `queries: Array[String]` + + The queries used to search for files. + + - `status: :in_progress | :searching | :completed | 2 more` + + The status of the file search tool call. One of `in_progress`, + `searching`, `incomplete` or `failed`, + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `type: :file_search_call` + + The type of the file search tool call. Always `file_search_call`. + + - `:file_search_call` + + - `results: Array[Result{ attributes, file_id, filename, 2 more}]` + + The results of the file search tool call. + + - `attributes: Hash[Symbol, String | Float | bool]` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. Keys are strings + with a maximum length of 64 characters. Values are strings with a maximum + length of 512 characters, booleans, or numbers. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `file_id: String` + + The unique ID of the file. + + - `filename: String` + + The name of the file. + + - `score: Float` + + The relevance score of the file - a value between 0 and 1. + + - `text: String` + + The text that was retrieved from the file. + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `arguments: String` + + A JSON string of the arguments to pass to the function. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `name: String` + + The name of the function to run. + + - `type: :function_call` + + The type of the function tool call. Always `function_call`. + + - `:function_call` + + - `id: String` + + The unique ID of the function tool call. + + - `namespace: String` + + The namespace of the function to run. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionToolCallOutputItem` + + - `id: String` + + The unique ID of the function call tool output. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the function call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the function call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the function call. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseFunctionWebSearch` + + 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. + + - `id: String` + + The unique ID of the web search tool call. + + - `action: Search{ type, queries, query, sources} | OpenPage{ type, url} | FindInPage{ pattern, type, url}` + + An object describing the specific action taken in this web search call. + Includes details on how the model used the web (search, open_page, find_in_page). + + - `class Search` + + Action type "search" - Performs a web search query. + + - `type: :search` + + The action type. + + - `:search` + + - `queries: Array[String]` + + The search queries. + + - `query: String` + + The search query. + + - `sources: Array[Source{ type, url}]` + + The sources used in the search. + + - `type: :url` + + The type of source. Always `url`. + + - `:url` + + - `url: String` + + The URL of the source. + + - `class OpenPage` + + Action type "open_page" - Opens a specific URL from search results. + + - `type: :open_page` + + The action type. + + - `:open_page` + + - `url: String` + + The URL opened by the model. + + - `class FindInPage` + + Action type "find_in_page": Searches for a pattern within a loaded page. + + - `pattern: String` + + The pattern or text to search for within the page. + + - `type: :find_in_page` + + The action type. + + - `:find_in_page` + + - `url: String` + + The URL of the page searched for the pattern. + + - `status: :in_progress | :searching | :completed | :failed` + + The status of the web search tool call. + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:failed` + + - `type: :web_search_call` + + The type of the web search tool call. Always `web_search_call`. + + - `:web_search_call` + + - `class ResponseComputerToolCall` + + 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. + + - `id: String` + + The unique ID of the computer call. + + - `call_id: String` + + An identifier used when responding to the tool call with output. + + - `pending_safety_checks: Array[PendingSafetyCheck{ id, code, message}]` + + The pending safety checks for the computer call. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :computer_call` + + The type of the computer call. Always `computer_call`. + + - `:computer_call` + + - `action: Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `actions: ComputerActionList` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `class ResponseComputerToolCallOutputItem` + + - `id: String` + + The unique ID of the computer call tool output. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + + - `status: :completed | :incomplete | :failed | :in_progress` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `:in_progress` + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the + developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseReasoningItem` + + 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). + + - `id: String` + + The unique identifier of the reasoning content. + + - `summary: Array[Summary{ text, type}]` + + Reasoning summary content. + + - `text: String` + + A summary of the reasoning output from the model so far. + + - `type: :summary_text` + + The type of the object. Always `summary_text`. + + - `:summary_text` + + - `type: :reasoning` + + The type of the object. Always `reasoning`. + + - `:reasoning` + + - `content: Array[Content{ text, type}]` + + Reasoning text content. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `encrypted_content: String` + + The encrypted content of the reasoning item - populated when a response is + generated with `reasoning.encrypted_content` in the `include` parameter. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseToolSearchCall` + + - `id: String` + + The unique ID of the tool search call item. + + - `arguments: untyped` + + Arguments used for the tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :tool_search_call` + + The type of the item. Always `tool_search_call`. + + - `:tool_search_call` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseToolSearchOutputItem` + + - `id: String` + + The unique ID of the tool search output item. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by tool search. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The type of the item. Always `tool_search_output`. + + - `:tool_search_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class AdditionalTools` + + - `id: String` + + The unique ID of the additional tools item. + + - `role: :unknown | :user | :assistant | 5 more` + + The role that provided the additional tools. + + - `:unknown` + + - `:user` + + - `:assistant` + + - `:system` + + - `:critic` + + - `:discriminator` + + - `:developer` + + - `:tool` + + - `tools: Array[Tool]` + + The additional tool definitions made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The type of the item. Always `additional_tools`. + + - `:additional_tools` + + - `class ResponseCompactionItem` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `id: String` + + The unique ID of the compaction item. + + - `encrypted_content: String` + + The encrypted content that was produced by compaction. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `id: String` + + The unique ID of the code interpreter tool call. + + - `code: String` + + The code to run, or null if not available. + + - `container_id: String` + + The ID of the container used to run the code. + + - `outputs: Array[Logs{ logs, type} | Image{ type, url}]` + + The outputs generated by the code interpreter, such as logs or images. + Can be null if no outputs are available. + + - `class Logs` + + The logs output from the code interpreter. + + - `logs: String` + + The logs output from the code interpreter. + + - `type: :logs` + + The type of the output. Always `logs`. + + - `:logs` + + - `class Image` + + The image output from the code interpreter. + + - `type: :image` + + The type of the output. Always `image`. + + - `:image` + + - `url: String` + + The URL of the image output from the code interpreter. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:interpreting` + + - `:failed` + + - `type: :code_interpreter_call` + + The type of the code interpreter tool call. Always `code_interpreter_call`. + + - `:code_interpreter_call` + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionShellToolCall` + + A tool call that executes one or more shell commands in a managed environment. + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + - `max_output_length: Integer` + + Optional maximum number of characters to return from each command. + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the commands. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `environment: ResponseLocalEnvironment | ResponseContainerReference` + + Represents the use of a local environment to perform shell actions. + + - `class ResponseLocalEnvironment` + + Represents the use of a local environment to perform shell actions. + + - `type: :local` + + The environment type. Always `local`. + + - `:local` + + - `class ResponseContainerReference` + + Represents a container created with /v1/containers. + + - `container_id: String` + + - `type: :container_reference` + + The environment type. Always `container_reference`. + + - `:container_reference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseFunctionShellToolCallOutput` + + The output of a shell tool call that was emitted. + + - `id: String` + + The unique ID of the shell call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `max_output_length: Integer` + + The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output. + + - `output: Array[Output{ outcome, stderr, stdout, created_by}]` + + An array of shell call output contents + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + Exit code from the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + The standard error output that was captured. + + - `stdout: String` + + The standard output that was captured. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call_output` + + The type of the shell call output. Always `shell_call_output`. + + - `:shell_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseApplyPatchToolCall` + + A tool call that applies file diffs by creating, deleting, or updating files. + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + One of the create_file, delete_file, or update_file operations applied via apply_patch. + + - `class CreateFile` + + Instruction describing how to create a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to create. + + - `type: :create_file` + + Create a new file with the provided diff. + + - `:create_file` + + - `class DeleteFile` + + Instruction describing how to delete a file via the apply_patch tool. + + - `path: String` + + Path of the file to delete. + + - `type: :delete_file` + + Delete the specified file. + + - `:delete_file` + + - `class UpdateFile` + + Instruction describing how to update a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to update. + + - `type: :update_file` + + Update an existing file with the provided diff. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseApplyPatchToolCallOutput` + + The output emitted by an apply patch tool call. + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `created_by: String` + + The ID of the entity that created this tool call output. + + - `output: String` + + Optional textual output returned by the apply patch tool. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `id: String` + + The unique ID of the approval response + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `reason: String` + + Optional reason for the decision. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `call_id: String` + + An identifier used to map this custom tool call to a tool call output. + + - `input: String` + + The input for the custom tool call generated by the model. + + - `name: String` + + The name of the custom tool being called. + + - `type: :custom_tool_call` + + The type of the custom tool call. Always `custom_tool_call`. + + - `:custom_tool_call` + + - `id: String` + + The unique ID of the custom tool call in the OpenAI platform. + + - `namespace: String` + + The namespace of the custom tool being called. + + - `class ResponseCustomToolCallOutputItem` + + The output of a custom tool call from your code, being sent back to the model. + + - `id: String` + + The unique ID of the custom tool call output item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `output_index: Integer` + + The index of the output item that was added. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.output_item.added"` + + The type of the event. Always `response.output_item.added`. + + - `:"response.output_item.added"` + +### Response Output Item Done Event + +- `class ResponseOutputItemDoneEvent` + + Emitted when an output item is marked done. + + - `item: ResponseOutputItem` + + The output item that was marked done. + + - `class ResponseOutputMessage` + + An output message from the model. + + - `id: String` + + The unique ID of the output message. + + - `content: Array[ResponseOutputText | ResponseOutputRefusal]` + + The content of the output message. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `role: :assistant` + + The role of the output message. Always `assistant`. + + - `:assistant` + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the output message. Always `message`. + + - `:message` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `class ResponseFileSearchToolCall` + + 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. + + - `id: String` + + The unique ID of the file search tool call. + + - `queries: Array[String]` + + The queries used to search for files. + + - `status: :in_progress | :searching | :completed | 2 more` + + The status of the file search tool call. One of `in_progress`, + `searching`, `incomplete` or `failed`, + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `type: :file_search_call` + + The type of the file search tool call. Always `file_search_call`. + + - `:file_search_call` + + - `results: Array[Result{ attributes, file_id, filename, 2 more}]` + + The results of the file search tool call. + + - `attributes: Hash[Symbol, String | Float | bool]` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. Keys are strings + with a maximum length of 64 characters. Values are strings with a maximum + length of 512 characters, booleans, or numbers. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `file_id: String` + + The unique ID of the file. + + - `filename: String` + + The name of the file. + + - `score: Float` + + The relevance score of the file - a value between 0 and 1. + + - `text: String` + + The text that was retrieved from the file. + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `arguments: String` + + A JSON string of the arguments to pass to the function. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `name: String` + + The name of the function to run. + + - `type: :function_call` + + The type of the function tool call. Always `function_call`. + + - `:function_call` + + - `id: String` + + The unique ID of the function tool call. + + - `namespace: String` + + The namespace of the function to run. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionToolCallOutputItem` + + - `id: String` + + The unique ID of the function call tool output. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the function call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the function call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the function call. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseFunctionWebSearch` + + 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. + + - `id: String` + + The unique ID of the web search tool call. + + - `action: Search{ type, queries, query, sources} | OpenPage{ type, url} | FindInPage{ pattern, type, url}` + + An object describing the specific action taken in this web search call. + Includes details on how the model used the web (search, open_page, find_in_page). + + - `class Search` + + Action type "search" - Performs a web search query. + + - `type: :search` + + The action type. + + - `:search` + + - `queries: Array[String]` + + The search queries. + + - `query: String` + + The search query. + + - `sources: Array[Source{ type, url}]` + + The sources used in the search. + + - `type: :url` + + The type of source. Always `url`. + + - `:url` + + - `url: String` + + The URL of the source. + + - `class OpenPage` + + Action type "open_page" - Opens a specific URL from search results. + + - `type: :open_page` + + The action type. + + - `:open_page` + + - `url: String` + + The URL opened by the model. + + - `class FindInPage` + + Action type "find_in_page": Searches for a pattern within a loaded page. + + - `pattern: String` + + The pattern or text to search for within the page. + + - `type: :find_in_page` + + The action type. + + - `:find_in_page` + + - `url: String` + + The URL of the page searched for the pattern. + + - `status: :in_progress | :searching | :completed | :failed` + + The status of the web search tool call. + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:failed` + + - `type: :web_search_call` + + The type of the web search tool call. Always `web_search_call`. + + - `:web_search_call` + + - `class ResponseComputerToolCall` + + 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. + + - `id: String` + + The unique ID of the computer call. + + - `call_id: String` + + An identifier used when responding to the tool call with output. + + - `pending_safety_checks: Array[PendingSafetyCheck{ id, code, message}]` + + The pending safety checks for the computer call. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :computer_call` + + The type of the computer call. Always `computer_call`. + + - `:computer_call` + + - `action: Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `actions: ComputerActionList` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `class ResponseComputerToolCallOutputItem` + + - `id: String` + + The unique ID of the computer call tool output. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + + - `status: :completed | :incomplete | :failed | :in_progress` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `:in_progress` + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the + developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseReasoningItem` + + 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). + + - `id: String` + + The unique identifier of the reasoning content. + + - `summary: Array[Summary{ text, type}]` + + Reasoning summary content. + + - `text: String` + + A summary of the reasoning output from the model so far. + + - `type: :summary_text` + + The type of the object. Always `summary_text`. + + - `:summary_text` + + - `type: :reasoning` + + The type of the object. Always `reasoning`. + + - `:reasoning` + + - `content: Array[Content{ text, type}]` + + Reasoning text content. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `encrypted_content: String` + + The encrypted content of the reasoning item - populated when a response is + generated with `reasoning.encrypted_content` in the `include` parameter. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseToolSearchCall` + + - `id: String` + + The unique ID of the tool search call item. + + - `arguments: untyped` + + Arguments used for the tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :tool_search_call` + + The type of the item. Always `tool_search_call`. + + - `:tool_search_call` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseToolSearchOutputItem` + + - `id: String` + + The unique ID of the tool search output item. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by tool search. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The type of the item. Always `tool_search_output`. + + - `:tool_search_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class AdditionalTools` + + - `id: String` + + The unique ID of the additional tools item. + + - `role: :unknown | :user | :assistant | 5 more` + + The role that provided the additional tools. + + - `:unknown` + + - `:user` + + - `:assistant` + + - `:system` + + - `:critic` + + - `:discriminator` + + - `:developer` + + - `:tool` + + - `tools: Array[Tool]` + + The additional tool definitions made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The type of the item. Always `additional_tools`. + + - `:additional_tools` + + - `class ResponseCompactionItem` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `id: String` + + The unique ID of the compaction item. + + - `encrypted_content: String` + + The encrypted content that was produced by compaction. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `id: String` + + The unique ID of the code interpreter tool call. + + - `code: String` + + The code to run, or null if not available. + + - `container_id: String` + + The ID of the container used to run the code. + + - `outputs: Array[Logs{ logs, type} | Image{ type, url}]` + + The outputs generated by the code interpreter, such as logs or images. + Can be null if no outputs are available. + + - `class Logs` + + The logs output from the code interpreter. + + - `logs: String` + + The logs output from the code interpreter. + + - `type: :logs` + + The type of the output. Always `logs`. + + - `:logs` + + - `class Image` + + The image output from the code interpreter. + + - `type: :image` + + The type of the output. Always `image`. + + - `:image` + + - `url: String` + + The URL of the image output from the code interpreter. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:interpreting` + + - `:failed` + + - `type: :code_interpreter_call` + + The type of the code interpreter tool call. Always `code_interpreter_call`. + + - `:code_interpreter_call` + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionShellToolCall` + + A tool call that executes one or more shell commands in a managed environment. + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + - `max_output_length: Integer` + + Optional maximum number of characters to return from each command. + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the commands. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `environment: ResponseLocalEnvironment | ResponseContainerReference` + + Represents the use of a local environment to perform shell actions. + + - `class ResponseLocalEnvironment` + + Represents the use of a local environment to perform shell actions. + + - `type: :local` + + The environment type. Always `local`. + + - `:local` + + - `class ResponseContainerReference` + + Represents a container created with /v1/containers. + + - `container_id: String` + + - `type: :container_reference` + + The environment type. Always `container_reference`. + + - `:container_reference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseFunctionShellToolCallOutput` + + The output of a shell tool call that was emitted. + + - `id: String` + + The unique ID of the shell call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `max_output_length: Integer` + + The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output. + + - `output: Array[Output{ outcome, stderr, stdout, created_by}]` + + An array of shell call output contents + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + Exit code from the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + The standard error output that was captured. + + - `stdout: String` + + The standard output that was captured. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call_output` + + The type of the shell call output. Always `shell_call_output`. + + - `:shell_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseApplyPatchToolCall` + + A tool call that applies file diffs by creating, deleting, or updating files. + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + One of the create_file, delete_file, or update_file operations applied via apply_patch. + + - `class CreateFile` + + Instruction describing how to create a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to create. + + - `type: :create_file` + + Create a new file with the provided diff. + + - `:create_file` + + - `class DeleteFile` + + Instruction describing how to delete a file via the apply_patch tool. + + - `path: String` + + Path of the file to delete. + + - `type: :delete_file` + + Delete the specified file. + + - `:delete_file` + + - `class UpdateFile` + + Instruction describing how to update a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to update. + + - `type: :update_file` + + Update an existing file with the provided diff. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseApplyPatchToolCallOutput` + + The output emitted by an apply patch tool call. + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `created_by: String` + + The ID of the entity that created this tool call output. + + - `output: String` + + Optional textual output returned by the apply patch tool. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `id: String` + + The unique ID of the approval response + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `reason: String` + + Optional reason for the decision. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `call_id: String` + + An identifier used to map this custom tool call to a tool call output. + + - `input: String` + + The input for the custom tool call generated by the model. + + - `name: String` + + The name of the custom tool being called. + + - `type: :custom_tool_call` + + The type of the custom tool call. Always `custom_tool_call`. + + - `:custom_tool_call` + + - `id: String` + + The unique ID of the custom tool call in the OpenAI platform. + + - `namespace: String` + + The namespace of the custom tool being called. + + - `class ResponseCustomToolCallOutputItem` + + The output of a custom tool call from your code, being sent back to the model. + + - `id: String` + + The unique ID of the custom tool call output item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `output_index: Integer` + + The index of the output item that was marked done. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.output_item.done"` + + The type of the event. Always `response.output_item.done`. + + - `:"response.output_item.done"` + +### Response Output Message + +- `class ResponseOutputMessage` + + An output message from the model. + + - `id: String` + + The unique ID of the output message. + + - `content: Array[ResponseOutputText | ResponseOutputRefusal]` + + The content of the output message. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `role: :assistant` + + The role of the output message. Always `assistant`. + + - `:assistant` + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the output message. Always `message`. + + - `:message` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + +### Response Output Refusal + +- `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + +### Response Output Text + +- `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + +### Response Output Text Annotation Added Event + +- `class ResponseOutputTextAnnotationAddedEvent` + + Emitted when an annotation is added to output text content. + + - `annotation: untyped` + + The annotation object being added. (See annotation schema for details.) + + - `annotation_index: Integer` + + The index of the annotation within the content part. + + - `content_index: Integer` + + The index of the content part within the output item. + + - `item_id: String` + + The unique identifier of the item to which the annotation is being added. + + - `output_index: Integer` + + The index of the output item in the response's output array. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.output_text.annotation.added"` + + The type of the event. Always 'response.output_text.annotation.added'. + + - `:"response.output_text.annotation.added"` + +### Response Prompt + +- `class ResponsePrompt` + + Reference to a prompt template and its variables. + [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts). + + - `id: String` + + The unique identifier of the prompt template to use. + + - `variables: Hash[Symbol, String | ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Optional map of values to substitute in for variables in your + prompt. The substitution values can either be strings, or other + Response input types like images or files. + + - `String = String` + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `version: String` + + Optional version of the prompt template. + +### Response Queued Event + +- `class ResponseQueuedEvent` + + Emitted when a response is queued and waiting to be processed. + + - `response: Response` + + The full response object that is queued. + + - `id: String` + + Unique identifier for this Response. + + - `created_at: Float` + + Unix timestamp (in seconds) of when this Response was created. + + - `error: ResponseError` + + An error object returned when the model fails to generate a Response. + + - `code: :server_error | :rate_limit_exceeded | :invalid_prompt | 15 more` + + The error code for the response. + + - `: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` + + - `message: String` + + A human-readable description of the error. + + - `incomplete_details: IncompleteDetails{ reason}` + + Details about why the response is incomplete. + + - `reason: :max_output_tokens | :content_filter` + + The reason why the response is incomplete. + + - `:max_output_tokens` + + - `:content_filter` + + - `instructions: String | Array[ResponseInputItem]` + + A system (or developer) message inserted into the model's context. + + When using along with `previous_response_id`, the instructions from a previous + response will not be carried over to the next response. This makes it simple + to swap out system (or developer) messages in new responses. + + - `String = String` + + A text input to the model, equivalent to a text input with the + `developer` role. + + - `InputItemList = Array[ResponseInputItem]` + + A list of one or many input items to the model, containing + different content types. + + - `class EasyInputMessage` + + 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. + + - `content: String | ResponseInputMessageContentList` + + Text, image, or audio input to the model, used to generate a response. + Can also contain previous assistant responses. + + - `String = String` + + A text input to the model. + + - `ResponseInputMessageContentList = Array[ResponseInputContent]` + + A list of one or many input items to the model, containing different content + types. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `role: :user | :assistant | :system | :developer` + + The role of the message input. One of `user`, `assistant`, `system`, or + `developer`. + + - `:user` + + - `:assistant` + + - `:system` + + - `:developer` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `type: :message` + + The type of the message input. Always `message`. + + - `:message` + + - `class Message` + + 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. + + - `content: ResponseInputMessageContentList` + + A list of one or many input items to the model, containing different content + types. + + - `role: :user | :system | :developer` + + The role of the message input. One of `user`, `system`, or `developer`. + + - `:user` + + - `:system` + + - `:developer` + + - `status: :in_progress | :completed | :incomplete` + + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the message input. Always set to `message`. + + - `:message` + + - `class ResponseOutputMessage` + + An output message from the model. + + - `id: String` + + The unique ID of the output message. + + - `content: Array[ResponseOutputText | ResponseOutputRefusal]` + + The content of the output message. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `role: :assistant` + + The role of the output message. Always `assistant`. + + - `:assistant` + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the output message. Always `message`. + + - `:message` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `class ResponseFileSearchToolCall` + + 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. + + - `id: String` + + The unique ID of the file search tool call. + + - `queries: Array[String]` + + The queries used to search for files. + + - `status: :in_progress | :searching | :completed | 2 more` + + The status of the file search tool call. One of `in_progress`, + `searching`, `incomplete` or `failed`, + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `type: :file_search_call` + + The type of the file search tool call. Always `file_search_call`. + + - `:file_search_call` + + - `results: Array[Result{ attributes, file_id, filename, 2 more}]` + + The results of the file search tool call. + + - `attributes: Hash[Symbol, String | Float | bool]` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. Keys are strings + with a maximum length of 64 characters. Values are strings with a maximum + length of 512 characters, booleans, or numbers. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `file_id: String` + + The unique ID of the file. + + - `filename: String` + + The name of the file. + + - `score: Float` + + The relevance score of the file - a value between 0 and 1. + + - `text: String` + + The text that was retrieved from the file. + + - `class ResponseComputerToolCall` + + 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. + + - `id: String` + + The unique ID of the computer call. + + - `call_id: String` + + An identifier used when responding to the tool call with output. + + - `pending_safety_checks: Array[PendingSafetyCheck{ id, code, message}]` + + The pending safety checks for the computer call. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :computer_call` + + The type of the computer call. Always `computer_call`. + + - `:computer_call` + + - `action: Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `actions: ComputerActionList` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `class ComputerCallOutput` + + The output of a computer tool call. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `id: String` + + The ID of the computer tool call output. + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionWebSearch` + + 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. + + - `id: String` + + The unique ID of the web search tool call. + + - `action: Search{ type, queries, query, sources} | OpenPage{ type, url} | FindInPage{ pattern, type, url}` + + An object describing the specific action taken in this web search call. + Includes details on how the model used the web (search, open_page, find_in_page). + + - `class Search` + + Action type "search" - Performs a web search query. + + - `type: :search` + + The action type. + + - `:search` + + - `queries: Array[String]` + + The search queries. + + - `query: String` + + The search query. + + - `sources: Array[Source{ type, url}]` + + The sources used in the search. + + - `type: :url` + + The type of source. Always `url`. + + - `:url` + + - `url: String` + + The URL of the source. + + - `class OpenPage` + + Action type "open_page" - Opens a specific URL from search results. + + - `type: :open_page` + + The action type. + + - `:open_page` + + - `url: String` + + The URL opened by the model. + + - `class FindInPage` + + Action type "find_in_page": Searches for a pattern within a loaded page. + + - `pattern: String` + + The pattern or text to search for within the page. + + - `type: :find_in_page` + + The action type. + + - `:find_in_page` + + - `url: String` + + The URL of the page searched for the pattern. + + - `status: :in_progress | :searching | :completed | :failed` + + The status of the web search tool call. + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:failed` + + - `type: :web_search_call` + + The type of the web search tool call. Always `web_search_call`. + + - `:web_search_call` + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `arguments: String` + + A JSON string of the arguments to pass to the function. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `name: String` + + The name of the function to run. + + - `type: :function_call` + + The type of the function tool call. Always `function_call`. + + - `:function_call` + + - `id: String` + + The unique ID of the function tool call. + + - `namespace: String` + + The namespace of the function to run. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class FunctionCallOutput` + + The output of a function tool call. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | ResponseFunctionCallOutputItemList` + + Text, image, or file output of the function tool call. + + - `String = String` + + A JSON string of the output of the function tool call. + + - `ResponseFunctionCallOutputItemList = Array[ResponseFunctionCallOutputItem]` + + An array of content outputs (text, image, file) for the function tool call. + + - `class ResponseInputTextContent` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImageContent` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision) + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFileContent` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The base64-encoded data of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `id: String` + + The unique ID of the function tool call output. Populated when this item is returned via API. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ToolSearchCall` + + - `arguments: untyped` + + The arguments supplied to the tool search call. + + - `type: :tool_search_call` + + The item type. Always `tool_search_call`. + + - `:tool_search_call` + + - `id: String` + + The unique ID of this tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseToolSearchOutputItemParam` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by the tool search output. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The item type. Always `tool_search_output`. + + - `:tool_search_output` + + - `id: String` + + The unique ID of this tool search output. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class AdditionalTools` + + - `role: :developer` + + The role that provided the additional tools. Only `developer` is supported. + + - `:developer` + + - `tools: Array[Tool]` + + A list of additional tools made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The item type. Always `additional_tools`. + + - `:additional_tools` + + - `id: String` + + The unique ID of this additional tools item. + + - `class ResponseReasoningItem` + + 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). + + - `id: String` + + The unique identifier of the reasoning content. + + - `summary: Array[Summary{ text, type}]` + + Reasoning summary content. + + - `text: String` + + A summary of the reasoning output from the model so far. + + - `type: :summary_text` + + The type of the object. Always `summary_text`. + + - `:summary_text` + + - `type: :reasoning` + + The type of the object. Always `reasoning`. + + - `:reasoning` + + - `content: Array[Content{ text, type}]` + + Reasoning text content. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `encrypted_content: String` + + The encrypted content of the reasoning item - populated when a response is + generated with `reasoning.encrypted_content` in the `include` parameter. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseCompactionItemParam` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `encrypted_content: String` + + The encrypted content of the compaction summary. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `id: String` + + The ID of the compaction item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `id: String` + + The unique ID of the code interpreter tool call. + + - `code: String` + + The code to run, or null if not available. + + - `container_id: String` + + The ID of the container used to run the code. + + - `outputs: Array[Logs{ logs, type} | Image{ type, url}]` + + The outputs generated by the code interpreter, such as logs or images. + Can be null if no outputs are available. + + - `class Logs` + + The logs output from the code interpreter. + + - `logs: String` + + The logs output from the code interpreter. + + - `type: :logs` + + The type of the output. Always `logs`. + + - `:logs` + + - `class Image` + + The image output from the code interpreter. + + - `type: :image` + + The type of the output. Always `image`. + + - `:image` + + - `url: String` + + The URL of the image output from the code interpreter. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:interpreting` + + - `:failed` + + - `type: :code_interpreter_call` + + The type of the code interpreter tool call. Always `code_interpreter_call`. + + - `:code_interpreter_call` + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCall` + + A tool representing a request to execute one or more shell commands. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + Ordered shell commands for the execution environment to run. + + - `max_output_length: Integer` + + Maximum number of UTF-8 characters to capture from combined stdout and stderr output. + + - `timeout_ms: Integer` + + Maximum wall-clock time in milliseconds to allow the shell commands to run. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `environment: LocalEnvironment | ContainerReference` + + The environment to execute the shell commands in. + + - `class LocalEnvironment` + + - `class ContainerReference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCallOutput` + + The streamed output items emitted by a shell tool call. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `output: Array[ResponseFunctionShellCallOutputContent]` + + Captured chunks of stdout and stderr output, along with their associated outcomes. + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + The exit or timeout outcome associated with this shell call. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + The exit code returned by the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + Captured stderr output for the shell call. + + - `stdout: String` + + Captured stdout output for the shell call. + + - `type: :shell_call_output` + + The type of the item. Always `shell_call_output`. + + - `:shell_call_output` + + - `id: String` + + The unique ID of the shell tool call output. Populated when this item is returned via API. + + - `max_output_length: Integer` + + The maximum number of UTF-8 characters captured for this shell call's combined output. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ApplyPatchCall` + + A tool call representing a request to create, delete, or update files using diff patches. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + The specific create, delete, or update instruction for the apply_patch tool call. + + - `class CreateFile` + + Instruction for creating a new file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply when creating the file. + + - `path: String` + + Path of the file to create relative to the workspace root. + + - `type: :create_file` + + The operation type. Always `create_file`. + + - `:create_file` + + - `class DeleteFile` + + Instruction for deleting an existing file via the apply_patch tool. + + - `path: String` + + Path of the file to delete relative to the workspace root. + + - `type: :delete_file` + + The operation type. Always `delete_file`. + + - `:delete_file` + + - `class UpdateFile` + + Instruction for updating an existing file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply to the existing file. + + - `path: String` + + Path of the file to update relative to the workspace root. + + - `type: :update_file` + + The operation type. Always `update_file`. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `class ApplyPatchCallOutput` + + The streamed output emitted by an apply patch tool call. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `output: String` + + Optional human-readable log text from the apply patch tool (e.g., patch results or errors). + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `id: String` + + The unique ID of the approval response + + - `reason: String` + + Optional reason for the decision. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class ResponseCustomToolCallOutput` + + The output of a custom tool call from your code, being sent back to the model. + + - `call_id: String` + + The call ID, used to map this custom tool call output to a custom tool call. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the custom tool call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the custom tool call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :custom_tool_call_output` + + The type of the custom tool call output. Always `custom_tool_call_output`. + + - `:custom_tool_call_output` + + - `id: String` + + The unique ID of the custom tool call output in the OpenAI platform. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `call_id: String` + + An identifier used to map this custom tool call to a tool call output. + + - `input: String` + + The input for the custom tool call generated by the model. + + - `name: String` + + The name of the custom tool being called. + + - `type: :custom_tool_call` + + The type of the custom tool call. Always `custom_tool_call`. + + - `:custom_tool_call` + + - `id: String` + + The unique ID of the custom tool call in the OpenAI platform. + + - `namespace: String` + + The namespace of the custom tool being called. + + - `class CompactionTrigger` + + Compacts the current context. Must be the final input item. + + - `type: :compaction_trigger` + + The type of the item. Always `compaction_trigger`. + + - `:compaction_trigger` + + - `class ItemReference` + + An internal identifier for an item to reference. + + - `id: String` + + The ID of the item to reference. + + - `type: :item_reference` + + The type of item to reference. Always `item_reference`. + + - `:item_reference` + + - `metadata: Metadata` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. + + Keys are strings with a maximum length of 64 characters. Values are strings + with a maximum length of 512 characters. + + - `model: ResponsesModel` + + Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI + offers a wide range of models with different capabilities, performance + characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) + to browse and compare available models. + + - `String = String` + + - `ChatModel = :"gpt-5.4" | :"gpt-5.4-mini" | :"gpt-5.4-nano" | 75 more` + + - `:"gpt-5.4"` + + - `:"gpt-5.4-mini"` + + - `:"gpt-5.4-nano"` + + - `:"gpt-5.4-mini-2026-03-17"` + + - `:"gpt-5.4-nano-2026-03-17"` + + - `:"gpt-5.3-chat-latest"` + + - `:"gpt-5.2"` + + - `:"gpt-5.2-2025-12-11"` + + - `:"gpt-5.2-chat-latest"` + + - `:"gpt-5.2-pro"` + + - `:"gpt-5.2-pro-2025-12-11"` + + - `:"gpt-5.1"` + + - `:"gpt-5.1-2025-11-13"` + + - `:"gpt-5.1-codex"` + + - `:"gpt-5.1-mini"` + + - `:"gpt-5.1-chat-latest"` + + - `:"gpt-5"` + + - `:"gpt-5-mini"` + + - `:"gpt-5-nano"` + + - `:"gpt-5-2025-08-07"` + + - `:"gpt-5-mini-2025-08-07"` + + - `:"gpt-5-nano-2025-08-07"` + + - `:"gpt-5-chat-latest"` + + - `:"gpt-4.1"` + + - `:"gpt-4.1-mini"` + + - `:"gpt-4.1-nano"` + + - `:"gpt-4.1-2025-04-14"` + + - `:"gpt-4.1-mini-2025-04-14"` + + - `:"gpt-4.1-nano-2025-04-14"` + + - `:"o4-mini"` + + - `:"o4-mini-2025-04-16"` + + - `:o3` + + - `:"o3-2025-04-16"` + + - `:"o3-mini"` + + - `:"o3-mini-2025-01-31"` + + - `:o1` + + - `:"o1-2024-12-17"` + + - `:"o1-preview"` + + - `:"o1-preview-2024-09-12"` + + - `:"o1-mini"` + + - `:"o1-mini-2024-09-12"` + + - `:"gpt-4o"` + + - `:"gpt-4o-2024-11-20"` + + - `:"gpt-4o-2024-08-06"` + + - `:"gpt-4o-2024-05-13"` + + - `:"gpt-4o-audio-preview"` + + - `:"gpt-4o-audio-preview-2024-10-01"` + + - `:"gpt-4o-audio-preview-2024-12-17"` + + - `:"gpt-4o-audio-preview-2025-06-03"` + + - `:"gpt-4o-mini-audio-preview"` + + - `:"gpt-4o-mini-audio-preview-2024-12-17"` + + - `:"gpt-4o-search-preview"` + + - `:"gpt-4o-mini-search-preview"` + + - `:"gpt-4o-search-preview-2025-03-11"` + + - `:"gpt-4o-mini-search-preview-2025-03-11"` + + - `:"chatgpt-4o-latest"` + + - `:"codex-mini-latest"` + + - `:"gpt-4o-mini"` + + - `:"gpt-4o-mini-2024-07-18"` + + - `:"gpt-4-turbo"` + + - `:"gpt-4-turbo-2024-04-09"` + + - `:"gpt-4-0125-preview"` + + - `:"gpt-4-turbo-preview"` + + - `:"gpt-4-1106-preview"` + + - `:"gpt-4-vision-preview"` + + - `:"gpt-4"` + + - `:"gpt-4-0314"` + + - `:"gpt-4-0613"` + + - `:"gpt-4-32k"` + + - `:"gpt-4-32k-0314"` + + - `:"gpt-4-32k-0613"` + + - `:"gpt-3.5-turbo"` + + - `:"gpt-3.5-turbo-16k"` + + - `:"gpt-3.5-turbo-0301"` + + - `:"gpt-3.5-turbo-0613"` + + - `:"gpt-3.5-turbo-1106"` + + - `:"gpt-3.5-turbo-0125"` + + - `:"gpt-3.5-turbo-16k-0613"` + + - `ResponsesOnlyModel = :"o1-pro" | :"o1-pro-2025-03-19" | :"o3-pro" | 11 more` + + - `:"o1-pro"` + + - `:"o1-pro-2025-03-19"` + + - `:"o3-pro"` + + - `:"o3-pro-2025-06-10"` + + - `:"o3-deep-research"` + + - `:"o3-deep-research-2025-06-26"` + + - `:"o4-mini-deep-research"` + + - `:"o4-mini-deep-research-2025-06-26"` + + - `:"computer-use-preview"` + + - `:"computer-use-preview-2025-03-11"` + + - `:"gpt-5-codex"` + + - `:"gpt-5-pro"` + + - `:"gpt-5-pro-2025-10-06"` + + - `:"gpt-5.1-codex-max"` + + - `object: :response` + + The object type of this resource - always set to `response`. + + - `:response` + + - `output: Array[ResponseOutputItem]` + + An array of content items generated by the model. + + - The length and order of items in the `output` array is dependent + on the model's response. + - Rather than accessing the first item in the `output` array and + assuming it's an `assistant` message with the content generated by + the model, you might consider using the `output_text` property where + supported in SDKs. + + - `class ResponseOutputMessage` + + An output message from the model. + + - `class ResponseFileSearchToolCall` + + 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. + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `class ResponseFunctionToolCallOutputItem` + + - `id: String` + + The unique ID of the function call tool output. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the function call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the function call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the function call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseFunctionWebSearch` + + 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. + + - `class ResponseComputerToolCall` + + 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. + + - `class ResponseComputerToolCallOutputItem` + + - `id: String` + + The unique ID of the computer call tool output. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `status: :completed | :incomplete | :failed | :in_progress` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `:in_progress` + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the + developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseReasoningItem` + + 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). + + - `class ResponseToolSearchCall` + + - `id: String` + + The unique ID of the tool search call item. + + - `arguments: untyped` + + Arguments used for the tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :tool_search_call` + + The type of the item. Always `tool_search_call`. + + - `:tool_search_call` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseToolSearchOutputItem` + + - `id: String` + + The unique ID of the tool search output item. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by tool search. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :tool_search_output` + + The type of the item. Always `tool_search_output`. + + - `:tool_search_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class AdditionalTools` + + - `id: String` + + The unique ID of the additional tools item. + + - `role: :unknown | :user | :assistant | 5 more` + + The role that provided the additional tools. + + - `:unknown` + + - `:user` + + - `:assistant` + + - `:system` + + - `:critic` + + - `:discriminator` + + - `:developer` + + - `:tool` + + - `tools: Array[Tool]` + + The additional tool definitions made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The type of the item. Always `additional_tools`. + + - `:additional_tools` + + - `class ResponseCompactionItem` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `id: String` + + The unique ID of the compaction item. + + - `encrypted_content: String` + + The encrypted content that was produced by compaction. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionShellToolCall` + + A tool call that executes one or more shell commands in a managed environment. + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + - `max_output_length: Integer` + + Optional maximum number of characters to return from each command. + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the commands. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `environment: ResponseLocalEnvironment | ResponseContainerReference` + + Represents the use of a local environment to perform shell actions. + + - `class ResponseLocalEnvironment` + + Represents the use of a local environment to perform shell actions. + + - `type: :local` + + The environment type. Always `local`. + + - `:local` + + - `class ResponseContainerReference` + + Represents a container created with /v1/containers. + + - `container_id: String` + + - `type: :container_reference` + + The environment type. Always `container_reference`. + + - `:container_reference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseFunctionShellToolCallOutput` + + The output of a shell tool call that was emitted. + + - `id: String` + + The unique ID of the shell call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `max_output_length: Integer` + + The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output. + + - `output: Array[Output{ outcome, stderr, stdout, created_by}]` + + An array of shell call output contents + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + Exit code from the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + The standard error output that was captured. + + - `stdout: String` + + The standard output that was captured. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call_output` + + The type of the shell call output. Always `shell_call_output`. + + - `:shell_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseApplyPatchToolCall` + + A tool call that applies file diffs by creating, deleting, or updating files. + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + One of the create_file, delete_file, or update_file operations applied via apply_patch. + + - `class CreateFile` + + Instruction describing how to create a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to create. + + - `type: :create_file` + + Create a new file with the provided diff. + + - `:create_file` + + - `class DeleteFile` + + Instruction describing how to delete a file via the apply_patch tool. + + - `path: String` + + Path of the file to delete. + + - `type: :delete_file` + + Delete the specified file. + + - `:delete_file` + + - `class UpdateFile` + + Instruction describing how to update a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to update. + + - `type: :update_file` + + Update an existing file with the provided diff. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseApplyPatchToolCallOutput` + + The output emitted by an apply patch tool call. + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `created_by: String` + + The ID of the entity that created this tool call output. + + - `output: String` + + Optional textual output returned by the apply patch tool. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `id: String` + + The unique ID of the approval response + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `reason: String` + + Optional reason for the decision. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `class ResponseCustomToolCallOutputItem` + + The output of a custom tool call from your code, being sent back to the model. + + - `id: String` + + The unique ID of the custom tool call output item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `parallel_tool_calls: bool` + + Whether to allow the model to run tool calls in parallel. + + - `temperature: Float` + + 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. + + - `tool_choice: ToolChoiceOptions | ToolChoiceAllowed | ToolChoiceTypes | 5 more` + + How the model should select which tool (or tools) to use when generating + a response. See the `tools` parameter to see how to specify which tools + the model can call. + + - `ToolChoiceOptions = :none | :auto | :required` + + Controls which (if any) tool is called by the model. + + `none` means the model will not call any tool and instead generates a message. + + `auto` means the model can pick between generating a message or calling one or + more tools. + + `required` means the model must call one or more tools. + + - `:none` + + - `:auto` + + - `:required` + + - `class ToolChoiceAllowed` + + Constrains the tools available to the model to a pre-defined set. + + - `mode: :auto | :required` + + Constrains the tools available to the model to a pre-defined set. + + `auto` allows the model to pick from among the allowed tools and generate a + message. + + `required` requires the model to call one or more of the allowed tools. + + - `:auto` + + - `:required` + + - `tools: Array[Hash[Symbol, untyped]]` + + A list of tool definitions that the model should be allowed to call. + + For the Responses API, the list of tool definitions might look like: + + ```json + [ + { "type": "function", "name": "get_weather" }, + { "type": "mcp", "server_label": "deepwiki" }, + { "type": "image_generation" } + ] + ``` + + - `type: :allowed_tools` + + Allowed tool configuration type. Always `allowed_tools`. + + - `:allowed_tools` + + - `class ToolChoiceTypes` + + 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). + + - `type: :file_search | :web_search_preview | :computer | 5 more` + + The type of hosted tool the model should to use. Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + + Allowed values are: + + - `file_search` + - `web_search_preview` + - `computer` + - `computer_use_preview` + - `computer_use` + - `code_interpreter` + - `image_generation` + + - `:file_search` + + - `:web_search_preview` + + - `:computer` + + - `:computer_use_preview` + + - `:computer_use` + + - `:web_search_preview_2025_03_11` + + - `:image_generation` + + - `:code_interpreter` + + - `class ToolChoiceFunction` + + Use this option to force the model to call a specific function. + + - `name: String` + + The name of the function to call. + + - `type: :function` + + For function calling, the type is always `function`. + + - `:function` + + - `class ToolChoiceMcp` + + Use this option to force the model to call a specific tool on a remote MCP server. + + - `server_label: String` + + The label of the MCP server to use. + + - `type: :mcp` + + For MCP tools, the type is always `mcp`. + + - `:mcp` + + - `name: String` + + The name of the tool to call on the server. + + - `class ToolChoiceCustom` + + Use this option to force the model to call a specific custom tool. + + - `name: String` + + The name of the custom tool to call. + + - `type: :custom` + + For custom tool calling, the type is always `custom`. + + - `:custom` + + - `class ToolChoiceApplyPatch` + + Forces the model to call the apply_patch tool when executing a tool call. + + - `type: :apply_patch` + + The tool to call. Always `apply_patch`. + + - `:apply_patch` + + - `class ToolChoiceShell` + + Forces the model to call the shell tool when a tool call is required. + + - `type: :shell` + + The tool to call. Always `shell`. + + - `:shell` + + - `tools: Array[Tool]` + + An array of tools the model may call while generating a response. You + can specify which tool to use by setting the `tool_choice` parameter. + + We support the following categories of tools: + + - **Built-in tools**: Tools that are provided by OpenAI that extend the + model's capabilities, like [web search](https://platform.openai.com/docs/guides/tools-web-search) + or [file search](https://platform.openai.com/docs/guides/tools-file-search). Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + - **MCP Tools**: Integrations with third-party systems via custom MCP servers + or predefined connectors such as Google Drive and SharePoint. Learn more about + [MCP Tools](https://platform.openai.com/docs/guides/tools-connectors-mcp). + - **Function calls (custom tools)**: Functions that are defined by you, + enabling the model to call your own code with strongly typed arguments + and outputs. Learn more about + [function calling](https://platform.openai.com/docs/guides/function-calling). You can also use + custom tools to call your own code. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `top_p: Float` + + 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. + + - `background: bool` + + Whether to run the model response in the background. + [Learn more](https://platform.openai.com/docs/guides/background). + + - `completed_at: Float` + + Unix timestamp (in seconds) of when this Response was completed. + Only present when the status is `completed`. + + - `conversation: Conversation{ id}` + + The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation. + + - `id: String` + + The unique ID of the conversation that this response was associated with. + + - `max_output_tokens: Integer` + + An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://platform.openai.com/docs/guides/reasoning). + + - `max_tool_calls: Integer` + + 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. + + - `moderation: Moderation{ input, output}` + + Moderation results for the response input and output, if moderated completions were requested. + + - `input: ModerationResult{ categories, category_applied_input_types, category_scores, 3 more} | Error{ code, message, type}` + + Moderation for the response input. + + - `class ModerationResult` + + A moderation result produced for the response input or output. + + - `categories: Hash[Symbol, bool]` + + A dictionary of moderation categories to booleans, True if the input is flagged under this category. + + - `category_applied_input_types: Hash[Symbol, Array[:text | :image]]` + + Which modalities of input are reflected by the score for each category. + + - `:text` + + - `:image` + + - `category_scores: Hash[Symbol, Float]` + + A dictionary of moderation categories to scores. + + - `flagged: bool` + + A boolean indicating whether the content was flagged by any category. + + - `model: String` + + The moderation model that produced this result. + + - `type: :moderation_result` + + The object type, which was always `moderation_result` for successful moderation results. + + - `:moderation_result` + + - `class Error` + + An error produced while attempting moderation for the response input or output. + + - `code: String` + + The error code. + + - `message: String` + + The error message. + + - `type: :error` + + The object type, which was always `error` for moderation failures. + + - `:error` + + - `output: ModerationResult{ categories, category_applied_input_types, category_scores, 3 more} | Error{ code, message, type}` + + Moderation for the response output. + + - `class ModerationResult` + + A moderation result produced for the response input or output. + + - `categories: Hash[Symbol, bool]` + + A dictionary of moderation categories to booleans, True if the input is flagged under this category. + + - `category_applied_input_types: Hash[Symbol, Array[:text | :image]]` + + Which modalities of input are reflected by the score for each category. + + - `:text` + + - `:image` + + - `category_scores: Hash[Symbol, Float]` + + A dictionary of moderation categories to scores. + + - `flagged: bool` + + A boolean indicating whether the content was flagged by any category. + + - `model: String` + + The moderation model that produced this result. + + - `type: :moderation_result` + + The object type, which was always `moderation_result` for successful moderation results. + + - `:moderation_result` + + - `class Error` + + An error produced while attempting moderation for the response input or output. + + - `code: String` + + The error code. + + - `message: String` + + The error message. + + - `type: :error` + + The object type, which was always `error` for moderation failures. + + - `:error` + + - `previous_response_id: String` + + The unique ID of the previous response to the model. Use this to + create multi-turn conversations. Learn more about + [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. + + - `prompt: ResponsePrompt` + + Reference to a prompt template and its variables. + [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts). + + - `id: String` + + The unique identifier of the prompt template to use. + + - `variables: Hash[Symbol, String | ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Optional map of values to substitute in for variables in your + prompt. The substitution values can either be strings, or other + Response input types like images or files. + + - `String = String` + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `version: String` + + Optional version of the prompt template. + + - `prompt_cache_key: String` + + Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://platform.openai.com/docs/guides/prompt-caching). + + - `prompt_cache_retention: :in_memory | :"24h"` + + The retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention). + For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported. + + For older models that support both `in_memory` and `24h`, the default depends on your organization's data retention policy: + + - Organizations without ZDR enabled default to `24h`. + - Organizations with ZDR enabled default to `in_memory` when `prompt_cache_retention` is not specified. + + - `:in_memory` + + - `:"24h"` + + - `reasoning: Reasoning` + + **gpt-5 and o-series models only** + + Configuration options for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + + - `effort: ReasoningEffort` + + Constrains effort on reasoning for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing + reasoning effort can result in faster responses and fewer tokens used + on reasoning in a response. + + - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1. + - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. + - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. + - `xhigh` is supported for all models after `gpt-5.1-codex-max`. + + - `:none` + + - `:minimal` + + - `:low` + + - `:medium` + + - `:high` + + - `:xhigh` + + - `generate_summary: :auto | :concise | :detailed` + + **Deprecated:** use `summary` instead. + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `summary: :auto | :concise | :detailed` + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + `concise` is supported for `computer-use-preview` models and all reasoning models after `gpt-5`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `safety_identifier: String` + + A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + + - `service_tier: :auto | :default | :flex | 2 more` + + Specifies the processing type used for serving the request. + + - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. + - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. + - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier. + - When not set, the default behavior is 'auto'. + + When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter. + + - `:auto` + + - `:default` + + - `:flex` + + - `:scale` + + - `:priority` + + - `status: ResponseStatus` + + The status of the response generation. One of `completed`, `failed`, + `in_progress`, `cancelled`, `queued`, or `incomplete`. + + - `:completed` + + - `:failed` + + - `:in_progress` + + - `:cancelled` + + - `:queued` + + - `:incomplete` + + - `text: ResponseTextConfig` + + 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) + + - `format_: ResponseFormatTextConfig` + + An object specifying the format that the model must output. + + Configuring `{ "type": "json_schema" }` enables Structured Outputs, + which ensures the model will match your supplied JSON schema. Learn more in the + [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). + + The default format is `{ "type": "text" }` with no additional options. + + **Not recommended for gpt-4o and newer models:** + + Setting to `{ "type": "json_object" }` enables the older JSON mode, which + ensures the message the model generates is valid JSON. Using `json_schema` + is preferred for models that support it. + + - `class ResponseFormatText` + + Default response format. Used to generate text responses. + + - `type: :text` + + The type of response format being defined. Always `text`. + + - `:text` + + - `class ResponseFormatTextJSONSchemaConfig` + + JSON Schema response format. Used to generate structured JSON responses. + Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). + + - `name: String` + + The name of the response format. Must be a-z, A-Z, 0-9, or contain + underscores and dashes, with a maximum length of 64. + + - `schema: Hash[Symbol, untyped]` + + The schema for the response format, described as a JSON Schema object. + Learn how to build JSON schemas [here](https://json-schema.org/). + + - `type: :json_schema` + + The type of response format being defined. Always `json_schema`. + + - `:json_schema` + + - `description: String` + + A description of what the response format is for, used by the model to + determine how to respond in the format. + + - `strict: bool` + + Whether to enable strict schema adherence when generating the output. + If set to true, the model will always follow the exact schema defined + in the `schema` field. Only a subset of JSON Schema is supported when + `strict` is `true`. To learn more, read the [Structured Outputs + guide](https://platform.openai.com/docs/guides/structured-outputs). + + - `class ResponseFormatJSONObject` + + 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. + + - `type: :json_object` + + The type of response format being defined. Always `json_object`. + + - `:json_object` + + - `verbosity: :low | :medium | :high` + + Constrains the verbosity of the model's response. Lower values will result in + more concise responses, while higher values will result in more verbose responses. + Currently supported values are `low`, `medium`, and `high`. + + - `:low` + + - `:medium` + + - `:high` + + - `top_logprobs: Integer` + + An integer between 0 and 20 specifying the maximum number of most likely + tokens to return at each token position, each with an associated log + probability. In some cases, the number of returned tokens may be fewer than + requested. + + - `truncation: :auto | :disabled` + + The truncation strategy to use for the model response. + + - `auto`: If the input to this Response exceeds + the model's context window size, the model will truncate the + response to fit the context window by dropping items from the beginning of the conversation. + - `disabled` (default): If the input size will exceed the context window + size for a model, the request will fail with a 400 error. + + - `:auto` + + - `:disabled` + + - `usage: ResponseUsage` + + Represents token usage details including input tokens, output tokens, + a breakdown of output tokens, and the total tokens used. + + - `input_tokens: Integer` + + The number of input tokens. + + - `input_tokens_details: InputTokensDetails{ cached_tokens}` + + A detailed breakdown of the input tokens. + + - `cached_tokens: Integer` + + The number of tokens that were retrieved from the cache. + [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching). + + - `output_tokens: Integer` + + The number of output tokens. + + - `output_tokens_details: OutputTokensDetails{ reasoning_tokens}` + + A detailed breakdown of the output tokens. + + - `reasoning_tokens: Integer` + + The number of reasoning tokens. + + - `total_tokens: Integer` + + The total number of tokens used. + + - `user: String` + + This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. + A stable identifier for your end-users. + Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + + - `sequence_number: Integer` + + The sequence number for this event. + + - `type: :"response.queued"` + + The type of the event. Always 'response.queued'. + + - `:"response.queued"` + +### Response Reasoning Item + +- `class ResponseReasoningItem` + + 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). + + - `id: String` + + The unique identifier of the reasoning content. + + - `summary: Array[Summary{ text, type}]` + + Reasoning summary content. + + - `text: String` + + A summary of the reasoning output from the model so far. + + - `type: :summary_text` + + The type of the object. Always `summary_text`. + + - `:summary_text` + + - `type: :reasoning` + + The type of the object. Always `reasoning`. + + - `:reasoning` + + - `content: Array[Content{ text, type}]` + + Reasoning text content. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `encrypted_content: String` + + The encrypted content of the reasoning item - populated when a response is + generated with `reasoning.encrypted_content` in the `include` parameter. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + +### Response Reasoning Summary Part Added Event + +- `class ResponseReasoningSummaryPartAddedEvent` + + Emitted when a new reasoning summary part is added. + + - `item_id: String` + + The ID of the item this summary part is associated with. + + - `output_index: Integer` + + The index of the output item this summary part is associated with. + + - `part: Part{ text, type}` + + The summary part that was added. + + - `text: String` + + The text of the summary part. + + - `type: :summary_text` + + The type of the summary part. Always `summary_text`. + + - `:summary_text` + + - `sequence_number: Integer` + + The sequence number of this event. + + - `summary_index: Integer` + + The index of the summary part within the reasoning summary. + + - `type: :"response.reasoning_summary_part.added"` + + The type of the event. Always `response.reasoning_summary_part.added`. + + - `:"response.reasoning_summary_part.added"` + +### Response Reasoning Summary Part Done Event + +- `class ResponseReasoningSummaryPartDoneEvent` + + Emitted when a reasoning summary part is completed. + + - `item_id: String` + + The ID of the item this summary part is associated with. + + - `output_index: Integer` + + The index of the output item this summary part is associated with. + + - `part: Part{ text, type}` + + The completed summary part. + + - `text: String` + + The text of the summary part. + + - `type: :summary_text` + + The type of the summary part. Always `summary_text`. + + - `:summary_text` + + - `sequence_number: Integer` + + The sequence number of this event. + + - `summary_index: Integer` + + The index of the summary part within the reasoning summary. + + - `type: :"response.reasoning_summary_part.done"` + + The type of the event. Always `response.reasoning_summary_part.done`. + + - `:"response.reasoning_summary_part.done"` + +### Response Reasoning Summary Text Delta Event + +- `class ResponseReasoningSummaryTextDeltaEvent` + + Emitted when a delta is added to a reasoning summary text. + + - `delta: String` + + The text delta that was added to the summary. + + - `item_id: String` + + The ID of the item this summary text delta is associated with. + + - `output_index: Integer` + + The index of the output item this summary text delta is associated with. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `summary_index: Integer` + + The index of the summary part within the reasoning summary. + + - `type: :"response.reasoning_summary_text.delta"` + + The type of the event. Always `response.reasoning_summary_text.delta`. + + - `:"response.reasoning_summary_text.delta"` + +### Response Reasoning Summary Text Done Event + +- `class ResponseReasoningSummaryTextDoneEvent` + + Emitted when a reasoning summary text is completed. + + - `item_id: String` + + The ID of the item this summary text is associated with. + + - `output_index: Integer` + + The index of the output item this summary text is associated with. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `summary_index: Integer` + + The index of the summary part within the reasoning summary. + + - `text: String` + + The full text of the completed reasoning summary. + + - `type: :"response.reasoning_summary_text.done"` + + The type of the event. Always `response.reasoning_summary_text.done`. + + - `:"response.reasoning_summary_text.done"` + +### Response Reasoning Text Delta Event + +- `class ResponseReasoningTextDeltaEvent` + + Emitted when a delta is added to a reasoning text. + + - `content_index: Integer` + + The index of the reasoning content part this delta is associated with. + + - `delta: String` + + The text delta that was added to the reasoning content. + + - `item_id: String` + + The ID of the item this reasoning text delta is associated with. + + - `output_index: Integer` + + The index of the output item this reasoning text delta is associated with. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.reasoning_text.delta"` + + The type of the event. Always `response.reasoning_text.delta`. + + - `:"response.reasoning_text.delta"` + +### Response Reasoning Text Done Event + +- `class ResponseReasoningTextDoneEvent` + + Emitted when a reasoning text is completed. + + - `content_index: Integer` + + The index of the reasoning content part. + + - `item_id: String` + + The ID of the item this reasoning text is associated with. + + - `output_index: Integer` + + The index of the output item this reasoning text is associated with. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `text: String` + + The full text of the completed reasoning content. + + - `type: :"response.reasoning_text.done"` + + The type of the event. Always `response.reasoning_text.done`. + + - `:"response.reasoning_text.done"` + +### Response Refusal Delta Event + +- `class ResponseRefusalDeltaEvent` + + Emitted when there is a partial refusal text. + + - `content_index: Integer` + + The index of the content part that the refusal text is added to. + + - `delta: String` + + The refusal text that is added. + + - `item_id: String` + + The ID of the output item that the refusal text is added to. + + - `output_index: Integer` + + The index of the output item that the refusal text is added to. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.refusal.delta"` + + The type of the event. Always `response.refusal.delta`. + + - `:"response.refusal.delta"` + +### Response Refusal Done Event + +- `class ResponseRefusalDoneEvent` + + Emitted when refusal text is finalized. + + - `content_index: Integer` + + The index of the content part that the refusal text is finalized. + + - `item_id: String` + + The ID of the output item that the refusal text is finalized. + + - `output_index: Integer` + + The index of the output item that the refusal text is finalized. + + - `refusal: String` + + The refusal text that is finalized. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.refusal.done"` + + The type of the event. Always `response.refusal.done`. + + - `:"response.refusal.done"` + +### Response Status + +- `ResponseStatus = :completed | :failed | :in_progress | 3 more` + + The status of the response generation. One of `completed`, `failed`, + `in_progress`, `cancelled`, `queued`, or `incomplete`. + + - `:completed` + + - `:failed` + + - `:in_progress` + + - `:cancelled` + + - `:queued` + + - `:incomplete` + +### Response Stream Event + +- `ResponseStreamEvent = ResponseAudioDeltaEvent | ResponseAudioDoneEvent | ResponseAudioTranscriptDeltaEvent | 50 more` + + Emitted when there is a partial audio response. + + - `class ResponseAudioDeltaEvent` + + Emitted when there is a partial audio response. + + - `delta: String` + + A chunk of Base64 encoded response audio bytes. + + - `sequence_number: Integer` + + A sequence number for this chunk of the stream response. + + - `type: :"response.audio.delta"` + + The type of the event. Always `response.audio.delta`. + + - `:"response.audio.delta"` + + - `class ResponseAudioDoneEvent` + + Emitted when the audio response is complete. + + - `sequence_number: Integer` + + The sequence number of the delta. + + - `type: :"response.audio.done"` + + The type of the event. Always `response.audio.done`. + + - `:"response.audio.done"` + + - `class ResponseAudioTranscriptDeltaEvent` + + Emitted when there is a partial transcript of audio. + + - `delta: String` + + The partial transcript of the audio response. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.audio.transcript.delta"` + + The type of the event. Always `response.audio.transcript.delta`. + + - `:"response.audio.transcript.delta"` + + - `class ResponseAudioTranscriptDoneEvent` + + Emitted when the full audio transcript is completed. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.audio.transcript.done"` + + The type of the event. Always `response.audio.transcript.done`. + + - `:"response.audio.transcript.done"` + + - `class ResponseCodeInterpreterCallCodeDeltaEvent` + + Emitted when a partial code snippet is streamed by the code interpreter. + + - `delta: String` + + The partial code snippet being streamed by the code interpreter. + + - `item_id: String` + + The unique identifier of the code interpreter tool call item. + + - `output_index: Integer` + + The index of the output item in the response for which the code is being streamed. + + - `sequence_number: Integer` + + The sequence number of this event, used to order streaming events. + + - `type: :"response.code_interpreter_call_code.delta"` + + The type of the event. Always `response.code_interpreter_call_code.delta`. + + - `:"response.code_interpreter_call_code.delta"` + + - `class ResponseCodeInterpreterCallCodeDoneEvent` + + Emitted when the code snippet is finalized by the code interpreter. + + - `code: String` + + The final code snippet output by the code interpreter. + + - `item_id: String` + + The unique identifier of the code interpreter tool call item. + + - `output_index: Integer` + + The index of the output item in the response for which the code is finalized. + + - `sequence_number: Integer` + + The sequence number of this event, used to order streaming events. + + - `type: :"response.code_interpreter_call_code.done"` + + The type of the event. Always `response.code_interpreter_call_code.done`. + + - `:"response.code_interpreter_call_code.done"` + + - `class ResponseCodeInterpreterCallCompletedEvent` + + Emitted when the code interpreter call is completed. + + - `item_id: String` + + The unique identifier of the code interpreter tool call item. + + - `output_index: Integer` + + The index of the output item in the response for which the code interpreter call is completed. + + - `sequence_number: Integer` + + The sequence number of this event, used to order streaming events. + + - `type: :"response.code_interpreter_call.completed"` + + The type of the event. Always `response.code_interpreter_call.completed`. + + - `:"response.code_interpreter_call.completed"` + + - `class ResponseCodeInterpreterCallInProgressEvent` + + Emitted when a code interpreter call is in progress. + + - `item_id: String` + + The unique identifier of the code interpreter tool call item. + + - `output_index: Integer` + + The index of the output item in the response for which the code interpreter call is in progress. + + - `sequence_number: Integer` + + The sequence number of this event, used to order streaming events. + + - `type: :"response.code_interpreter_call.in_progress"` + + The type of the event. Always `response.code_interpreter_call.in_progress`. + + - `:"response.code_interpreter_call.in_progress"` + + - `class ResponseCodeInterpreterCallInterpretingEvent` + + Emitted when the code interpreter is actively interpreting the code snippet. + + - `item_id: String` + + The unique identifier of the code interpreter tool call item. + + - `output_index: Integer` + + The index of the output item in the response for which the code interpreter is interpreting code. + + - `sequence_number: Integer` + + The sequence number of this event, used to order streaming events. + + - `type: :"response.code_interpreter_call.interpreting"` + + The type of the event. Always `response.code_interpreter_call.interpreting`. + + - `:"response.code_interpreter_call.interpreting"` + + - `class ResponseCompletedEvent` + + Emitted when the model response is complete. + + - `response: Response` + + Properties of the completed response. + + - `id: String` + + Unique identifier for this Response. + + - `created_at: Float` + + Unix timestamp (in seconds) of when this Response was created. + + - `error: ResponseError` + + An error object returned when the model fails to generate a Response. + + - `code: :server_error | :rate_limit_exceeded | :invalid_prompt | 15 more` + + The error code for the response. + + - `: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` + + - `message: String` + + A human-readable description of the error. + + - `incomplete_details: IncompleteDetails{ reason}` + + Details about why the response is incomplete. + + - `reason: :max_output_tokens | :content_filter` + + The reason why the response is incomplete. + + - `:max_output_tokens` + + - `:content_filter` + + - `instructions: String | Array[ResponseInputItem]` + + A system (or developer) message inserted into the model's context. + + When using along with `previous_response_id`, the instructions from a previous + response will not be carried over to the next response. This makes it simple + to swap out system (or developer) messages in new responses. + + - `String = String` + + A text input to the model, equivalent to a text input with the + `developer` role. + + - `InputItemList = Array[ResponseInputItem]` + + A list of one or many input items to the model, containing + different content types. + + - `class EasyInputMessage` + + 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. + + - `content: String | ResponseInputMessageContentList` + + Text, image, or audio input to the model, used to generate a response. + Can also contain previous assistant responses. + + - `String = String` + + A text input to the model. + + - `ResponseInputMessageContentList = Array[ResponseInputContent]` + + A list of one or many input items to the model, containing different content + types. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `role: :user | :assistant | :system | :developer` + + The role of the message input. One of `user`, `assistant`, `system`, or + `developer`. + + - `:user` + + - `:assistant` + + - `:system` + + - `:developer` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `type: :message` + + The type of the message input. Always `message`. + + - `:message` + + - `class Message` + + 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. + + - `content: ResponseInputMessageContentList` + + A list of one or many input items to the model, containing different content + types. + + - `role: :user | :system | :developer` + + The role of the message input. One of `user`, `system`, or `developer`. + + - `:user` + + - `:system` + + - `:developer` + + - `status: :in_progress | :completed | :incomplete` + + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the message input. Always set to `message`. + + - `:message` + + - `class ResponseOutputMessage` + + An output message from the model. + + - `id: String` + + The unique ID of the output message. + + - `content: Array[ResponseOutputText | ResponseOutputRefusal]` + + The content of the output message. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `role: :assistant` + + The role of the output message. Always `assistant`. + + - `:assistant` + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the output message. Always `message`. + + - `:message` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `class ResponseFileSearchToolCall` + + 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. + + - `id: String` + + The unique ID of the file search tool call. + + - `queries: Array[String]` + + The queries used to search for files. + + - `status: :in_progress | :searching | :completed | 2 more` + + The status of the file search tool call. One of `in_progress`, + `searching`, `incomplete` or `failed`, + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `type: :file_search_call` + + The type of the file search tool call. Always `file_search_call`. + + - `:file_search_call` + + - `results: Array[Result{ attributes, file_id, filename, 2 more}]` + + The results of the file search tool call. + + - `attributes: Hash[Symbol, String | Float | bool]` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. Keys are strings + with a maximum length of 64 characters. Values are strings with a maximum + length of 512 characters, booleans, or numbers. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `file_id: String` + + The unique ID of the file. + + - `filename: String` + + The name of the file. + + - `score: Float` + + The relevance score of the file - a value between 0 and 1. + + - `text: String` + + The text that was retrieved from the file. + + - `class ResponseComputerToolCall` + + 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. + + - `id: String` + + The unique ID of the computer call. + + - `call_id: String` + + An identifier used when responding to the tool call with output. + + - `pending_safety_checks: Array[PendingSafetyCheck{ id, code, message}]` + + The pending safety checks for the computer call. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :computer_call` + + The type of the computer call. Always `computer_call`. + + - `:computer_call` + + - `action: Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `actions: ComputerActionList` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `class ComputerCallOutput` + + The output of a computer tool call. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `id: String` + + The ID of the computer tool call output. + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionWebSearch` + + 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. + + - `id: String` + + The unique ID of the web search tool call. + + - `action: Search{ type, queries, query, sources} | OpenPage{ type, url} | FindInPage{ pattern, type, url}` + + An object describing the specific action taken in this web search call. + Includes details on how the model used the web (search, open_page, find_in_page). + + - `class Search` + + Action type "search" - Performs a web search query. + + - `type: :search` + + The action type. + + - `:search` + + - `queries: Array[String]` + + The search queries. + + - `query: String` + + The search query. + + - `sources: Array[Source{ type, url}]` + + The sources used in the search. + + - `type: :url` + + The type of source. Always `url`. + + - `:url` + + - `url: String` + + The URL of the source. + + - `class OpenPage` + + Action type "open_page" - Opens a specific URL from search results. + + - `type: :open_page` + + The action type. + + - `:open_page` + + - `url: String` + + The URL opened by the model. + + - `class FindInPage` + + Action type "find_in_page": Searches for a pattern within a loaded page. + + - `pattern: String` + + The pattern or text to search for within the page. + + - `type: :find_in_page` + + The action type. + + - `:find_in_page` + + - `url: String` + + The URL of the page searched for the pattern. + + - `status: :in_progress | :searching | :completed | :failed` + + The status of the web search tool call. + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:failed` + + - `type: :web_search_call` + + The type of the web search tool call. Always `web_search_call`. + + - `:web_search_call` + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `arguments: String` + + A JSON string of the arguments to pass to the function. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `name: String` + + The name of the function to run. + + - `type: :function_call` + + The type of the function tool call. Always `function_call`. + + - `:function_call` + + - `id: String` + + The unique ID of the function tool call. + + - `namespace: String` + + The namespace of the function to run. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class FunctionCallOutput` + + The output of a function tool call. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | ResponseFunctionCallOutputItemList` + + Text, image, or file output of the function tool call. + + - `String = String` + + A JSON string of the output of the function tool call. + + - `ResponseFunctionCallOutputItemList = Array[ResponseFunctionCallOutputItem]` + + An array of content outputs (text, image, file) for the function tool call. + + - `class ResponseInputTextContent` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImageContent` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision) + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFileContent` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The base64-encoded data of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `id: String` + + The unique ID of the function tool call output. Populated when this item is returned via API. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ToolSearchCall` + + - `arguments: untyped` + + The arguments supplied to the tool search call. + + - `type: :tool_search_call` + + The item type. Always `tool_search_call`. + + - `:tool_search_call` + + - `id: String` + + The unique ID of this tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseToolSearchOutputItemParam` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by the tool search output. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The item type. Always `tool_search_output`. + + - `:tool_search_output` + + - `id: String` + + The unique ID of this tool search output. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class AdditionalTools` + + - `role: :developer` + + The role that provided the additional tools. Only `developer` is supported. + + - `:developer` + + - `tools: Array[Tool]` + + A list of additional tools made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The item type. Always `additional_tools`. + + - `:additional_tools` + + - `id: String` + + The unique ID of this additional tools item. + + - `class ResponseReasoningItem` + + 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). + + - `id: String` + + The unique identifier of the reasoning content. + + - `summary: Array[Summary{ text, type}]` + + Reasoning summary content. + + - `text: String` + + A summary of the reasoning output from the model so far. + + - `type: :summary_text` + + The type of the object. Always `summary_text`. + + - `:summary_text` + + - `type: :reasoning` + + The type of the object. Always `reasoning`. + + - `:reasoning` + + - `content: Array[Content{ text, type}]` + + Reasoning text content. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `encrypted_content: String` + + The encrypted content of the reasoning item - populated when a response is + generated with `reasoning.encrypted_content` in the `include` parameter. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseCompactionItemParam` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `encrypted_content: String` + + The encrypted content of the compaction summary. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `id: String` + + The ID of the compaction item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `id: String` + + The unique ID of the code interpreter tool call. + + - `code: String` + + The code to run, or null if not available. + + - `container_id: String` + + The ID of the container used to run the code. + + - `outputs: Array[Logs{ logs, type} | Image{ type, url}]` + + The outputs generated by the code interpreter, such as logs or images. + Can be null if no outputs are available. + + - `class Logs` + + The logs output from the code interpreter. + + - `logs: String` + + The logs output from the code interpreter. + + - `type: :logs` + + The type of the output. Always `logs`. + + - `:logs` + + - `class Image` + + The image output from the code interpreter. + + - `type: :image` + + The type of the output. Always `image`. + + - `:image` + + - `url: String` + + The URL of the image output from the code interpreter. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:interpreting` + + - `:failed` + + - `type: :code_interpreter_call` + + The type of the code interpreter tool call. Always `code_interpreter_call`. + + - `:code_interpreter_call` + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCall` + + A tool representing a request to execute one or more shell commands. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + Ordered shell commands for the execution environment to run. + + - `max_output_length: Integer` + + Maximum number of UTF-8 characters to capture from combined stdout and stderr output. + + - `timeout_ms: Integer` + + Maximum wall-clock time in milliseconds to allow the shell commands to run. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `environment: LocalEnvironment | ContainerReference` + + The environment to execute the shell commands in. + + - `class LocalEnvironment` + + - `class ContainerReference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCallOutput` + + The streamed output items emitted by a shell tool call. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `output: Array[ResponseFunctionShellCallOutputContent]` + + Captured chunks of stdout and stderr output, along with their associated outcomes. + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + The exit or timeout outcome associated with this shell call. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + The exit code returned by the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + Captured stderr output for the shell call. + + - `stdout: String` + + Captured stdout output for the shell call. + + - `type: :shell_call_output` + + The type of the item. Always `shell_call_output`. + + - `:shell_call_output` + + - `id: String` + + The unique ID of the shell tool call output. Populated when this item is returned via API. + + - `max_output_length: Integer` + + The maximum number of UTF-8 characters captured for this shell call's combined output. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ApplyPatchCall` + + A tool call representing a request to create, delete, or update files using diff patches. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + The specific create, delete, or update instruction for the apply_patch tool call. + + - `class CreateFile` + + Instruction for creating a new file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply when creating the file. + + - `path: String` + + Path of the file to create relative to the workspace root. + + - `type: :create_file` + + The operation type. Always `create_file`. + + - `:create_file` + + - `class DeleteFile` + + Instruction for deleting an existing file via the apply_patch tool. + + - `path: String` + + Path of the file to delete relative to the workspace root. + + - `type: :delete_file` + + The operation type. Always `delete_file`. + + - `:delete_file` + + - `class UpdateFile` + + Instruction for updating an existing file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply to the existing file. + + - `path: String` + + Path of the file to update relative to the workspace root. + + - `type: :update_file` + + The operation type. Always `update_file`. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `class ApplyPatchCallOutput` + + The streamed output emitted by an apply patch tool call. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `output: String` + + Optional human-readable log text from the apply patch tool (e.g., patch results or errors). + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `id: String` + + The unique ID of the approval response + + - `reason: String` + + Optional reason for the decision. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class ResponseCustomToolCallOutput` + + The output of a custom tool call from your code, being sent back to the model. + + - `call_id: String` + + The call ID, used to map this custom tool call output to a custom tool call. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the custom tool call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the custom tool call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :custom_tool_call_output` + + The type of the custom tool call output. Always `custom_tool_call_output`. + + - `:custom_tool_call_output` + + - `id: String` + + The unique ID of the custom tool call output in the OpenAI platform. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `call_id: String` + + An identifier used to map this custom tool call to a tool call output. + + - `input: String` + + The input for the custom tool call generated by the model. + + - `name: String` + + The name of the custom tool being called. + + - `type: :custom_tool_call` + + The type of the custom tool call. Always `custom_tool_call`. + + - `:custom_tool_call` + + - `id: String` + + The unique ID of the custom tool call in the OpenAI platform. + + - `namespace: String` + + The namespace of the custom tool being called. + + - `class CompactionTrigger` + + Compacts the current context. Must be the final input item. + + - `type: :compaction_trigger` + + The type of the item. Always `compaction_trigger`. + + - `:compaction_trigger` + + - `class ItemReference` + + An internal identifier for an item to reference. + + - `id: String` + + The ID of the item to reference. + + - `type: :item_reference` + + The type of item to reference. Always `item_reference`. + + - `:item_reference` + + - `metadata: Metadata` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. + + Keys are strings with a maximum length of 64 characters. Values are strings + with a maximum length of 512 characters. + + - `model: ResponsesModel` + + Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI + offers a wide range of models with different capabilities, performance + characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) + to browse and compare available models. + + - `String = String` + + - `ChatModel = :"gpt-5.4" | :"gpt-5.4-mini" | :"gpt-5.4-nano" | 75 more` + + - `:"gpt-5.4"` + + - `:"gpt-5.4-mini"` + + - `:"gpt-5.4-nano"` + + - `:"gpt-5.4-mini-2026-03-17"` + + - `:"gpt-5.4-nano-2026-03-17"` + + - `:"gpt-5.3-chat-latest"` + + - `:"gpt-5.2"` + + - `:"gpt-5.2-2025-12-11"` + + - `:"gpt-5.2-chat-latest"` + + - `:"gpt-5.2-pro"` + + - `:"gpt-5.2-pro-2025-12-11"` + + - `:"gpt-5.1"` + + - `:"gpt-5.1-2025-11-13"` + + - `:"gpt-5.1-codex"` + + - `:"gpt-5.1-mini"` + + - `:"gpt-5.1-chat-latest"` + + - `:"gpt-5"` + + - `:"gpt-5-mini"` + + - `:"gpt-5-nano"` + + - `:"gpt-5-2025-08-07"` + + - `:"gpt-5-mini-2025-08-07"` + + - `:"gpt-5-nano-2025-08-07"` + + - `:"gpt-5-chat-latest"` + + - `:"gpt-4.1"` + + - `:"gpt-4.1-mini"` + + - `:"gpt-4.1-nano"` + + - `:"gpt-4.1-2025-04-14"` + + - `:"gpt-4.1-mini-2025-04-14"` + + - `:"gpt-4.1-nano-2025-04-14"` + + - `:"o4-mini"` + + - `:"o4-mini-2025-04-16"` + + - `:o3` + + - `:"o3-2025-04-16"` + + - `:"o3-mini"` + + - `:"o3-mini-2025-01-31"` + + - `:o1` + + - `:"o1-2024-12-17"` + + - `:"o1-preview"` + + - `:"o1-preview-2024-09-12"` + + - `:"o1-mini"` + + - `:"o1-mini-2024-09-12"` + + - `:"gpt-4o"` + + - `:"gpt-4o-2024-11-20"` + + - `:"gpt-4o-2024-08-06"` + + - `:"gpt-4o-2024-05-13"` + + - `:"gpt-4o-audio-preview"` + + - `:"gpt-4o-audio-preview-2024-10-01"` + + - `:"gpt-4o-audio-preview-2024-12-17"` + + - `:"gpt-4o-audio-preview-2025-06-03"` + + - `:"gpt-4o-mini-audio-preview"` + + - `:"gpt-4o-mini-audio-preview-2024-12-17"` + + - `:"gpt-4o-search-preview"` + + - `:"gpt-4o-mini-search-preview"` + + - `:"gpt-4o-search-preview-2025-03-11"` + + - `:"gpt-4o-mini-search-preview-2025-03-11"` + + - `:"chatgpt-4o-latest"` + + - `:"codex-mini-latest"` + + - `:"gpt-4o-mini"` + + - `:"gpt-4o-mini-2024-07-18"` + + - `:"gpt-4-turbo"` + + - `:"gpt-4-turbo-2024-04-09"` + + - `:"gpt-4-0125-preview"` + + - `:"gpt-4-turbo-preview"` + + - `:"gpt-4-1106-preview"` + + - `:"gpt-4-vision-preview"` + + - `:"gpt-4"` + + - `:"gpt-4-0314"` + + - `:"gpt-4-0613"` + + - `:"gpt-4-32k"` + + - `:"gpt-4-32k-0314"` + + - `:"gpt-4-32k-0613"` + + - `:"gpt-3.5-turbo"` + + - `:"gpt-3.5-turbo-16k"` + + - `:"gpt-3.5-turbo-0301"` + + - `:"gpt-3.5-turbo-0613"` + + - `:"gpt-3.5-turbo-1106"` + + - `:"gpt-3.5-turbo-0125"` + + - `:"gpt-3.5-turbo-16k-0613"` + + - `ResponsesOnlyModel = :"o1-pro" | :"o1-pro-2025-03-19" | :"o3-pro" | 11 more` + + - `:"o1-pro"` + + - `:"o1-pro-2025-03-19"` + + - `:"o3-pro"` + + - `:"o3-pro-2025-06-10"` + + - `:"o3-deep-research"` + + - `:"o3-deep-research-2025-06-26"` + + - `:"o4-mini-deep-research"` + + - `:"o4-mini-deep-research-2025-06-26"` + + - `:"computer-use-preview"` + + - `:"computer-use-preview-2025-03-11"` + + - `:"gpt-5-codex"` + + - `:"gpt-5-pro"` + + - `:"gpt-5-pro-2025-10-06"` + + - `:"gpt-5.1-codex-max"` + + - `object: :response` + + The object type of this resource - always set to `response`. + + - `:response` + + - `output: Array[ResponseOutputItem]` + + An array of content items generated by the model. + + - The length and order of items in the `output` array is dependent + on the model's response. + - Rather than accessing the first item in the `output` array and + assuming it's an `assistant` message with the content generated by + the model, you might consider using the `output_text` property where + supported in SDKs. + + - `class ResponseOutputMessage` + + An output message from the model. + + - `class ResponseFileSearchToolCall` + + 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. + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `class ResponseFunctionToolCallOutputItem` + + - `id: String` + + The unique ID of the function call tool output. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the function call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the function call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the function call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseFunctionWebSearch` + + 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. + + - `class ResponseComputerToolCall` + + 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. + + - `class ResponseComputerToolCallOutputItem` + + - `id: String` + + The unique ID of the computer call tool output. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `status: :completed | :incomplete | :failed | :in_progress` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `:in_progress` + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the + developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseReasoningItem` + + 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). + + - `class ResponseToolSearchCall` + + - `id: String` + + The unique ID of the tool search call item. + + - `arguments: untyped` + + Arguments used for the tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :tool_search_call` + + The type of the item. Always `tool_search_call`. + + - `:tool_search_call` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseToolSearchOutputItem` + + - `id: String` + + The unique ID of the tool search output item. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by tool search. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :tool_search_output` + + The type of the item. Always `tool_search_output`. + + - `:tool_search_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class AdditionalTools` + + - `id: String` + + The unique ID of the additional tools item. + + - `role: :unknown | :user | :assistant | 5 more` + + The role that provided the additional tools. + + - `:unknown` + + - `:user` + + - `:assistant` + + - `:system` + + - `:critic` + + - `:discriminator` + + - `:developer` + + - `:tool` + + - `tools: Array[Tool]` + + The additional tool definitions made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The type of the item. Always `additional_tools`. + + - `:additional_tools` + + - `class ResponseCompactionItem` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `id: String` + + The unique ID of the compaction item. + + - `encrypted_content: String` + + The encrypted content that was produced by compaction. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionShellToolCall` + + A tool call that executes one or more shell commands in a managed environment. + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + - `max_output_length: Integer` + + Optional maximum number of characters to return from each command. + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the commands. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `environment: ResponseLocalEnvironment | ResponseContainerReference` + + Represents the use of a local environment to perform shell actions. + + - `class ResponseLocalEnvironment` + + Represents the use of a local environment to perform shell actions. + + - `type: :local` + + The environment type. Always `local`. + + - `:local` + + - `class ResponseContainerReference` + + Represents a container created with /v1/containers. + + - `container_id: String` + + - `type: :container_reference` + + The environment type. Always `container_reference`. + + - `:container_reference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseFunctionShellToolCallOutput` + + The output of a shell tool call that was emitted. + + - `id: String` + + The unique ID of the shell call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `max_output_length: Integer` + + The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output. + + - `output: Array[Output{ outcome, stderr, stdout, created_by}]` + + An array of shell call output contents + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + Exit code from the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + The standard error output that was captured. + + - `stdout: String` + + The standard output that was captured. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call_output` + + The type of the shell call output. Always `shell_call_output`. + + - `:shell_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseApplyPatchToolCall` + + A tool call that applies file diffs by creating, deleting, or updating files. + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + One of the create_file, delete_file, or update_file operations applied via apply_patch. + + - `class CreateFile` + + Instruction describing how to create a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to create. + + - `type: :create_file` + + Create a new file with the provided diff. + + - `:create_file` + + - `class DeleteFile` + + Instruction describing how to delete a file via the apply_patch tool. + + - `path: String` + + Path of the file to delete. + + - `type: :delete_file` + + Delete the specified file. + + - `:delete_file` + + - `class UpdateFile` + + Instruction describing how to update a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to update. + + - `type: :update_file` + + Update an existing file with the provided diff. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseApplyPatchToolCallOutput` + + The output emitted by an apply patch tool call. + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `created_by: String` + + The ID of the entity that created this tool call output. + + - `output: String` + + Optional textual output returned by the apply patch tool. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `id: String` + + The unique ID of the approval response + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `reason: String` + + Optional reason for the decision. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `class ResponseCustomToolCallOutputItem` + + The output of a custom tool call from your code, being sent back to the model. + + - `id: String` + + The unique ID of the custom tool call output item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `parallel_tool_calls: bool` + + Whether to allow the model to run tool calls in parallel. + + - `temperature: Float` + + 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. + + - `tool_choice: ToolChoiceOptions | ToolChoiceAllowed | ToolChoiceTypes | 5 more` + + How the model should select which tool (or tools) to use when generating + a response. See the `tools` parameter to see how to specify which tools + the model can call. + + - `ToolChoiceOptions = :none | :auto | :required` + + Controls which (if any) tool is called by the model. + + `none` means the model will not call any tool and instead generates a message. + + `auto` means the model can pick between generating a message or calling one or + more tools. + + `required` means the model must call one or more tools. + + - `:none` + + - `:auto` + + - `:required` + + - `class ToolChoiceAllowed` + + Constrains the tools available to the model to a pre-defined set. + + - `mode: :auto | :required` + + Constrains the tools available to the model to a pre-defined set. + + `auto` allows the model to pick from among the allowed tools and generate a + message. + + `required` requires the model to call one or more of the allowed tools. + + - `:auto` + + - `:required` + + - `tools: Array[Hash[Symbol, untyped]]` + + A list of tool definitions that the model should be allowed to call. + + For the Responses API, the list of tool definitions might look like: + + ```json + [ + { "type": "function", "name": "get_weather" }, + { "type": "mcp", "server_label": "deepwiki" }, + { "type": "image_generation" } + ] + ``` + + - `type: :allowed_tools` + + Allowed tool configuration type. Always `allowed_tools`. + + - `:allowed_tools` + + - `class ToolChoiceTypes` + + 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). + + - `type: :file_search | :web_search_preview | :computer | 5 more` + + The type of hosted tool the model should to use. Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + + Allowed values are: + + - `file_search` + - `web_search_preview` + - `computer` + - `computer_use_preview` + - `computer_use` + - `code_interpreter` + - `image_generation` + + - `:file_search` + + - `:web_search_preview` + + - `:computer` + + - `:computer_use_preview` + + - `:computer_use` + + - `:web_search_preview_2025_03_11` + + - `:image_generation` + + - `:code_interpreter` + + - `class ToolChoiceFunction` + + Use this option to force the model to call a specific function. + + - `name: String` + + The name of the function to call. + + - `type: :function` + + For function calling, the type is always `function`. + + - `:function` + + - `class ToolChoiceMcp` + + Use this option to force the model to call a specific tool on a remote MCP server. + + - `server_label: String` + + The label of the MCP server to use. + + - `type: :mcp` + + For MCP tools, the type is always `mcp`. + + - `:mcp` + + - `name: String` + + The name of the tool to call on the server. + + - `class ToolChoiceCustom` + + Use this option to force the model to call a specific custom tool. + + - `name: String` + + The name of the custom tool to call. + + - `type: :custom` + + For custom tool calling, the type is always `custom`. + + - `:custom` + + - `class ToolChoiceApplyPatch` + + Forces the model to call the apply_patch tool when executing a tool call. + + - `type: :apply_patch` + + The tool to call. Always `apply_patch`. + + - `:apply_patch` + + - `class ToolChoiceShell` + + Forces the model to call the shell tool when a tool call is required. + + - `type: :shell` + + The tool to call. Always `shell`. + + - `:shell` + + - `tools: Array[Tool]` + + An array of tools the model may call while generating a response. You + can specify which tool to use by setting the `tool_choice` parameter. + + We support the following categories of tools: + + - **Built-in tools**: Tools that are provided by OpenAI that extend the + model's capabilities, like [web search](https://platform.openai.com/docs/guides/tools-web-search) + or [file search](https://platform.openai.com/docs/guides/tools-file-search). Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + - **MCP Tools**: Integrations with third-party systems via custom MCP servers + or predefined connectors such as Google Drive and SharePoint. Learn more about + [MCP Tools](https://platform.openai.com/docs/guides/tools-connectors-mcp). + - **Function calls (custom tools)**: Functions that are defined by you, + enabling the model to call your own code with strongly typed arguments + and outputs. Learn more about + [function calling](https://platform.openai.com/docs/guides/function-calling). You can also use + custom tools to call your own code. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `top_p: Float` + + 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. + + - `background: bool` + + Whether to run the model response in the background. + [Learn more](https://platform.openai.com/docs/guides/background). + + - `completed_at: Float` + + Unix timestamp (in seconds) of when this Response was completed. + Only present when the status is `completed`. + + - `conversation: Conversation{ id}` + + The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation. + + - `id: String` + + The unique ID of the conversation that this response was associated with. + + - `max_output_tokens: Integer` + + An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://platform.openai.com/docs/guides/reasoning). + + - `max_tool_calls: Integer` + + 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. + + - `moderation: Moderation{ input, output}` + + Moderation results for the response input and output, if moderated completions were requested. + + - `input: ModerationResult{ categories, category_applied_input_types, category_scores, 3 more} | Error{ code, message, type}` + + Moderation for the response input. + + - `class ModerationResult` + + A moderation result produced for the response input or output. + + - `categories: Hash[Symbol, bool]` + + A dictionary of moderation categories to booleans, True if the input is flagged under this category. + + - `category_applied_input_types: Hash[Symbol, Array[:text | :image]]` + + Which modalities of input are reflected by the score for each category. + + - `:text` + + - `:image` + + - `category_scores: Hash[Symbol, Float]` + + A dictionary of moderation categories to scores. + + - `flagged: bool` + + A boolean indicating whether the content was flagged by any category. + + - `model: String` + + The moderation model that produced this result. + + - `type: :moderation_result` + + The object type, which was always `moderation_result` for successful moderation results. + + - `:moderation_result` + + - `class Error` + + An error produced while attempting moderation for the response input or output. + + - `code: String` + + The error code. + + - `message: String` + + The error message. + + - `type: :error` + + The object type, which was always `error` for moderation failures. + + - `:error` + + - `output: ModerationResult{ categories, category_applied_input_types, category_scores, 3 more} | Error{ code, message, type}` + + Moderation for the response output. + + - `class ModerationResult` + + A moderation result produced for the response input or output. + + - `categories: Hash[Symbol, bool]` + + A dictionary of moderation categories to booleans, True if the input is flagged under this category. + + - `category_applied_input_types: Hash[Symbol, Array[:text | :image]]` + + Which modalities of input are reflected by the score for each category. + + - `:text` + + - `:image` + + - `category_scores: Hash[Symbol, Float]` + + A dictionary of moderation categories to scores. + + - `flagged: bool` + + A boolean indicating whether the content was flagged by any category. + + - `model: String` + + The moderation model that produced this result. + + - `type: :moderation_result` + + The object type, which was always `moderation_result` for successful moderation results. + + - `:moderation_result` + + - `class Error` + + An error produced while attempting moderation for the response input or output. + + - `code: String` + + The error code. + + - `message: String` + + The error message. + + - `type: :error` + + The object type, which was always `error` for moderation failures. + + - `:error` + + - `previous_response_id: String` + + The unique ID of the previous response to the model. Use this to + create multi-turn conversations. Learn more about + [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. + + - `prompt: ResponsePrompt` + + Reference to a prompt template and its variables. + [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts). + + - `id: String` + + The unique identifier of the prompt template to use. + + - `variables: Hash[Symbol, String | ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Optional map of values to substitute in for variables in your + prompt. The substitution values can either be strings, or other + Response input types like images or files. + + - `String = String` + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `version: String` + + Optional version of the prompt template. + + - `prompt_cache_key: String` + + Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://platform.openai.com/docs/guides/prompt-caching). + + - `prompt_cache_retention: :in_memory | :"24h"` + + The retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention). + For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported. + + For older models that support both `in_memory` and `24h`, the default depends on your organization's data retention policy: + + - Organizations without ZDR enabled default to `24h`. + - Organizations with ZDR enabled default to `in_memory` when `prompt_cache_retention` is not specified. + + - `:in_memory` + + - `:"24h"` + + - `reasoning: Reasoning` + + **gpt-5 and o-series models only** + + Configuration options for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + + - `effort: ReasoningEffort` + + Constrains effort on reasoning for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing + reasoning effort can result in faster responses and fewer tokens used + on reasoning in a response. + + - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1. + - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. + - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. + - `xhigh` is supported for all models after `gpt-5.1-codex-max`. + + - `:none` + + - `:minimal` + + - `:low` + + - `:medium` + + - `:high` + + - `:xhigh` + + - `generate_summary: :auto | :concise | :detailed` + + **Deprecated:** use `summary` instead. + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `summary: :auto | :concise | :detailed` + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + `concise` is supported for `computer-use-preview` models and all reasoning models after `gpt-5`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `safety_identifier: String` + + A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + + - `service_tier: :auto | :default | :flex | 2 more` + + Specifies the processing type used for serving the request. + + - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. + - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. + - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier. + - When not set, the default behavior is 'auto'. + + When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter. + + - `:auto` + + - `:default` + + - `:flex` + + - `:scale` + + - `:priority` + + - `status: ResponseStatus` + + The status of the response generation. One of `completed`, `failed`, + `in_progress`, `cancelled`, `queued`, or `incomplete`. + + - `:completed` + + - `:failed` + + - `:in_progress` + + - `:cancelled` + + - `:queued` + + - `:incomplete` + + - `text: ResponseTextConfig` + + 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) + + - `format_: ResponseFormatTextConfig` + + An object specifying the format that the model must output. + + Configuring `{ "type": "json_schema" }` enables Structured Outputs, + which ensures the model will match your supplied JSON schema. Learn more in the + [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). + + The default format is `{ "type": "text" }` with no additional options. + + **Not recommended for gpt-4o and newer models:** + + Setting to `{ "type": "json_object" }` enables the older JSON mode, which + ensures the message the model generates is valid JSON. Using `json_schema` + is preferred for models that support it. + + - `class ResponseFormatText` + + Default response format. Used to generate text responses. + + - `type: :text` + + The type of response format being defined. Always `text`. + + - `:text` + + - `class ResponseFormatTextJSONSchemaConfig` + + JSON Schema response format. Used to generate structured JSON responses. + Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). + + - `name: String` + + The name of the response format. Must be a-z, A-Z, 0-9, or contain + underscores and dashes, with a maximum length of 64. + + - `schema: Hash[Symbol, untyped]` + + The schema for the response format, described as a JSON Schema object. + Learn how to build JSON schemas [here](https://json-schema.org/). + + - `type: :json_schema` + + The type of response format being defined. Always `json_schema`. + + - `:json_schema` + + - `description: String` + + A description of what the response format is for, used by the model to + determine how to respond in the format. + + - `strict: bool` + + Whether to enable strict schema adherence when generating the output. + If set to true, the model will always follow the exact schema defined + in the `schema` field. Only a subset of JSON Schema is supported when + `strict` is `true`. To learn more, read the [Structured Outputs + guide](https://platform.openai.com/docs/guides/structured-outputs). + + - `class ResponseFormatJSONObject` + + 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. + + - `type: :json_object` + + The type of response format being defined. Always `json_object`. + + - `:json_object` + + - `verbosity: :low | :medium | :high` + + Constrains the verbosity of the model's response. Lower values will result in + more concise responses, while higher values will result in more verbose responses. + Currently supported values are `low`, `medium`, and `high`. + + - `:low` + + - `:medium` + + - `:high` + + - `top_logprobs: Integer` + + An integer between 0 and 20 specifying the maximum number of most likely + tokens to return at each token position, each with an associated log + probability. In some cases, the number of returned tokens may be fewer than + requested. + + - `truncation: :auto | :disabled` + + The truncation strategy to use for the model response. + + - `auto`: If the input to this Response exceeds + the model's context window size, the model will truncate the + response to fit the context window by dropping items from the beginning of the conversation. + - `disabled` (default): If the input size will exceed the context window + size for a model, the request will fail with a 400 error. + + - `:auto` + + - `:disabled` + + - `usage: ResponseUsage` + + Represents token usage details including input tokens, output tokens, + a breakdown of output tokens, and the total tokens used. + + - `input_tokens: Integer` + + The number of input tokens. + + - `input_tokens_details: InputTokensDetails{ cached_tokens}` + + A detailed breakdown of the input tokens. + + - `cached_tokens: Integer` + + The number of tokens that were retrieved from the cache. + [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching). + + - `output_tokens: Integer` + + The number of output tokens. + + - `output_tokens_details: OutputTokensDetails{ reasoning_tokens}` + + A detailed breakdown of the output tokens. + + - `reasoning_tokens: Integer` + + The number of reasoning tokens. + + - `total_tokens: Integer` + + The total number of tokens used. + + - `user: String` + + This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. + A stable identifier for your end-users. + Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + + - `sequence_number: Integer` + + The sequence number for this event. + + - `type: :"response.completed"` + + The type of the event. Always `response.completed`. + + - `:"response.completed"` + + - `class ResponseContentPartAddedEvent` + + Emitted when a new content part is added. + + - `content_index: Integer` + + The index of the content part that was added. + + - `item_id: String` + + The ID of the output item that the content part was added to. + + - `output_index: Integer` + + The index of the output item that the content part was added to. + + - `part: ResponseOutputText | ResponseOutputRefusal | ReasoningText{ text, type}` + + The content part that was added. + + - `class ResponseOutputText` + + A text output from the model. + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `class ReasoningText` + + Reasoning text from the model. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.content_part.added"` + + The type of the event. Always `response.content_part.added`. + + - `:"response.content_part.added"` + + - `class ResponseContentPartDoneEvent` + + Emitted when a content part is done. + + - `content_index: Integer` + + The index of the content part that is done. + + - `item_id: String` + + The ID of the output item that the content part was added to. + + - `output_index: Integer` + + The index of the output item that the content part was added to. + + - `part: ResponseOutputText | ResponseOutputRefusal | ReasoningText{ text, type}` + + The content part that is done. + + - `class ResponseOutputText` + + A text output from the model. + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `class ReasoningText` + + Reasoning text from the model. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.content_part.done"` + + The type of the event. Always `response.content_part.done`. + + - `:"response.content_part.done"` + + - `class ResponseCreatedEvent` + + An event that is emitted when a response is created. + + - `response: Response` + + The response that was created. + + - `sequence_number: Integer` + + The sequence number for this event. + + - `type: :"response.created"` + + The type of the event. Always `response.created`. + + - `:"response.created"` + + - `class ResponseErrorEvent` + + Emitted when an error occurs. + + - `code: String` + + The error code. + + - `message: String` + + The error message. + + - `param: String` + + The error parameter. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :error` + + The type of the event. Always `error`. + + - `:error` + + - `class ResponseFileSearchCallCompletedEvent` + + Emitted when a file search call is completed (results found). + + - `item_id: String` + + The ID of the output item that the file search call is initiated. + + - `output_index: Integer` + + The index of the output item that the file search call is initiated. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.file_search_call.completed"` + + The type of the event. Always `response.file_search_call.completed`. + + - `:"response.file_search_call.completed"` + + - `class ResponseFileSearchCallInProgressEvent` + + Emitted when a file search call is initiated. + + - `item_id: String` + + The ID of the output item that the file search call is initiated. + + - `output_index: Integer` + + The index of the output item that the file search call is initiated. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.file_search_call.in_progress"` + + The type of the event. Always `response.file_search_call.in_progress`. + + - `:"response.file_search_call.in_progress"` + + - `class ResponseFileSearchCallSearchingEvent` + + Emitted when a file search is currently searching. + + - `item_id: String` + + The ID of the output item that the file search call is initiated. + + - `output_index: Integer` + + The index of the output item that the file search call is searching. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.file_search_call.searching"` + + The type of the event. Always `response.file_search_call.searching`. + + - `:"response.file_search_call.searching"` + + - `class ResponseFunctionCallArgumentsDeltaEvent` + + Emitted when there is a partial function-call arguments delta. + + - `delta: String` + + The function-call arguments delta that is added. + + - `item_id: String` + + The ID of the output item that the function-call arguments delta is added to. + + - `output_index: Integer` + + The index of the output item that the function-call arguments delta is added to. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.function_call_arguments.delta"` + + The type of the event. Always `response.function_call_arguments.delta`. + + - `:"response.function_call_arguments.delta"` + + - `class ResponseFunctionCallArgumentsDoneEvent` + + Emitted when function-call arguments are finalized. + + - `arguments: String` + + The function-call arguments. + + - `item_id: String` + + The ID of the item. + + - `name: String` + + The name of the function that was called. + + - `output_index: Integer` + + The index of the output item. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.function_call_arguments.done"` + + - `:"response.function_call_arguments.done"` + + - `class ResponseInProgressEvent` + + Emitted when the response is in progress. + + - `response: Response` + + The response that is in progress. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.in_progress"` + + The type of the event. Always `response.in_progress`. + + - `:"response.in_progress"` + + - `class ResponseFailedEvent` + + An event that is emitted when a response fails. + + - `response: Response` + + The response that failed. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.failed"` + + The type of the event. Always `response.failed`. + + - `:"response.failed"` + + - `class ResponseIncompleteEvent` + + An event that is emitted when a response finishes as incomplete. + + - `response: Response` + + The response that was incomplete. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.incomplete"` + + The type of the event. Always `response.incomplete`. + + - `:"response.incomplete"` + + - `class ResponseOutputItemAddedEvent` + + Emitted when a new output item is added. + + - `item: ResponseOutputItem` + + The output item that was added. + + - `class ResponseOutputMessage` + + An output message from the model. + + - `class ResponseFileSearchToolCall` + + 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. + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `class ResponseFunctionToolCallOutputItem` + + - `class ResponseFunctionWebSearch` + + 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. + + - `class ResponseComputerToolCall` + + 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. + + - `class ResponseComputerToolCallOutputItem` + + - `class ResponseReasoningItem` + + 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). + + - `class ResponseToolSearchCall` + + - `class ResponseToolSearchOutputItem` + + - `class AdditionalTools` + + - `class ResponseCompactionItem` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `class ResponseFunctionShellToolCall` + + A tool call that executes one or more shell commands in a managed environment. + + - `class ResponseFunctionShellToolCallOutput` + + The output of a shell tool call that was emitted. + + - `class ResponseApplyPatchToolCall` + + A tool call that applies file diffs by creating, deleting, or updating files. + + - `class ResponseApplyPatchToolCallOutput` + + The output emitted by an apply patch tool call. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `class ResponseCustomToolCallOutputItem` + + The output of a custom tool call from your code, being sent back to the model. + + - `output_index: Integer` + + The index of the output item that was added. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.output_item.added"` + + The type of the event. Always `response.output_item.added`. + + - `:"response.output_item.added"` + + - `class ResponseOutputItemDoneEvent` + + Emitted when an output item is marked done. + + - `item: ResponseOutputItem` + + The output item that was marked done. + + - `output_index: Integer` + + The index of the output item that was marked done. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.output_item.done"` + + The type of the event. Always `response.output_item.done`. + + - `:"response.output_item.done"` + + - `class ResponseReasoningSummaryPartAddedEvent` + + Emitted when a new reasoning summary part is added. + + - `item_id: String` + + The ID of the item this summary part is associated with. + + - `output_index: Integer` + + The index of the output item this summary part is associated with. + + - `part: Part{ text, type}` + + The summary part that was added. + + - `text: String` + + The text of the summary part. + + - `type: :summary_text` + + The type of the summary part. Always `summary_text`. + + - `:summary_text` + + - `sequence_number: Integer` + + The sequence number of this event. + + - `summary_index: Integer` + + The index of the summary part within the reasoning summary. + + - `type: :"response.reasoning_summary_part.added"` + + The type of the event. Always `response.reasoning_summary_part.added`. + + - `:"response.reasoning_summary_part.added"` + + - `class ResponseReasoningSummaryPartDoneEvent` + + Emitted when a reasoning summary part is completed. + + - `item_id: String` + + The ID of the item this summary part is associated with. + + - `output_index: Integer` + + The index of the output item this summary part is associated with. + + - `part: Part{ text, type}` + + The completed summary part. + + - `text: String` + + The text of the summary part. + + - `type: :summary_text` + + The type of the summary part. Always `summary_text`. + + - `:summary_text` + + - `sequence_number: Integer` + + The sequence number of this event. + + - `summary_index: Integer` + + The index of the summary part within the reasoning summary. + + - `type: :"response.reasoning_summary_part.done"` + + The type of the event. Always `response.reasoning_summary_part.done`. + + - `:"response.reasoning_summary_part.done"` + + - `class ResponseReasoningSummaryTextDeltaEvent` + + Emitted when a delta is added to a reasoning summary text. + + - `delta: String` + + The text delta that was added to the summary. + + - `item_id: String` + + The ID of the item this summary text delta is associated with. + + - `output_index: Integer` + + The index of the output item this summary text delta is associated with. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `summary_index: Integer` + + The index of the summary part within the reasoning summary. + + - `type: :"response.reasoning_summary_text.delta"` + + The type of the event. Always `response.reasoning_summary_text.delta`. + + - `:"response.reasoning_summary_text.delta"` + + - `class ResponseReasoningSummaryTextDoneEvent` + + Emitted when a reasoning summary text is completed. + + - `item_id: String` + + The ID of the item this summary text is associated with. + + - `output_index: Integer` + + The index of the output item this summary text is associated with. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `summary_index: Integer` + + The index of the summary part within the reasoning summary. + + - `text: String` + + The full text of the completed reasoning summary. + + - `type: :"response.reasoning_summary_text.done"` + + The type of the event. Always `response.reasoning_summary_text.done`. + + - `:"response.reasoning_summary_text.done"` + + - `class ResponseReasoningTextDeltaEvent` + + Emitted when a delta is added to a reasoning text. + + - `content_index: Integer` + + The index of the reasoning content part this delta is associated with. + + - `delta: String` + + The text delta that was added to the reasoning content. + + - `item_id: String` + + The ID of the item this reasoning text delta is associated with. + + - `output_index: Integer` + + The index of the output item this reasoning text delta is associated with. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.reasoning_text.delta"` + + The type of the event. Always `response.reasoning_text.delta`. + + - `:"response.reasoning_text.delta"` + + - `class ResponseReasoningTextDoneEvent` + + Emitted when a reasoning text is completed. + + - `content_index: Integer` + + The index of the reasoning content part. + + - `item_id: String` + + The ID of the item this reasoning text is associated with. + + - `output_index: Integer` + + The index of the output item this reasoning text is associated with. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `text: String` + + The full text of the completed reasoning content. + + - `type: :"response.reasoning_text.done"` + + The type of the event. Always `response.reasoning_text.done`. + + - `:"response.reasoning_text.done"` + + - `class ResponseRefusalDeltaEvent` + + Emitted when there is a partial refusal text. + + - `content_index: Integer` + + The index of the content part that the refusal text is added to. + + - `delta: String` + + The refusal text that is added. + + - `item_id: String` + + The ID of the output item that the refusal text is added to. + + - `output_index: Integer` + + The index of the output item that the refusal text is added to. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.refusal.delta"` + + The type of the event. Always `response.refusal.delta`. + + - `:"response.refusal.delta"` + + - `class ResponseRefusalDoneEvent` + + Emitted when refusal text is finalized. + + - `content_index: Integer` + + The index of the content part that the refusal text is finalized. + + - `item_id: String` + + The ID of the output item that the refusal text is finalized. + + - `output_index: Integer` + + The index of the output item that the refusal text is finalized. + + - `refusal: String` + + The refusal text that is finalized. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.refusal.done"` + + The type of the event. Always `response.refusal.done`. + + - `:"response.refusal.done"` + + - `class ResponseTextDeltaEvent` + + Emitted when there is an additional text delta. + + - `content_index: Integer` + + The index of the content part that the text delta was added to. + + - `delta: String` + + The text delta that was added. + + - `item_id: String` + + The ID of the output item that the text delta was added to. + + - `logprobs: Array[Logprob{ token, logprob, top_logprobs}]` + + The log probabilities of the tokens in the delta. + + - `token: String` + + A possible text token. + + - `logprob: Float` + + The log probability of this token. + + - `top_logprobs: Array[TopLogprob{ token, logprob}]` + + The log probabilities of up to 20 of the most likely tokens. + + - `token: String` + + A possible text token. + + - `logprob: Float` + + The log probability of this token. + + - `output_index: Integer` + + The index of the output item that the text delta was added to. + + - `sequence_number: Integer` + + The sequence number for this event. + + - `type: :"response.output_text.delta"` + + The type of the event. Always `response.output_text.delta`. + + - `:"response.output_text.delta"` + + - `class ResponseTextDoneEvent` + + Emitted when text content is finalized. + + - `content_index: Integer` + + The index of the content part that the text content is finalized. + + - `item_id: String` + + The ID of the output item that the text content is finalized. + + - `logprobs: Array[Logprob{ token, logprob, top_logprobs}]` + + The log probabilities of the tokens in the delta. + + - `token: String` + + A possible text token. + + - `logprob: Float` + + The log probability of this token. + + - `top_logprobs: Array[TopLogprob{ token, logprob}]` + + The log probabilities of up to 20 of the most likely tokens. + + - `token: String` + + A possible text token. + + - `logprob: Float` + + The log probability of this token. + + - `output_index: Integer` + + The index of the output item that the text content is finalized. + + - `sequence_number: Integer` + + The sequence number for this event. + + - `text: String` + + The text content that is finalized. + + - `type: :"response.output_text.done"` + + The type of the event. Always `response.output_text.done`. + + - `:"response.output_text.done"` + + - `class ResponseWebSearchCallCompletedEvent` + + Emitted when a web search call is completed. + + - `item_id: String` + + Unique ID for the output item associated with the web search call. + + - `output_index: Integer` + + The index of the output item that the web search call is associated with. + + - `sequence_number: Integer` + + The sequence number of the web search call being processed. + + - `type: :"response.web_search_call.completed"` + + The type of the event. Always `response.web_search_call.completed`. + + - `:"response.web_search_call.completed"` + + - `class ResponseWebSearchCallInProgressEvent` + + Emitted when a web search call is initiated. + + - `item_id: String` + + Unique ID for the output item associated with the web search call. + + - `output_index: Integer` + + The index of the output item that the web search call is associated with. + + - `sequence_number: Integer` + + The sequence number of the web search call being processed. + + - `type: :"response.web_search_call.in_progress"` + + The type of the event. Always `response.web_search_call.in_progress`. + + - `:"response.web_search_call.in_progress"` + + - `class ResponseWebSearchCallSearchingEvent` + + Emitted when a web search call is executing. + + - `item_id: String` + + Unique ID for the output item associated with the web search call. + + - `output_index: Integer` + + The index of the output item that the web search call is associated with. + + - `sequence_number: Integer` + + The sequence number of the web search call being processed. + + - `type: :"response.web_search_call.searching"` + + The type of the event. Always `response.web_search_call.searching`. + + - `:"response.web_search_call.searching"` + + - `class ResponseImageGenCallCompletedEvent` + + Emitted when an image generation tool call has completed and the final image is available. + + - `item_id: String` + + The unique identifier of the image generation item being processed. + + - `output_index: Integer` + + The index of the output item in the response's output array. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.image_generation_call.completed"` + + The type of the event. Always 'response.image_generation_call.completed'. + + - `:"response.image_generation_call.completed"` + + - `class ResponseImageGenCallGeneratingEvent` + + Emitted when an image generation tool call is actively generating an image (intermediate state). + + - `item_id: String` + + The unique identifier of the image generation item being processed. + + - `output_index: Integer` + + The index of the output item in the response's output array. + + - `sequence_number: Integer` + + The sequence number of the image generation item being processed. + + - `type: :"response.image_generation_call.generating"` + + The type of the event. Always 'response.image_generation_call.generating'. + + - `:"response.image_generation_call.generating"` + + - `class ResponseImageGenCallInProgressEvent` + + Emitted when an image generation tool call is in progress. + + - `item_id: String` + + The unique identifier of the image generation item being processed. + + - `output_index: Integer` + + The index of the output item in the response's output array. + + - `sequence_number: Integer` + + The sequence number of the image generation item being processed. + + - `type: :"response.image_generation_call.in_progress"` + + The type of the event. Always 'response.image_generation_call.in_progress'. + + - `:"response.image_generation_call.in_progress"` + + - `class ResponseImageGenCallPartialImageEvent` + + Emitted when a partial image is available during image generation streaming. + + - `item_id: String` + + The unique identifier of the image generation item being processed. + + - `output_index: Integer` + + The index of the output item in the response's output array. + + - `partial_image_b64: String` + + Base64-encoded partial image data, suitable for rendering as an image. + + - `partial_image_index: Integer` + + 0-based index for the partial image (backend is 1-based, but this is 0-based for the user). + + - `sequence_number: Integer` + + The sequence number of the image generation item being processed. + + - `type: :"response.image_generation_call.partial_image"` + + The type of the event. Always 'response.image_generation_call.partial_image'. + + - `:"response.image_generation_call.partial_image"` + + - `class ResponseMcpCallArgumentsDeltaEvent` + + Emitted when there is a delta (partial update) to the arguments of an MCP tool call. + + - `delta: String` + + A JSON string containing the partial update to the arguments for the MCP tool call. + + - `item_id: String` + + The unique identifier of the MCP tool call item being processed. + + - `output_index: Integer` + + The index of the output item in the response's output array. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.mcp_call_arguments.delta"` + + The type of the event. Always 'response.mcp_call_arguments.delta'. + + - `:"response.mcp_call_arguments.delta"` + + - `class ResponseMcpCallArgumentsDoneEvent` + + Emitted when the arguments for an MCP tool call are finalized. + + - `arguments: String` + + A JSON string containing the finalized arguments for the MCP tool call. + + - `item_id: String` + + The unique identifier of the MCP tool call item being processed. + + - `output_index: Integer` + + The index of the output item in the response's output array. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.mcp_call_arguments.done"` + + The type of the event. Always 'response.mcp_call_arguments.done'. + + - `:"response.mcp_call_arguments.done"` + + - `class ResponseMcpCallCompletedEvent` + + Emitted when an MCP tool call has completed successfully. + + - `item_id: String` + + The ID of the MCP tool call item that completed. + + - `output_index: Integer` + + The index of the output item that completed. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.mcp_call.completed"` + + The type of the event. Always 'response.mcp_call.completed'. + + - `:"response.mcp_call.completed"` + + - `class ResponseMcpCallFailedEvent` + + Emitted when an MCP tool call has failed. + + - `item_id: String` + + The ID of the MCP tool call item that failed. + + - `output_index: Integer` + + The index of the output item that failed. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.mcp_call.failed"` + + The type of the event. Always 'response.mcp_call.failed'. + + - `:"response.mcp_call.failed"` + + - `class ResponseMcpCallInProgressEvent` + + Emitted when an MCP tool call is in progress. + + - `item_id: String` + + The unique identifier of the MCP tool call item being processed. + + - `output_index: Integer` + + The index of the output item in the response's output array. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.mcp_call.in_progress"` + + The type of the event. Always 'response.mcp_call.in_progress'. + + - `:"response.mcp_call.in_progress"` + + - `class ResponseMcpListToolsCompletedEvent` + + Emitted when the list of available MCP tools has been successfully retrieved. + + - `item_id: String` + + The ID of the MCP tool call item that produced this output. + + - `output_index: Integer` + + The index of the output item that was processed. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.mcp_list_tools.completed"` + + The type of the event. Always 'response.mcp_list_tools.completed'. + + - `:"response.mcp_list_tools.completed"` + + - `class ResponseMcpListToolsFailedEvent` + + Emitted when the attempt to list available MCP tools has failed. + + - `item_id: String` + + The ID of the MCP tool call item that failed. + + - `output_index: Integer` + + The index of the output item that failed. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.mcp_list_tools.failed"` + + The type of the event. Always 'response.mcp_list_tools.failed'. + + - `:"response.mcp_list_tools.failed"` + + - `class ResponseMcpListToolsInProgressEvent` + + Emitted when the system is in the process of retrieving the list of available MCP tools. + + - `item_id: String` + + The ID of the MCP tool call item that is being processed. + + - `output_index: Integer` + + The index of the output item that is being processed. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.mcp_list_tools.in_progress"` + + The type of the event. Always 'response.mcp_list_tools.in_progress'. + + - `:"response.mcp_list_tools.in_progress"` + + - `class ResponseOutputTextAnnotationAddedEvent` + + Emitted when an annotation is added to output text content. + + - `annotation: untyped` + + The annotation object being added. (See annotation schema for details.) + + - `annotation_index: Integer` + + The index of the annotation within the content part. + + - `content_index: Integer` + + The index of the content part within the output item. + + - `item_id: String` + + The unique identifier of the item to which the annotation is being added. + + - `output_index: Integer` + + The index of the output item in the response's output array. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.output_text.annotation.added"` + + The type of the event. Always 'response.output_text.annotation.added'. + + - `:"response.output_text.annotation.added"` + + - `class ResponseQueuedEvent` + + Emitted when a response is queued and waiting to be processed. + + - `response: Response` + + The full response object that is queued. + + - `sequence_number: Integer` + + The sequence number for this event. + + - `type: :"response.queued"` + + The type of the event. Always 'response.queued'. + + - `:"response.queued"` + + - `class ResponseCustomToolCallInputDeltaEvent` + + Event representing a delta (partial update) to the input of a custom tool call. + + - `delta: String` + + The incremental input data (delta) for the custom tool call. + + - `item_id: String` + + Unique identifier for the API item associated with this event. + + - `output_index: Integer` + + The index of the output this delta applies to. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.custom_tool_call_input.delta"` + + The event type identifier. + + - `:"response.custom_tool_call_input.delta"` + + - `class ResponseCustomToolCallInputDoneEvent` + + Event indicating that input for a custom tool call is complete. + + - `input: String` + + The complete input data for the custom tool call. + + - `item_id: String` + + Unique identifier for the API item associated with this event. + + - `output_index: Integer` + + The index of the output this event applies to. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.custom_tool_call_input.done"` + + The event type identifier. + + - `:"response.custom_tool_call_input.done"` + +### Response Text Config + +- `class ResponseTextConfig` + + 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) + + - `format_: ResponseFormatTextConfig` + + An object specifying the format that the model must output. + + Configuring `{ "type": "json_schema" }` enables Structured Outputs, + which ensures the model will match your supplied JSON schema. Learn more in the + [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). + + The default format is `{ "type": "text" }` with no additional options. + + **Not recommended for gpt-4o and newer models:** + + Setting to `{ "type": "json_object" }` enables the older JSON mode, which + ensures the message the model generates is valid JSON. Using `json_schema` + is preferred for models that support it. + + - `class ResponseFormatText` + + Default response format. Used to generate text responses. + + - `type: :text` + + The type of response format being defined. Always `text`. + + - `:text` + + - `class ResponseFormatTextJSONSchemaConfig` + + JSON Schema response format. Used to generate structured JSON responses. + Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). + + - `name: String` + + The name of the response format. Must be a-z, A-Z, 0-9, or contain + underscores and dashes, with a maximum length of 64. + + - `schema: Hash[Symbol, untyped]` + + The schema for the response format, described as a JSON Schema object. + Learn how to build JSON schemas [here](https://json-schema.org/). + + - `type: :json_schema` + + The type of response format being defined. Always `json_schema`. + + - `:json_schema` + + - `description: String` + + A description of what the response format is for, used by the model to + determine how to respond in the format. + + - `strict: bool` + + Whether to enable strict schema adherence when generating the output. + If set to true, the model will always follow the exact schema defined + in the `schema` field. Only a subset of JSON Schema is supported when + `strict` is `true`. To learn more, read the [Structured Outputs + guide](https://platform.openai.com/docs/guides/structured-outputs). + + - `class ResponseFormatJSONObject` + + 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. + + - `type: :json_object` + + The type of response format being defined. Always `json_object`. + + - `:json_object` + + - `verbosity: :low | :medium | :high` + + Constrains the verbosity of the model's response. Lower values will result in + more concise responses, while higher values will result in more verbose responses. + Currently supported values are `low`, `medium`, and `high`. + + - `:low` + + - `:medium` + + - `:high` + +### Response Text Delta Event + +- `class ResponseTextDeltaEvent` + + Emitted when there is an additional text delta. + + - `content_index: Integer` + + The index of the content part that the text delta was added to. + + - `delta: String` + + The text delta that was added. + + - `item_id: String` + + The ID of the output item that the text delta was added to. + + - `logprobs: Array[Logprob{ token, logprob, top_logprobs}]` + + The log probabilities of the tokens in the delta. + + - `token: String` + + A possible text token. + + - `logprob: Float` + + The log probability of this token. + + - `top_logprobs: Array[TopLogprob{ token, logprob}]` + + The log probabilities of up to 20 of the most likely tokens. + + - `token: String` + + A possible text token. + + - `logprob: Float` + + The log probability of this token. + + - `output_index: Integer` + + The index of the output item that the text delta was added to. + + - `sequence_number: Integer` + + The sequence number for this event. + + - `type: :"response.output_text.delta"` + + The type of the event. Always `response.output_text.delta`. + + - `:"response.output_text.delta"` + +### Response Text Done Event + +- `class ResponseTextDoneEvent` + + Emitted when text content is finalized. + + - `content_index: Integer` + + The index of the content part that the text content is finalized. + + - `item_id: String` + + The ID of the output item that the text content is finalized. + + - `logprobs: Array[Logprob{ token, logprob, top_logprobs}]` + + The log probabilities of the tokens in the delta. + + - `token: String` + + A possible text token. + + - `logprob: Float` + + The log probability of this token. + + - `top_logprobs: Array[TopLogprob{ token, logprob}]` + + The log probabilities of up to 20 of the most likely tokens. + + - `token: String` + + A possible text token. + + - `logprob: Float` + + The log probability of this token. + + - `output_index: Integer` + + The index of the output item that the text content is finalized. + + - `sequence_number: Integer` + + The sequence number for this event. + + - `text: String` + + The text content that is finalized. + + - `type: :"response.output_text.done"` + + The type of the event. Always `response.output_text.done`. + + - `:"response.output_text.done"` + +### Response Tool Search Call + +- `class ResponseToolSearchCall` + + - `id: String` + + The unique ID of the tool search call item. + + - `arguments: untyped` + + Arguments used for the tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :tool_search_call` + + The type of the item. Always `tool_search_call`. + + - `:tool_search_call` + + - `created_by: String` + + The identifier of the actor that created the item. + +### Response Tool Search Output Item + +- `class ResponseToolSearchOutputItem` + + - `id: String` + + The unique ID of the tool search output item. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by tool search. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The type of the item. Always `tool_search_output`. + + - `:tool_search_output` + + - `created_by: String` + + The identifier of the actor that created the item. + +### Response Tool Search Output Item Param + +- `class ResponseToolSearchOutputItemParam` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by the tool search output. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The item type. Always `tool_search_output`. + + - `:tool_search_output` + + - `id: String` + + The unique ID of this tool search output. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + +### Response Usage + +- `class ResponseUsage` + + Represents token usage details including input tokens, output tokens, + a breakdown of output tokens, and the total tokens used. + + - `input_tokens: Integer` + + The number of input tokens. + + - `input_tokens_details: InputTokensDetails{ cached_tokens}` + + A detailed breakdown of the input tokens. + + - `cached_tokens: Integer` + + The number of tokens that were retrieved from the cache. + [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching). + + - `output_tokens: Integer` + + The number of output tokens. + + - `output_tokens_details: OutputTokensDetails{ reasoning_tokens}` + + A detailed breakdown of the output tokens. + + - `reasoning_tokens: Integer` + + The number of reasoning tokens. + + - `total_tokens: Integer` + + The total number of tokens used. + +### Response Web Search Call Completed Event + +- `class ResponseWebSearchCallCompletedEvent` + + Emitted when a web search call is completed. + + - `item_id: String` + + Unique ID for the output item associated with the web search call. + + - `output_index: Integer` + + The index of the output item that the web search call is associated with. + + - `sequence_number: Integer` + + The sequence number of the web search call being processed. + + - `type: :"response.web_search_call.completed"` + + The type of the event. Always `response.web_search_call.completed`. + + - `:"response.web_search_call.completed"` + +### Response Web Search Call In Progress Event + +- `class ResponseWebSearchCallInProgressEvent` + + Emitted when a web search call is initiated. + + - `item_id: String` + + Unique ID for the output item associated with the web search call. + + - `output_index: Integer` + + The index of the output item that the web search call is associated with. + + - `sequence_number: Integer` + + The sequence number of the web search call being processed. + + - `type: :"response.web_search_call.in_progress"` + + The type of the event. Always `response.web_search_call.in_progress`. + + - `:"response.web_search_call.in_progress"` + +### Response Web Search Call Searching Event + +- `class ResponseWebSearchCallSearchingEvent` + + Emitted when a web search call is executing. + + - `item_id: String` + + Unique ID for the output item associated with the web search call. + + - `output_index: Integer` + + The index of the output item that the web search call is associated with. + + - `sequence_number: Integer` + + The sequence number of the web search call being processed. + + - `type: :"response.web_search_call.searching"` + + The type of the event. Always `response.web_search_call.searching`. + + - `:"response.web_search_call.searching"` + +### Responses Client Event + +- `class ResponsesClientEvent` + + - `type: :"response.create"` + + The type of the client event. Always `response.create`. + + - `:"response.create"` + + - `background: bool` + + Whether to run the model response in the background. + [Learn more](https://platform.openai.com/docs/guides/background). + + - `context_management: Array[ContextManagement{ type, compact_threshold}]` + + Context management configuration for this request. + + - `type: String` + + The context management entry type. Currently only 'compaction' is supported. + + - `compact_threshold: Integer` + + Token threshold at which compaction should be triggered for this entry. + + - `conversation: String | ResponseConversationParam` + + The conversation that this response belongs to. Items from this conversation are prepended to `input_items` for this response request. + Input items and output items from this response are automatically added to this conversation after this response completes. + + - `String = String` + + The unique ID of the conversation. + + - `class ResponseConversationParam` + + The conversation that this response belongs to. + + - `id: String` + + The unique ID of the conversation. + + - `include: Array[ResponseIncludable]` + + Specify additional output data to include in the model response. Currently supported values are: + + - `web_search_call.action.sources`: Include the sources of the web search tool call. + - `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items. + - `computer_call_output.output.image_url`: Include image urls from the computer call output. + - `file_search_call.results`: Include the search results of the file search tool call. + - `message.input_image.image_url`: Include image urls from the input message. + - `message.output_text.logprobs`: Include logprobs with assistant messages. + - `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program). + + - `:"file_search_call.results"` + + - `:"web_search_call.results"` + + - `:"web_search_call.action.sources"` + + - `:"message.input_image.image_url"` + + - `:"computer_call_output.output.image_url"` + + - `:"code_interpreter_call.outputs"` + + - `:"reasoning.encrypted_content"` + + - `:"message.output_text.logprobs"` + + - `input: String | ResponseInput` + + Text, image, or file inputs to the model, used to generate a response. + + Learn more: + + - [Text inputs and outputs](https://platform.openai.com/docs/guides/text) + - [Image inputs](https://platform.openai.com/docs/guides/images) + - [File inputs](https://platform.openai.com/docs/guides/pdf-files) + - [Conversation state](https://platform.openai.com/docs/guides/conversation-state) + - [Function calling](https://platform.openai.com/docs/guides/function-calling) + + - `String = String` + + A text input to the model, equivalent to a text input with the + `user` role. + + - `ResponseInput = Array[ResponseInputItem]` + + A list of one or many input items to the model, containing + different content types. + + - `class EasyInputMessage` + + 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. + + - `content: String | ResponseInputMessageContentList` + + Text, image, or audio input to the model, used to generate a response. + Can also contain previous assistant responses. + + - `String = String` + + A text input to the model. + + - `ResponseInputMessageContentList = Array[ResponseInputContent]` + + A list of one or many input items to the model, containing different content + types. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `role: :user | :assistant | :system | :developer` + + The role of the message input. One of `user`, `assistant`, `system`, or + `developer`. + + - `:user` + + - `:assistant` + + - `:system` + + - `:developer` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `type: :message` + + The type of the message input. Always `message`. + + - `:message` + + - `class Message` + + 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. + + - `content: ResponseInputMessageContentList` + + A list of one or many input items to the model, containing different content + types. + + - `role: :user | :system | :developer` + + The role of the message input. One of `user`, `system`, or `developer`. + + - `:user` + + - `:system` + + - `:developer` + + - `status: :in_progress | :completed | :incomplete` + + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the message input. Always set to `message`. + + - `:message` + + - `class ResponseOutputMessage` + + An output message from the model. + + - `id: String` + + The unique ID of the output message. + + - `content: Array[ResponseOutputText | ResponseOutputRefusal]` + + The content of the output message. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `role: :assistant` + + The role of the output message. Always `assistant`. + + - `:assistant` + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the output message. Always `message`. + + - `:message` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `class ResponseFileSearchToolCall` + + 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. + + - `id: String` + + The unique ID of the file search tool call. + + - `queries: Array[String]` + + The queries used to search for files. + + - `status: :in_progress | :searching | :completed | 2 more` + + The status of the file search tool call. One of `in_progress`, + `searching`, `incomplete` or `failed`, + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `type: :file_search_call` + + The type of the file search tool call. Always `file_search_call`. + + - `:file_search_call` + + - `results: Array[Result{ attributes, file_id, filename, 2 more}]` + + The results of the file search tool call. + + - `attributes: Hash[Symbol, String | Float | bool]` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. Keys are strings + with a maximum length of 64 characters. Values are strings with a maximum + length of 512 characters, booleans, or numbers. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `file_id: String` + + The unique ID of the file. + + - `filename: String` + + The name of the file. + + - `score: Float` + + The relevance score of the file - a value between 0 and 1. + + - `text: String` + + The text that was retrieved from the file. + + - `class ResponseComputerToolCall` + + 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. + + - `id: String` + + The unique ID of the computer call. + + - `call_id: String` + + An identifier used when responding to the tool call with output. + + - `pending_safety_checks: Array[PendingSafetyCheck{ id, code, message}]` + + The pending safety checks for the computer call. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :computer_call` + + The type of the computer call. Always `computer_call`. + + - `:computer_call` + + - `action: Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `actions: ComputerActionList` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `class ComputerCallOutput` + + The output of a computer tool call. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `id: String` + + The ID of the computer tool call output. + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionWebSearch` + + 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. + + - `id: String` + + The unique ID of the web search tool call. + + - `action: Search{ type, queries, query, sources} | OpenPage{ type, url} | FindInPage{ pattern, type, url}` + + An object describing the specific action taken in this web search call. + Includes details on how the model used the web (search, open_page, find_in_page). + + - `class Search` + + Action type "search" - Performs a web search query. + + - `type: :search` + + The action type. + + - `:search` + + - `queries: Array[String]` + + The search queries. + + - `query: String` + + The search query. + + - `sources: Array[Source{ type, url}]` + + The sources used in the search. + + - `type: :url` + + The type of source. Always `url`. + + - `:url` + + - `url: String` + + The URL of the source. + + - `class OpenPage` + + Action type "open_page" - Opens a specific URL from search results. + + - `type: :open_page` + + The action type. + + - `:open_page` + + - `url: String` + + The URL opened by the model. + + - `class FindInPage` + + Action type "find_in_page": Searches for a pattern within a loaded page. + + - `pattern: String` + + The pattern or text to search for within the page. + + - `type: :find_in_page` + + The action type. + + - `:find_in_page` + + - `url: String` + + The URL of the page searched for the pattern. + + - `status: :in_progress | :searching | :completed | :failed` + + The status of the web search tool call. + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:failed` + + - `type: :web_search_call` + + The type of the web search tool call. Always `web_search_call`. + + - `:web_search_call` + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `arguments: String` + + A JSON string of the arguments to pass to the function. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `name: String` + + The name of the function to run. + + - `type: :function_call` + + The type of the function tool call. Always `function_call`. + + - `:function_call` + + - `id: String` + + The unique ID of the function tool call. + + - `namespace: String` + + The namespace of the function to run. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class FunctionCallOutput` + + The output of a function tool call. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | ResponseFunctionCallOutputItemList` + + Text, image, or file output of the function tool call. + + - `String = String` + + A JSON string of the output of the function tool call. + + - `ResponseFunctionCallOutputItemList = Array[ResponseFunctionCallOutputItem]` + + An array of content outputs (text, image, file) for the function tool call. + + - `class ResponseInputTextContent` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImageContent` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision) + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFileContent` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The base64-encoded data of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `id: String` + + The unique ID of the function tool call output. Populated when this item is returned via API. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ToolSearchCall` + + - `arguments: untyped` + + The arguments supplied to the tool search call. + + - `type: :tool_search_call` + + The item type. Always `tool_search_call`. + + - `:tool_search_call` + + - `id: String` + + The unique ID of this tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseToolSearchOutputItemParam` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by the tool search output. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The item type. Always `tool_search_output`. + + - `:tool_search_output` + + - `id: String` + + The unique ID of this tool search output. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class AdditionalTools` + + - `role: :developer` + + The role that provided the additional tools. Only `developer` is supported. + + - `:developer` + + - `tools: Array[Tool]` + + A list of additional tools made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The item type. Always `additional_tools`. + + - `:additional_tools` + + - `id: String` + + The unique ID of this additional tools item. + + - `class ResponseReasoningItem` + + 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). + + - `id: String` + + The unique identifier of the reasoning content. + + - `summary: Array[Summary{ text, type}]` + + Reasoning summary content. + + - `text: String` + + A summary of the reasoning output from the model so far. + + - `type: :summary_text` + + The type of the object. Always `summary_text`. + + - `:summary_text` + + - `type: :reasoning` + + The type of the object. Always `reasoning`. + + - `:reasoning` + + - `content: Array[Content{ text, type}]` + + Reasoning text content. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `encrypted_content: String` + + The encrypted content of the reasoning item - populated when a response is + generated with `reasoning.encrypted_content` in the `include` parameter. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseCompactionItemParam` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `encrypted_content: String` + + The encrypted content of the compaction summary. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `id: String` + + The ID of the compaction item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `id: String` + + The unique ID of the code interpreter tool call. + + - `code: String` + + The code to run, or null if not available. + + - `container_id: String` + + The ID of the container used to run the code. + + - `outputs: Array[Logs{ logs, type} | Image{ type, url}]` + + The outputs generated by the code interpreter, such as logs or images. + Can be null if no outputs are available. + + - `class Logs` + + The logs output from the code interpreter. + + - `logs: String` + + The logs output from the code interpreter. + + - `type: :logs` + + The type of the output. Always `logs`. + + - `:logs` + + - `class Image` + + The image output from the code interpreter. + + - `type: :image` + + The type of the output. Always `image`. + + - `:image` + + - `url: String` + + The URL of the image output from the code interpreter. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:interpreting` + + - `:failed` + + - `type: :code_interpreter_call` + + The type of the code interpreter tool call. Always `code_interpreter_call`. + + - `:code_interpreter_call` + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCall` + + A tool representing a request to execute one or more shell commands. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + Ordered shell commands for the execution environment to run. + + - `max_output_length: Integer` + + Maximum number of UTF-8 characters to capture from combined stdout and stderr output. + + - `timeout_ms: Integer` + + Maximum wall-clock time in milliseconds to allow the shell commands to run. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `environment: LocalEnvironment | ContainerReference` + + The environment to execute the shell commands in. + + - `class LocalEnvironment` + + - `class ContainerReference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCallOutput` + + The streamed output items emitted by a shell tool call. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `output: Array[ResponseFunctionShellCallOutputContent]` + + Captured chunks of stdout and stderr output, along with their associated outcomes. + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + The exit or timeout outcome associated with this shell call. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + The exit code returned by the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + Captured stderr output for the shell call. + + - `stdout: String` + + Captured stdout output for the shell call. + + - `type: :shell_call_output` + + The type of the item. Always `shell_call_output`. + + - `:shell_call_output` + + - `id: String` + + The unique ID of the shell tool call output. Populated when this item is returned via API. + + - `max_output_length: Integer` + + The maximum number of UTF-8 characters captured for this shell call's combined output. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ApplyPatchCall` + + A tool call representing a request to create, delete, or update files using diff patches. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + The specific create, delete, or update instruction for the apply_patch tool call. + + - `class CreateFile` + + Instruction for creating a new file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply when creating the file. + + - `path: String` + + Path of the file to create relative to the workspace root. + + - `type: :create_file` + + The operation type. Always `create_file`. + + - `:create_file` + + - `class DeleteFile` + + Instruction for deleting an existing file via the apply_patch tool. + + - `path: String` + + Path of the file to delete relative to the workspace root. + + - `type: :delete_file` + + The operation type. Always `delete_file`. + + - `:delete_file` + + - `class UpdateFile` + + Instruction for updating an existing file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply to the existing file. + + - `path: String` + + Path of the file to update relative to the workspace root. + + - `type: :update_file` + + The operation type. Always `update_file`. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `class ApplyPatchCallOutput` + + The streamed output emitted by an apply patch tool call. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `output: String` + + Optional human-readable log text from the apply patch tool (e.g., patch results or errors). + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `id: String` + + The unique ID of the approval response + + - `reason: String` + + Optional reason for the decision. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class ResponseCustomToolCallOutput` + + The output of a custom tool call from your code, being sent back to the model. + + - `call_id: String` + + The call ID, used to map this custom tool call output to a custom tool call. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the custom tool call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the custom tool call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :custom_tool_call_output` + + The type of the custom tool call output. Always `custom_tool_call_output`. + + - `:custom_tool_call_output` + + - `id: String` + + The unique ID of the custom tool call output in the OpenAI platform. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `call_id: String` + + An identifier used to map this custom tool call to a tool call output. + + - `input: String` + + The input for the custom tool call generated by the model. + + - `name: String` + + The name of the custom tool being called. + + - `type: :custom_tool_call` + + The type of the custom tool call. Always `custom_tool_call`. + + - `:custom_tool_call` + + - `id: String` + + The unique ID of the custom tool call in the OpenAI platform. + + - `namespace: String` + + The namespace of the custom tool being called. + + - `class CompactionTrigger` + + Compacts the current context. Must be the final input item. + + - `type: :compaction_trigger` + + The type of the item. Always `compaction_trigger`. + + - `:compaction_trigger` + + - `class ItemReference` + + An internal identifier for an item to reference. + + - `id: String` + + The ID of the item to reference. + + - `type: :item_reference` + + The type of item to reference. Always `item_reference`. + + - `:item_reference` + + - `instructions: String` + + A system (or developer) message inserted into the model's context. + + When using along with `previous_response_id`, the instructions from a previous + response will not be carried over to the next response. This makes it simple + to swap out system (or developer) messages in new responses. + + - `max_output_tokens: Integer` + + An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://platform.openai.com/docs/guides/reasoning). + + - `max_tool_calls: Integer` + + 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: Metadata` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. + + Keys are strings with a maximum length of 64 characters. Values are strings + with a maximum length of 512 characters. + + - `model: ResponsesModel` + + Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI + offers a wide range of models with different capabilities, performance + characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) + to browse and compare available models. + + - `String = String` + + - `ChatModel = :"gpt-5.4" | :"gpt-5.4-mini" | :"gpt-5.4-nano" | 75 more` + + - `:"gpt-5.4"` + + - `:"gpt-5.4-mini"` + + - `:"gpt-5.4-nano"` + + - `:"gpt-5.4-mini-2026-03-17"` + + - `:"gpt-5.4-nano-2026-03-17"` + + - `:"gpt-5.3-chat-latest"` + + - `:"gpt-5.2"` + + - `:"gpt-5.2-2025-12-11"` + + - `:"gpt-5.2-chat-latest"` + + - `:"gpt-5.2-pro"` + + - `:"gpt-5.2-pro-2025-12-11"` + + - `:"gpt-5.1"` + + - `:"gpt-5.1-2025-11-13"` + + - `:"gpt-5.1-codex"` + + - `:"gpt-5.1-mini"` + + - `:"gpt-5.1-chat-latest"` + + - `:"gpt-5"` + + - `:"gpt-5-mini"` + + - `:"gpt-5-nano"` + + - `:"gpt-5-2025-08-07"` + + - `:"gpt-5-mini-2025-08-07"` + + - `:"gpt-5-nano-2025-08-07"` + + - `:"gpt-5-chat-latest"` + + - `:"gpt-4.1"` + + - `:"gpt-4.1-mini"` + + - `:"gpt-4.1-nano"` + + - `:"gpt-4.1-2025-04-14"` + + - `:"gpt-4.1-mini-2025-04-14"` + + - `:"gpt-4.1-nano-2025-04-14"` + + - `:"o4-mini"` + + - `:"o4-mini-2025-04-16"` + + - `:o3` + + - `:"o3-2025-04-16"` + + - `:"o3-mini"` + + - `:"o3-mini-2025-01-31"` + + - `:o1` + + - `:"o1-2024-12-17"` + + - `:"o1-preview"` + + - `:"o1-preview-2024-09-12"` + + - `:"o1-mini"` + + - `:"o1-mini-2024-09-12"` + + - `:"gpt-4o"` + + - `:"gpt-4o-2024-11-20"` + + - `:"gpt-4o-2024-08-06"` + + - `:"gpt-4o-2024-05-13"` + + - `:"gpt-4o-audio-preview"` + + - `:"gpt-4o-audio-preview-2024-10-01"` + + - `:"gpt-4o-audio-preview-2024-12-17"` + + - `:"gpt-4o-audio-preview-2025-06-03"` + + - `:"gpt-4o-mini-audio-preview"` + + - `:"gpt-4o-mini-audio-preview-2024-12-17"` + + - `:"gpt-4o-search-preview"` + + - `:"gpt-4o-mini-search-preview"` + + - `:"gpt-4o-search-preview-2025-03-11"` + + - `:"gpt-4o-mini-search-preview-2025-03-11"` + + - `:"chatgpt-4o-latest"` + + - `:"codex-mini-latest"` + + - `:"gpt-4o-mini"` + + - `:"gpt-4o-mini-2024-07-18"` + + - `:"gpt-4-turbo"` + + - `:"gpt-4-turbo-2024-04-09"` + + - `:"gpt-4-0125-preview"` + + - `:"gpt-4-turbo-preview"` + + - `:"gpt-4-1106-preview"` + + - `:"gpt-4-vision-preview"` + + - `:"gpt-4"` + + - `:"gpt-4-0314"` + + - `:"gpt-4-0613"` + + - `:"gpt-4-32k"` + + - `:"gpt-4-32k-0314"` + + - `:"gpt-4-32k-0613"` + + - `:"gpt-3.5-turbo"` + + - `:"gpt-3.5-turbo-16k"` + + - `:"gpt-3.5-turbo-0301"` + + - `:"gpt-3.5-turbo-0613"` + + - `:"gpt-3.5-turbo-1106"` + + - `:"gpt-3.5-turbo-0125"` + + - `:"gpt-3.5-turbo-16k-0613"` + + - `ResponsesOnlyModel = :"o1-pro" | :"o1-pro-2025-03-19" | :"o3-pro" | 11 more` + + - `:"o1-pro"` + + - `:"o1-pro-2025-03-19"` + + - `:"o3-pro"` + + - `:"o3-pro-2025-06-10"` + + - `:"o3-deep-research"` + + - `:"o3-deep-research-2025-06-26"` + + - `:"o4-mini-deep-research"` + + - `:"o4-mini-deep-research-2025-06-26"` + + - `:"computer-use-preview"` + + - `:"computer-use-preview-2025-03-11"` + + - `:"gpt-5-codex"` + + - `:"gpt-5-pro"` + + - `:"gpt-5-pro-2025-10-06"` + + - `:"gpt-5.1-codex-max"` + + - `moderation: Moderation{ model}` + + Configuration for running moderation on the input and output of this response. + + - `model: String` + + The moderation model to use for moderated completions, e.g. 'omni-moderation-latest'. + + - `parallel_tool_calls: bool` + + Whether to allow the model to run tool calls in parallel. + + - `previous_response_id: String` + + The unique ID of the previous response to the model. Use this to + create multi-turn conversations. Learn more about + [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. + + - `prompt: ResponsePrompt` + + Reference to a prompt template and its variables. + [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts). + + - `id: String` + + The unique identifier of the prompt template to use. + + - `variables: Hash[Symbol, String | ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Optional map of values to substitute in for variables in your + prompt. The substitution values can either be strings, or other + Response input types like images or files. + + - `String = String` + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `version: String` + + Optional version of the prompt template. + + - `prompt_cache_key: String` + + Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://platform.openai.com/docs/guides/prompt-caching). + + - `prompt_cache_retention: :in_memory | :"24h"` + + The retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention). + For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported. + + For older models that support both `in_memory` and `24h`, the default depends on your organization's data retention policy: + + - Organizations without ZDR enabled default to `24h`. + - Organizations with ZDR enabled default to `in_memory` when `prompt_cache_retention` is not specified. + + - `:in_memory` + + - `:"24h"` + + - `reasoning: Reasoning` + + **gpt-5 and o-series models only** + + Configuration options for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + + - `effort: ReasoningEffort` + + Constrains effort on reasoning for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing + reasoning effort can result in faster responses and fewer tokens used + on reasoning in a response. + + - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1. + - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. + - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. + - `xhigh` is supported for all models after `gpt-5.1-codex-max`. + + - `:none` + + - `:minimal` + + - `:low` + + - `:medium` + + - `:high` + + - `:xhigh` + + - `generate_summary: :auto | :concise | :detailed` + + **Deprecated:** use `summary` instead. + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `summary: :auto | :concise | :detailed` + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + `concise` is supported for `computer-use-preview` models and all reasoning models after `gpt-5`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `safety_identifier: String` + + A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + + - `service_tier: :auto | :default | :flex | 2 more` + + Specifies the processing type used for serving the request. + + - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. + - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. + - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier. + - When not set, the default behavior is 'auto'. + + When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter. + + - `:auto` + + - `:default` + + - `:flex` + + - `:scale` + + - `:priority` + + - `store: bool` + + Whether to store the generated model response for later retrieval via + API. + + - `stream: bool` + + If set to true, the model response data will be streamed to the client + as it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format). + See the [Streaming section below](https://platform.openai.com/docs/api-reference/responses-streaming) + for more information. + + - `stream_options: StreamOptions{ include_obfuscation}` + + Options for streaming responses. Only set this when you set `stream: true`. + + - `include_obfuscation: bool` + + When true, stream obfuscation will be enabled. Stream obfuscation adds + random characters to an `obfuscation` field on streaming delta events to + normalize payload sizes as a mitigation to certain side-channel attacks. + These obfuscation fields are included by default, but add a small amount + of overhead to the data stream. You can set `include_obfuscation` to + false to optimize for bandwidth if you trust the network links between + your application and the OpenAI API. + + - `temperature: Float` + + 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. + + - `text: ResponseTextConfig` + + 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) + + - `format_: ResponseFormatTextConfig` + + An object specifying the format that the model must output. + + Configuring `{ "type": "json_schema" }` enables Structured Outputs, + which ensures the model will match your supplied JSON schema. Learn more in the + [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). + + The default format is `{ "type": "text" }` with no additional options. + + **Not recommended for gpt-4o and newer models:** + + Setting to `{ "type": "json_object" }` enables the older JSON mode, which + ensures the message the model generates is valid JSON. Using `json_schema` + is preferred for models that support it. + + - `class ResponseFormatText` + + Default response format. Used to generate text responses. + + - `type: :text` + + The type of response format being defined. Always `text`. + + - `:text` + + - `class ResponseFormatTextJSONSchemaConfig` + + JSON Schema response format. Used to generate structured JSON responses. + Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). + + - `name: String` + + The name of the response format. Must be a-z, A-Z, 0-9, or contain + underscores and dashes, with a maximum length of 64. + + - `schema: Hash[Symbol, untyped]` + + The schema for the response format, described as a JSON Schema object. + Learn how to build JSON schemas [here](https://json-schema.org/). + + - `type: :json_schema` + + The type of response format being defined. Always `json_schema`. + + - `:json_schema` + + - `description: String` + + A description of what the response format is for, used by the model to + determine how to respond in the format. + + - `strict: bool` + + Whether to enable strict schema adherence when generating the output. + If set to true, the model will always follow the exact schema defined + in the `schema` field. Only a subset of JSON Schema is supported when + `strict` is `true`. To learn more, read the [Structured Outputs + guide](https://platform.openai.com/docs/guides/structured-outputs). + + - `class ResponseFormatJSONObject` + + 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. + + - `type: :json_object` + + The type of response format being defined. Always `json_object`. + + - `:json_object` + + - `verbosity: :low | :medium | :high` + + Constrains the verbosity of the model's response. Lower values will result in + more concise responses, while higher values will result in more verbose responses. + Currently supported values are `low`, `medium`, and `high`. + + - `:low` + + - `:medium` + + - `:high` + + - `tool_choice: ToolChoiceOptions | ToolChoiceAllowed | ToolChoiceTypes | 5 more` + + How the model should select which tool (or tools) to use when generating + a response. See the `tools` parameter to see how to specify which tools + the model can call. + + - `ToolChoiceOptions = :none | :auto | :required` + + Controls which (if any) tool is called by the model. + + `none` means the model will not call any tool and instead generates a message. + + `auto` means the model can pick between generating a message or calling one or + more tools. + + `required` means the model must call one or more tools. + + - `:none` + + - `:auto` + + - `:required` + + - `class ToolChoiceAllowed` + + Constrains the tools available to the model to a pre-defined set. + + - `mode: :auto | :required` + + Constrains the tools available to the model to a pre-defined set. + + `auto` allows the model to pick from among the allowed tools and generate a + message. + + `required` requires the model to call one or more of the allowed tools. + + - `:auto` + + - `:required` + + - `tools: Array[Hash[Symbol, untyped]]` + + A list of tool definitions that the model should be allowed to call. + + For the Responses API, the list of tool definitions might look like: + + ```json + [ + { "type": "function", "name": "get_weather" }, + { "type": "mcp", "server_label": "deepwiki" }, + { "type": "image_generation" } + ] + ``` + + - `type: :allowed_tools` + + Allowed tool configuration type. Always `allowed_tools`. + + - `:allowed_tools` + + - `class ToolChoiceTypes` + + 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). + + - `type: :file_search | :web_search_preview | :computer | 5 more` + + The type of hosted tool the model should to use. Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + + Allowed values are: + + - `file_search` + - `web_search_preview` + - `computer` + - `computer_use_preview` + - `computer_use` + - `code_interpreter` + - `image_generation` + + - `:file_search` + + - `:web_search_preview` + + - `:computer` + + - `:computer_use_preview` + + - `:computer_use` + + - `:web_search_preview_2025_03_11` + + - `:image_generation` + + - `:code_interpreter` + + - `class ToolChoiceFunction` + + Use this option to force the model to call a specific function. + + - `name: String` + + The name of the function to call. + + - `type: :function` + + For function calling, the type is always `function`. + + - `:function` + + - `class ToolChoiceMcp` + + Use this option to force the model to call a specific tool on a remote MCP server. + + - `server_label: String` + + The label of the MCP server to use. + + - `type: :mcp` + + For MCP tools, the type is always `mcp`. + + - `:mcp` + + - `name: String` + + The name of the tool to call on the server. + + - `class ToolChoiceCustom` + + Use this option to force the model to call a specific custom tool. + + - `name: String` + + The name of the custom tool to call. + + - `type: :custom` + + For custom tool calling, the type is always `custom`. + + - `:custom` + + - `class ToolChoiceApplyPatch` + + Forces the model to call the apply_patch tool when executing a tool call. + + - `type: :apply_patch` + + The tool to call. Always `apply_patch`. + + - `:apply_patch` + + - `class ToolChoiceShell` + + Forces the model to call the shell tool when a tool call is required. + + - `type: :shell` + + The tool to call. Always `shell`. + + - `:shell` + + - `tools: Array[Tool]` + + An array of tools the model may call while generating a response. You + can specify which tool to use by setting the `tool_choice` parameter. + + We support the following categories of tools: + + - **Built-in tools**: Tools that are provided by OpenAI that extend the + model's capabilities, like [web search](https://platform.openai.com/docs/guides/tools-web-search) + or [file search](https://platform.openai.com/docs/guides/tools-file-search). Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + - **MCP Tools**: Integrations with third-party systems via custom MCP servers + or predefined connectors such as Google Drive and SharePoint. Learn more about + [MCP Tools](https://platform.openai.com/docs/guides/tools-connectors-mcp). + - **Function calls (custom tools)**: Functions that are defined by you, + enabling the model to call your own code with strongly typed arguments + and outputs. Learn more about + [function calling](https://platform.openai.com/docs/guides/function-calling). You can also use + custom tools to call your own code. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `top_logprobs: Integer` + + An integer between 0 and 20 specifying the maximum number of most likely + tokens to return at each token position, each with an associated log + probability. In some cases, the number of returned tokens may be fewer than + requested. + + - `top_p: Float` + + 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: :auto | :disabled` + + The truncation strategy to use for the model response. + + - `auto`: If the input to this Response exceeds + the model's context window size, the model will truncate the + response to fit the context window by dropping items from the beginning of the conversation. + - `disabled` (default): If the input size will exceed the context window + size for a model, the request will fail with a 400 error. + + - `:auto` + + - `:disabled` + + - `user: String` + + This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. + A stable identifier for your end-users. + Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + +### Responses Server Event + +- `ResponsesServerEvent = ResponseAudioDeltaEvent | ResponseAudioDoneEvent | ResponseAudioTranscriptDeltaEvent | 50 more` + + Server events emitted by the Responses WebSocket server. + + - `class ResponseAudioDeltaEvent` + + Emitted when there is a partial audio response. + + - `delta: String` + + A chunk of Base64 encoded response audio bytes. + + - `sequence_number: Integer` + + A sequence number for this chunk of the stream response. + + - `type: :"response.audio.delta"` + + The type of the event. Always `response.audio.delta`. + + - `:"response.audio.delta"` + + - `class ResponseAudioDoneEvent` + + Emitted when the audio response is complete. + + - `sequence_number: Integer` + + The sequence number of the delta. + + - `type: :"response.audio.done"` + + The type of the event. Always `response.audio.done`. + + - `:"response.audio.done"` + + - `class ResponseAudioTranscriptDeltaEvent` + + Emitted when there is a partial transcript of audio. + + - `delta: String` + + The partial transcript of the audio response. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.audio.transcript.delta"` + + The type of the event. Always `response.audio.transcript.delta`. + + - `:"response.audio.transcript.delta"` + + - `class ResponseAudioTranscriptDoneEvent` + + Emitted when the full audio transcript is completed. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.audio.transcript.done"` + + The type of the event. Always `response.audio.transcript.done`. + + - `:"response.audio.transcript.done"` + + - `class ResponseCodeInterpreterCallCodeDeltaEvent` + + Emitted when a partial code snippet is streamed by the code interpreter. + + - `delta: String` + + The partial code snippet being streamed by the code interpreter. + + - `item_id: String` + + The unique identifier of the code interpreter tool call item. + + - `output_index: Integer` + + The index of the output item in the response for which the code is being streamed. + + - `sequence_number: Integer` + + The sequence number of this event, used to order streaming events. + + - `type: :"response.code_interpreter_call_code.delta"` + + The type of the event. Always `response.code_interpreter_call_code.delta`. + + - `:"response.code_interpreter_call_code.delta"` + + - `class ResponseCodeInterpreterCallCodeDoneEvent` + + Emitted when the code snippet is finalized by the code interpreter. + + - `code: String` + + The final code snippet output by the code interpreter. + + - `item_id: String` + + The unique identifier of the code interpreter tool call item. + + - `output_index: Integer` + + The index of the output item in the response for which the code is finalized. + + - `sequence_number: Integer` + + The sequence number of this event, used to order streaming events. + + - `type: :"response.code_interpreter_call_code.done"` + + The type of the event. Always `response.code_interpreter_call_code.done`. + + - `:"response.code_interpreter_call_code.done"` + + - `class ResponseCodeInterpreterCallCompletedEvent` + + Emitted when the code interpreter call is completed. + + - `item_id: String` + + The unique identifier of the code interpreter tool call item. + + - `output_index: Integer` + + The index of the output item in the response for which the code interpreter call is completed. + + - `sequence_number: Integer` + + The sequence number of this event, used to order streaming events. + + - `type: :"response.code_interpreter_call.completed"` + + The type of the event. Always `response.code_interpreter_call.completed`. + + - `:"response.code_interpreter_call.completed"` + + - `class ResponseCodeInterpreterCallInProgressEvent` + + Emitted when a code interpreter call is in progress. + + - `item_id: String` + + The unique identifier of the code interpreter tool call item. + + - `output_index: Integer` + + The index of the output item in the response for which the code interpreter call is in progress. + + - `sequence_number: Integer` + + The sequence number of this event, used to order streaming events. + + - `type: :"response.code_interpreter_call.in_progress"` + + The type of the event. Always `response.code_interpreter_call.in_progress`. + + - `:"response.code_interpreter_call.in_progress"` + + - `class ResponseCodeInterpreterCallInterpretingEvent` + + Emitted when the code interpreter is actively interpreting the code snippet. + + - `item_id: String` + + The unique identifier of the code interpreter tool call item. + + - `output_index: Integer` + + The index of the output item in the response for which the code interpreter is interpreting code. + + - `sequence_number: Integer` + + The sequence number of this event, used to order streaming events. + + - `type: :"response.code_interpreter_call.interpreting"` + + The type of the event. Always `response.code_interpreter_call.interpreting`. + + - `:"response.code_interpreter_call.interpreting"` + + - `class ResponseCompletedEvent` + + Emitted when the model response is complete. + + - `response: Response` + + Properties of the completed response. + + - `id: String` + + Unique identifier for this Response. + + - `created_at: Float` + + Unix timestamp (in seconds) of when this Response was created. + + - `error: ResponseError` + + An error object returned when the model fails to generate a Response. + + - `code: :server_error | :rate_limit_exceeded | :invalid_prompt | 15 more` + + The error code for the response. + + - `: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` + + - `message: String` + + A human-readable description of the error. + + - `incomplete_details: IncompleteDetails{ reason}` + + Details about why the response is incomplete. + + - `reason: :max_output_tokens | :content_filter` + + The reason why the response is incomplete. + + - `:max_output_tokens` + + - `:content_filter` + + - `instructions: String | Array[ResponseInputItem]` + + A system (or developer) message inserted into the model's context. + + When using along with `previous_response_id`, the instructions from a previous + response will not be carried over to the next response. This makes it simple + to swap out system (or developer) messages in new responses. + + - `String = String` + + A text input to the model, equivalent to a text input with the + `developer` role. + + - `InputItemList = Array[ResponseInputItem]` + + A list of one or many input items to the model, containing + different content types. + + - `class EasyInputMessage` + + 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. + + - `content: String | ResponseInputMessageContentList` + + Text, image, or audio input to the model, used to generate a response. + Can also contain previous assistant responses. + + - `String = String` + + A text input to the model. + + - `ResponseInputMessageContentList = Array[ResponseInputContent]` + + A list of one or many input items to the model, containing different content + types. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `role: :user | :assistant | :system | :developer` + + The role of the message input. One of `user`, `assistant`, `system`, or + `developer`. + + - `:user` + + - `:assistant` + + - `:system` + + - `:developer` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `type: :message` + + The type of the message input. Always `message`. + + - `:message` + + - `class Message` + + 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. + + - `content: ResponseInputMessageContentList` + + A list of one or many input items to the model, containing different content + types. + + - `role: :user | :system | :developer` + + The role of the message input. One of `user`, `system`, or `developer`. + + - `:user` + + - `:system` + + - `:developer` + + - `status: :in_progress | :completed | :incomplete` + + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the message input. Always set to `message`. + + - `:message` + + - `class ResponseOutputMessage` + + An output message from the model. + + - `id: String` + + The unique ID of the output message. + + - `content: Array[ResponseOutputText | ResponseOutputRefusal]` + + The content of the output message. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `role: :assistant` + + The role of the output message. Always `assistant`. + + - `:assistant` + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the output message. Always `message`. + + - `:message` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `class ResponseFileSearchToolCall` + + 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. + + - `id: String` + + The unique ID of the file search tool call. + + - `queries: Array[String]` + + The queries used to search for files. + + - `status: :in_progress | :searching | :completed | 2 more` + + The status of the file search tool call. One of `in_progress`, + `searching`, `incomplete` or `failed`, + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `type: :file_search_call` + + The type of the file search tool call. Always `file_search_call`. + + - `:file_search_call` + + - `results: Array[Result{ attributes, file_id, filename, 2 more}]` + + The results of the file search tool call. + + - `attributes: Hash[Symbol, String | Float | bool]` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. Keys are strings + with a maximum length of 64 characters. Values are strings with a maximum + length of 512 characters, booleans, or numbers. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `file_id: String` + + The unique ID of the file. + + - `filename: String` + + The name of the file. + + - `score: Float` + + The relevance score of the file - a value between 0 and 1. + + - `text: String` + + The text that was retrieved from the file. + + - `class ResponseComputerToolCall` + + 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. + + - `id: String` + + The unique ID of the computer call. + + - `call_id: String` + + An identifier used when responding to the tool call with output. + + - `pending_safety_checks: Array[PendingSafetyCheck{ id, code, message}]` + + The pending safety checks for the computer call. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :computer_call` + + The type of the computer call. Always `computer_call`. + + - `:computer_call` + + - `action: Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `actions: ComputerActionList` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `class ComputerCallOutput` + + The output of a computer tool call. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `id: String` + + The ID of the computer tool call output. + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionWebSearch` + + 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. + + - `id: String` + + The unique ID of the web search tool call. + + - `action: Search{ type, queries, query, sources} | OpenPage{ type, url} | FindInPage{ pattern, type, url}` + + An object describing the specific action taken in this web search call. + Includes details on how the model used the web (search, open_page, find_in_page). + + - `class Search` + + Action type "search" - Performs a web search query. + + - `type: :search` + + The action type. + + - `:search` + + - `queries: Array[String]` + + The search queries. + + - `query: String` + + The search query. + + - `sources: Array[Source{ type, url}]` + + The sources used in the search. + + - `type: :url` + + The type of source. Always `url`. + + - `:url` + + - `url: String` + + The URL of the source. + + - `class OpenPage` + + Action type "open_page" - Opens a specific URL from search results. + + - `type: :open_page` + + The action type. + + - `:open_page` + + - `url: String` + + The URL opened by the model. + + - `class FindInPage` + + Action type "find_in_page": Searches for a pattern within a loaded page. + + - `pattern: String` + + The pattern or text to search for within the page. + + - `type: :find_in_page` + + The action type. + + - `:find_in_page` + + - `url: String` + + The URL of the page searched for the pattern. + + - `status: :in_progress | :searching | :completed | :failed` + + The status of the web search tool call. + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:failed` + + - `type: :web_search_call` + + The type of the web search tool call. Always `web_search_call`. + + - `:web_search_call` + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `arguments: String` + + A JSON string of the arguments to pass to the function. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `name: String` + + The name of the function to run. + + - `type: :function_call` + + The type of the function tool call. Always `function_call`. + + - `:function_call` + + - `id: String` + + The unique ID of the function tool call. + + - `namespace: String` + + The namespace of the function to run. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class FunctionCallOutput` + + The output of a function tool call. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | ResponseFunctionCallOutputItemList` + + Text, image, or file output of the function tool call. + + - `String = String` + + A JSON string of the output of the function tool call. + + - `ResponseFunctionCallOutputItemList = Array[ResponseFunctionCallOutputItem]` + + An array of content outputs (text, image, file) for the function tool call. + + - `class ResponseInputTextContent` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImageContent` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision) + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFileContent` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The base64-encoded data of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `id: String` + + The unique ID of the function tool call output. Populated when this item is returned via API. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ToolSearchCall` + + - `arguments: untyped` + + The arguments supplied to the tool search call. + + - `type: :tool_search_call` + + The item type. Always `tool_search_call`. + + - `:tool_search_call` + + - `id: String` + + The unique ID of this tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseToolSearchOutputItemParam` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by the tool search output. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The item type. Always `tool_search_output`. + + - `:tool_search_output` + + - `id: String` + + The unique ID of this tool search output. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class AdditionalTools` + + - `role: :developer` + + The role that provided the additional tools. Only `developer` is supported. + + - `:developer` + + - `tools: Array[Tool]` + + A list of additional tools made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The item type. Always `additional_tools`. + + - `:additional_tools` + + - `id: String` + + The unique ID of this additional tools item. + + - `class ResponseReasoningItem` + + 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). + + - `id: String` + + The unique identifier of the reasoning content. + + - `summary: Array[Summary{ text, type}]` + + Reasoning summary content. + + - `text: String` + + A summary of the reasoning output from the model so far. + + - `type: :summary_text` + + The type of the object. Always `summary_text`. + + - `:summary_text` + + - `type: :reasoning` + + The type of the object. Always `reasoning`. + + - `:reasoning` + + - `content: Array[Content{ text, type}]` + + Reasoning text content. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `encrypted_content: String` + + The encrypted content of the reasoning item - populated when a response is + generated with `reasoning.encrypted_content` in the `include` parameter. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseCompactionItemParam` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `encrypted_content: String` + + The encrypted content of the compaction summary. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `id: String` + + The ID of the compaction item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `id: String` + + The unique ID of the code interpreter tool call. + + - `code: String` + + The code to run, or null if not available. + + - `container_id: String` + + The ID of the container used to run the code. + + - `outputs: Array[Logs{ logs, type} | Image{ type, url}]` + + The outputs generated by the code interpreter, such as logs or images. + Can be null if no outputs are available. + + - `class Logs` + + The logs output from the code interpreter. + + - `logs: String` + + The logs output from the code interpreter. + + - `type: :logs` + + The type of the output. Always `logs`. + + - `:logs` + + - `class Image` + + The image output from the code interpreter. + + - `type: :image` + + The type of the output. Always `image`. + + - `:image` + + - `url: String` + + The URL of the image output from the code interpreter. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:interpreting` + + - `:failed` + + - `type: :code_interpreter_call` + + The type of the code interpreter tool call. Always `code_interpreter_call`. + + - `:code_interpreter_call` + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCall` + + A tool representing a request to execute one or more shell commands. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + Ordered shell commands for the execution environment to run. + + - `max_output_length: Integer` + + Maximum number of UTF-8 characters to capture from combined stdout and stderr output. + + - `timeout_ms: Integer` + + Maximum wall-clock time in milliseconds to allow the shell commands to run. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `environment: LocalEnvironment | ContainerReference` + + The environment to execute the shell commands in. + + - `class LocalEnvironment` + + - `class ContainerReference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCallOutput` + + The streamed output items emitted by a shell tool call. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `output: Array[ResponseFunctionShellCallOutputContent]` + + Captured chunks of stdout and stderr output, along with their associated outcomes. + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + The exit or timeout outcome associated with this shell call. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + The exit code returned by the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + Captured stderr output for the shell call. + + - `stdout: String` + + Captured stdout output for the shell call. + + - `type: :shell_call_output` + + The type of the item. Always `shell_call_output`. + + - `:shell_call_output` + + - `id: String` + + The unique ID of the shell tool call output. Populated when this item is returned via API. + + - `max_output_length: Integer` + + The maximum number of UTF-8 characters captured for this shell call's combined output. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ApplyPatchCall` + + A tool call representing a request to create, delete, or update files using diff patches. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + The specific create, delete, or update instruction for the apply_patch tool call. + + - `class CreateFile` + + Instruction for creating a new file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply when creating the file. + + - `path: String` + + Path of the file to create relative to the workspace root. + + - `type: :create_file` + + The operation type. Always `create_file`. + + - `:create_file` + + - `class DeleteFile` + + Instruction for deleting an existing file via the apply_patch tool. + + - `path: String` + + Path of the file to delete relative to the workspace root. + + - `type: :delete_file` + + The operation type. Always `delete_file`. + + - `:delete_file` + + - `class UpdateFile` + + Instruction for updating an existing file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply to the existing file. + + - `path: String` + + Path of the file to update relative to the workspace root. + + - `type: :update_file` + + The operation type. Always `update_file`. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `class ApplyPatchCallOutput` + + The streamed output emitted by an apply patch tool call. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `output: String` + + Optional human-readable log text from the apply patch tool (e.g., patch results or errors). + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `id: String` + + The unique ID of the approval response + + - `reason: String` + + Optional reason for the decision. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class ResponseCustomToolCallOutput` + + The output of a custom tool call from your code, being sent back to the model. + + - `call_id: String` + + The call ID, used to map this custom tool call output to a custom tool call. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the custom tool call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the custom tool call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :custom_tool_call_output` + + The type of the custom tool call output. Always `custom_tool_call_output`. + + - `:custom_tool_call_output` + + - `id: String` + + The unique ID of the custom tool call output in the OpenAI platform. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `call_id: String` + + An identifier used to map this custom tool call to a tool call output. + + - `input: String` + + The input for the custom tool call generated by the model. + + - `name: String` + + The name of the custom tool being called. + + - `type: :custom_tool_call` + + The type of the custom tool call. Always `custom_tool_call`. + + - `:custom_tool_call` + + - `id: String` + + The unique ID of the custom tool call in the OpenAI platform. + + - `namespace: String` + + The namespace of the custom tool being called. + + - `class CompactionTrigger` + + Compacts the current context. Must be the final input item. + + - `type: :compaction_trigger` + + The type of the item. Always `compaction_trigger`. + + - `:compaction_trigger` + + - `class ItemReference` + + An internal identifier for an item to reference. + + - `id: String` + + The ID of the item to reference. + + - `type: :item_reference` + + The type of item to reference. Always `item_reference`. + + - `:item_reference` + + - `metadata: Metadata` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. + + Keys are strings with a maximum length of 64 characters. Values are strings + with a maximum length of 512 characters. + + - `model: ResponsesModel` + + Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI + offers a wide range of models with different capabilities, performance + characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) + to browse and compare available models. + + - `String = String` + + - `ChatModel = :"gpt-5.4" | :"gpt-5.4-mini" | :"gpt-5.4-nano" | 75 more` + + - `:"gpt-5.4"` + + - `:"gpt-5.4-mini"` + + - `:"gpt-5.4-nano"` + + - `:"gpt-5.4-mini-2026-03-17"` + + - `:"gpt-5.4-nano-2026-03-17"` + + - `:"gpt-5.3-chat-latest"` + + - `:"gpt-5.2"` + + - `:"gpt-5.2-2025-12-11"` + + - `:"gpt-5.2-chat-latest"` + + - `:"gpt-5.2-pro"` + + - `:"gpt-5.2-pro-2025-12-11"` + + - `:"gpt-5.1"` + + - `:"gpt-5.1-2025-11-13"` + + - `:"gpt-5.1-codex"` + + - `:"gpt-5.1-mini"` + + - `:"gpt-5.1-chat-latest"` + + - `:"gpt-5"` + + - `:"gpt-5-mini"` + + - `:"gpt-5-nano"` + + - `:"gpt-5-2025-08-07"` + + - `:"gpt-5-mini-2025-08-07"` + + - `:"gpt-5-nano-2025-08-07"` + + - `:"gpt-5-chat-latest"` + + - `:"gpt-4.1"` + + - `:"gpt-4.1-mini"` + + - `:"gpt-4.1-nano"` + + - `:"gpt-4.1-2025-04-14"` + + - `:"gpt-4.1-mini-2025-04-14"` + + - `:"gpt-4.1-nano-2025-04-14"` + + - `:"o4-mini"` + + - `:"o4-mini-2025-04-16"` + + - `:o3` + + - `:"o3-2025-04-16"` + + - `:"o3-mini"` + + - `:"o3-mini-2025-01-31"` + + - `:o1` + + - `:"o1-2024-12-17"` + + - `:"o1-preview"` + + - `:"o1-preview-2024-09-12"` + + - `:"o1-mini"` + + - `:"o1-mini-2024-09-12"` + + - `:"gpt-4o"` + + - `:"gpt-4o-2024-11-20"` + + - `:"gpt-4o-2024-08-06"` + + - `:"gpt-4o-2024-05-13"` + + - `:"gpt-4o-audio-preview"` + + - `:"gpt-4o-audio-preview-2024-10-01"` + + - `:"gpt-4o-audio-preview-2024-12-17"` + + - `:"gpt-4o-audio-preview-2025-06-03"` + + - `:"gpt-4o-mini-audio-preview"` + + - `:"gpt-4o-mini-audio-preview-2024-12-17"` + + - `:"gpt-4o-search-preview"` + + - `:"gpt-4o-mini-search-preview"` + + - `:"gpt-4o-search-preview-2025-03-11"` + + - `:"gpt-4o-mini-search-preview-2025-03-11"` + + - `:"chatgpt-4o-latest"` + + - `:"codex-mini-latest"` + + - `:"gpt-4o-mini"` + + - `:"gpt-4o-mini-2024-07-18"` + + - `:"gpt-4-turbo"` + + - `:"gpt-4-turbo-2024-04-09"` + + - `:"gpt-4-0125-preview"` + + - `:"gpt-4-turbo-preview"` + + - `:"gpt-4-1106-preview"` + + - `:"gpt-4-vision-preview"` + + - `:"gpt-4"` + + - `:"gpt-4-0314"` + + - `:"gpt-4-0613"` + + - `:"gpt-4-32k"` + + - `:"gpt-4-32k-0314"` + + - `:"gpt-4-32k-0613"` + + - `:"gpt-3.5-turbo"` + + - `:"gpt-3.5-turbo-16k"` + + - `:"gpt-3.5-turbo-0301"` + + - `:"gpt-3.5-turbo-0613"` + + - `:"gpt-3.5-turbo-1106"` + + - `:"gpt-3.5-turbo-0125"` + + - `:"gpt-3.5-turbo-16k-0613"` + + - `ResponsesOnlyModel = :"o1-pro" | :"o1-pro-2025-03-19" | :"o3-pro" | 11 more` + + - `:"o1-pro"` + + - `:"o1-pro-2025-03-19"` + + - `:"o3-pro"` + + - `:"o3-pro-2025-06-10"` + + - `:"o3-deep-research"` + + - `:"o3-deep-research-2025-06-26"` + + - `:"o4-mini-deep-research"` + + - `:"o4-mini-deep-research-2025-06-26"` + + - `:"computer-use-preview"` + + - `:"computer-use-preview-2025-03-11"` + + - `:"gpt-5-codex"` + + - `:"gpt-5-pro"` + + - `:"gpt-5-pro-2025-10-06"` + + - `:"gpt-5.1-codex-max"` + + - `object: :response` + + The object type of this resource - always set to `response`. + + - `:response` + + - `output: Array[ResponseOutputItem]` + + An array of content items generated by the model. + + - The length and order of items in the `output` array is dependent + on the model's response. + - Rather than accessing the first item in the `output` array and + assuming it's an `assistant` message with the content generated by + the model, you might consider using the `output_text` property where + supported in SDKs. + + - `class ResponseOutputMessage` + + An output message from the model. + + - `class ResponseFileSearchToolCall` + + 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. + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `class ResponseFunctionToolCallOutputItem` + + - `id: String` + + The unique ID of the function call tool output. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the function call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the function call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the function call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseFunctionWebSearch` + + 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. + + - `class ResponseComputerToolCall` + + 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. + + - `class ResponseComputerToolCallOutputItem` + + - `id: String` + + The unique ID of the computer call tool output. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `status: :completed | :incomplete | :failed | :in_progress` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `:in_progress` + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the + developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseReasoningItem` + + 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). + + - `class ResponseToolSearchCall` + + - `id: String` + + The unique ID of the tool search call item. + + - `arguments: untyped` + + Arguments used for the tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :tool_search_call` + + The type of the item. Always `tool_search_call`. + + - `:tool_search_call` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseToolSearchOutputItem` + + - `id: String` + + The unique ID of the tool search output item. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by tool search. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :tool_search_output` + + The type of the item. Always `tool_search_output`. + + - `:tool_search_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class AdditionalTools` + + - `id: String` + + The unique ID of the additional tools item. + + - `role: :unknown | :user | :assistant | 5 more` + + The role that provided the additional tools. + + - `:unknown` + + - `:user` + + - `:assistant` + + - `:system` + + - `:critic` + + - `:discriminator` + + - `:developer` + + - `:tool` + + - `tools: Array[Tool]` + + The additional tool definitions made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The type of the item. Always `additional_tools`. + + - `:additional_tools` + + - `class ResponseCompactionItem` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `id: String` + + The unique ID of the compaction item. + + - `encrypted_content: String` + + The encrypted content that was produced by compaction. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionShellToolCall` + + A tool call that executes one or more shell commands in a managed environment. + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + - `max_output_length: Integer` + + Optional maximum number of characters to return from each command. + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the commands. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `environment: ResponseLocalEnvironment | ResponseContainerReference` + + Represents the use of a local environment to perform shell actions. + + - `class ResponseLocalEnvironment` + + Represents the use of a local environment to perform shell actions. + + - `type: :local` + + The environment type. Always `local`. + + - `:local` + + - `class ResponseContainerReference` + + Represents a container created with /v1/containers. + + - `container_id: String` + + - `type: :container_reference` + + The environment type. Always `container_reference`. + + - `:container_reference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseFunctionShellToolCallOutput` + + The output of a shell tool call that was emitted. + + - `id: String` + + The unique ID of the shell call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `max_output_length: Integer` + + The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output. + + - `output: Array[Output{ outcome, stderr, stdout, created_by}]` + + An array of shell call output contents + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + Exit code from the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + The standard error output that was captured. + + - `stdout: String` + + The standard output that was captured. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call_output` + + The type of the shell call output. Always `shell_call_output`. + + - `:shell_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseApplyPatchToolCall` + + A tool call that applies file diffs by creating, deleting, or updating files. + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + One of the create_file, delete_file, or update_file operations applied via apply_patch. + + - `class CreateFile` + + Instruction describing how to create a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to create. + + - `type: :create_file` + + Create a new file with the provided diff. + + - `:create_file` + + - `class DeleteFile` + + Instruction describing how to delete a file via the apply_patch tool. + + - `path: String` + + Path of the file to delete. + + - `type: :delete_file` + + Delete the specified file. + + - `:delete_file` + + - `class UpdateFile` + + Instruction describing how to update a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to update. + + - `type: :update_file` + + Update an existing file with the provided diff. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseApplyPatchToolCallOutput` + + The output emitted by an apply patch tool call. + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `created_by: String` + + The ID of the entity that created this tool call output. + + - `output: String` + + Optional textual output returned by the apply patch tool. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `id: String` + + The unique ID of the approval response + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `reason: String` + + Optional reason for the decision. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `class ResponseCustomToolCallOutputItem` + + The output of a custom tool call from your code, being sent back to the model. + + - `id: String` + + The unique ID of the custom tool call output item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `parallel_tool_calls: bool` + + Whether to allow the model to run tool calls in parallel. + + - `temperature: Float` + + 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. + + - `tool_choice: ToolChoiceOptions | ToolChoiceAllowed | ToolChoiceTypes | 5 more` + + How the model should select which tool (or tools) to use when generating + a response. See the `tools` parameter to see how to specify which tools + the model can call. + + - `ToolChoiceOptions = :none | :auto | :required` + + Controls which (if any) tool is called by the model. + + `none` means the model will not call any tool and instead generates a message. + + `auto` means the model can pick between generating a message or calling one or + more tools. + + `required` means the model must call one or more tools. + + - `:none` + + - `:auto` + + - `:required` + + - `class ToolChoiceAllowed` + + Constrains the tools available to the model to a pre-defined set. + + - `mode: :auto | :required` + + Constrains the tools available to the model to a pre-defined set. + + `auto` allows the model to pick from among the allowed tools and generate a + message. + + `required` requires the model to call one or more of the allowed tools. + + - `:auto` + + - `:required` + + - `tools: Array[Hash[Symbol, untyped]]` + + A list of tool definitions that the model should be allowed to call. + + For the Responses API, the list of tool definitions might look like: + + ```json + [ + { "type": "function", "name": "get_weather" }, + { "type": "mcp", "server_label": "deepwiki" }, + { "type": "image_generation" } + ] + ``` + + - `type: :allowed_tools` + + Allowed tool configuration type. Always `allowed_tools`. + + - `:allowed_tools` + + - `class ToolChoiceTypes` + + 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). + + - `type: :file_search | :web_search_preview | :computer | 5 more` + + The type of hosted tool the model should to use. Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + + Allowed values are: + + - `file_search` + - `web_search_preview` + - `computer` + - `computer_use_preview` + - `computer_use` + - `code_interpreter` + - `image_generation` + + - `:file_search` + + - `:web_search_preview` + + - `:computer` + + - `:computer_use_preview` + + - `:computer_use` + + - `:web_search_preview_2025_03_11` + + - `:image_generation` + + - `:code_interpreter` + + - `class ToolChoiceFunction` + + Use this option to force the model to call a specific function. + + - `name: String` + + The name of the function to call. + + - `type: :function` + + For function calling, the type is always `function`. + + - `:function` + + - `class ToolChoiceMcp` + + Use this option to force the model to call a specific tool on a remote MCP server. + + - `server_label: String` + + The label of the MCP server to use. + + - `type: :mcp` + + For MCP tools, the type is always `mcp`. + + - `:mcp` + + - `name: String` + + The name of the tool to call on the server. + + - `class ToolChoiceCustom` + + Use this option to force the model to call a specific custom tool. + + - `name: String` + + The name of the custom tool to call. + + - `type: :custom` + + For custom tool calling, the type is always `custom`. + + - `:custom` + + - `class ToolChoiceApplyPatch` + + Forces the model to call the apply_patch tool when executing a tool call. + + - `type: :apply_patch` + + The tool to call. Always `apply_patch`. + + - `:apply_patch` + + - `class ToolChoiceShell` + + Forces the model to call the shell tool when a tool call is required. + + - `type: :shell` + + The tool to call. Always `shell`. + + - `:shell` + + - `tools: Array[Tool]` + + An array of tools the model may call while generating a response. You + can specify which tool to use by setting the `tool_choice` parameter. + + We support the following categories of tools: + + - **Built-in tools**: Tools that are provided by OpenAI that extend the + model's capabilities, like [web search](https://platform.openai.com/docs/guides/tools-web-search) + or [file search](https://platform.openai.com/docs/guides/tools-file-search). Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + - **MCP Tools**: Integrations with third-party systems via custom MCP servers + or predefined connectors such as Google Drive and SharePoint. Learn more about + [MCP Tools](https://platform.openai.com/docs/guides/tools-connectors-mcp). + - **Function calls (custom tools)**: Functions that are defined by you, + enabling the model to call your own code with strongly typed arguments + and outputs. Learn more about + [function calling](https://platform.openai.com/docs/guides/function-calling). You can also use + custom tools to call your own code. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `top_p: Float` + + 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. + + - `background: bool` + + Whether to run the model response in the background. + [Learn more](https://platform.openai.com/docs/guides/background). + + - `completed_at: Float` + + Unix timestamp (in seconds) of when this Response was completed. + Only present when the status is `completed`. + + - `conversation: Conversation{ id}` + + The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation. + + - `id: String` + + The unique ID of the conversation that this response was associated with. + + - `max_output_tokens: Integer` + + An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://platform.openai.com/docs/guides/reasoning). + + - `max_tool_calls: Integer` + + 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. + + - `moderation: Moderation{ input, output}` + + Moderation results for the response input and output, if moderated completions were requested. + + - `input: ModerationResult{ categories, category_applied_input_types, category_scores, 3 more} | Error{ code, message, type}` + + Moderation for the response input. + + - `class ModerationResult` + + A moderation result produced for the response input or output. + + - `categories: Hash[Symbol, bool]` + + A dictionary of moderation categories to booleans, True if the input is flagged under this category. + + - `category_applied_input_types: Hash[Symbol, Array[:text | :image]]` + + Which modalities of input are reflected by the score for each category. + + - `:text` + + - `:image` + + - `category_scores: Hash[Symbol, Float]` + + A dictionary of moderation categories to scores. + + - `flagged: bool` + + A boolean indicating whether the content was flagged by any category. + + - `model: String` + + The moderation model that produced this result. + + - `type: :moderation_result` + + The object type, which was always `moderation_result` for successful moderation results. + + - `:moderation_result` + + - `class Error` + + An error produced while attempting moderation for the response input or output. + + - `code: String` + + The error code. + + - `message: String` + + The error message. + + - `type: :error` + + The object type, which was always `error` for moderation failures. + + - `:error` + + - `output: ModerationResult{ categories, category_applied_input_types, category_scores, 3 more} | Error{ code, message, type}` + + Moderation for the response output. + + - `class ModerationResult` + + A moderation result produced for the response input or output. + + - `categories: Hash[Symbol, bool]` + + A dictionary of moderation categories to booleans, True if the input is flagged under this category. + + - `category_applied_input_types: Hash[Symbol, Array[:text | :image]]` + + Which modalities of input are reflected by the score for each category. + + - `:text` + + - `:image` + + - `category_scores: Hash[Symbol, Float]` + + A dictionary of moderation categories to scores. + + - `flagged: bool` + + A boolean indicating whether the content was flagged by any category. + + - `model: String` + + The moderation model that produced this result. + + - `type: :moderation_result` + + The object type, which was always `moderation_result` for successful moderation results. + + - `:moderation_result` + + - `class Error` + + An error produced while attempting moderation for the response input or output. + + - `code: String` + + The error code. + + - `message: String` + + The error message. + + - `type: :error` + + The object type, which was always `error` for moderation failures. + + - `:error` + + - `previous_response_id: String` + + The unique ID of the previous response to the model. Use this to + create multi-turn conversations. Learn more about + [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. + + - `prompt: ResponsePrompt` + + Reference to a prompt template and its variables. + [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts). + + - `id: String` + + The unique identifier of the prompt template to use. + + - `variables: Hash[Symbol, String | ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Optional map of values to substitute in for variables in your + prompt. The substitution values can either be strings, or other + Response input types like images or files. + + - `String = String` + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `version: String` + + Optional version of the prompt template. + + - `prompt_cache_key: String` + + Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://platform.openai.com/docs/guides/prompt-caching). + + - `prompt_cache_retention: :in_memory | :"24h"` + + The retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention). + For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported. + + For older models that support both `in_memory` and `24h`, the default depends on your organization's data retention policy: + + - Organizations without ZDR enabled default to `24h`. + - Organizations with ZDR enabled default to `in_memory` when `prompt_cache_retention` is not specified. + + - `:in_memory` + + - `:"24h"` + + - `reasoning: Reasoning` + + **gpt-5 and o-series models only** + + Configuration options for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + + - `effort: ReasoningEffort` + + Constrains effort on reasoning for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing + reasoning effort can result in faster responses and fewer tokens used + on reasoning in a response. + + - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1. + - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. + - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. + - `xhigh` is supported for all models after `gpt-5.1-codex-max`. + + - `:none` + + - `:minimal` + + - `:low` + + - `:medium` + + - `:high` + + - `:xhigh` + + - `generate_summary: :auto | :concise | :detailed` + + **Deprecated:** use `summary` instead. + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `summary: :auto | :concise | :detailed` + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + `concise` is supported for `computer-use-preview` models and all reasoning models after `gpt-5`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `safety_identifier: String` + + A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + + - `service_tier: :auto | :default | :flex | 2 more` + + Specifies the processing type used for serving the request. + + - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. + - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. + - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier. + - When not set, the default behavior is 'auto'. + + When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter. + + - `:auto` + + - `:default` + + - `:flex` + + - `:scale` + + - `:priority` + + - `status: ResponseStatus` + + The status of the response generation. One of `completed`, `failed`, + `in_progress`, `cancelled`, `queued`, or `incomplete`. + + - `:completed` + + - `:failed` + + - `:in_progress` + + - `:cancelled` + + - `:queued` + + - `:incomplete` + + - `text: ResponseTextConfig` + + 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) + + - `format_: ResponseFormatTextConfig` + + An object specifying the format that the model must output. + + Configuring `{ "type": "json_schema" }` enables Structured Outputs, + which ensures the model will match your supplied JSON schema. Learn more in the + [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). + + The default format is `{ "type": "text" }` with no additional options. + + **Not recommended for gpt-4o and newer models:** + + Setting to `{ "type": "json_object" }` enables the older JSON mode, which + ensures the message the model generates is valid JSON. Using `json_schema` + is preferred for models that support it. + + - `class ResponseFormatText` + + Default response format. Used to generate text responses. + + - `type: :text` + + The type of response format being defined. Always `text`. + + - `:text` + + - `class ResponseFormatTextJSONSchemaConfig` + + JSON Schema response format. Used to generate structured JSON responses. + Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). + + - `name: String` + + The name of the response format. Must be a-z, A-Z, 0-9, or contain + underscores and dashes, with a maximum length of 64. + + - `schema: Hash[Symbol, untyped]` + + The schema for the response format, described as a JSON Schema object. + Learn how to build JSON schemas [here](https://json-schema.org/). + + - `type: :json_schema` + + The type of response format being defined. Always `json_schema`. + + - `:json_schema` + + - `description: String` + + A description of what the response format is for, used by the model to + determine how to respond in the format. + + - `strict: bool` + + Whether to enable strict schema adherence when generating the output. + If set to true, the model will always follow the exact schema defined + in the `schema` field. Only a subset of JSON Schema is supported when + `strict` is `true`. To learn more, read the [Structured Outputs + guide](https://platform.openai.com/docs/guides/structured-outputs). + + - `class ResponseFormatJSONObject` + + 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. + + - `type: :json_object` + + The type of response format being defined. Always `json_object`. + + - `:json_object` + + - `verbosity: :low | :medium | :high` + + Constrains the verbosity of the model's response. Lower values will result in + more concise responses, while higher values will result in more verbose responses. + Currently supported values are `low`, `medium`, and `high`. + + - `:low` + + - `:medium` + + - `:high` + + - `top_logprobs: Integer` + + An integer between 0 and 20 specifying the maximum number of most likely + tokens to return at each token position, each with an associated log + probability. In some cases, the number of returned tokens may be fewer than + requested. + + - `truncation: :auto | :disabled` + + The truncation strategy to use for the model response. + + - `auto`: If the input to this Response exceeds + the model's context window size, the model will truncate the + response to fit the context window by dropping items from the beginning of the conversation. + - `disabled` (default): If the input size will exceed the context window + size for a model, the request will fail with a 400 error. + + - `:auto` + + - `:disabled` + + - `usage: ResponseUsage` + + Represents token usage details including input tokens, output tokens, + a breakdown of output tokens, and the total tokens used. + + - `input_tokens: Integer` + + The number of input tokens. + + - `input_tokens_details: InputTokensDetails{ cached_tokens}` + + A detailed breakdown of the input tokens. + + - `cached_tokens: Integer` + + The number of tokens that were retrieved from the cache. + [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching). + + - `output_tokens: Integer` + + The number of output tokens. + + - `output_tokens_details: OutputTokensDetails{ reasoning_tokens}` + + A detailed breakdown of the output tokens. + + - `reasoning_tokens: Integer` + + The number of reasoning tokens. + + - `total_tokens: Integer` + + The total number of tokens used. + + - `user: String` + + This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. + A stable identifier for your end-users. + Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + + - `sequence_number: Integer` + + The sequence number for this event. + + - `type: :"response.completed"` + + The type of the event. Always `response.completed`. + + - `:"response.completed"` + + - `class ResponseContentPartAddedEvent` + + Emitted when a new content part is added. + + - `content_index: Integer` + + The index of the content part that was added. + + - `item_id: String` + + The ID of the output item that the content part was added to. + + - `output_index: Integer` + + The index of the output item that the content part was added to. + + - `part: ResponseOutputText | ResponseOutputRefusal | ReasoningText{ text, type}` + + The content part that was added. + + - `class ResponseOutputText` + + A text output from the model. + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `class ReasoningText` + + Reasoning text from the model. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.content_part.added"` + + The type of the event. Always `response.content_part.added`. + + - `:"response.content_part.added"` + + - `class ResponseContentPartDoneEvent` + + Emitted when a content part is done. + + - `content_index: Integer` + + The index of the content part that is done. + + - `item_id: String` + + The ID of the output item that the content part was added to. + + - `output_index: Integer` + + The index of the output item that the content part was added to. + + - `part: ResponseOutputText | ResponseOutputRefusal | ReasoningText{ text, type}` + + The content part that is done. + + - `class ResponseOutputText` + + A text output from the model. + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `class ReasoningText` + + Reasoning text from the model. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.content_part.done"` + + The type of the event. Always `response.content_part.done`. + + - `:"response.content_part.done"` + + - `class ResponseCreatedEvent` + + An event that is emitted when a response is created. + + - `response: Response` + + The response that was created. + + - `sequence_number: Integer` + + The sequence number for this event. + + - `type: :"response.created"` + + The type of the event. Always `response.created`. + + - `:"response.created"` + + - `class ResponseErrorEvent` + + Emitted when an error occurs. + + - `code: String` + + The error code. + + - `message: String` + + The error message. + + - `param: String` + + The error parameter. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :error` + + The type of the event. Always `error`. + + - `:error` + + - `class ResponseFileSearchCallCompletedEvent` + + Emitted when a file search call is completed (results found). + + - `item_id: String` + + The ID of the output item that the file search call is initiated. + + - `output_index: Integer` + + The index of the output item that the file search call is initiated. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.file_search_call.completed"` + + The type of the event. Always `response.file_search_call.completed`. + + - `:"response.file_search_call.completed"` + + - `class ResponseFileSearchCallInProgressEvent` + + Emitted when a file search call is initiated. + + - `item_id: String` + + The ID of the output item that the file search call is initiated. + + - `output_index: Integer` + + The index of the output item that the file search call is initiated. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.file_search_call.in_progress"` + + The type of the event. Always `response.file_search_call.in_progress`. + + - `:"response.file_search_call.in_progress"` + + - `class ResponseFileSearchCallSearchingEvent` + + Emitted when a file search is currently searching. + + - `item_id: String` + + The ID of the output item that the file search call is initiated. + + - `output_index: Integer` + + The index of the output item that the file search call is searching. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.file_search_call.searching"` + + The type of the event. Always `response.file_search_call.searching`. + + - `:"response.file_search_call.searching"` + + - `class ResponseFunctionCallArgumentsDeltaEvent` + + Emitted when there is a partial function-call arguments delta. + + - `delta: String` + + The function-call arguments delta that is added. + + - `item_id: String` + + The ID of the output item that the function-call arguments delta is added to. + + - `output_index: Integer` + + The index of the output item that the function-call arguments delta is added to. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.function_call_arguments.delta"` + + The type of the event. Always `response.function_call_arguments.delta`. + + - `:"response.function_call_arguments.delta"` + + - `class ResponseFunctionCallArgumentsDoneEvent` + + Emitted when function-call arguments are finalized. + + - `arguments: String` + + The function-call arguments. + + - `item_id: String` + + The ID of the item. + + - `name: String` + + The name of the function that was called. + + - `output_index: Integer` + + The index of the output item. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.function_call_arguments.done"` + + - `:"response.function_call_arguments.done"` + + - `class ResponseInProgressEvent` + + Emitted when the response is in progress. + + - `response: Response` + + The response that is in progress. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.in_progress"` + + The type of the event. Always `response.in_progress`. + + - `:"response.in_progress"` + + - `class ResponseFailedEvent` + + An event that is emitted when a response fails. + + - `response: Response` + + The response that failed. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.failed"` + + The type of the event. Always `response.failed`. + + - `:"response.failed"` + + - `class ResponseIncompleteEvent` + + An event that is emitted when a response finishes as incomplete. + + - `response: Response` + + The response that was incomplete. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.incomplete"` + + The type of the event. Always `response.incomplete`. + + - `:"response.incomplete"` + + - `class ResponseOutputItemAddedEvent` + + Emitted when a new output item is added. + + - `item: ResponseOutputItem` + + The output item that was added. + + - `class ResponseOutputMessage` + + An output message from the model. + + - `class ResponseFileSearchToolCall` + + 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. + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `class ResponseFunctionToolCallOutputItem` + + - `class ResponseFunctionWebSearch` + + 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. + + - `class ResponseComputerToolCall` + + 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. + + - `class ResponseComputerToolCallOutputItem` + + - `class ResponseReasoningItem` + + 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). + + - `class ResponseToolSearchCall` + + - `class ResponseToolSearchOutputItem` + + - `class AdditionalTools` + + - `class ResponseCompactionItem` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `class ResponseFunctionShellToolCall` + + A tool call that executes one or more shell commands in a managed environment. + + - `class ResponseFunctionShellToolCallOutput` + + The output of a shell tool call that was emitted. + + - `class ResponseApplyPatchToolCall` + + A tool call that applies file diffs by creating, deleting, or updating files. + + - `class ResponseApplyPatchToolCallOutput` + + The output emitted by an apply patch tool call. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `class ResponseCustomToolCallOutputItem` + + The output of a custom tool call from your code, being sent back to the model. + + - `output_index: Integer` + + The index of the output item that was added. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.output_item.added"` + + The type of the event. Always `response.output_item.added`. + + - `:"response.output_item.added"` + + - `class ResponseOutputItemDoneEvent` + + Emitted when an output item is marked done. + + - `item: ResponseOutputItem` + + The output item that was marked done. + + - `output_index: Integer` + + The index of the output item that was marked done. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.output_item.done"` + + The type of the event. Always `response.output_item.done`. + + - `:"response.output_item.done"` + + - `class ResponseReasoningSummaryPartAddedEvent` + + Emitted when a new reasoning summary part is added. + + - `item_id: String` + + The ID of the item this summary part is associated with. + + - `output_index: Integer` + + The index of the output item this summary part is associated with. + + - `part: Part{ text, type}` + + The summary part that was added. + + - `text: String` + + The text of the summary part. + + - `type: :summary_text` + + The type of the summary part. Always `summary_text`. + + - `:summary_text` + + - `sequence_number: Integer` + + The sequence number of this event. + + - `summary_index: Integer` + + The index of the summary part within the reasoning summary. + + - `type: :"response.reasoning_summary_part.added"` + + The type of the event. Always `response.reasoning_summary_part.added`. + + - `:"response.reasoning_summary_part.added"` + + - `class ResponseReasoningSummaryPartDoneEvent` + + Emitted when a reasoning summary part is completed. + + - `item_id: String` + + The ID of the item this summary part is associated with. + + - `output_index: Integer` + + The index of the output item this summary part is associated with. + + - `part: Part{ text, type}` + + The completed summary part. + + - `text: String` + + The text of the summary part. + + - `type: :summary_text` + + The type of the summary part. Always `summary_text`. + + - `:summary_text` + + - `sequence_number: Integer` + + The sequence number of this event. + + - `summary_index: Integer` + + The index of the summary part within the reasoning summary. + + - `type: :"response.reasoning_summary_part.done"` + + The type of the event. Always `response.reasoning_summary_part.done`. + + - `:"response.reasoning_summary_part.done"` + + - `class ResponseReasoningSummaryTextDeltaEvent` + + Emitted when a delta is added to a reasoning summary text. + + - `delta: String` + + The text delta that was added to the summary. + + - `item_id: String` + + The ID of the item this summary text delta is associated with. + + - `output_index: Integer` + + The index of the output item this summary text delta is associated with. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `summary_index: Integer` + + The index of the summary part within the reasoning summary. + + - `type: :"response.reasoning_summary_text.delta"` + + The type of the event. Always `response.reasoning_summary_text.delta`. + + - `:"response.reasoning_summary_text.delta"` + + - `class ResponseReasoningSummaryTextDoneEvent` + + Emitted when a reasoning summary text is completed. + + - `item_id: String` + + The ID of the item this summary text is associated with. + + - `output_index: Integer` + + The index of the output item this summary text is associated with. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `summary_index: Integer` + + The index of the summary part within the reasoning summary. + + - `text: String` + + The full text of the completed reasoning summary. + + - `type: :"response.reasoning_summary_text.done"` + + The type of the event. Always `response.reasoning_summary_text.done`. + + - `:"response.reasoning_summary_text.done"` + + - `class ResponseReasoningTextDeltaEvent` + + Emitted when a delta is added to a reasoning text. + + - `content_index: Integer` + + The index of the reasoning content part this delta is associated with. + + - `delta: String` + + The text delta that was added to the reasoning content. + + - `item_id: String` + + The ID of the item this reasoning text delta is associated with. + + - `output_index: Integer` + + The index of the output item this reasoning text delta is associated with. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.reasoning_text.delta"` + + The type of the event. Always `response.reasoning_text.delta`. + + - `:"response.reasoning_text.delta"` + + - `class ResponseReasoningTextDoneEvent` + + Emitted when a reasoning text is completed. + + - `content_index: Integer` + + The index of the reasoning content part. + + - `item_id: String` + + The ID of the item this reasoning text is associated with. + + - `output_index: Integer` + + The index of the output item this reasoning text is associated with. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `text: String` + + The full text of the completed reasoning content. + + - `type: :"response.reasoning_text.done"` + + The type of the event. Always `response.reasoning_text.done`. + + - `:"response.reasoning_text.done"` + + - `class ResponseRefusalDeltaEvent` + + Emitted when there is a partial refusal text. + + - `content_index: Integer` + + The index of the content part that the refusal text is added to. + + - `delta: String` + + The refusal text that is added. + + - `item_id: String` + + The ID of the output item that the refusal text is added to. + + - `output_index: Integer` + + The index of the output item that the refusal text is added to. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.refusal.delta"` + + The type of the event. Always `response.refusal.delta`. + + - `:"response.refusal.delta"` + + - `class ResponseRefusalDoneEvent` + + Emitted when refusal text is finalized. + + - `content_index: Integer` + + The index of the content part that the refusal text is finalized. + + - `item_id: String` + + The ID of the output item that the refusal text is finalized. + + - `output_index: Integer` + + The index of the output item that the refusal text is finalized. + + - `refusal: String` + + The refusal text that is finalized. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.refusal.done"` + + The type of the event. Always `response.refusal.done`. + + - `:"response.refusal.done"` + + - `class ResponseTextDeltaEvent` + + Emitted when there is an additional text delta. + + - `content_index: Integer` + + The index of the content part that the text delta was added to. + + - `delta: String` + + The text delta that was added. + + - `item_id: String` + + The ID of the output item that the text delta was added to. + + - `logprobs: Array[Logprob{ token, logprob, top_logprobs}]` + + The log probabilities of the tokens in the delta. + + - `token: String` + + A possible text token. + + - `logprob: Float` + + The log probability of this token. + + - `top_logprobs: Array[TopLogprob{ token, logprob}]` + + The log probabilities of up to 20 of the most likely tokens. + + - `token: String` + + A possible text token. + + - `logprob: Float` + + The log probability of this token. + + - `output_index: Integer` + + The index of the output item that the text delta was added to. + + - `sequence_number: Integer` + + The sequence number for this event. + + - `type: :"response.output_text.delta"` + + The type of the event. Always `response.output_text.delta`. + + - `:"response.output_text.delta"` + + - `class ResponseTextDoneEvent` + + Emitted when text content is finalized. + + - `content_index: Integer` + + The index of the content part that the text content is finalized. + + - `item_id: String` + + The ID of the output item that the text content is finalized. + + - `logprobs: Array[Logprob{ token, logprob, top_logprobs}]` + + The log probabilities of the tokens in the delta. + + - `token: String` + + A possible text token. + + - `logprob: Float` + + The log probability of this token. + + - `top_logprobs: Array[TopLogprob{ token, logprob}]` + + The log probabilities of up to 20 of the most likely tokens. + + - `token: String` + + A possible text token. + + - `logprob: Float` + + The log probability of this token. + + - `output_index: Integer` + + The index of the output item that the text content is finalized. + + - `sequence_number: Integer` + + The sequence number for this event. + + - `text: String` + + The text content that is finalized. + + - `type: :"response.output_text.done"` + + The type of the event. Always `response.output_text.done`. + + - `:"response.output_text.done"` + + - `class ResponseWebSearchCallCompletedEvent` + + Emitted when a web search call is completed. + + - `item_id: String` + + Unique ID for the output item associated with the web search call. + + - `output_index: Integer` + + The index of the output item that the web search call is associated with. + + - `sequence_number: Integer` + + The sequence number of the web search call being processed. + + - `type: :"response.web_search_call.completed"` + + The type of the event. Always `response.web_search_call.completed`. + + - `:"response.web_search_call.completed"` + + - `class ResponseWebSearchCallInProgressEvent` + + Emitted when a web search call is initiated. + + - `item_id: String` + + Unique ID for the output item associated with the web search call. + + - `output_index: Integer` + + The index of the output item that the web search call is associated with. + + - `sequence_number: Integer` + + The sequence number of the web search call being processed. + + - `type: :"response.web_search_call.in_progress"` + + The type of the event. Always `response.web_search_call.in_progress`. + + - `:"response.web_search_call.in_progress"` + + - `class ResponseWebSearchCallSearchingEvent` + + Emitted when a web search call is executing. + + - `item_id: String` + + Unique ID for the output item associated with the web search call. + + - `output_index: Integer` + + The index of the output item that the web search call is associated with. + + - `sequence_number: Integer` + + The sequence number of the web search call being processed. + + - `type: :"response.web_search_call.searching"` + + The type of the event. Always `response.web_search_call.searching`. + + - `:"response.web_search_call.searching"` + + - `class ResponseImageGenCallCompletedEvent` + + Emitted when an image generation tool call has completed and the final image is available. + + - `item_id: String` + + The unique identifier of the image generation item being processed. + + - `output_index: Integer` + + The index of the output item in the response's output array. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.image_generation_call.completed"` + + The type of the event. Always 'response.image_generation_call.completed'. + + - `:"response.image_generation_call.completed"` + + - `class ResponseImageGenCallGeneratingEvent` + + Emitted when an image generation tool call is actively generating an image (intermediate state). + + - `item_id: String` + + The unique identifier of the image generation item being processed. + + - `output_index: Integer` + + The index of the output item in the response's output array. + + - `sequence_number: Integer` + + The sequence number of the image generation item being processed. + + - `type: :"response.image_generation_call.generating"` + + The type of the event. Always 'response.image_generation_call.generating'. + + - `:"response.image_generation_call.generating"` + + - `class ResponseImageGenCallInProgressEvent` + + Emitted when an image generation tool call is in progress. + + - `item_id: String` + + The unique identifier of the image generation item being processed. + + - `output_index: Integer` + + The index of the output item in the response's output array. + + - `sequence_number: Integer` + + The sequence number of the image generation item being processed. + + - `type: :"response.image_generation_call.in_progress"` + + The type of the event. Always 'response.image_generation_call.in_progress'. + + - `:"response.image_generation_call.in_progress"` + + - `class ResponseImageGenCallPartialImageEvent` + + Emitted when a partial image is available during image generation streaming. + + - `item_id: String` + + The unique identifier of the image generation item being processed. + + - `output_index: Integer` + + The index of the output item in the response's output array. + + - `partial_image_b64: String` + + Base64-encoded partial image data, suitable for rendering as an image. + + - `partial_image_index: Integer` + + 0-based index for the partial image (backend is 1-based, but this is 0-based for the user). + + - `sequence_number: Integer` + + The sequence number of the image generation item being processed. + + - `type: :"response.image_generation_call.partial_image"` + + The type of the event. Always 'response.image_generation_call.partial_image'. + + - `:"response.image_generation_call.partial_image"` + + - `class ResponseMcpCallArgumentsDeltaEvent` + + Emitted when there is a delta (partial update) to the arguments of an MCP tool call. + + - `delta: String` + + A JSON string containing the partial update to the arguments for the MCP tool call. + + - `item_id: String` + + The unique identifier of the MCP tool call item being processed. + + - `output_index: Integer` + + The index of the output item in the response's output array. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.mcp_call_arguments.delta"` + + The type of the event. Always 'response.mcp_call_arguments.delta'. + + - `:"response.mcp_call_arguments.delta"` + + - `class ResponseMcpCallArgumentsDoneEvent` + + Emitted when the arguments for an MCP tool call are finalized. + + - `arguments: String` + + A JSON string containing the finalized arguments for the MCP tool call. + + - `item_id: String` + + The unique identifier of the MCP tool call item being processed. + + - `output_index: Integer` + + The index of the output item in the response's output array. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.mcp_call_arguments.done"` + + The type of the event. Always 'response.mcp_call_arguments.done'. + + - `:"response.mcp_call_arguments.done"` + + - `class ResponseMcpCallCompletedEvent` + + Emitted when an MCP tool call has completed successfully. + + - `item_id: String` + + The ID of the MCP tool call item that completed. + + - `output_index: Integer` + + The index of the output item that completed. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.mcp_call.completed"` + + The type of the event. Always 'response.mcp_call.completed'. + + - `:"response.mcp_call.completed"` + + - `class ResponseMcpCallFailedEvent` + + Emitted when an MCP tool call has failed. + + - `item_id: String` + + The ID of the MCP tool call item that failed. + + - `output_index: Integer` + + The index of the output item that failed. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.mcp_call.failed"` + + The type of the event. Always 'response.mcp_call.failed'. + + - `:"response.mcp_call.failed"` + + - `class ResponseMcpCallInProgressEvent` + + Emitted when an MCP tool call is in progress. + + - `item_id: String` + + The unique identifier of the MCP tool call item being processed. + + - `output_index: Integer` + + The index of the output item in the response's output array. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.mcp_call.in_progress"` + + The type of the event. Always 'response.mcp_call.in_progress'. + + - `:"response.mcp_call.in_progress"` + + - `class ResponseMcpListToolsCompletedEvent` + + Emitted when the list of available MCP tools has been successfully retrieved. + + - `item_id: String` + + The ID of the MCP tool call item that produced this output. + + - `output_index: Integer` + + The index of the output item that was processed. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.mcp_list_tools.completed"` + + The type of the event. Always 'response.mcp_list_tools.completed'. + + - `:"response.mcp_list_tools.completed"` + + - `class ResponseMcpListToolsFailedEvent` + + Emitted when the attempt to list available MCP tools has failed. + + - `item_id: String` + + The ID of the MCP tool call item that failed. + + - `output_index: Integer` + + The index of the output item that failed. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.mcp_list_tools.failed"` + + The type of the event. Always 'response.mcp_list_tools.failed'. + + - `:"response.mcp_list_tools.failed"` + + - `class ResponseMcpListToolsInProgressEvent` + + Emitted when the system is in the process of retrieving the list of available MCP tools. + + - `item_id: String` + + The ID of the MCP tool call item that is being processed. + + - `output_index: Integer` + + The index of the output item that is being processed. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.mcp_list_tools.in_progress"` + + The type of the event. Always 'response.mcp_list_tools.in_progress'. + + - `:"response.mcp_list_tools.in_progress"` + + - `class ResponseOutputTextAnnotationAddedEvent` + + Emitted when an annotation is added to output text content. + + - `annotation: untyped` + + The annotation object being added. (See annotation schema for details.) + + - `annotation_index: Integer` + + The index of the annotation within the content part. + + - `content_index: Integer` + + The index of the content part within the output item. + + - `item_id: String` + + The unique identifier of the item to which the annotation is being added. + + - `output_index: Integer` + + The index of the output item in the response's output array. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.output_text.annotation.added"` + + The type of the event. Always 'response.output_text.annotation.added'. + + - `:"response.output_text.annotation.added"` + + - `class ResponseQueuedEvent` + + Emitted when a response is queued and waiting to be processed. + + - `response: Response` + + The full response object that is queued. + + - `sequence_number: Integer` + + The sequence number for this event. + + - `type: :"response.queued"` + + The type of the event. Always 'response.queued'. + + - `:"response.queued"` + + - `class ResponseCustomToolCallInputDeltaEvent` + + Event representing a delta (partial update) to the input of a custom tool call. + + - `delta: String` + + The incremental input data (delta) for the custom tool call. + + - `item_id: String` + + Unique identifier for the API item associated with this event. + + - `output_index: Integer` + + The index of the output this delta applies to. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.custom_tool_call_input.delta"` + + The event type identifier. + + - `:"response.custom_tool_call_input.delta"` + + - `class ResponseCustomToolCallInputDoneEvent` + + Event indicating that input for a custom tool call is complete. + + - `input: String` + + The complete input data for the custom tool call. + + - `item_id: String` + + Unique identifier for the API item associated with this event. + + - `output_index: Integer` + + The index of the output this event applies to. + + - `sequence_number: Integer` + + The sequence number of this event. + + - `type: :"response.custom_tool_call_input.done"` + + The event type identifier. + + - `:"response.custom_tool_call_input.done"` + +### Skill Reference + +- `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + +### Tool + +- `Tool = FunctionTool | FileSearchTool | ComputerTool | 12 more` + + A tool that can be used to generate a response. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + +### Tool Choice Allowed + +- `class ToolChoiceAllowed` + + Constrains the tools available to the model to a pre-defined set. + + - `mode: :auto | :required` + + Constrains the tools available to the model to a pre-defined set. + + `auto` allows the model to pick from among the allowed tools and generate a + message. + + `required` requires the model to call one or more of the allowed tools. + + - `:auto` + + - `:required` + + - `tools: Array[Hash[Symbol, untyped]]` + + A list of tool definitions that the model should be allowed to call. + + For the Responses API, the list of tool definitions might look like: + + ```json + [ + { "type": "function", "name": "get_weather" }, + { "type": "mcp", "server_label": "deepwiki" }, + { "type": "image_generation" } + ] + ``` + + - `type: :allowed_tools` + + Allowed tool configuration type. Always `allowed_tools`. + + - `:allowed_tools` + +### Tool Choice Apply Patch + +- `class ToolChoiceApplyPatch` + + Forces the model to call the apply_patch tool when executing a tool call. + + - `type: :apply_patch` + + The tool to call. Always `apply_patch`. + + - `:apply_patch` + +### Tool Choice Custom + +- `class ToolChoiceCustom` + + Use this option to force the model to call a specific custom tool. + + - `name: String` + + The name of the custom tool to call. + + - `type: :custom` + + For custom tool calling, the type is always `custom`. + + - `:custom` + +### Tool Choice Function + +- `class ToolChoiceFunction` + + Use this option to force the model to call a specific function. + + - `name: String` + + The name of the function to call. + + - `type: :function` + + For function calling, the type is always `function`. + + - `:function` + +### Tool Choice Mcp + +- `class ToolChoiceMcp` + + Use this option to force the model to call a specific tool on a remote MCP server. + + - `server_label: String` + + The label of the MCP server to use. + + - `type: :mcp` + + For MCP tools, the type is always `mcp`. + + - `:mcp` + + - `name: String` + + The name of the tool to call on the server. + +### Tool Choice Options + +- `ToolChoiceOptions = :none | :auto | :required` + + Controls which (if any) tool is called by the model. + + `none` means the model will not call any tool and instead generates a message. + + `auto` means the model can pick between generating a message or calling one or + more tools. + + `required` means the model must call one or more tools. + + - `:none` + + - `:auto` + + - `:required` + +### Tool Choice Shell + +- `class ToolChoiceShell` + + Forces the model to call the shell tool when a tool call is required. + + - `type: :shell` + + The tool to call. Always `shell`. + + - `:shell` + +### Tool Choice Types + +- `class ToolChoiceTypes` + + 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). + + - `type: :file_search | :web_search_preview | :computer | 5 more` + + The type of hosted tool the model should to use. Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + + Allowed values are: + + - `file_search` + - `web_search_preview` + - `computer` + - `computer_use_preview` + - `computer_use` + - `code_interpreter` + - `image_generation` + + - `:file_search` + + - `:web_search_preview` + + - `:computer` + + - `:computer_use_preview` + + - `:computer_use` + + - `:web_search_preview_2025_03_11` + + - `:image_generation` + + - `:code_interpreter` + +### Tool Search Tool + +- `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + +### Web Search Preview Tool + +- `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + +### Web Search Tool + +- `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + +# Input Items + +## List input items + +`responses.input_items.list(response_id, **kwargs) -> CursorPage` + +**get** `/responses/{response_id}/input_items` + +Returns a list of input items for a given response. + +### Parameters + +- `response_id: String` + +- `after: String` + + An item ID to list items after, used in pagination. + +- `include: Array[ResponseIncludable]` + + Additional fields to include in the response. See the `include` + parameter for Response creation above for more information. + + - `:"file_search_call.results"` + + - `:"web_search_call.results"` + + - `:"web_search_call.action.sources"` + + - `:"message.input_image.image_url"` + + - `:"computer_call_output.output.image_url"` + + - `:"code_interpreter_call.outputs"` + + - `:"reasoning.encrypted_content"` + + - `:"message.output_text.logprobs"` + +- `limit: Integer` + + A limit on the number of objects to be returned. Limit can range between + 1 and 100, and the default is 20. + +- `order: :asc | :desc` + + The order to return the input items in. Default is `desc`. + + - `asc`: Return the input items in ascending order. + - `desc`: Return the input items in descending order. + + - `:asc` + + - `:desc` + +### Returns + +- `ResponseItem = ResponseInputMessageItem | ResponseOutputMessage | ResponseFileSearchToolCall | 24 more` + + Content item used to generate a response. + + - `class ResponseInputMessageItem` + + - `id: String` + + The unique ID of the message input. + + - `content: ResponseInputMessageContentList` + + A list of one or many input items to the model, containing different content + types. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `role: :user | :system | :developer` + + The role of the message input. One of `user`, `system`, or `developer`. + + - `:user` + + - `:system` + + - `:developer` + + - `type: :message` + + The type of the message input. Always set to `message`. + + - `:message` + + - `status: :in_progress | :completed | :incomplete` + + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseOutputMessage` + + An output message from the model. + + - `id: String` + + The unique ID of the output message. + + - `content: Array[ResponseOutputText | ResponseOutputRefusal]` + + The content of the output message. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `role: :assistant` + + The role of the output message. Always `assistant`. + + - `:assistant` + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the output message. Always `message`. + + - `:message` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `class ResponseFileSearchToolCall` + + 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. + + - `id: String` + + The unique ID of the file search tool call. + + - `queries: Array[String]` + + The queries used to search for files. + + - `status: :in_progress | :searching | :completed | 2 more` + + The status of the file search tool call. One of `in_progress`, + `searching`, `incomplete` or `failed`, + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `type: :file_search_call` + + The type of the file search tool call. Always `file_search_call`. + + - `:file_search_call` + + - `results: Array[Result{ attributes, file_id, filename, 2 more}]` + + The results of the file search tool call. + + - `attributes: Hash[Symbol, String | Float | bool]` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. Keys are strings + with a maximum length of 64 characters. Values are strings with a maximum + length of 512 characters, booleans, or numbers. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `file_id: String` + + The unique ID of the file. + + - `filename: String` + + The name of the file. + + - `score: Float` + + The relevance score of the file - a value between 0 and 1. + + - `text: String` + + The text that was retrieved from the file. + + - `class ResponseComputerToolCall` + + 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. + + - `id: String` + + The unique ID of the computer call. + + - `call_id: String` + + An identifier used when responding to the tool call with output. + + - `pending_safety_checks: Array[PendingSafetyCheck{ id, code, message}]` + + The pending safety checks for the computer call. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :computer_call` + + The type of the computer call. Always `computer_call`. + + - `:computer_call` + + - `action: Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `actions: ComputerActionList` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `class ResponseComputerToolCallOutputItem` + + - `id: String` + + The unique ID of the computer call tool output. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + + - `status: :completed | :incomplete | :failed | :in_progress` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `:in_progress` + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the + developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseFunctionWebSearch` + + 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. + + - `id: String` + + The unique ID of the web search tool call. + + - `action: Search{ type, queries, query, sources} | OpenPage{ type, url} | FindInPage{ pattern, type, url}` + + An object describing the specific action taken in this web search call. + Includes details on how the model used the web (search, open_page, find_in_page). + + - `class Search` + + Action type "search" - Performs a web search query. + + - `type: :search` + + The action type. + + - `:search` + + - `queries: Array[String]` + + The search queries. + + - `query: String` + + The search query. + + - `sources: Array[Source{ type, url}]` + + The sources used in the search. + + - `type: :url` + + The type of source. Always `url`. + + - `:url` + + - `url: String` + + The URL of the source. + + - `class OpenPage` + + Action type "open_page" - Opens a specific URL from search results. + + - `type: :open_page` + + The action type. + + - `:open_page` + + - `url: String` + + The URL opened by the model. + + - `class FindInPage` + + Action type "find_in_page": Searches for a pattern within a loaded page. + + - `pattern: String` + + The pattern or text to search for within the page. + + - `type: :find_in_page` + + The action type. + + - `:find_in_page` + + - `url: String` + + The URL of the page searched for the pattern. + + - `status: :in_progress | :searching | :completed | :failed` + + The status of the web search tool call. + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:failed` + + - `type: :web_search_call` + + The type of the web search tool call. Always `web_search_call`. + + - `:web_search_call` + + - `class ResponseFunctionToolCallItem` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `id: String` + + The unique ID of the function tool call. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseFunctionToolCallOutputItem` + + - `id: String` + + The unique ID of the function call tool output. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the function call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the function call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the function call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseToolSearchCall` + + - `id: String` + + The unique ID of the tool search call item. + + - `arguments: untyped` + + Arguments used for the tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :tool_search_call` + + The type of the item. Always `tool_search_call`. + + - `:tool_search_call` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseToolSearchOutputItem` + + - `id: String` + + The unique ID of the tool search output item. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by tool search. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The type of the item. Always `tool_search_output`. + + - `:tool_search_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class AdditionalTools` + + - `id: String` + + The unique ID of the additional tools item. + + - `role: :unknown | :user | :assistant | 5 more` + + The role that provided the additional tools. + + - `:unknown` + + - `:user` + + - `:assistant` + + - `:system` + + - `:critic` + + - `:discriminator` + + - `:developer` + + - `:tool` + + - `tools: Array[Tool]` + + The additional tool definitions made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The type of the item. Always `additional_tools`. + + - `:additional_tools` + + - `class ResponseReasoningItem` + + 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). + + - `id: String` + + The unique identifier of the reasoning content. + + - `summary: Array[Summary{ text, type}]` + + Reasoning summary content. + + - `text: String` + + A summary of the reasoning output from the model so far. + + - `type: :summary_text` + + The type of the object. Always `summary_text`. + + - `:summary_text` + + - `type: :reasoning` + + The type of the object. Always `reasoning`. + + - `:reasoning` + + - `content: Array[Content{ text, type}]` + + Reasoning text content. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `encrypted_content: String` + + The encrypted content of the reasoning item - populated when a response is + generated with `reasoning.encrypted_content` in the `include` parameter. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseCompactionItem` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `id: String` + + The unique ID of the compaction item. + + - `encrypted_content: String` + + The encrypted content that was produced by compaction. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `id: String` + + The unique ID of the code interpreter tool call. + + - `code: String` + + The code to run, or null if not available. + + - `container_id: String` + + The ID of the container used to run the code. + + - `outputs: Array[Logs{ logs, type} | Image{ type, url}]` + + The outputs generated by the code interpreter, such as logs or images. + Can be null if no outputs are available. + + - `class Logs` + + The logs output from the code interpreter. + + - `logs: String` + + The logs output from the code interpreter. + + - `type: :logs` + + The type of the output. Always `logs`. + + - `:logs` + + - `class Image` + + The image output from the code interpreter. + + - `type: :image` + + The type of the output. Always `image`. + + - `:image` + + - `url: String` + + The URL of the image output from the code interpreter. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:interpreting` + + - `:failed` + + - `type: :code_interpreter_call` + + The type of the code interpreter tool call. Always `code_interpreter_call`. + + - `:code_interpreter_call` + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionShellToolCall` + + A tool call that executes one or more shell commands in a managed environment. + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + - `max_output_length: Integer` + + Optional maximum number of characters to return from each command. + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the commands. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `environment: ResponseLocalEnvironment | ResponseContainerReference` + + Represents the use of a local environment to perform shell actions. + + - `class ResponseLocalEnvironment` + + Represents the use of a local environment to perform shell actions. + + - `type: :local` + + The environment type. Always `local`. + + - `:local` + + - `class ResponseContainerReference` + + Represents a container created with /v1/containers. + + - `container_id: String` + + - `type: :container_reference` + + The environment type. Always `container_reference`. + + - `:container_reference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseFunctionShellToolCallOutput` + + The output of a shell tool call that was emitted. + + - `id: String` + + The unique ID of the shell call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `max_output_length: Integer` + + The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output. + + - `output: Array[Output{ outcome, stderr, stdout, created_by}]` + + An array of shell call output contents + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + Exit code from the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + The standard error output that was captured. + + - `stdout: String` + + The standard output that was captured. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call_output` + + The type of the shell call output. Always `shell_call_output`. + + - `:shell_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseApplyPatchToolCall` + + A tool call that applies file diffs by creating, deleting, or updating files. + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + One of the create_file, delete_file, or update_file operations applied via apply_patch. + + - `class CreateFile` + + Instruction describing how to create a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to create. + + - `type: :create_file` + + Create a new file with the provided diff. + + - `:create_file` + + - `class DeleteFile` + + Instruction describing how to delete a file via the apply_patch tool. + + - `path: String` + + Path of the file to delete. + + - `type: :delete_file` + + Delete the specified file. + + - `:delete_file` + + - `class UpdateFile` + + Instruction describing how to update a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to update. + + - `type: :update_file` + + Update an existing file with the provided diff. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseApplyPatchToolCallOutput` + + The output emitted by an apply patch tool call. + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `created_by: String` + + The ID of the entity that created this tool call output. + + - `output: String` + + Optional textual output returned by the apply patch tool. + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `id: String` + + The unique ID of the approval response + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `reason: String` + + Optional reason for the decision. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class ResponseCustomToolCallItem` + + A call to a custom tool created by the model. + + - `id: String` + + The unique ID of the custom tool call item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseCustomToolCallOutputItem` + + The output of a custom tool call from your code, being sent back to the model. + + - `id: String` + + The unique ID of the custom tool call output item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + +### Example + +```ruby +require "openai" + +openai = OpenAI::Client.new(api_key: "My API Key") + +page = openai.responses.input_items.list("response_id") + +puts(page) +``` + +#### Response + +```json +{ + "data": [ + { + "id": "id", + "content": [ + { + "text": "text", + "type": "input_text" + } + ], + "role": "user", + "type": "message", + "status": "in_progress" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id", + "object": "list" +} +``` + +## Domain Types + +### Response Item List + +- `class ResponseItemList` + + A list of Response items. + + - `data: Array[ResponseItem]` + + A list of items used to generate this response. + + - `class ResponseInputMessageItem` + + - `id: String` + + The unique ID of the message input. + + - `content: ResponseInputMessageContentList` + + A list of one or many input items to the model, containing different content + types. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `role: :user | :system | :developer` + + The role of the message input. One of `user`, `system`, or `developer`. + + - `:user` + + - `:system` + + - `:developer` + + - `type: :message` + + The type of the message input. Always set to `message`. + + - `:message` + + - `status: :in_progress | :completed | :incomplete` + + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseOutputMessage` + + An output message from the model. + + - `id: String` + + The unique ID of the output message. + + - `content: Array[ResponseOutputText | ResponseOutputRefusal]` + + The content of the output message. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `role: :assistant` + + The role of the output message. Always `assistant`. + + - `:assistant` + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the output message. Always `message`. + + - `:message` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `class ResponseFileSearchToolCall` + + 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. + + - `id: String` + + The unique ID of the file search tool call. + + - `queries: Array[String]` + + The queries used to search for files. + + - `status: :in_progress | :searching | :completed | 2 more` + + The status of the file search tool call. One of `in_progress`, + `searching`, `incomplete` or `failed`, + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `type: :file_search_call` + + The type of the file search tool call. Always `file_search_call`. + + - `:file_search_call` + + - `results: Array[Result{ attributes, file_id, filename, 2 more}]` + + The results of the file search tool call. + + - `attributes: Hash[Symbol, String | Float | bool]` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. Keys are strings + with a maximum length of 64 characters. Values are strings with a maximum + length of 512 characters, booleans, or numbers. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `file_id: String` + + The unique ID of the file. + + - `filename: String` + + The name of the file. + + - `score: Float` + + The relevance score of the file - a value between 0 and 1. + + - `text: String` + + The text that was retrieved from the file. + + - `class ResponseComputerToolCall` + + 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. + + - `id: String` + + The unique ID of the computer call. + + - `call_id: String` + + An identifier used when responding to the tool call with output. + + - `pending_safety_checks: Array[PendingSafetyCheck{ id, code, message}]` + + The pending safety checks for the computer call. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :computer_call` + + The type of the computer call. Always `computer_call`. + + - `:computer_call` + + - `action: Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `actions: ComputerActionList` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `class ResponseComputerToolCallOutputItem` + + - `id: String` + + The unique ID of the computer call tool output. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + + - `status: :completed | :incomplete | :failed | :in_progress` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `:in_progress` + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the + developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseFunctionWebSearch` + + 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. + + - `id: String` + + The unique ID of the web search tool call. + + - `action: Search{ type, queries, query, sources} | OpenPage{ type, url} | FindInPage{ pattern, type, url}` + + An object describing the specific action taken in this web search call. + Includes details on how the model used the web (search, open_page, find_in_page). + + - `class Search` + + Action type "search" - Performs a web search query. + + - `type: :search` + + The action type. + + - `:search` + + - `queries: Array[String]` + + The search queries. + + - `query: String` + + The search query. + + - `sources: Array[Source{ type, url}]` + + The sources used in the search. + + - `type: :url` + + The type of source. Always `url`. + + - `:url` + + - `url: String` + + The URL of the source. + + - `class OpenPage` + + Action type "open_page" - Opens a specific URL from search results. + + - `type: :open_page` + + The action type. + + - `:open_page` + + - `url: String` + + The URL opened by the model. + + - `class FindInPage` + + Action type "find_in_page": Searches for a pattern within a loaded page. + + - `pattern: String` + + The pattern or text to search for within the page. + + - `type: :find_in_page` + + The action type. + + - `:find_in_page` + + - `url: String` + + The URL of the page searched for the pattern. + + - `status: :in_progress | :searching | :completed | :failed` + + The status of the web search tool call. + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:failed` + + - `type: :web_search_call` + + The type of the web search tool call. Always `web_search_call`. + + - `:web_search_call` + + - `class ResponseFunctionToolCallItem` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `id: String` + + The unique ID of the function tool call. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseFunctionToolCallOutputItem` + + - `id: String` + + The unique ID of the function call tool output. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the function call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the function call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the function call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseToolSearchCall` + + - `id: String` + + The unique ID of the tool search call item. + + - `arguments: untyped` + + Arguments used for the tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :tool_search_call` + + The type of the item. Always `tool_search_call`. + + - `:tool_search_call` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseToolSearchOutputItem` + + - `id: String` + + The unique ID of the tool search output item. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output item that was recorded. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by tool search. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The type of the item. Always `tool_search_output`. + + - `:tool_search_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class AdditionalTools` + + - `id: String` + + The unique ID of the additional tools item. + + - `role: :unknown | :user | :assistant | 5 more` + + The role that provided the additional tools. + + - `:unknown` + + - `:user` + + - `:assistant` + + - `:system` + + - `:critic` + + - `:discriminator` + + - `:developer` + + - `:tool` + + - `tools: Array[Tool]` + + The additional tool definitions made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The type of the item. Always `additional_tools`. + + - `:additional_tools` + + - `class ResponseReasoningItem` + + 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). + + - `id: String` + + The unique identifier of the reasoning content. + + - `summary: Array[Summary{ text, type}]` + + Reasoning summary content. + + - `text: String` + + A summary of the reasoning output from the model so far. + + - `type: :summary_text` + + The type of the object. Always `summary_text`. + + - `:summary_text` + + - `type: :reasoning` + + The type of the object. Always `reasoning`. + + - `:reasoning` + + - `content: Array[Content{ text, type}]` + + Reasoning text content. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `encrypted_content: String` + + The encrypted content of the reasoning item - populated when a response is + generated with `reasoning.encrypted_content` in the `include` parameter. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseCompactionItem` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `id: String` + + The unique ID of the compaction item. + + - `encrypted_content: String` + + The encrypted content that was produced by compaction. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `id: String` + + The unique ID of the code interpreter tool call. + + - `code: String` + + The code to run, or null if not available. + + - `container_id: String` + + The ID of the container used to run the code. + + - `outputs: Array[Logs{ logs, type} | Image{ type, url}]` + + The outputs generated by the code interpreter, such as logs or images. + Can be null if no outputs are available. + + - `class Logs` + + The logs output from the code interpreter. + + - `logs: String` + + The logs output from the code interpreter. + + - `type: :logs` + + The type of the output. Always `logs`. + + - `:logs` + + - `class Image` + + The image output from the code interpreter. + + - `type: :image` + + The type of the output. Always `image`. + + - `:image` + + - `url: String` + + The URL of the image output from the code interpreter. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:interpreting` + + - `:failed` + + - `type: :code_interpreter_call` + + The type of the code interpreter tool call. Always `code_interpreter_call`. + + - `:code_interpreter_call` + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionShellToolCall` + + A tool call that executes one or more shell commands in a managed environment. + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + - `max_output_length: Integer` + + Optional maximum number of characters to return from each command. + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the commands. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `environment: ResponseLocalEnvironment | ResponseContainerReference` + + Represents the use of a local environment to perform shell actions. + + - `class ResponseLocalEnvironment` + + Represents the use of a local environment to perform shell actions. + + - `type: :local` + + The environment type. Always `local`. + + - `:local` + + - `class ResponseContainerReference` + + Represents a container created with /v1/containers. + + - `container_id: String` + + - `type: :container_reference` + + The environment type. Always `container_reference`. + + - `:container_reference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseFunctionShellToolCallOutput` + + The output of a shell tool call that was emitted. + + - `id: String` + + The unique ID of the shell call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `max_output_length: Integer` + + The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output. + + - `output: Array[Output{ outcome, stderr, stdout, created_by}]` + + An array of shell call output contents + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + Exit code from the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + The standard error output that was captured. + + - `stdout: String` + + The standard output that was captured. + + - `created_by: String` + + The identifier of the actor that created the item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :shell_call_output` + + The type of the shell call output. Always `shell_call_output`. + + - `:shell_call_output` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseApplyPatchToolCall` + + A tool call that applies file diffs by creating, deleting, or updating files. + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + One of the create_file, delete_file, or update_file operations applied via apply_patch. + + - `class CreateFile` + + Instruction describing how to create a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to create. + + - `type: :create_file` + + Create a new file with the provided diff. + + - `:create_file` + + - `class DeleteFile` + + Instruction describing how to delete a file via the apply_patch tool. + + - `path: String` + + Path of the file to delete. + + - `type: :delete_file` + + Delete the specified file. + + - `:delete_file` + + - `class UpdateFile` + + Instruction describing how to update a file via the apply_patch tool. + + - `diff: String` + + Diff to apply. + + - `path: String` + + Path of the file to update. + + - `type: :update_file` + + Update an existing file with the provided diff. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `created_by: String` + + The ID of the entity that created this tool call. + + - `class ResponseApplyPatchToolCallOutput` + + The output emitted by an apply patch tool call. + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `created_by: String` + + The ID of the entity that created this tool call output. + + - `output: String` + + Optional textual output returned by the apply patch tool. + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `id: String` + + The unique ID of the approval response + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `reason: String` + + Optional reason for the decision. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class ResponseCustomToolCallItem` + + A call to a custom tool created by the model. + + - `id: String` + + The unique ID of the custom tool call item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `class ResponseCustomToolCallOutputItem` + + The output of a custom tool call from your code, being sent back to the model. + + - `id: String` + + The unique ID of the custom tool call output item. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `created_by: String` + + The identifier of the actor that created the item. + + - `first_id: String` + + The ID of the first item in the list. + + - `has_more: bool` + + Whether there are more items available. + + - `last_id: String` + + The ID of the last item in the list. + + - `object: :list` + + The type of object returned, must be `list`. + + - `:list` + +# Input Tokens + +## Get input token counts + +`responses.input_tokens.count(**kwargs) -> InputTokenCountResponse` + +**post** `/responses/input_tokens` + +Returns input token counts of the request. + +Returns an object with `object` set to `response.input_tokens` and an `input_tokens` count. + +### Parameters + +- `conversation: String | ResponseConversationParam` + + The conversation that this response belongs to. Items from this conversation are prepended to `input_items` for this response request. + Input items and output items from this response are automatically added to this conversation after this response completes. + + - `String = String` + + The unique ID of the conversation. + + - `class ResponseConversationParam` + + The conversation that this response belongs to. + + - `id: String` + + The unique ID of the conversation. + +- `input: String | Array[ResponseInputItem]` + + Text, image, or file inputs to the model, used to generate a response + + - `String = String` + + A text input to the model, equivalent to a text input with the `user` role. + + - `UnionMember1 = Array[ResponseInputItem]` + + A list of one or many input items to the model, containing different content types. + + - `class EasyInputMessage` + + 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. + + - `content: String | ResponseInputMessageContentList` + + Text, image, or audio input to the model, used to generate a response. + Can also contain previous assistant responses. + + - `String = String` + + A text input to the model. + + - `ResponseInputMessageContentList = Array[ResponseInputContent]` + + A list of one or many input items to the model, containing different content + types. + + - `class ResponseInputText` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The content of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `role: :user | :assistant | :system | :developer` + + The role of the message input. One of `user`, `assistant`, `system`, or + `developer`. + + - `:user` + + - `:assistant` + + - `:system` + + - `:developer` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `type: :message` + + The type of the message input. Always `message`. + + - `:message` + + - `class Message` + + 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. + + - `content: ResponseInputMessageContentList` + + A list of one or many input items to the model, containing different content + types. + + - `role: :user | :system | :developer` + + The role of the message input. One of `user`, `system`, or `developer`. + + - `:user` + + - `:system` + + - `:developer` + + - `status: :in_progress | :completed | :incomplete` + + The status of item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the message input. Always set to `message`. + + - `:message` + + - `class ResponseOutputMessage` + + An output message from the model. + + - `id: String` + + The unique ID of the output message. + + - `content: Array[ResponseOutputText | ResponseOutputRefusal]` + + The content of the output message. + + - `class ResponseOutputText` + + A text output from the model. + + - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more} | FilePath{ file_id, index, type}]` + + The annotations of the text output. + + - `class FileCitation` + + A citation to a file. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the file cited. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_citation` + + The type of the file citation. Always `file_citation`. + + - `:file_citation` + + - `class URLCitation` + + A citation for a web resource used to generate a model response. + + - `end_index: Integer` + + The index of the last character of the URL citation in the message. + + - `start_index: Integer` + + The index of the first character of the URL citation in the message. + + - `title: String` + + The title of the web resource. + + - `type: :url_citation` + + The type of the URL citation. Always `url_citation`. + + - `:url_citation` + + - `url: String` + + The URL of the web resource. + + - `class ContainerFileCitation` + + A citation for a container file used to generate a model response. + + - `container_id: String` + + The ID of the container file. + + - `end_index: Integer` + + The index of the last character of the container file citation in the message. + + - `file_id: String` + + The ID of the file. + + - `filename: String` + + The filename of the container file cited. + + - `start_index: Integer` + + The index of the first character of the container file citation in the message. + + - `type: :container_file_citation` + + The type of the container file citation. Always `container_file_citation`. + + - `:container_file_citation` + + - `class FilePath` + + A path to a file. + + - `file_id: String` + + The ID of the file. + + - `index: Integer` + + The index of the file in the list of files. + + - `type: :file_path` + + The type of the file path. Always `file_path`. + + - `:file_path` + + - `text: String` + + The text output from the model. + + - `type: :output_text` + + The type of the output text. Always `output_text`. + + - `:output_text` + + - `logprobs: Array[Logprob{ token, bytes, logprob, top_logprobs}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `top_logprobs: Array[TopLogprob{ token, bytes, logprob}]` + + - `token: String` + + - `bytes: Array[Integer]` + + - `logprob: Float` + + - `class ResponseOutputRefusal` + + A refusal from the model. + + - `refusal: String` + + The refusal explanation from the model. + + - `type: :refusal` + + The type of the refusal. Always `refusal`. + + - `:refusal` + + - `role: :assistant` + + The role of the output message. Always `assistant`. + + - `:assistant` + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :message` + + The type of the output message. Always `message`. + + - `:message` + + - `phase: :commentary | :final_answer` + + Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). + For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend + phase on all assistant messages — dropping it can degrade performance. Not used for user messages. + + - `:commentary` + + - `:final_answer` + + - `class ResponseFileSearchToolCall` + + 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. + + - `id: String` + + The unique ID of the file search tool call. + + - `queries: Array[String]` + + The queries used to search for files. + + - `status: :in_progress | :searching | :completed | 2 more` + + The status of the file search tool call. One of `in_progress`, + `searching`, `incomplete` or `failed`, + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:incomplete` + + - `:failed` + + - `type: :file_search_call` + + The type of the file search tool call. Always `file_search_call`. + + - `:file_search_call` + + - `results: Array[Result{ attributes, file_id, filename, 2 more}]` + + The results of the file search tool call. + + - `attributes: Hash[Symbol, String | Float | bool]` + + Set of 16 key-value pairs that can be attached to an object. This can be + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. Keys are strings + with a maximum length of 64 characters. Values are strings with a maximum + length of 512 characters, booleans, or numbers. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `file_id: String` + + The unique ID of the file. + + - `filename: String` + + The name of the file. + + - `score: Float` + + The relevance score of the file - a value between 0 and 1. + + - `text: String` + + The text that was retrieved from the file. + + - `class ResponseComputerToolCall` + + 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. + + - `id: String` + + The unique ID of the computer call. + + - `call_id: String` + + An identifier used when responding to the tool call with output. + + - `pending_safety_checks: Array[PendingSafetyCheck{ id, code, message}]` + + The pending safety checks for the computer call. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :computer_call` + + The type of the computer call. Always `computer_call`. + + - `:computer_call` + + - `action: Click{ button, type, x, 2 more} | DoubleClick{ keys, type, x, y_} | Drag{ path, type, keys} | 6 more` + + A click action. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `actions: ComputerActionList` + + Flattened batched actions for `computer_use`. Each action includes an + `type` discriminator and action-specific fields. + + - `class Click` + + A click action. + + - `button: :left | :right | :wheel | 2 more` + + Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. + + - `:left` + + - `:right` + + - `:wheel` + + - `:back` + + - `:forward` + + - `type: :click` + + Specifies the event type. For a click action, this property is always `click`. + + - `:click` + + - `x: Integer` + + The x-coordinate where the click occurred. + + - `y_: Integer` + + The y-coordinate where the click occurred. + + - `keys: Array[String]` + + The keys being held while clicking. + + - `class DoubleClick` + + A double click action. + + - `keys: Array[String]` + + The keys being held while double-clicking. + + - `type: :double_click` + + Specifies the event type. For a double click action, this property is always set to `double_click`. + + - `:double_click` + + - `x: Integer` + + The x-coordinate where the double click occurred. + + - `y_: Integer` + + The y-coordinate where the double click occurred. + + - `class Drag` + + A drag action. + + - `path: Array[Path{ x, y_}]` + + An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg + + ``` + [ + { x: 100, y: 200 }, + { x: 200, y: 300 } + ] + ``` + + - `x: Integer` + + The x-coordinate. + + - `y_: Integer` + + The y-coordinate. + + - `type: :drag` + + Specifies the event type. For a drag action, this property is always set to `drag`. + + - `:drag` + + - `keys: Array[String]` + + The keys being held while dragging the mouse. + + - `class Keypress` + + A collection of keypresses the model would like to perform. + + - `keys: Array[String]` + + The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. + + - `type: :keypress` + + Specifies the event type. For a keypress action, this property is always set to `keypress`. + + - `:keypress` + + - `class Move` + + A mouse move action. + + - `type: :move` + + Specifies the event type. For a move action, this property is always set to `move`. + + - `:move` + + - `x: Integer` + + The x-coordinate to move to. + + - `y_: Integer` + + The y-coordinate to move to. + + - `keys: Array[String]` + + The keys being held while moving the mouse. + + - `class Screenshot` + + A screenshot action. + + - `type: :screenshot` + + Specifies the event type. For a screenshot action, this property is always set to `screenshot`. + + - `:screenshot` + + - `class Scroll` + + A scroll action. + + - `scroll_x: Integer` + + The horizontal scroll distance. + + - `scroll_y: Integer` + + The vertical scroll distance. + + - `type: :scroll` + + Specifies the event type. For a scroll action, this property is always set to `scroll`. + + - `:scroll` + + - `x: Integer` + + The x-coordinate where the scroll occurred. + + - `y_: Integer` + + The y-coordinate where the scroll occurred. + + - `keys: Array[String]` + + The keys being held while scrolling. + + - `class Type` + + An action to type in text. + + - `text: String` + + The text to type. + + - `type: :type` + + Specifies the event type. For a type action, this property is always set to `type`. + + - `:type` + + - `class Wait` + + A wait action. + + - `type: :wait` + + Specifies the event type. For a wait action, this property is always set to `wait`. + + - `:wait` + + - `class ComputerCallOutput` + + The output of a computer tool call. + + - `call_id: String` + + The ID of the computer tool call that produced the output. + + - `output: ResponseComputerToolCallOutputScreenshot` + + A computer screenshot image used with the computer use tool. + + - `type: :computer_screenshot` + + Specifies the event type. For a computer screenshot, this property is + always set to `computer_screenshot`. + + - `:computer_screenshot` + + - `file_id: String` + + The identifier of an uploaded file that contains the screenshot. + + - `image_url: String` + + The URL of the screenshot image. + + - `type: :computer_call_output` + + The type of the computer tool call output. Always `computer_call_output`. + + - `:computer_call_output` + + - `id: String` + + The ID of the computer tool call output. + + - `acknowledged_safety_checks: Array[AcknowledgedSafetyCheck{ id, code, message}]` + + The safety checks reported by the API that have been acknowledged by the developer. + + - `id: String` + + The ID of the pending safety check. + + - `code: String` + + The type of the pending safety check. + + - `message: String` + + Details about the pending safety check. + + - `status: :in_progress | :completed | :incomplete` + + The status of the message input. One of `in_progress`, `completed`, or `incomplete`. Populated when input items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseFunctionWebSearch` + + 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. + + - `id: String` + + The unique ID of the web search tool call. + + - `action: Search{ type, queries, query, sources} | OpenPage{ type, url} | FindInPage{ pattern, type, url}` + + An object describing the specific action taken in this web search call. + Includes details on how the model used the web (search, open_page, find_in_page). + + - `class Search` + + Action type "search" - Performs a web search query. + + - `type: :search` + + The action type. + + - `:search` + + - `queries: Array[String]` + + The search queries. + + - `query: String` + + The search query. + + - `sources: Array[Source{ type, url}]` + + The sources used in the search. + + - `type: :url` + + The type of source. Always `url`. + + - `:url` + + - `url: String` + + The URL of the source. + + - `class OpenPage` + + Action type "open_page" - Opens a specific URL from search results. + + - `type: :open_page` + + The action type. + + - `:open_page` + + - `url: String` + + The URL opened by the model. + + - `class FindInPage` + + Action type "find_in_page": Searches for a pattern within a loaded page. + + - `pattern: String` + + The pattern or text to search for within the page. + + - `type: :find_in_page` + + The action type. + + - `:find_in_page` + + - `url: String` + + The URL of the page searched for the pattern. + + - `status: :in_progress | :searching | :completed | :failed` + + The status of the web search tool call. + + - `:in_progress` + + - `:searching` + + - `:completed` + + - `:failed` + + - `type: :web_search_call` + + The type of the web search tool call. Always `web_search_call`. + + - `:web_search_call` + + - `class ResponseFunctionToolCall` + + A tool call to run a function. See the + [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. + + - `arguments: String` + + A JSON string of the arguments to pass to the function. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `name: String` + + The name of the function to run. + + - `type: :function_call` + + The type of the function tool call. Always `function_call`. + + - `:function_call` + + - `id: String` + + The unique ID of the function tool call. + + - `namespace: String` + + The namespace of the function to run. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class FunctionCallOutput` + + The output of a function tool call. + + - `call_id: String` + + The unique ID of the function tool call generated by the model. + + - `output: String | ResponseFunctionCallOutputItemList` + + Text, image, or file output of the function tool call. + + - `String = String` + + A JSON string of the output of the function tool call. + + - `ResponseFunctionCallOutputItemList = Array[ResponseFunctionCallOutputItem]` + + An array of content outputs (text, image, file) for the function tool call. + + - `class ResponseInputTextContent` + + A text input to the model. + + - `text: String` + + The text input to the model. + + - `type: :input_text` + + The type of the input item. Always `input_text`. + + - `:input_text` + + - `class ResponseInputImageContent` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision) + + - `type: :input_image` + + The type of the input item. Always `input_image`. + + - `:input_image` + + - `detail: :low | :high | :auto | :original` + + The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. + + - `:low` + + - `:high` + + - `:auto` + + - `:original` + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `image_url: String` + + The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. + + - `class ResponseInputFileContent` + + A file input to the model. + + - `type: :input_file` + + The type of the input item. Always `input_file`. + + - `:input_file` + + - `detail: :low | :high` + + The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. + + - `:low` + + - `:high` + + - `file_data: String` + + The base64-encoded data of the file to be sent to the model. + + - `file_id: String` + + The ID of the file to be sent to the model. + + - `file_url: String` + + The URL of the file to be sent to the model. + + - `filename: String` + + The name of the file to be sent to the model. + + - `type: :function_call_output` + + The type of the function tool call output. Always `function_call_output`. + + - `:function_call_output` + + - `id: String` + + The unique ID of the function tool call output. Populated when this item is returned via API. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ToolSearchCall` + + - `arguments: untyped` + + The arguments supplied to the tool search call. + + - `type: :tool_search_call` + + The item type. Always `tool_search_call`. + + - `:tool_search_call` + + - `id: String` + + The unique ID of this tool search call. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseToolSearchOutputItemParam` + + - `tools: Array[Tool]` + + The loaded tool definitions returned by the tool search output. + + - `class FunctionTool` + + 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). + + - `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 to enforce strict parameter validation. Default `true`. + + - `type: :function` + + The type of the function tool. Always `function`. + + - `:function` + + - `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. + + - `class FileSearchTool` + + 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). + + - `type: :file_search` + + The type of the file search tool. Always `file_search`. + + - `:file_search` + + - `vector_store_ids: Array[String]` + + The IDs of the vector stores to search. + + - `filters: ComparisonFilter | CompoundFilter` + + A filter to apply. + + - `class ComparisonFilter` + + 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 + + - `: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. + + - `String = String` + + - `Float = Float` + + - `UnionMember2 = bool` + + - `UnionMember3 = Array[String | Float]` + + - `String = String` + + - `Float = Float` + + - `class CompoundFilter` + + Combine multiple filters using `and` or `or`. + + - `filters: Array[ComparisonFilter | untyped]` + + Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. + + - `class ComparisonFilter` + + A filter used to compare a specified attribute key to a given value using a defined comparison operation. + + - `UnionMember1 = untyped` + + - `type: :and | :or` + + Type of operation: `and` or `or`. + + - `: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. + + - `hybrid_search: HybridSearch{ embedding_weight, text_weight}` + + Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. + + - `embedding_weight: Float` + + The weight of the embedding in the reciprocal ranking fusion. + + - `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. + + - `: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 ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `type: :computer` + + The type of the computer tool. Always `computer`. + + - `:computer` + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `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. + + - `:windows` + + - `:mac` + + - `:linux` + + - `:ubuntu` + + - `:browser` + + - `type: :computer_use_preview` + + The type of the computer use tool. Always `computer_use_preview`. + + - `:computer_use_preview` + + - `class WebSearchTool` + + 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). + + - `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`. + + - `:web_search` + + - `:web_search_2025_08_26` + + - `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. + + - `: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](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `class Mcp` + + 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). + + - `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`. + + - `:mcp` + + - `allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}` + + List of allowed tool names or a filter object. + + - `McpAllowedTools = Array[String]` + + A string array of allowed tool names + + - `class McpToolFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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` or `connector_id` must be provided. Learn more about service + connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + + 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` + + - `: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. + + - `class McpToolApprovalFilter` + + 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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-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. + + - `: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` or `connector_id` must be + provided. + + - `class CodeInterpreter` + + 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. + + - `String = String` + + The container ID. + + - `class CodeInterpreterToolAuto` + + Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. + + - `type: :auto` + + Always `auto`. + + - `: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. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `type: :disabled` + + Disable outbound network access. Always `disabled`. + + - `:disabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `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`. + + - `:allowlist` + + - `domain_secrets: Array[ContainerNetworkPolicyDomainSecret]` + + Optional domain-scoped secrets for allowlisted domains. + + - `domain: String` + + The domain associated with the secret. + + - `name: String` + + The name of the secret to inject for the domain. + + - `value: String` + + The secret value to inject for the domain. + + - `type: :code_interpreter` + + The type of the code interpreter tool. Always `code_interpreter`. + + - `:code_interpreter` + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `type: :image_generation` + + The type of the image generation tool. Always `image_generation`. + + - `:image_generation` + + - `action: :generate | :edit | :auto` + + Whether to generate a new image or edit an existing image. Default: `auto`. + + - `:generate` + + - `:edit` + + - `:auto` + + - `background: :transparent | :opaque | :auto` + + Allows to set transparency for the background of the generated image(s). + This parameter is only supported for GPT image models that support + transparent backgrounds. 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. + + `gpt-image-2` and `gpt-image-2-2026-04-21` do not support + transparent backgrounds. Requests with `background` set to + `transparent` will return an error for these models; use `opaque` or + `auto` instead. + + If `transparent`, the output format needs to support transparency, + so it should be set to either `png` (default value) or `webp`. + + - `: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`. + + - `: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. Default: `gpt-image-1`. + + - `String = String` + + - `Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more` + + The image generation model to use. Default: `gpt-image-1`. + + - `:"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`. + + - `:auto` + + - `:low` + + - `output_compression: Integer` + + Compression level for the output image. Default: 100. + + - `output_format: :png | :webp | :jpeg` + + The output format of the generated image. One of `png`, `webp`, or + `jpeg`. Default: `png`. + + - `:png` + + - `:webp` + + - `:jpeg` + + - `partial_images: Integer` + + Number of partial images to generate in streaming mode, from 0 (default value) to 3. + + - `quality: :low | :medium | :high | :auto` + + The quality of the generated image. One of `low`, `medium`, `high`, + or `auto`. Default: `auto`. + + - `: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`. + + - `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`. + + - `:"1024x1024"` + + - `:"1024x1536"` + + - `:"1536x1024"` + + - `:auto` + + - `class LocalShell` + + 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`. + + - `:local_shell` + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `type: :shell` + + The type of the shell tool. Always `shell`. + + - `:shell` + + - `environment: ContainerAuto | LocalEnvironment | ContainerReference` + + - `class ContainerAuto` + + - `type: :container_auto` + + Automatically creates a container for this request + + - `:container_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 container. + + - `:"1g"` + + - `:"4g"` + + - `:"16g"` + + - `:"64g"` + + - `network_policy: ContainerNetworkPolicyDisabled | ContainerNetworkPolicyAllowlist` + + Network access policy for the container. + + - `class ContainerNetworkPolicyDisabled` + + - `class ContainerNetworkPolicyAllowlist` + + - `skills: Array[SkillReference | InlineSkill]` + + An optional list of skills referenced by id or inline data. + + - `class SkillReference` + + - `skill_id: String` + + The ID of the referenced skill. + + - `type: :skill_reference` + + References a skill created with the /v1/skills endpoint. + + - `:skill_reference` + + - `version: String` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + + - `class InlineSkill` + + - `description: String` + + The description of the skill. + + - `name: String` + + The name of the skill. + + - `source: InlineSkillSource` + + Inline skill payload + + - `data: String` + + Base64-encoded skill zip bundle. + + - `media_type: :"application/zip"` + + The media type of the inline skill payload. Must be `application/zip`. + + - `:"application/zip"` + + - `type: :base64` + + The type of the inline skill source. Must be `base64`. + + - `:base64` + + - `type: :inline` + + Defines an inline skill for this request. + + - `:inline` + + - `class LocalEnvironment` + + - `type: :local` + + Use a local computer environment. + + - `:local` + + - `skills: Array[LocalSkill]` + + 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 ContainerReference` + + - `container_id: String` + + The ID of the referenced container. + + - `type: :container_reference` + + References a container created with the /v1/containers endpoint + + - `:container_reference` + + - `class CustomTool` + + 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) + + - `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`. + + - `:custom` + + - `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_: CustomToolInputFormat` + + The input format for the custom tool. Default is unconstrained text. + + - `class Text` + + Unconstrained free-form text. + + - `type: :text` + + Unconstrained text format. Always `text`. + + - `:text` + + - `class Grammar` + + 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`. + + - `:lark` + + - `:regex` + + - `type: :grammar` + + Grammar format. Always `grammar`. + + - `:grammar` + + - `class NamespaceTool` + + 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`). + + - `tools: Array[Function{ name, type, defer_loading, 3 more} | CustomTool]` + + The function/custom tools available inside this namespace. + + - `class Function` + + - `name: String` + + - `type: :function` + + - `:function` + + - `defer_loading: bool` + + Whether this function should be deferred and discovered via tool search. + + - `description: String` + + - `parameters: untyped` + + - `strict: bool` + + - `class CustomTool` + + 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) + + - `type: :namespace` + + The type of the tool. Always `namespace`. + + - `:namespace` + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `type: :tool_search` + + The type of the tool. Always `tool_search`. + + - `: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. + + - `:server` + + - `:client` + + - `parameters: untyped` + + Parameter schema for a client-executed tool search tool. + + - `class WebSearchPreviewTool` + + 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). + + - `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`. + + - `:web_search_preview` + + - `:web_search_preview_2025_03_11` + + - `search_content_types: Array[:text | :image]` + + - `: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. + + - `:low` + + - `:medium` + + - `:high` + + - `user_location: UserLocation{ type, city, country, 2 more}` + + The user's location. + + - `type: :approximate` + + The type of location approximation. Always `approximate`. + + - `:approximate` + + - `city: String` + + Free text input for the city of the user, e.g. `San Francisco`. + + - `country: String` + + The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) 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](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :apply_patch` + + The type of the tool. Always `apply_patch`. + + - `:apply_patch` + + - `type: :tool_search_output` + + The item type. Always `tool_search_output`. + + - `:tool_search_output` + + - `id: String` + + The unique ID of this tool search output. + + - `call_id: String` + + The unique ID of the tool search call generated by the model. + + - `execution: :server | :client` + + Whether tool search was executed by the server or by the client. + + - `:server` + + - `:client` + + - `status: :in_progress | :completed | :incomplete` + + The status of the tool search output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class AdditionalTools` + + - `role: :developer` + + The role that provided the additional tools. Only `developer` is supported. + + - `:developer` + + - `tools: Array[Tool]` + + A list of additional tools made available at this item. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + + - `type: :additional_tools` + + The item type. Always `additional_tools`. + + - `:additional_tools` + + - `id: String` + + The unique ID of this additional tools item. + + - `class ResponseReasoningItem` + + 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). + + - `id: String` + + The unique identifier of the reasoning content. + + - `summary: Array[Summary{ text, type}]` + + Reasoning summary content. + + - `text: String` + + A summary of the reasoning output from the model so far. + + - `type: :summary_text` + + The type of the object. Always `summary_text`. + + - `:summary_text` + + - `type: :reasoning` + + The type of the object. Always `reasoning`. + + - `:reasoning` + + - `content: Array[Content{ text, type}]` + + Reasoning text content. + + - `text: String` + + The reasoning text from the model. + + - `type: :reasoning_text` + + The type of the reasoning text. Always `reasoning_text`. + + - `:reasoning_text` + + - `encrypted_content: String` + + The encrypted content of the reasoning item - populated when a response is + generated with `reasoning.encrypted_content` in the `include` parameter. + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ResponseCompactionItemParam` + + A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + + - `encrypted_content: String` + + The encrypted content of the compaction summary. + + - `type: :compaction` + + The type of the item. Always `compaction`. + + - `:compaction` + + - `id: String` + + The ID of the compaction item. + + - `class ImageGenerationCall` + + An image generation request made by the model. + + - `id: String` + + The unique ID of the image generation call. + + - `result: String` + + The generated image encoded in base64. + + - `status: :in_progress | :completed | :generating | :failed` + + The status of the image generation call. + + - `:in_progress` + + - `:completed` + + - `:generating` + + - `:failed` + + - `type: :image_generation_call` + + The type of the image generation call. Always `image_generation_call`. + + - `:image_generation_call` + + - `class ResponseCodeInterpreterToolCall` + + A tool call to run code. + + - `id: String` + + The unique ID of the code interpreter tool call. + + - `code: String` + + The code to run, or null if not available. + + - `container_id: String` + + The ID of the container used to run the code. + + - `outputs: Array[Logs{ logs, type} | Image{ type, url}]` + + The outputs generated by the code interpreter, such as logs or images. + Can be null if no outputs are available. + + - `class Logs` + + The logs output from the code interpreter. + + - `logs: String` + + The logs output from the code interpreter. + + - `type: :logs` + + The type of the output. Always `logs`. + + - `:logs` + + - `class Image` + + The image output from the code interpreter. + + - `type: :image` + + The type of the output. Always `image`. + + - `:image` + + - `url: String` + + The URL of the image output from the code interpreter. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:interpreting` + + - `:failed` + + - `type: :code_interpreter_call` + + The type of the code interpreter tool call. Always `code_interpreter_call`. + + - `:code_interpreter_call` + + - `class LocalShellCall` + + A tool call to run a command on the local shell. + + - `id: String` + + The unique ID of the local shell call. + + - `action: Action{ command, env, type, 3 more}` + + Execute a shell command on the server. + + - `command: Array[String]` + + The command to run. + + - `env: Hash[Symbol, String]` + + Environment variables to set for the command. + + - `type: :exec` + + The type of the local shell action. Always `exec`. + + - `:exec` + + - `timeout_ms: Integer` + + Optional timeout in milliseconds for the command. + + - `user: String` + + Optional user to run the command as. + + - `working_directory: String` + + Optional working directory to run the command in. + + - `call_id: String` + + The unique ID of the local shell tool call generated by the model. + + - `status: :in_progress | :completed | :incomplete` + + The status of the local shell call. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `type: :local_shell_call` + + The type of the local shell call. Always `local_shell_call`. + + - `:local_shell_call` + + - `class LocalShellCallOutput` + + The output of a local shell tool call. + + - `id: String` + + The unique ID of the local shell tool call generated by the model. + + - `output: String` + + A JSON string of the output of the local shell tool call. + + - `type: :local_shell_call_output` + + The type of the local shell tool call output. Always `local_shell_call_output`. + + - `:local_shell_call_output` + + - `status: :in_progress | :completed | :incomplete` + + The status of the item. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCall` + + A tool representing a request to execute one or more shell commands. + + - `action: Action{ commands, max_output_length, timeout_ms}` + + The shell commands and limits that describe how to run the tool call. + + - `commands: Array[String]` + + Ordered shell commands for the execution environment to run. + + - `max_output_length: Integer` + + Maximum number of UTF-8 characters to capture from combined stdout and stderr output. + + - `timeout_ms: Integer` + + Maximum wall-clock time in milliseconds to allow the shell commands to run. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `type: :shell_call` + + The type of the item. Always `shell_call`. + + - `:shell_call` + + - `id: String` + + The unique ID of the shell tool call. Populated when this item is returned via API. + + - `environment: LocalEnvironment | ContainerReference` + + The environment to execute the shell commands in. + + - `class LocalEnvironment` + + - `class ContainerReference` + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ShellCallOutput` + + The streamed output items emitted by a shell tool call. + + - `call_id: String` + + The unique ID of the shell tool call generated by the model. + + - `output: Array[ResponseFunctionShellCallOutputContent]` + + Captured chunks of stdout and stderr output, along with their associated outcomes. + + - `outcome: Timeout{ type} | Exit{ exit_code, type}` + + The exit or timeout outcome associated with this shell call. + + - `class Timeout` + + Indicates that the shell call exceeded its configured time limit. + + - `type: :timeout` + + The outcome type. Always `timeout`. + + - `:timeout` + + - `class Exit` + + Indicates that the shell commands finished and returned an exit code. + + - `exit_code: Integer` + + The exit code returned by the shell process. + + - `type: :exit` + + The outcome type. Always `exit`. + + - `:exit` + + - `stderr: String` + + Captured stderr output for the shell call. + + - `stdout: String` + + Captured stdout output for the shell call. + + - `type: :shell_call_output` + + The type of the item. Always `shell_call_output`. + + - `:shell_call_output` + + - `id: String` + + The unique ID of the shell tool call output. Populated when this item is returned via API. + + - `max_output_length: Integer` + + The maximum number of UTF-8 characters captured for this shell call's combined output. + + - `status: :in_progress | :completed | :incomplete` + + The status of the shell call output. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `class ApplyPatchCall` + + A tool call representing a request to create, delete, or update files using diff patches. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `operation: CreateFile{ diff, path, type} | DeleteFile{ path, type} | UpdateFile{ diff, path, type}` + + The specific create, delete, or update instruction for the apply_patch tool call. + + - `class CreateFile` + + Instruction for creating a new file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply when creating the file. + + - `path: String` + + Path of the file to create relative to the workspace root. + + - `type: :create_file` + + The operation type. Always `create_file`. + + - `:create_file` + + - `class DeleteFile` + + Instruction for deleting an existing file via the apply_patch tool. + + - `path: String` + + Path of the file to delete relative to the workspace root. + + - `type: :delete_file` + + The operation type. Always `delete_file`. + + - `:delete_file` + + - `class UpdateFile` + + Instruction for updating an existing file via the apply_patch tool. + + - `diff: String` + + Unified diff content to apply to the existing file. + + - `path: String` + + Path of the file to update relative to the workspace root. + + - `type: :update_file` + + The operation type. Always `update_file`. + + - `:update_file` + + - `status: :in_progress | :completed` + + The status of the apply patch tool call. One of `in_progress` or `completed`. + + - `:in_progress` + + - `:completed` + + - `type: :apply_patch_call` + + The type of the item. Always `apply_patch_call`. + + - `:apply_patch_call` + + - `id: String` + + The unique ID of the apply patch tool call. Populated when this item is returned via API. + + - `class ApplyPatchCallOutput` + + The streamed output emitted by an apply patch tool call. + + - `call_id: String` + + The unique ID of the apply patch tool call generated by the model. + + - `status: :completed | :failed` + + The status of the apply patch tool call output. One of `completed` or `failed`. + + - `:completed` + + - `:failed` + + - `type: :apply_patch_call_output` + + The type of the item. Always `apply_patch_call_output`. + + - `:apply_patch_call_output` + + - `id: String` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. + + - `output: String` + + Optional human-readable log text from the apply patch tool (e.g., patch results or errors). + + - `class McpListTools` + + A list of tools available on an MCP server. + + - `id: String` + + The unique ID of the list. + + - `server_label: String` + + The label of the MCP server. + + - `tools: Array[Tool{ input_schema, name, annotations, description}]` + + The tools available on the server. + + - `input_schema: untyped` + + The JSON schema describing the tool's input. + + - `name: String` + + The name of the tool. + + - `annotations: untyped` + + Additional annotations about the tool. + + - `description: String` + + The description of the tool. + + - `type: :mcp_list_tools` + + The type of the item. Always `mcp_list_tools`. + + - `:mcp_list_tools` + + - `error: String` + + Error message if the server could not list tools. + + - `class McpApprovalRequest` + + A request for human approval of a tool invocation. + + - `id: String` + + The unique ID of the approval request. + + - `arguments: String` + + A JSON string of arguments for the tool. + + - `name: String` + + The name of the tool to run. + + - `server_label: String` + + The label of the MCP server making the request. + + - `type: :mcp_approval_request` + + The type of the item. Always `mcp_approval_request`. + + - `:mcp_approval_request` + + - `class McpApprovalResponse` + + A response to an MCP approval request. + + - `approval_request_id: String` + + The ID of the approval request being answered. + + - `approve: bool` + + Whether the request was approved. + + - `type: :mcp_approval_response` + + The type of the item. Always `mcp_approval_response`. + + - `:mcp_approval_response` + + - `id: String` + + The unique ID of the approval response + + - `reason: String` + + Optional reason for the decision. + + - `class McpCall` + + An invocation of a tool on an MCP server. + + - `id: String` + + The unique ID of the tool call. + + - `arguments: String` + + A JSON string of the arguments passed to the tool. + + - `name: String` + + The name of the tool that was run. + + - `server_label: String` + + The label of the MCP server running the tool. + + - `type: :mcp_call` + + The type of the item. Always `mcp_call`. + + - `:mcp_call` + + - `approval_request_id: String` + + Unique identifier for the MCP tool call approval request. + Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. + + - `error: String` + + The error from the tool call, if any. + + - `output: String` + + The output from the tool call. + + - `status: :in_progress | :completed | :incomplete | 2 more` + + The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. + + - `:in_progress` + + - `:completed` + + - `:incomplete` + + - `:calling` + + - `:failed` + + - `class ResponseCustomToolCallOutput` + + The output of a custom tool call from your code, being sent back to the model. + + - `call_id: String` + + The call ID, used to map this custom tool call output to a custom tool call. + + - `output: String | Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + The output from the custom tool call generated by your code. + Can be a string or an list of output content. + + - `String = String` + + A string of the output of the custom tool call. + + - `OutputContentList = Array[ResponseInputText | ResponseInputImage | ResponseInputFile]` + + Text, image, or file output of the custom tool call. + + - `class ResponseInputText` + + A text input to the model. + + - `class ResponseInputImage` + + An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + + - `class ResponseInputFile` + + A file input to the model. + + - `type: :custom_tool_call_output` + + The type of the custom tool call output. Always `custom_tool_call_output`. + + - `:custom_tool_call_output` + + - `id: String` + + The unique ID of the custom tool call output in the OpenAI platform. + + - `class ResponseCustomToolCall` + + A call to a custom tool created by the model. + + - `call_id: String` + + An identifier used to map this custom tool call to a tool call output. + + - `input: String` + + The input for the custom tool call generated by the model. + + - `name: String` + + The name of the custom tool being called. + + - `type: :custom_tool_call` + + The type of the custom tool call. Always `custom_tool_call`. + + - `:custom_tool_call` + + - `id: String` + + The unique ID of the custom tool call in the OpenAI platform. + + - `namespace: String` + + The namespace of the custom tool being called. + + - `class CompactionTrigger` + + Compacts the current context. Must be the final input item. + + - `type: :compaction_trigger` + + The type of the item. Always `compaction_trigger`. + + - `:compaction_trigger` + + - `class ItemReference` + + An internal identifier for an item to reference. + + - `id: String` + + The ID of the item to reference. + + - `type: :item_reference` + + The type of item to reference. Always `item_reference`. + + - `:item_reference` + +- `instructions: String` + + A system (or developer) message inserted into the model's context. + When used along with `previous_response_id`, the instructions from a previous response will not be carried over to the next response. This makes it simple to swap out system (or developer) messages in new responses. + +- `model: String` + + Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) to browse and compare available models. + +- `parallel_tool_calls: bool` + + Whether to allow the model to run tool calls in parallel. + +- `personality: String | :friendly | :pragmatic` + + A model-owned style preset to apply to this request. Omit this parameter to use the model's default style. Supported values may expand over time. Values must be at most 64 characters. + + - `String = String` + + - `Personality = :friendly | :pragmatic` + + A model-owned style preset to apply to this request. Omit this parameter to use the model's default style. Supported values may expand over time. Values must be at most 64 characters. + + - `:friendly` + + - `:pragmatic` + +- `previous_response_id: String` + + The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. + +- `reasoning: Reasoning` + + **gpt-5 and o-series models only** Configuration options for [reasoning models](https://platform.openai.com/docs/guides/reasoning). + + - `effort: ReasoningEffort` + + Constrains effort on reasoning for + [reasoning models](https://platform.openai.com/docs/guides/reasoning). + Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing + reasoning effort can result in faster responses and fewer tokens used + on reasoning in a response. + + - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1. + - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. + - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. + - `xhigh` is supported for all models after `gpt-5.1-codex-max`. + + - `:none` + + - `:minimal` + + - `:low` + + - `:medium` + + - `:high` + + - `:xhigh` + + - `generate_summary: :auto | :concise | :detailed` + + **Deprecated:** use `summary` instead. + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + - `:auto` + + - `:concise` + + - `:detailed` + + - `summary: :auto | :concise | :detailed` + + A summary of the reasoning performed by the model. This can be + useful for debugging and understanding the model's reasoning process. + One of `auto`, `concise`, or `detailed`. + + `concise` is supported for `computer-use-preview` models and all reasoning models after `gpt-5`. + + - `:auto` + + - `:concise` + + - `:detailed` + +- `text: Text{ format_, verbosity}` + + 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) + + - `format_: ResponseFormatTextConfig` + + An object specifying the format that the model must output. + + Configuring `{ "type": "json_schema" }` enables Structured Outputs, + which ensures the model will match your supplied JSON schema. Learn more in the + [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). + + The default format is `{ "type": "text" }` with no additional options. + + **Not recommended for gpt-4o and newer models:** + + Setting to `{ "type": "json_object" }` enables the older JSON mode, which + ensures the message the model generates is valid JSON. Using `json_schema` + is preferred for models that support it. + + - `class ResponseFormatText` + + Default response format. Used to generate text responses. + + - `type: :text` + + The type of response format being defined. Always `text`. + + - `:text` + + - `class ResponseFormatTextJSONSchemaConfig` + + JSON Schema response format. Used to generate structured JSON responses. + Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). + + - `name: String` + + The name of the response format. Must be a-z, A-Z, 0-9, or contain + underscores and dashes, with a maximum length of 64. + + - `schema: Hash[Symbol, untyped]` + + The schema for the response format, described as a JSON Schema object. + Learn how to build JSON schemas [here](https://json-schema.org/). + + - `type: :json_schema` + + The type of response format being defined. Always `json_schema`. + + - `:json_schema` + + - `description: String` + + A description of what the response format is for, used by the model to + determine how to respond in the format. + + - `strict: bool` + + Whether to enable strict schema adherence when generating the output. + If set to true, the model will always follow the exact schema defined + in the `schema` field. Only a subset of JSON Schema is supported when + `strict` is `true`. To learn more, read the [Structured Outputs + guide](https://platform.openai.com/docs/guides/structured-outputs). + + - `class ResponseFormatJSONObject` + + 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. + + - `type: :json_object` + + The type of response format being defined. Always `json_object`. + + - `:json_object` + + - `verbosity: :low | :medium | :high` + + Constrains the verbosity of the model's response. Lower values will result in + more concise responses, while higher values will result in more verbose responses. + Currently supported values are `low`, `medium`, and `high`. + + - `:low` + + - `:medium` + + - `:high` + +- `tool_choice: ToolChoiceOptions | ToolChoiceAllowed | ToolChoiceTypes | 5 more` + + Controls which tool the model should use, if any. + + - `ToolChoiceOptions = :none | :auto | :required` + + Controls which (if any) tool is called by the model. + + `none` means the model will not call any tool and instead generates a message. + + `auto` means the model can pick between generating a message or calling one or + more tools. + + `required` means the model must call one or more tools. + + - `:none` + + - `:auto` + + - `:required` + + - `class ToolChoiceAllowed` + + Constrains the tools available to the model to a pre-defined set. + + - `mode: :auto | :required` + + Constrains the tools available to the model to a pre-defined set. + + `auto` allows the model to pick from among the allowed tools and generate a + message. + + `required` requires the model to call one or more of the allowed tools. + + - `:auto` + + - `:required` + + - `tools: Array[Hash[Symbol, untyped]]` + + A list of tool definitions that the model should be allowed to call. + + For the Responses API, the list of tool definitions might look like: + + ```json + [ + { "type": "function", "name": "get_weather" }, + { "type": "mcp", "server_label": "deepwiki" }, + { "type": "image_generation" } + ] + ``` + + - `type: :allowed_tools` + + Allowed tool configuration type. Always `allowed_tools`. + + - `:allowed_tools` + + - `class ToolChoiceTypes` + + 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). + + - `type: :file_search | :web_search_preview | :computer | 5 more` + + The type of hosted tool the model should to use. Learn more about + [built-in tools](https://platform.openai.com/docs/guides/tools). + + Allowed values are: + + - `file_search` + - `web_search_preview` + - `computer` + - `computer_use_preview` + - `computer_use` + - `code_interpreter` + - `image_generation` + + - `:file_search` + + - `:web_search_preview` + + - `:computer` + + - `:computer_use_preview` + + - `:computer_use` + + - `:web_search_preview_2025_03_11` + + - `:image_generation` + + - `:code_interpreter` + + - `class ToolChoiceFunction` + + Use this option to force the model to call a specific function. + + - `name: String` + + The name of the function to call. + + - `type: :function` + + For function calling, the type is always `function`. + + - `:function` + + - `class ToolChoiceMcp` + + Use this option to force the model to call a specific tool on a remote MCP server. + + - `server_label: String` + + The label of the MCP server to use. + + - `type: :mcp` + + For MCP tools, the type is always `mcp`. + + - `:mcp` + + - `name: String` + + The name of the tool to call on the server. + + - `class ToolChoiceCustom` + + Use this option to force the model to call a specific custom tool. + + - `name: String` + + The name of the custom tool to call. + + - `type: :custom` + + For custom tool calling, the type is always `custom`. + + - `:custom` + + - `class ToolChoiceApplyPatch` + + Forces the model to call the apply_patch tool when executing a tool call. + + - `type: :apply_patch` + + The tool to call. Always `apply_patch`. + + - `:apply_patch` + + - `class ToolChoiceShell` + + Forces the model to call the shell tool when a tool call is required. + + - `type: :shell` + + The tool to call. Always `shell`. + + - `:shell` + +- `tools: Array[Tool]` + + An array of tools the model may call while generating a response. You can specify which tool to use by setting the `tool_choice` parameter. + + - `class FunctionTool` + + 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). + + - `class FileSearchTool` + + 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). + + - `class ComputerTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class ComputerUsePreviewTool` + + A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + + - `class WebSearchTool` + + 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). + + - `class Mcp` + + 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). + + - `class CodeInterpreter` + + A tool that runs Python code to help generate a response to a prompt. + + - `class ImageGeneration` + + A tool that generates images using the GPT image models. + + - `class LocalShell` + + A tool that allows the model to execute shell commands in a local environment. + + - `class FunctionShellTool` + + A tool that allows the model to execute shell commands. + + - `class CustomTool` + + 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) + + - `class NamespaceTool` + + Groups function/custom tools under a shared namespace. + + - `class ToolSearchTool` + + Hosted or BYOT tool search configuration for deferred tools. + + - `class WebSearchPreviewTool` + + 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). + + - `class ApplyPatchTool` + + Allows the assistant to create, delete, or update files using unified diffs. + +- `truncation: :auto | :disabled` + + The truncation strategy to use for the model response. - `auto`: If the input to this Response exceeds the model's context window size, the model will truncate the response to fit the context window by dropping items from the beginning of the conversation. - `disabled` (default): If the input size will exceed the context window size for a model, the request will fail with a 400 error. + + - `:auto` + + - `:disabled` + +### Returns + +- `class InputTokenCountResponse` + + - `input_tokens: Integer` + + - `object: :"response.input_tokens"` + + - `:"response.input_tokens"` + +### Example + +```ruby +require "openai" + +openai = OpenAI::Client.new(api_key: "My API Key") + +response = openai.responses.input_tokens.count + +puts(response) +``` + +#### Response + +```json +{ + "input_tokens": 123, + "object": "response.input_tokens" +} +``` + +### Example + +```ruby +require "openai" + +openai = OpenAI::Client.new + +response = openai.responses.input_tokens.count(model: "gpt-5", input: "Tell me a joke.") + +puts(response) +``` + +#### Response + +```json +{ + "object": "response.input_tokens", + "input_tokens": 11 +} +``` + +## Domain Types + +### Input Token Count Response + +- `class InputTokenCountResponse` + + - `input_tokens: Integer` + + - `object: :"response.input_tokens"` + + - `:"response.input_tokens"`