One of the following:
String = String

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

UnionMember1 = Array[BetaResponseInputItem]

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

One of the following:
class BetaEasyInputMessage { 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 | BetaResponseInputMessageContentList { , , }

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

One of the following:
String = String

A text input to the model.

BetaResponseInputMessageContentList = Array[BetaResponseInputContent]

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

One of the following:
class BetaResponseInputText { 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: PromptCacheBreakpoint{ 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.

class BetaResponseInputImage { detail, type, file_id, 2 more }

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

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.

One of the following:
:low
:high
:auto
:original
type: :input_image

The type of the input item. Always 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.

formaturi
prompt_cache_breakpoint: PromptCacheBreakpoint{ 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.

class BetaResponseInputFile { 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: :auto | :low | :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.

One of the following:
:auto
: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.

formaturi
filename: String

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

prompt_cache_breakpoint: PromptCacheBreakpoint{ 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 | :assistant | :system | :developer

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

One of the following:
: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.

One of the following:
:commentary
:final_answer
type: :message

The type of the message input. Always message.

class Message { 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: BetaResponseInputMessageContentList { , , }

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

One of the following:
class BetaResponseInputText { 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: PromptCacheBreakpoint{ 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.

class BetaResponseInputImage { detail, type, file_id, 2 more }

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

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.

One of the following:
:low
:high
:auto
:original
type: :input_image

The type of the input item. Always 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.

formaturi
prompt_cache_breakpoint: PromptCacheBreakpoint{ 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.

class BetaResponseInputFile { 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: :auto | :low | :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.

One of the following:
:auto
: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.

formaturi
filename: String

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

prompt_cache_breakpoint: PromptCacheBreakpoint{ 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 | :system | :developer

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

One of the following:
:user
:system
:developer
agent: Agent{ agent_name}

The agent that produced this item.

agent_name: String

The canonical name of the agent that produced this item.

status: :in_progress | :completed | :incomplete

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

One of the following:
:in_progress
:completed
:incomplete
type: :message

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

class BetaResponseOutputMessage { id, content, role, 4 more }

An output message from the model.

id: String

The unique ID of the output message.

content: Array[BetaResponseOutputText { annotations, text, type, logprobs } | BetaResponseOutputRefusal { refusal, type } ]

The content of the output message.

One of the following:
class BetaResponseOutputText { annotations, text, type, logprobs }

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.

One of the following:
class FileCitation { 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: Integer

The index of the file in the list of files.

type: :file_citation

The type of the file citation. Always file_citation.

class URLCitation { end_index, start_index, title, 2 more }

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

The URL of the web resource.

formaturi
class ContainerFileCitation { 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: 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.

class FilePath { file_id, index, type }

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.

text: String

The text output from the model.

type: :output_text

The type of the output text. Always 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 BetaResponseOutputRefusal { 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 | :completed | :incomplete

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

One of the following:
:in_progress
:completed
:incomplete
type: :message

The type of the output message. Always message.

agent: Agent{ agent_name}

The agent that produced this item.

agent_name: String

The canonical name of the agent that produced this item.

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.

One of the following:
:commentary
:final_answer
class BetaResponseFileSearchToolCall { 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[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,

One of the following:
:in_progress
:searching
:completed
:incomplete
:failed
type: :file_search_call

The type of the file search tool call. Always file_search_call.

agent: Agent{ agent_name}

The agent that produced this item.

agent_name: String

The canonical name of the agent that produced this item.

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.

One of the following:
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.

formatfloat
text: String

The text that was retrieved from the file.

class BetaResponseComputerToolCall { 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[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.

One of the following:
:in_progress
:completed
:incomplete
type: :computer_call

The type of the computer call. Always computer_call.

action: BetaComputerAction

A click action.

One of the following:
class Click { button, type, x, 2 more }

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.

One of the following:
:left
:right
:wheel
:back
:forward
type: :click

Specifies the event type. For a click action, this property is always 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 { keys, type, x, y_ }

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.

x: Integer

The x-coordinate where the double click occurred.

y_: Integer

The y-coordinate where the double click occurred.

class Drag { path, type, keys }

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.

keys: Array[String]

The keys being held while dragging the mouse.

class Keypress { keys, type }

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.

class Move { 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: 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 { type }

A screenshot action.

type: :screenshot

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

class Scroll { scroll_x, scroll_y, type, 3 more }

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.

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 { 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.

class Wait { type }

A wait action.

type: :wait

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

actions: BetaComputerActionList { Click, DoubleClick, Drag, 6 more }

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

One of the following:
class Click { button, type, x, 2 more }

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.

One of the following:
:left
:right
:wheel
:back
:forward
type: :click

Specifies the event type. For a click action, this property is always 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 { keys, type, x, y_ }

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.

x: Integer

The x-coordinate where the double click occurred.

y_: Integer

The y-coordinate where the double click occurred.

class Drag { path, type, keys }

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.

keys: Array[String]

The keys being held while dragging the mouse.

class Keypress { keys, type }

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.

class Move { 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: 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 { type }

A screenshot action.

type: :screenshot

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

class Scroll { scroll_x, scroll_y, type, 3 more }

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.

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 { 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.

class Wait { type }

A wait action.

type: :wait

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

agent: Agent{ agent_name}

The agent that produced this item.

agent_name: String

The canonical name of the agent that produced this item.

class ComputerCallOutput { 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.

minLength1
maxLength64
output: BetaResponseComputerToolCallOutputScreenshot { 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: String

The identifier of an uploaded file that contains the screenshot.

image_url: String

The URL of the screenshot image.

formaturi
type: :computer_call_output

The type of the computer tool call output. Always 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.

agent: Agent{ agent_name}

The agent that produced this item.

agent_name: String

The canonical name of the agent that produced this item.

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.

One of the following:
:in_progress
:completed
:incomplete
One of the following:
One of the following:
class BetaResponseFunctionToolCall { 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: String

The unique ID of the function tool call.

agent: Agent{ agent_name}

The agent that produced this item.

agent_name: String

The canonical name of the agent that produced this item.

async: bool

Whether the function tool call runs asynchronously.

caller_: Direct{ type} | Program{ caller_id, type}

The execution context that produced this tool call.

One of the following:
class Direct { type }
type: :direct
class Program { caller_id, type }
caller_id: String

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

type: :program
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.

One of the following:
:in_progress
:completed
:incomplete
class FunctionCallOutput { output, type, id, 6 more }

The output of a function tool call.

output: String | BetaResponseFunctionCallOutputItemList { , , }

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

One of the following:
String = String

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

BetaResponseFunctionCallOutputItemList = Array[BetaResponseFunctionCallOutputItem]

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

One of the following:
class BetaResponseInputTextContent { text, type, prompt_cache_breakpoint }

A text input to the model.

text: String

The text input to the model.

maxLength10485760
type: :input_text

The type of the input item. Always input_text.

prompt_cache_breakpoint: PromptCacheBreakpoint{ 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.

class BetaResponseInputImageContent { 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: :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.

One of the following:
: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.

maxLength20971520
formaturi
prompt_cache_breakpoint: PromptCacheBreakpoint{ 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.

class BetaResponseInputFileContent { 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: :auto | :low | :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.

One of the following:
:auto
:low
:high
file_data: String

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

maxLength73400320
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.

formaturi
filename: String

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

prompt_cache_breakpoint: PromptCacheBreakpoint{ 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: String

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

agent: Agent{ agent_name}

The agent that produced this item.

agent_name: String

The canonical name of the agent that produced this item.

call_id: String

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

minLength1
maxLength64
caller_: Direct{ type} | Program{ caller_id, type}

The execution context that produced this tool call.

One of the following:
class Direct { type }
type: :direct

The caller type. Always direct.

class Program { caller_id, type }
caller_id: String

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

minLength1
maxLength64
type: :program

The caller type. Always program.

name: String

The name of the tool that produced the output.

minLength1
maxLength128
namespace: String

The namespace of the tool that produced the output.

minLength1
maxLength64
status: :in_progress | :completed | :incomplete

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

One of the following:
:in_progress
:completed
:incomplete
class AgentMessage { author, content, recipient, 3 more }

A message routed between agents.

author: String

The sending agent identity.

content: Array[BetaResponseInputTextContent { text, type, prompt_cache_breakpoint } | BetaResponseInputImageContent { type, detail, file_id, 2 more } | EncryptedContent{ encrypted_content, type}]

Plaintext, image, or encrypted content sent between agents.

One of the following:
class BetaResponseInputTextContent { text, type, prompt_cache_breakpoint }

A text input to the model.

text: String

The text input to the model.

maxLength10485760
type: :input_text

The type of the input item. Always input_text.

prompt_cache_breakpoint: PromptCacheBreakpoint{ 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.

class BetaResponseInputImageContent { 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: :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.

One of the following:
: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.

maxLength20971520
formaturi
prompt_cache_breakpoint: PromptCacheBreakpoint{ 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.

class EncryptedContent { encrypted_content, type }

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

encrypted_content: String

Opaque encrypted content.

maxLength10485760
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: String

The unique ID of this agent message item.

agent: Agent{ agent_name}

The agent that produced this item.

agent_name: String

The canonical name of the agent that produced this item.

class MultiAgentCall { action, arguments, call_id, 3 more }
action: :spawn_agent | :interrupt_agent | :list_agents | 3 more

The multi-agent action that was executed.

One of the following:
: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.

minLength1
maxLength64
type: :multi_agent_call

The item type. Always multi_agent_call.

id: String

The unique ID of this multi-agent call.

agent: Agent{ agent_name}

The agent that produced this item.

agent_name: String

The canonical name of the agent that produced this item.

class MultiAgentCallOutput { action, call_id, output, 3 more }
action: :spawn_agent | :interrupt_agent | :list_agents | 3 more

The multi-agent action that produced this result.

One of the following:
:spawn_agent
:interrupt_agent
:list_agents
:send_message
:followup_task
:wait_agent
call_id: String

The unique ID of the multi-agent call.

minLength1
maxLength64
output: Array[Output{ text, type, annotations}]

Text output returned by the multi-agent action.

text: String

The text content.

maxLength10485760
type: :output_text

The content type. Always output_text.

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}]

Citations associated with the text content.

One of the following:
class FileCitation { file_id, filename, index, type }
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.

minimum0
type: :file_citation

The citation type. Always file_citation.

class URLCitation { end_index, start_index, title, 2 more }
end_index: Integer

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

minimum0
start_index: Integer

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

minimum0
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.

formaturi
class ContainerFileCitation { container_id, end_index, file_id, 3 more }
container_id: String

The ID of the container.

end_index: Integer

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

minimum0
file_id: String

The ID of the container file.

filename: String

The filename of the container file cited.

start_index: Integer

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

minimum0
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: String

The unique ID of this multi-agent call output.

agent: Agent{ agent_name}

The agent that produced this item.

class ToolSearchCall { arguments, type, id, 4 more }
class BetaResponseToolSearchOutputItemParam { tools, type, id, 4 more }
class AdditionalTools { role, tools, type, 2 more }
class BetaResponseConfigurationUpdateItemParam { 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.

class BetaResponseReasoningItem { 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.

class BetaResponseCompactionItemParam { encrypted_content, type, id, agent }

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

class ImageGenerationCall { id, result, status, 8 more }

An image generation request made by the model.

class BetaResponseCodeInterpreterToolCall { id, code, container_id, 4 more }

A tool call to run code.

class LocalShellCall { id, action, call_id, 3 more }

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

class LocalShellCallOutput { id, output, type, 2 more }

The output of a local shell tool call.

class ShellCall { action, call_id, type, 5 more }

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

class ShellCallOutput { call_id, output, type, 5 more }

The streamed output items emitted by a shell tool call.

class ApplyPatchCall { call_id, operation, status, 4 more }

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

class ApplyPatchCallOutput { call_id, status, type, 4 more }

The streamed output emitted by an apply patch tool call.

class McpListTools { id, server_label, tools, 3 more }

A list of tools available on an MCP server.

class McpApprovalRequest { id, arguments, name, 3 more }

A request for human approval of a tool invocation.

class McpApprovalResponse { approval_request_id, approve, type, 3 more }

A response to an MCP approval request.

class McpCall { id, arguments, name, 7 more }

An invocation of a tool on an MCP server.

class BetaResponseCustomToolCallOutput { call_id, output, type, 3 more }

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

class BetaResponseCustomToolCall { call_id, input, name, 6 more }

A call to a custom tool created by the model.

class CompactionTrigger { type, agent }

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

class ItemReference { id, agent, type }

An internal identifier for an item to reference.

class Program { id, call_id, code, 3 more }
class ProgramOutput { id, call_id, result, 3 more }