union_member_0: string

A text input to the model, equivalent to a text input with the developer role.

Input item list: array of BetaResponseInputItem

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

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.

content: string or BetaResponseInputMessageContentList { beta_response_input_text, beta_response_input_image, beta_response_input_file }

Text, image, or audio input to the model, used to generate a response. Can also contain previous assistant responses.

Text input: string

A text input to the model.

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_text: object { text, type, prompt_cache_breakpoint }

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.

prompt_cache_breakpoint: optional object { mode }

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

mode: "explicit"

The breakpoint mode. Always explicit.

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

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

detail: "low" or "high" or "auto" or "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.

file_id: optional string

The ID of the file to be sent to the model.

image_url: optional string

The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.

prompt_cache_breakpoint: optional object { mode }

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

mode: "explicit"

The breakpoint mode. Always explicit.

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

A file input to the model.

type: "input_file"

The type of the input item. Always input_file.

detail: optional "auto" or "low" or "high"

The detail level of the file to be sent to the model. Use auto to let the system select the detail level; for GPT-5.6 and later models, auto uses high-quality rendering, which may increase input token usage. Use low for lower-cost rendering, or high to render the file at higher quality. Defaults to auto.

"auto"
"low"
"high"
file_data: optional string

The content of the file to be sent to the model.

file_id: optional string

The ID of the file to be sent to the model.

file_url: optional string

The URL of the file to be sent to the model.

filename: optional string

The name of the file to be sent to the model.

prompt_cache_breakpoint: optional object { mode }

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

mode: "explicit"

The breakpoint mode. Always explicit.

role: "user" or "assistant" or "system" or "developer"

The role of the message input. One of user, assistant, system, or developer.

"user"
"assistant"
"system"
"developer"
phase: optional "commentary" or "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: optional "message"

The type of the message input. Always message.

"message"
message: object { content, role, agent, 2 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.

content: array of BetaResponseInputContent

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

beta_response_input_text: object { text, type, prompt_cache_breakpoint }

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.

prompt_cache_breakpoint: optional object { mode }

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

mode: "explicit"

The breakpoint mode. Always explicit.

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

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

detail: "low" or "high" or "auto" or "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.

file_id: optional string

The ID of the file to be sent to the model.

image_url: optional string

The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.

prompt_cache_breakpoint: optional object { mode }

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

mode: "explicit"

The breakpoint mode. Always explicit.

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

A file input to the model.

type: "input_file"

The type of the input item. Always input_file.

detail: optional "auto" or "low" or "high"

The detail level of the file to be sent to the model. Use auto to let the system select the detail level; for GPT-5.6 and later models, auto uses high-quality rendering, which may increase input token usage. Use low for lower-cost rendering, or high to render the file at higher quality. Defaults to auto.

"auto"
"low"
"high"
file_data: optional string

The content of the file to be sent to the model.

file_id: optional string

The ID of the file to be sent to the model.

file_url: optional string

The URL of the file to be sent to the model.

filename: optional string

The name of the file to be sent to the model.

prompt_cache_breakpoint: optional object { mode }

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

mode: "explicit"

The breakpoint mode. Always explicit.

role: "user" or "system" or "developer"

The role of the message input. One of user, system, or developer.

"user"
"system"
"developer"
agent: optional object { agent_name }

The agent that produced this item.

agent_name: string

The canonical name of the agent that produced this item.

status: optional "in_progress" or "completed" or "incomplete"

The status of item. One of in_progress, completed, or incomplete. Populated when items are returned via API.

"in_progress"
"completed"
"incomplete"
type: optional "message"

The type of the message input. Always set to message.

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

An output message from the model.

id: string

The unique ID of the output message.

content: array of BetaResponseOutputText { annotations, text, type, logprobs } or BetaResponseOutputRefusal { refusal, type }

The content of the output message.

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

A text output from the model.

annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }

The annotations of the text output.

file_citation: object { file_id, filename, index, type }

A citation to a file.

file_id: string

The ID of the file.

filename: string

The filename of the file cited.

index: number

The index of the file in the list of files.

type: "file_citation"

The type of the file citation. Always file_citation.

url_citation: object { end_index, start_index, title, 2 more }

A citation for a web resource used to generate a model response.

end_index: number

The index of the last character of the URL citation in the message.

start_index: number

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: string

The URL of the web resource.

container_file_citation: object { container_id, end_index, file_id, 3 more }

A citation for a container file used to generate a model response.

container_id: string

The ID of the container file.

end_index: number

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: number

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.

file_path: object { file_id, index, type }

A path to a file.

file_id: string

The ID of the file.

index: number

The index of the file in the list of files.

type: "file_path"

The type of the file path. Always file_path.

text: string

The text output from the model.

type: "output_text"

The type of the output text. Always output_text.

logprobs: optional array of object { token, bytes, logprob, top_logprobs }
token: string
bytes: array of number
logprob: number
top_logprobs: array of object { token, bytes, logprob }
token: string
bytes: array of number
logprob: number
beta_response_output_refusal: object { refusal, type }

A refusal from the model.

refusal: string

The refusal explanation from the model.

type: "refusal"

The type of the refusal. Always refusal.

role: "assistant"

The role of the output message. Always assistant.

status: "in_progress" or "completed" or "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.

agent: optional object { agent_name }

The agent that produced this item.

agent_name: string

The canonical name of the agent that produced this item.

phase: optional "commentary" or "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"
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.

id: string

The unique ID of the file search tool call.

queries: array of string

The queries used to search for files.

status: "in_progress" or "searching" or "completed" or 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.

agent: optional object { agent_name }

The agent that produced this item.

agent_name: string

The canonical name of the agent that produced this item.

results: optional array of object { attributes, file_id, filename, 2 more }

The results of the file search tool call.

attributes: optional map[string or number or boolean]

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.

union_member_0: string
union_member_1: number
union_member_2: boolean
file_id: optional string

The unique ID of the file.

filename: optional string

The name of the file.

score: optional number

The relevance score of the file - a value between 0 and 1.

text: optional string

The text that was retrieved from the file.

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.

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 of object { id, code, message }

The pending safety checks for the computer call.

id: string

The ID of the pending safety check.

code: optional string

The type of the pending safety check.

message: optional string

Details about the pending safety check.

status: "in_progress" or "completed" or "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: optional object { button, type, x, 2 more } or object { keys, type, x, y } or object { path, type, keys } or 6 more

A click action.

click: object { button, type, x, 2 more }

A click action.

button: "left" or "right" or "wheel" or 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.

x: number

The x-coordinate where the click occurred.

y: number

The y-coordinate where the click occurred.

keys: optional array of string

The keys being held while clicking.

double_click: object { keys, type, x, y }

A double click action.

keys: array of 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.

x: number

The x-coordinate where the double click occurred.

y: number

The y-coordinate where the double click occurred.

drag: object { path, type, keys }

A drag action.

path: array of object { 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: number

The x-coordinate.

y: number

The y-coordinate.

type: "drag"

Specifies the event type. For a drag action, this property is always set to drag.

keys: optional array of string

The keys being held while dragging the mouse.

keypress: object { keys, type }

A collection of keypresses the model would like to perform.

keys: array of 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.

move: object { type, x, y, keys }

A mouse move action.

type: "move"

Specifies the event type. For a move action, this property is always set to move.

x: number

The x-coordinate to move to.

y: number

The y-coordinate to move to.

keys: optional array of string

The keys being held while moving the mouse.

screenshot: object { type }

A screenshot action.

scroll: object { scroll_x, scroll_y, type, 3 more }

A scroll action.

scroll_x: number

The horizontal scroll distance.

scroll_y: number

The vertical scroll distance.

type: "scroll"

Specifies the event type. For a scroll action, this property is always set to scroll.

x: number

The x-coordinate where the scroll occurred.

y: number

The y-coordinate where the scroll occurred.

keys: optional array of string

The keys being held while scrolling.

type: object { text, 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.

wait: object { type }

A wait action.

actions: optional array of BetaComputerAction

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

click: object { button, type, x, 2 more }

A click action.

button: "left" or "right" or "wheel" or 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.

x: number

The x-coordinate where the click occurred.

y: number

The y-coordinate where the click occurred.

keys: optional array of string

The keys being held while clicking.

double_click: object { keys, type, x, y }

A double click action.

keys: array of 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.

x: number

The x-coordinate where the double click occurred.

y: number

The y-coordinate where the double click occurred.

drag: object { path, type, keys }

A drag action.

path: array of object { 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: number

The x-coordinate.

y: number

The y-coordinate.

type: "drag"

Specifies the event type. For a drag action, this property is always set to drag.

keys: optional array of string

The keys being held while dragging the mouse.

keypress: object { keys, type }

A collection of keypresses the model would like to perform.

keys: array of 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.

move: object { type, x, y, keys }

A mouse move action.

type: "move"

Specifies the event type. For a move action, this property is always set to move.

x: number

The x-coordinate to move to.

y: number

The y-coordinate to move to.

keys: optional array of string

The keys being held while moving the mouse.

screenshot: object { type }

A screenshot action.

scroll: object { scroll_x, scroll_y, type, 3 more }

A scroll action.

scroll_x: number

The horizontal scroll distance.

scroll_y: number

The vertical scroll distance.

type: "scroll"

Specifies the event type. For a scroll action, this property is always set to scroll.

x: number

The x-coordinate where the scroll occurred.

y: number

The y-coordinate where the scroll occurred.

keys: optional array of string

The keys being held while scrolling.

type: object { text, 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.

wait: object { type }

A wait action.

agent: optional object { agent_name }

The agent that produced this item.

agent_name: string

The canonical name of the agent that produced this item.

computer_call_output: object { call_id, output, type, 4 more }

The output of a computer tool call.

call_id: string

The ID of the computer tool call that produced the output.

output: object { type, file_id, image_url }

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.

file_id: optional string

The identifier of an uploaded file that contains the screenshot.

image_url: optional string

The URL of the screenshot image.

type: "computer_call_output"

The type of the computer tool call output. Always computer_call_output.

id: optional string

The ID of the computer tool call output.

acknowledged_safety_checks: optional array of object { 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: optional string

The type of the pending safety check.

message: optional string

Details about the pending safety check.

agent: optional object { agent_name }

The agent that produced this item.

agent_name: string

The canonical name of the agent that produced this item.

status: optional "in_progress" or "completed" or "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"
beta_response_function_web_search: object { id, action, status, 2 more }

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

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.

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.

id: optional string

The unique ID of the function tool call.

agent: optional object { agent_name }

The agent that produced this item.

agent_name: string

The canonical name of the agent that produced this item.

async: optional boolean

Whether the function tool call runs asynchronously.

caller: optional object { type } or object { caller_id, type }

The execution context that produced this tool call.

direct: object { type }
program: object { caller_id, type }
caller_id: string

The call ID of the program item that produced this tool call.

type: "program"
namespace: optional string

The namespace of the function to run.

status: optional "in_progress" or "completed" or "incomplete"

The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.

"in_progress"
"completed"
"incomplete"
function_call_output: object { output, type, id, 6 more }

The output of a function tool call.

output: string or BetaResponseFunctionCallOutputItemList { beta_response_input_text_content, beta_response_input_image_content, beta_response_input_file_content }

Text, image, or file output of the function tool call.

union_member_0: string

A JSON string of the output of the function tool call.

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_input_text_content: object { text, type, prompt_cache_breakpoint }

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.

prompt_cache_breakpoint: optional object { mode }

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

mode: "explicit"

The breakpoint mode. Always explicit.

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

An image input to the model. Learn about image inputs

type: "input_image"

The type of the input item. Always input_image.

detail: optional "low" or "high" or "auto" or "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: optional string

The ID of the file to be sent to the model.

image_url: optional string

The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.

prompt_cache_breakpoint: optional object { mode }

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

mode: "explicit"

The breakpoint mode. Always explicit.

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

A file input to the model.

type: "input_file"

The type of the input item. Always input_file.

detail: optional "auto" or "low" or "high"

The detail level of the file to be sent to the model. Use auto to let the system select the detail level; for GPT-5.6 and later models, auto uses high-quality rendering, which may increase input token usage. Use low for lower-cost rendering, or high to render the file at higher quality. Defaults to auto.

"auto"
"low"
"high"
file_data: optional string

The base64-encoded data of the file to be sent to the model.

file_id: optional string

The ID of the file to be sent to the model.

file_url: optional string

The URL of the file to be sent to the model.

filename: optional string

The name of the file to be sent to the model.

prompt_cache_breakpoint: optional object { mode }

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

mode: "explicit"

The breakpoint mode. Always explicit.

type: "function_call_output"

The type of the function tool call output. Always function_call_output.

id: optional string

The unique ID of the function tool call output. Populated when this item is returned via API.

agent: optional object { agent_name }

The agent that produced this item.

agent_name: string

The canonical name of the agent that produced this item.

call_id: optional string

The unique ID of the function tool call generated by the model.

caller: optional object { type } or object { caller_id, type }

The execution context that produced this tool call.

direct: object { type }
program: object { caller_id, type }
caller_id: string

The call ID of the program item that produced this tool call.

type: "program"

The caller type. Always program.

name: optional string

The name of the tool that produced the output.

namespace: optional string

The namespace of the tool that produced the output.

status: optional "in_progress" or "completed" or "incomplete"

The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.

"in_progress"
"completed"
"incomplete"
agent_message: object { author, content, recipient, 3 more }

A message routed between agents.

author: string

The sending agent identity.

content: array of BetaResponseInputTextContent { text, type, prompt_cache_breakpoint } or BetaResponseInputImageContent { type, detail, file_id, 2 more } or object { encrypted_content, type }

Plaintext, image, or encrypted content sent between agents.

beta_response_input_text_content: object { text, type, prompt_cache_breakpoint }

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.

prompt_cache_breakpoint: optional object { mode }

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

mode: "explicit"

The breakpoint mode. Always explicit.

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

An image input to the model. Learn about image inputs

type: "input_image"

The type of the input item. Always input_image.

detail: optional "low" or "high" or "auto" or "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: optional string

The ID of the file to be sent to the model.

image_url: optional string

The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.

prompt_cache_breakpoint: optional object { mode }

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

mode: "explicit"

The breakpoint mode. Always explicit.

encrypted_content: object { encrypted_content, type }

Opaque encrypted content that Responses API decrypts inside trusted model execution.

encrypted_content: string

Opaque encrypted content.

type: "encrypted_content"

The type of the input item. Always encrypted_content.

recipient: string

The destination agent identity.

type: "agent_message"

The item type. Always agent_message.

id: optional string

The unique ID of this agent message item.

agent: optional object { agent_name }

The agent that produced this item.

agent_name: string

The canonical name of the agent that produced this item.

multi_agent_call: object { action, arguments, call_id, 3 more }
action: "spawn_agent" or "interrupt_agent" or "list_agents" or 3 more

The multi-agent action that was executed.

"spawn_agent"
"interrupt_agent"
"list_agents"
"send_message"
"followup_task"
"wait_agent"
arguments: string

The action arguments as a JSON string.

call_id: string

The unique ID linking this call to its output.

type: "multi_agent_call"

The item type. Always multi_agent_call.

id: optional string

The unique ID of this multi-agent call.

agent: optional object { agent_name }

The agent that produced this item.

agent_name: string

The canonical name of the agent that produced this item.

multi_agent_call_output: object { action, call_id, output, 3 more }
action: "spawn_agent" or "interrupt_agent" or "list_agents" or 3 more

The multi-agent action that produced this result.

"spawn_agent"
"interrupt_agent"
"list_agents"
"send_message"
"followup_task"
"wait_agent"
call_id: string

The unique ID of the multi-agent call.

output: array of object { text, type, annotations }

Text output returned by the multi-agent action.

text: string

The text content.

type: "output_text"

The content type. Always output_text.

annotations: optional array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more }

Citations associated with the text content.

file_citation: object { file_id, filename, index, type }
file_id: string

The ID of the file.

filename: string

The filename of the file cited.

index: number

The index of the file in the list of files.

type: "file_citation"

The citation type. Always file_citation.

url_citation: object { end_index, start_index, title, 2 more }
end_index: number

The index of the last character of the citation in the message.

start_index: number

The index of the first character of the citation in the message.

title: string

The title of the cited resource.

type: "url_citation"

The citation type. Always url_citation.

url: string

The URL of the cited resource.

container_file_citation: object { container_id, end_index, file_id, 3 more }
container_id: string

The ID of the container.

end_index: number

The index of the last character of the citation in the message.

file_id: string

The ID of the container file.

filename: string

The filename of the container file cited.

start_index: number

The index of the first character of the citation in the message.

type: "container_file_citation"

The citation type. Always container_file_citation.

type: "multi_agent_call_output"

The item type. Always multi_agent_call_output.

id: optional string

The unique ID of this multi-agent call output.

agent: optional object { agent_name }

The agent that produced this item.

agent_name: string

The canonical name of the agent that produced this item.

tool_search_call: object { arguments, type, id, 4 more }
arguments: unknown

The arguments supplied to the tool search call.

type: "tool_search_call"

The item type. Always tool_search_call.

id: optional string

The unique ID of this tool search call.

agent: optional object { agent_name }

The agent that produced this item.

agent_name: string

The canonical name of the agent that produced this item.

call_id: optional string

The unique ID of the tool search call generated by the model.

execution: optional "server" or "client"

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

status: optional "in_progress" or "completed" or "incomplete"

The status of the tool search call.

beta_response_tool_search_output_item_param: object { tools, type, id, 4 more }
additional_tools: object { role, tools, type, 2 more }
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_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_compaction_item_param: object { encrypted_content, type, id, agent }

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

image_generation_call: object { id, result, status, 8 more }

An image generation request made by the model.

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

A tool call to run code.

local_shell_call: object { id, action, call_id, 3 more }

A tool call to run a command on the local shell.

local_shell_call_output: object { id, output, type, 2 more }

The output of a local shell tool call.

shell_call: object { action, call_id, type, 5 more }

A tool representing a request to execute one or more shell commands.

shell_call_output: object { call_id, output, type, 5 more }

The streamed output items emitted by a shell tool call.

apply_patch_call: object { call_id, operation, status, 4 more }

A tool call representing a request to create, delete, or update files using diff patches.

apply_patch_call_output: object { call_id, status, type, 4 more }

The streamed output emitted by an apply patch tool call.

mcp_list_tools: object { id, server_label, tools, 3 more }

A list of tools available on an MCP server.

mcp_approval_request: object { id, arguments, name, 3 more }

A request for human approval of a tool invocation.

mcp_approval_response: object { approval_request_id, approve, type, 3 more }

A response to an MCP approval request.

mcp_call: object { id, arguments, name, 7 more }

An invocation of a tool on an MCP server.

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: object { call_id, input, name, 6 more }

A call to a custom tool created by the model.

compaction_trigger: object { type, agent }

Compacts the current context. Must be the final input item.

item_reference: object { id, agent, type }

An internal identifier for an item to reference.

program: object { id, call_id, code, 3 more }
program_output: object { id, call_id, result, 3 more }