Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Suggested
Overview Models Agents Tools Audio & voice Production API reference
API Reference
Beta

Responses

Cancel a response
$ openai beta:responses cancel
POST/responses/{response_id}/cancel
Compact conversation
$ openai beta:responses compact
POST/responses/compact
Create a model response
$ openai beta:responses create
POST/responses
Delete a model response
$ openai beta:responses delete
DELETE/responses/{response_id}
Get a model response
$ openai beta:responses retrieve
GET/responses/{response_id}
ModelsExpand Collapse
beta_apply_patch_tool: object { type, allowed_callers }

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

beta_compacted_response: object { id, created_at, object, 2 more }
beta_computer_action: object { button, type, x, 2 more } or object { keys, type, x, y } or object { path, type, keys } or 6 more

A click action.

beta_computer_action_list: array of BetaComputerAction

Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.

beta_computer_tool: object { type }

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

beta_computer_use_preview_tool: object { display_height, display_width, environment, type }

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

beta_container_auto: object { type, file_ids, memory_limit, 2 more }
beta_container_network_policy_allowlist: object { allowed_domains, type, domain_secrets }
beta_container_network_policy_disabled: object { type }
beta_container_network_policy_domain_secret: object { domain, name, value }
beta_container_reference: object { container_id, type }
beta_custom_tool: object { name, type, allowed_callers, 4 more }

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

beta_easy_input_message: object { content, role, phase, type }

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.

beta_file_search_tool: object { type, vector_store_ids, filters, 2 more }

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

beta_function_shell_tool: object { type, allowed_callers, environment }

A tool that allows the model to execute shell commands.

beta_function_tool: object { name, parameters, strict, 6 more }

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

beta_inline_skill: object { description, name, source, type }
beta_inline_skill_source: object { data, media_type, type }

Inline skill payload

beta_local_environment: object { type, skills }
beta_local_skill: object { description, name, path }
beta_mcp_tool_call_error: object { code, message, type } or object { content, type } or object { code, message, type }
beta_namespace_tool: object { description, name, tools, type }

Groups function/custom tools under a shared namespace.

beta_response: object { id, created_at, error, 32 more }
beta_response_apply_patch_tool_call: object { id, call_id, operation, 5 more }

A tool call that applies file diffs by creating, deleting, or updating files.

beta_response_apply_patch_tool_call_output: object { id, call_id, status, 5 more }

The output emitted by an apply patch tool call.

beta_response_audio_delta_event: object { delta, sequence_number, type, agent }

Emitted when there is a partial audio response.

beta_response_audio_done_event: object { sequence_number, type, agent }

Emitted when the audio response is complete.

beta_response_audio_transcript_delta_event: object { delta, sequence_number, type, agent }

Emitted when there is a partial transcript of audio.

beta_response_audio_transcript_done_event: object { sequence_number, type, agent }

Emitted when the full audio transcript is completed.

beta_response_code_interpreter_call_code_delta_event: object { delta, item_id, output_index, 3 more }

Emitted when a partial code snippet is streamed by the code interpreter.

beta_response_code_interpreter_call_code_done_event: object { code, item_id, output_index, 3 more }

Emitted when the code snippet is finalized by the code interpreter.

beta_response_code_interpreter_call_completed_event: object { item_id, output_index, sequence_number, 2 more }

Emitted when the code interpreter call is completed.

beta_response_code_interpreter_call_in_progress_event: object { item_id, output_index, sequence_number, 2 more }

Emitted when a code interpreter call is in progress.

beta_response_code_interpreter_call_interpreting_event: object { item_id, output_index, sequence_number, 2 more }

Emitted when the code interpreter is actively interpreting the code snippet.

beta_response_code_interpreter_tool_call: object { id, code, container_id, 4 more }

A tool call to run code.

beta_response_compaction_item: object { id, encrypted_content, type, 2 more }

A compaction item generated by the v1/responses/compact API.

beta_response_compaction_item_param: object { encrypted_content, type, id, agent }

A compaction item generated by the v1/responses/compact API.

beta_response_completed_event: object { response, sequence_number, type, agent }

Emitted when the model response is complete.

beta_response_computer_tool_call: object { id, call_id, pending_safety_checks, 5 more }

A tool call to a computer use tool. See the computer use guide for more information.

beta_response_computer_tool_call_output_item: object { id, call_id, output, 5 more }
beta_response_computer_tool_call_output_screenshot: object { type, file_id, image_url }

A computer screenshot image used with the computer use tool.

beta_response_configuration_update_item: object { id, type, agent, reasoning }

A configuration update that applies to subsequent responses until it is replaced by another configuration update.

beta_response_configuration_update_item_param: object { type, id, agent, reasoning }

An update to the conversation’s response configuration. The configuration remains in effect for subsequent responses until it is replaced by another configuration update.

beta_response_container_reference: object { container_id, type }

Represents a container created with /v1/containers.

beta_response_content: BetaResponseInputText { text, type, prompt_cache_breakpoint } or BetaResponseInputImage { detail, type, file_id, 2 more } or BetaResponseInputFile { type, detail, file_data, 4 more } or 3 more

Multi-modal input and output contents.

beta_response_content_part_added_event: object { content_index, item_id, output_index, 4 more }

Emitted when a new content part is added.

beta_response_content_part_done_event: object { content_index, item_id, output_index, 4 more }

Emitted when a content part is done.

beta_response_conversation_param: object { id }

The conversation that this response belongs to.

beta_response_created_event: object { response, sequence_number, type, agent }

An event that is emitted when a response is created.

beta_response_custom_tool_call: object { call_id, input, name, 6 more }

A call to a custom tool created by the model.

beta_response_custom_tool_call_input_delta_event: object { delta, item_id, output_index, 3 more }

Event representing a delta (partial update) to the input of a custom tool call.

beta_response_custom_tool_call_input_done_event: object { input, item_id, output_index, 3 more }

Event indicating that input for a custom tool call is complete.

beta_response_custom_tool_call_item: BetaResponseCustomToolCall { call_id, input, name, 6 more }

A call to a custom tool created by the model.

beta_response_custom_tool_call_output: object { call_id, output, type, 3 more }

The output of a custom tool call from your code, being sent back to the model.

beta_response_custom_tool_call_output_item: BetaResponseCustomToolCallOutput { call_id, output, type, 3 more }

The output of a custom tool call from your code, being sent back to the model.

beta_response_error: object { code, message, misalignment }

An error object returned when the model fails to generate a Response.

beta_response_error_event: object { code, message, param, 3 more }

Emitted when an error occurs.

beta_response_failed_event: object { response, sequence_number, type, agent }

An event that is emitted when a response fails.

beta_response_file_search_call_completed_event: object { item_id, output_index, sequence_number, 2 more }

Emitted when a file search call is completed (results found).

beta_response_file_search_call_in_progress_event: object { item_id, output_index, sequence_number, 2 more }

Emitted when a file search call is initiated.

beta_response_file_search_call_searching_event: object { item_id, output_index, sequence_number, 2 more }

Emitted when a file search is currently searching.

beta_response_file_search_tool_call: object { id, queries, status, 3 more }

The results of a file search tool call. See the file search guide for more information.

beta_response_format_text_config: object { type } or BetaResponseFormatTextJSONSchemaConfig { name, schema, type, 2 more } or object { type }

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.

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.

beta_response_format_text_json_schema_config: object { name, schema, type, 2 more }

JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.

beta_response_function_call_arguments_delta_event: object { delta, item_id, output_index, 3 more }

Emitted when there is a partial function-call arguments delta.

beta_response_function_call_arguments_done_event: object { arguments, item_id, output_index, 3 more }

Emitted when function-call arguments are finalized.

beta_response_function_call_output_item: BetaResponseInputTextContent { text, type, prompt_cache_breakpoint } or BetaResponseInputImageContent { type, detail, file_id, 2 more } or BetaResponseInputFileContent { type, detail, file_data, 4 more }

A piece of message content, such as text, an image, or a file.

beta_response_function_call_output_item_list: array of BetaResponseFunctionCallOutputItem

An array of content outputs (text, image, file) for the function tool call.

beta_response_function_shell_call_output_content: object { outcome, stderr, stdout }

Captured stdout and stderr for a portion of a shell tool call output.

beta_response_function_shell_tool_call: object { id, action, call_id, 6 more }

A tool call that executes one or more shell commands in a managed environment.

beta_response_function_shell_tool_call_output: object { id, call_id, max_output_length, 6 more }

The output of a shell tool call that was emitted.

beta_response_function_tool_call: object { arguments, call_id, name, 7 more }

A tool call to run a function. See the function calling guide for more information.

beta_response_function_tool_call_item: BetaResponseFunctionToolCall { arguments, call_id, name, 7 more }

A tool call to run a function. See the function calling guide for more information.

beta_response_function_tool_call_output_item: object { id, output, status, 7 more }
beta_response_image_gen_call_completed_event: object { item_id, output_index, sequence_number, 2 more }

Emitted when an image generation tool call has completed and the final image is available.

beta_response_image_gen_call_generating_event: object { item_id, output_index, sequence_number, 2 more }

Emitted when an image generation tool call is actively generating an image (intermediate state).

beta_response_image_gen_call_in_progress_event: object { item_id, output_index, sequence_number, 2 more }

Emitted when an image generation tool call is in progress.

beta_response_image_gen_call_partial_image_event: object { item_id, output_index, partial_image_b64, 8 more }

Emitted when a partial image is available during image generation streaming.

beta_response_in_progress_event: object { response, sequence_number, type, agent }

Emitted when the response is in progress.

beta_response_includable: "file_search_call.results" or "web_search_call.results" or "web_search_call.action.sources" or 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).
beta_response_incomplete_event: object { response, sequence_number, type, agent }

An event that is emitted when a response finishes as incomplete.

Over WebSocket, steering can finish a response with response.incomplete_details.reason set to steered, followed automatically by a successor response.created that commits the queued steering input.

beta_response_inject_created_event: object { response_id, sequence_number, type, stream_id }

Emitted when all injected input items were validated and committed to the active response.

beta_response_inject_event: object { input, response_id, type }

Injects input items into an active response over a WebSocket connection. The items are validated and committed atomically. Currently, the server accepts client-owned tool outputs that resume a waiting agent.

beta_response_inject_failed_event: object { error, input, response_id, 3 more }

Emitted when injected input could not be committed to a response. The event returns the uncommitted raw input so the client can retry it in another response when appropriate.

beta_response_input: array of BetaResponseInputItem

A list of one or many input items to the model, containing different content types.

beta_response_input_audio: object { input_audio, type }

An audio input to the model.

beta_response_input_content: BetaResponseInputText { text, type, prompt_cache_breakpoint } or BetaResponseInputImage { detail, type, file_id, 2 more } or BetaResponseInputFile { type, detail, file_data, 4 more }

A text input to the model.

beta_response_input_file: object { type, detail, file_data, 4 more }

A file input to the model.

beta_response_input_file_content: object { type, detail, file_data, 4 more }

A file input to the model.

beta_response_input_image: object { detail, type, file_id, 2 more }

An image input to the model. Learn about image inputs.

beta_response_input_image_content: object { type, detail, file_id, 2 more }

An image input to the model. Learn about image inputs

beta_response_input_item: BetaEasyInputMessage { content, role, phase, type } or object { content, role, agent, 2 more } or BetaResponseOutputMessage { id, content, role, 4 more } or 33 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.

beta_response_input_message_content_list: array of BetaResponseInputContent

A list of one or many input items to the model, containing different content types.

beta_response_input_message_item: object { id, content, role, 3 more }
beta_response_input_text: object { text, type, prompt_cache_breakpoint }

A text input to the model.

beta_response_input_text_content: object { text, type, prompt_cache_breakpoint }

A text input to the model.

beta_response_item: BetaResponseInputMessageItem { id, content, role, 3 more } or BetaResponseOutputMessage { id, content, role, 4 more } or BetaResponseFileSearchToolCall { id, queries, status, 3 more } or 30 more

Content item used to generate a response.

beta_response_local_environment: object { type }

Represents the use of a local environment to perform shell actions.

beta_response_mcp_call_arguments_delta_event: object { delta, item_id, output_index, 3 more }

Emitted when there is a delta (partial update) to the arguments of an MCP tool call.

beta_response_mcp_call_arguments_done_event: object { arguments, item_id, output_index, 3 more }

Emitted when the arguments for an MCP tool call are finalized.

beta_response_mcp_call_completed_event: object { item_id, output_index, sequence_number, 2 more }

Emitted when an MCP tool call has completed successfully.

beta_response_mcp_call_failed_event: object { item_id, output_index, sequence_number, 2 more }

Emitted when an MCP tool call has failed.

beta_response_mcp_call_in_progress_event: object { item_id, output_index, sequence_number, 2 more }

Emitted when an MCP tool call is in progress.

beta_response_mcp_list_tools_completed_event: object { item_id, output_index, sequence_number, 2 more }

Emitted when the list of available MCP tools has been successfully retrieved.

beta_response_mcp_list_tools_failed_event: object { item_id, output_index, sequence_number, 2 more }

Emitted when the attempt to list available MCP tools has failed.

beta_response_mcp_list_tools_in_progress_event: object { item_id, output_index, sequence_number, 2 more }

Emitted when the system is in the process of retrieving the list of available MCP tools.

beta_response_output_audio: object { data, transcript, type }

An audio output from the model.

beta_response_output_item: BetaResponseOutputMessage { id, content, role, 4 more } or BetaResponseFileSearchToolCall { id, queries, status, 3 more } or BetaResponseFunctionToolCall { arguments, call_id, name, 7 more } or 28 more

An output message from the model.

beta_response_output_item_added_event: object { item, output_index, sequence_number, 2 more }

Emitted when a new output item is added.

beta_response_output_item_done_event: object { item, output_index, sequence_number, 2 more }

Emitted when an output item is marked done.

beta_response_output_message: object { id, content, role, 4 more }

An output message from the model.

beta_response_output_refusal: object { refusal, type }

A refusal from the model.

beta_response_output_text: object { annotations, text, type, logprobs }

A text output from the model.

beta_response_output_text_annotation_added_event: object { annotation, annotation_index, content_index, 5 more }

Emitted when an annotation is added to output text content.

beta_response_prompt: object { id, variables, version }

Reference to a prompt template and its variables. Learn more.

beta_response_queued_event: object { response, sequence_number, type, agent }

Emitted when a response is queued and waiting to be processed.

beta_response_reasoning_item: object { id, summary, type, 4 more }

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.

beta_response_reasoning_summary_part_added_event: object { item_id, output_index, part, 4 more }

Emitted when a new reasoning summary part is added.

beta_response_reasoning_summary_part_done_event: object { item_id, output_index, part, 5 more }

Emitted when a reasoning summary part is completed.

beta_response_reasoning_summary_text_delta_event: object { delta, item_id, output_index, 4 more }

Emitted when a delta is added to a reasoning summary text.

beta_response_reasoning_summary_text_done_event: object { item_id, output_index, sequence_number, 4 more }

Emitted when a reasoning summary text is completed.

beta_response_reasoning_text_delta_event: object { content_index, delta, item_id, 4 more }

Emitted when a delta is added to a reasoning text.

beta_response_reasoning_text_done_event: object { content_index, item_id, output_index, 4 more }

Emitted when a reasoning text is completed.

beta_response_refusal_delta_event: object { content_index, delta, item_id, 4 more }

Emitted when there is a partial refusal text.

beta_response_refusal_done_event: object { content_index, item_id, output_index, 4 more }

Emitted when refusal text is finalized.

beta_response_shell_call_command_added_event: object { command, command_index, output_index, 3 more }

A streaming event that indicated a shell command was added to a tool call.

beta_response_shell_call_command_delta_event: object { command_index, delta, output_index, 4 more }

A streaming event that indicated a shell command was incrementally updated.

beta_response_shell_call_command_done_event: object { command, command_index, output_index, 3 more }

A streaming event that indicated a shell command was completed.

beta_response_shell_call_output_content_delta_event: object { command_index, delta, item_id, 4 more }

A streaming event that indicated shell call output was incrementally added.

beta_response_shell_call_output_content_done_event: object { command_index, item_id, output, 4 more }

A streaming event that indicated shell call output was completed.

beta_response_status: "completed" or "failed" or "in_progress" or 3 more

The status of the response generation. One of completed, failed, in_progress, cancelled, queued, or incomplete.

beta_response_steer_accepted_event: object { sequence_number, steer, type, stream_id }

Emitted when steering input has been validated and queued. Acceptance means the server owns the input, not that it has been applied. The successor’s response.created event is the commit point. If accepted input cannot be committed, response.steer.failed returns it with the same steering ID.

When the response stops for client-owned tool output or approval, the input remains queued and response.steer.pending is emitted after response.completed. Fill the pending event’s required_input stubs with saved results and send one matching explicit response.create per parent. Do not resend accepted input while it is still queued.

beta_response_steer_event: object { input, previous_response_id, type }

Queues user input to steer a response on this WebSocket connection. Input can contain text, images, and files. Steering is supported only for single-agent responses on models and execution modes that support steering. Responses bound to a conversation or using automatic compaction do not support steering.

A response.steer.accepted event acknowledges that the server owns the queued input, not that it has been applied. The successor’s response.created event is the commit point. Input that cannot be committed is returned in response.steer.failed.

Steering may cause the active response to finish at a safe output boundary with response.incomplete and incomplete_details.reason set to steered, followed automatically by a successor response.created. Normal completion can also be followed by an automatic successor. Automatic successors inherit the previous response’s settings and continue from it with the queued input.

If the response stops for client-owned tool output or approval, accepted steering input remains queued and response.steer.pending is emitted after response.completed. Fill the required_input stubs from that event with saved tool results or approval decisions, and send one explicit response.create per parent with the same previous_response_id and WebSocket lane. Do not rerun tools or resend accepted steering input. The queued input is prepended in submission order to that request’s input, and the explicit request retains its own settings.

This event accepts only type, previous_response_id, and input. Do not send stream_id; the target response determines the WebSocket lane.

beta_response_steer_failed_event: object { error, sequence_number, steer, 2 more }

Emitted when steering input is rejected or cannot be committed to a successor response. Returns the original, uncommitted input so the client can carry it into response.create when appropriate. Invalid input must be corrected before retrying.

Failures after acceptance include the same steering ID. Failures before an ID is allocated omit steer.id. A lost connection or missing acknowledgement leaves the outcome unknown; it is not proof that the input was rejected.

beta_response_steer_input: string or array of object { content, role, type, 3 more } or object { output, type, id, 6 more }

Input to queue for a continuation of the response. Uses the same string or input-item shape as response.create.input, with a non-empty array when supplying input items.

Steering accepts only messages with the user role. Each message may contain only type, role, and content, with content as a string or an array of input_text, input_image, and input_file parts. The optional type must be message. Other roles, tool outputs, and item types are not supported for steering.

beta_response_steer_input_content: BetaResponseInputTextContent { text, type, prompt_cache_breakpoint } or BetaResponseInputImageContent { type, detail, file_id, 2 more } or BetaResponseInputFileContent { type, detail, file_data, 4 more }

A piece of message content, such as text, an image, or a file.

beta_response_steer_pending_event: object { reason, required_input, sequence_number, 3 more }

Emitted when accepted steering input remains queued after the target response completes. The server still owns the input. Do not resend it. The successor’s response.created event is the commit point.

When reason is waiting_for_required_input, this event follows response.completed while the response waits for the tool results or approval decisions identified by required_input. Copy those stubs, fill their result fields using the ordinary response.create input schemas, and submit one continuation per parent with the same previous_response_id and WebSocket lane. Use saved results without rerunning tools. The queued steering input is prepended in submission order to the continuation’s input. That explicit request retains its own settings.

This notification is emitted at most once per steering submission. Multiple submissions for the same parent can report the same required inputs; they do not each require a separate continuation.

beta_response_steer_required_input: object { call_id, name, type } or object { call_id, type } or object { call_id, type } or 4 more

An input stub identifying an outstanding client-owned tool result or approval decision. Copy the stub and fill the result fields using the corresponding response.create input schema. Use saved results without rerunning the tool. The server does not supply results, approval decisions, or safety acknowledgements in these stubs.

beta_response_stream_event: BetaResponseAudioDeltaEvent { delta, sequence_number, type, agent } or BetaResponseAudioDoneEvent { sequence_number, type, agent } or BetaResponseAudioTranscriptDeltaEvent { delta, sequence_number, type, agent } or 55 more

Event emitted while a response is streamed.

beta_response_text_config: object { format, verbosity }

Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more:

beta_response_text_delta_event: object { content_index, delta, item_id, 5 more }

Emitted when there is an additional text delta.

beta_response_text_done_event: object { content_index, item_id, logprobs, 5 more }

Emitted when text content is finalized.

beta_response_tool_search_call: object { id, arguments, call_id, 5 more }
beta_response_tool_search_output_item: object { id, call_id, execution, 5 more }
beta_response_tool_search_output_item_param: object { tools, type, id, 4 more }
beta_response_usage: object { input_tokens, input_tokens_details, output_tokens, 2 more }

Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used.

beta_response_web_search_call_completed_event: object { item_id, output_index, sequence_number, 2 more }

Emitted when a web search call is completed.

beta_response_web_search_call_in_progress_event: object { item_id, output_index, sequence_number, 2 more }

Emitted when a web search call is initiated.

beta_response_web_search_call_searching_event: object { item_id, output_index, sequence_number, 2 more }

Emitted when a web search call is executing.

beta_responses_client_event: object { type, background, context_management, 31 more } or BetaResponseSteerEvent { input, previous_response_id, type } or BetaResponseInjectEvent { input, response_id, type }

Client events accepted by the Responses WebSocket server.

beta_responses_server_event: BetaResponseAudioDeltaEvent { delta, sequence_number, type, agent } or BetaResponseAudioDoneEvent { sequence_number, type, agent } or BetaResponseAudioTranscriptDeltaEvent { delta, sequence_number, type, agent } or 60 more

Server events emitted by the Responses WebSocket server.

beta_skill_reference: object { skill_id, type, version }
beta_tool: BetaFunctionTool { name, parameters, strict, 6 more } or BetaFileSearchTool { type, vector_store_ids, filters, 2 more } or BetaComputerTool { type } or 13 more

A tool that can be used to generate a response.

beta_tool_choice_allowed: object { mode, tools, type }

Constrains the tools available to the model to a pre-defined set.

beta_tool_choice_apply_patch: object { type }

Forces the model to call the apply_patch tool when executing a tool call.

beta_tool_choice_custom: object { name, type }

Use this option to force the model to call a specific custom tool.

beta_tool_choice_function: object { name, type }

Use this option to force the model to call a specific function.

beta_tool_choice_mcp: object { server_label, type, name }

Use this option to force the model to call a specific tool on a remote MCP server.

beta_tool_choice_options: "none" or "auto" or "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.

beta_tool_choice_shell: object { type }

Forces the model to call the shell tool when a tool call is required.

beta_tool_choice_types: object { type }

Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.

beta_tool_search_tool: object { type, description, execution, parameters }

Hosted or BYOT tool search configuration for deferred tools.

beta_web_search_preview_tool: object { type, search_content_types, search_context_size, user_location }

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

beta_web_search_tool: object { type, external_web_access, filters, 2 more }

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

ResponsesInput Items

List input items
$ openai beta:responses:input-items list
GET/responses/{response_id}/input_items
ModelsExpand Collapse
beta_responseItemList: object { data, first_id, has_more, 2 more }

A list of Response items.

ResponsesInput Tokens

Get input token counts
$ openai beta:responses:input-tokens count
POST/responses/input_tokens