Cancel a response
POST
/responses/{response_id}/cancelCancels a model response with the given ID. Only responses created with
the background parameter set to true can be cancelled.
Learn more.
Cancel a response
curl -X POST https://api.openai.com/v1/responses/resp_123/cancel \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OPENAI_API_KEY"
Response example
{
"id": "resp_67cb71b351908190a308f3859487620d06981a8637e6bc44",
"object": "response",
"access_programs": null,
"created_at": 1741386163,
"status": "cancelled",
"background": true,
"completed_at": null,
"error": null,
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"model": "gpt-6-astra",
"output": [
{
"type": "message",
"id": "msg_67cb71b3c2b0819084d481baaaf148f206981a8637e6bc44",
"status": "in_progress",
"role": "assistant",
"content": [
{
"type": "output_text",
"text": "Silent circuits hum, \nThoughts emerge in data streams— \nDigital dawn breaks.",
"annotations": [],
"logprobs": []
}
]
}
],
"parallel_tool_calls": true,
"previous_response_id": null,
"reasoning": {
"effort": null,
"summary": null
},
"store": true,
"temperature": 1.0,
"text": {
"format": {
"type": "text"
}
},
"tool_choice": "auto",
"tools": [],
"top_p": 1.0,
"truncation": "disabled",
"usage": null,
"user": null,
"metadata": {}
}
Returns
BetaResponse object { id, access_programs, created_at, 37 more }
BetaResponse object { id, access_programs, created_at, 37 more }
id: string Unique identifier for this Response.
access_programs: object or null cyber: "standard" or "daybreak_blue" or "daybreak_red" The effective Cyber access program used for this response.
One of the following: "standard" "daybreak_blue" "daybreak_red" created_at: number Unix timestamp (in seconds) of when this Response was created.
formatunixtime error: BetaResponseError or null An error object returned when the model fails to generate a Response.
code: "server_error" or "rate_limit_exceeded" or "invalid_prompt" or 18 more The error code for the response.
One of the following: "server_error" "rate_limit_exceeded" "invalid_prompt" "data_residency_mismatch" "bio_policy" "misalignment_policy_violation" "vector_store_timeout" "invalid_image" "invalid_image_format" "invalid_base64_image" "invalid_image_url" "image_too_large" "image_too_small" "image_parse_error" "image_content_policy_violation" "invalid_image_mode" "image_file_too_large" "unsupported_image_media_type" "empty_image_file" "failed_to_download_image" "image_file_not_found" message: string A human-readable description of the error.
misalignment: optional { detailed_explanation, error_type, review_target, steer } detailed_explanation: optional string The public explanation for this block.
error_type: optional string or "potentially_unintended_data_transfer" or "potentially_unintended_data_access" or "potentially_unintended_destructive_activity" or "other" An optional classification; clients must accept additional values.
One of the following: string SafetyAlertErrorType = "potentially_unintended_data_transfer" or "potentially_unintended_data_access" or "potentially_unintended_destructive_activity" or "other" An optional classification; clients must accept additional values.
One of the following: "potentially_unintended_data_transfer" "potentially_unintended_data_access" "potentially_unintended_destructive_activity" "other" review_target: optional string or null An opaque target for explicitly continuing this review, or null when unavailable.
pattern^[A-Za-z0-9._~:-]+$ minLength1 maxLength96 steer: optional { message } An optional public continuation instruction.
message: string The public continuation instruction.
param: optional string or null The request parameter associated with the error, or null if none was recorded.
type: optional string or null The original error type, or null if it was not recorded.
incomplete_details: object or null Details about why the response is incomplete.
reason: optional "max_output_tokens" or "max_messages" or "content_filter" or "steered" The reason why the response is incomplete. steered means
the response stopped at a safe output boundary after a
WebSocket response.steer event. The server can then create
a successor response automatically with the queued input.
One of the following: "max_output_tokens" "max_messages" "content_filter" "steered" instructions: string or array of BetaEasyInputMessage or Message or BetaResponseOutputMessage or 33 more or null A system (or developer) message inserted into the model’s context.
When using along with previous_response_id, the instructions from a previous
response will not be carried over to the next response. This makes it simple
to swap out system (or developer) messages in new responses.
One of the following: string A text input to the model, equivalent to a text input with the
developer role.
InputItemList = array of BetaEasyInputMessage or Message or BetaResponseOutputMessage or 33 more A list of one or many input items to the model, containing
different content types.
One of the following: 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 or BetaResponseInputMessageContentList Text, image, or audio input to the model, used to generate a response.
Can also contain previous assistant responses.
One of the following: TextInput = string A text input to the model.
BetaResponseInputMessageContentList = array of BetaResponseInputContent A list of one or many input items to the model, containing different content
types.
One of the following: BetaResponseInputText { text, type, prompt_cache_breakpoint } A text input to the model.
text: string The text input to the model.
type: "input_text" (default: "input_text") The type of the input item. Always input_text.
prompt_cache_breakpoint: optional { mode, ttl } Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.
mode: "explicit" (default: "explicit") The breakpoint mode. Always explicit.
ttl: optional "30m" or "12h" The minimum lifetime of this cache breakpoint. Defaults to the request TTL.
One of the following: "30m" "12h" BetaResponseInputImage { detail, type, file_id, 2 more } An image input to the model. Learn about image inputs.
detail: BetaImageDetail 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" (default: "input_image") The type of the input item. Always input_image.
file_id: optional string or null The ID of the file to be sent to the model.
image_url: optional string or null 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: optional { mode, ttl } Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.
mode: "explicit" (default: "explicit") The breakpoint mode. Always explicit.
ttl: optional "30m" or "12h" The minimum lifetime of this cache breakpoint. Defaults to the request TTL.
One of the following: "30m" "12h" BetaResponseInputFile { type, detail, file_data, 4 more } A file input to the model.
type: "input_file" (default: "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.
One of the following: "auto" "low" "high" file_data: optional string The content of the file to be sent to the model.
file_id: optional string or null 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.
formaturi filename: optional string The name of the file to be sent to the model.
prompt_cache_breakpoint: optional { mode, ttl } Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.
mode: "explicit" (default: "explicit") The breakpoint mode. Always explicit.
ttl: optional "30m" or "12h" The minimum lifetime of this cache breakpoint. Defaults to the request TTL.
One of the following: "30m" "12h" role: "user" or "assistant" or "system" or "developer" The role of the message input. One of user, assistant, system, or
developer.
One of the following: "user" "assistant" "system" "developer" phase: optional "commentary" or "final_answer" or null 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: optional "message" The type of the message input. Always message.
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: BetaResponseInputText { text, type, prompt_cache_breakpoint } A text input to the model.
text: string The text input to the model.
type: "input_text" (default: "input_text") The type of the input item. Always input_text.
prompt_cache_breakpoint: optional { mode, ttl } Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.
mode: "explicit" (default: "explicit") The breakpoint mode. Always explicit.
ttl: optional "30m" or "12h" The minimum lifetime of this cache breakpoint. Defaults to the request TTL.
One of the following: "30m" "12h" BetaResponseInputImage { detail, type, file_id, 2 more } An image input to the model. Learn about image inputs.
detail: BetaImageDetail 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" (default: "input_image") The type of the input item. Always input_image.
file_id: optional string or null The ID of the file to be sent to the model.
image_url: optional string or null 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: optional { mode, ttl } Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.
mode: "explicit" (default: "explicit") The breakpoint mode. Always explicit.
ttl: optional "30m" or "12h" The minimum lifetime of this cache breakpoint. Defaults to the request TTL.
One of the following: "30m" "12h" BetaResponseInputFile { type, detail, file_data, 4 more } A file input to the model.
type: "input_file" (default: "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.
One of the following: "auto" "low" "high" file_data: optional string The content of the file to be sent to the model.
file_id: optional string or null 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.
formaturi filename: optional string The name of the file to be sent to the model.
prompt_cache_breakpoint: optional { mode, ttl } Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.
mode: "explicit" (default: "explicit") The breakpoint mode. Always explicit.
ttl: optional "30m" or "12h" The minimum lifetime of this cache breakpoint. Defaults to the request TTL.
One of the following: "30m" "12h" role: "user" or "system" or "developer" The role of the message input. One of user, system, or developer.
One of the following: "user" "system" "developer" agent: optional object or null 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.
One of the following: "in_progress" "completed" "incomplete" type: optional "message" The type of the message input. Always set to message.
BetaResponseOutputMessage { id, content, role, 4 more } An output message from the model.
id: string The unique ID of the output message.
content: array of BetaResponseOutputText or BetaResponseOutputRefusal The content of the output message.
One of the following: BetaResponseOutputText { annotations, logprobs, text, type } A text output from the model.
annotations: array of FileCitation or URLCitation or ContainerFileCitation or FilePath The annotations of the text output.
One of the following: 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 in the output text at which to insert the file citation.
type: "file_citation" (default: "file_citation") The type of the file citation. Always file_citation.
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" (default: "url_citation") The type of the URL citation. Always url_citation.
url: string The URL of the web resource.
formaturi 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" (default: "container_file_citation") The type of the container file citation. Always container_file_citation.
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.
logprobs: array of { token, bytes, logprob, top_logprobs } token: string bytes: array of number logprob: number top_logprobs: array of { token, bytes, logprob } token: string bytes: array of number logprob: number text: string The text output from the model.
type: "output_text" (default: "output_text") The type of the output text. Always output_text.
BetaResponseOutputRefusal { refusal, type } A refusal from the model.
refusal: string The refusal explanation from the model.
type: "refusal" (default: "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.
One of the following: "in_progress" "completed" "incomplete" type: "message" The type of the output message. Always message.
agent: optional object or null 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" or null 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" FileSearchCall { 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,
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: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
results: optional array of object or null The results of the file search tool call.
attributes: optional map[string or number or boolean] or null 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 maxLength512 number 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.
formatfloat text: optional string The text that was retrieved from the file.
ComputerCall { 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 { id, code, message } The pending safety checks for the computer call.
id: string The ID of the pending safety check.
code: optional string or null The type of the pending safety check.
message: optional string or null 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.
One of the following: "in_progress" "completed" "incomplete" type: "computer_call" (default: "computer_call") The type of the computer call. Always computer_call.
action: optional BetaComputerAction A click action.
One of the following: Click { 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.
One of the following: "left" "right" "wheel" "back" "forward" type: "click" (default: "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: optional array of string or null The keys being held while clicking.
DoubleClick { keys, type, x, y } A double click action.
keys: array of string or null The keys being held while double-clicking.
type: "double_click" (default: "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.
Drag { path, type, keys } A drag action.
path: array of { 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" (default: "drag") Specifies the event type. For a drag action, this property is always set to drag.
keys: optional array of string or null The keys being held while dragging the mouse.
Keypress { 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" (default: "keypress") Specifies the event type. For a keypress action, this property is always set to keypress.
Move { type, x, y, keys } A mouse move action.
type: "move" (default: "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: optional array of string or null The keys being held while moving the mouse.
Screenshot { type } A screenshot action.
type: "screenshot" (default: "screenshot") Specifies the event type. For a screenshot action, this property is always set to screenshot.
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" (default: "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: optional array of string or null The keys being held while scrolling.
Type { text, type } An action to type in text.
text: string The text to type.
type: "type" (default: "type") Specifies the event type. For a type action, this property is always set to type.
Wait { type } A wait action.
type: "wait" (default: "wait") Specifies the event type. For a wait action, this property is always set to wait.
actions: optional 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: Click { 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.
One of the following: "left" "right" "wheel" "back" "forward" type: "click" (default: "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: optional array of string or null The keys being held while clicking.
DoubleClick { keys, type, x, y } A double click action.
keys: array of string or null The keys being held while double-clicking.
type: "double_click" (default: "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.
Drag { path, type, keys } A drag action.
path: array of { 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" (default: "drag") Specifies the event type. For a drag action, this property is always set to drag.
keys: optional array of string or null The keys being held while dragging the mouse.
Keypress { 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" (default: "keypress") Specifies the event type. For a keypress action, this property is always set to keypress.
Move { type, x, y, keys } A mouse move action.
type: "move" (default: "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: optional array of string or null The keys being held while moving the mouse.
Screenshot { type } A screenshot action.
type: "screenshot" (default: "screenshot") Specifies the event type. For a screenshot action, this property is always set to screenshot.
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" (default: "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: optional array of string or null The keys being held while scrolling.
Type { text, type } An action to type in text.
text: string The text to type.
type: "type" (default: "type") Specifies the event type. For a type action, this property is always set to type.
Wait { type } A wait action.
type: "wait" (default: "wait") Specifies the event type. For a wait action, this property is always set to wait.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
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" (default: "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.
formaturi type: "computer_call_output" (default: "computer_call_output") The type of the computer tool call output. Always computer_call_output.
id: optional string or null The ID of the computer tool call output.
acknowledged_safety_checks: optional array of object or null 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 or null The type of the pending safety check.
message: optional string or null Details about the pending safety check.
agent: optional object or null 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" or null 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" WebSearchCall { id, status, type, 2 more } The results of a web search tool call. See the
web search guide for more information.
id: string The unique ID of the web search tool call.
status: "in_progress" or "searching" or "completed" or 2 more The status of the web search tool call.
One of the following: "in_progress" "searching" "completed" "failed" "incomplete" type: "web_search_call" The type of the web search tool call. Always web_search_call.
action: optional Search or OpenPage or FindInPage An object describing the specific action taken in this web search call.
Includes details on how the model used the web (search, open_page, find_in_page).
One of the following: Search { type, queries, query, sources } Action type “search” - Performs a web search query.
type: "search" The action type.
queries: optional array of string The search queries.
query: optional string Deprecated.
The search query.
sources: optional array of { type, url } The sources used in the search.
type: "url" The type of source. Always url.
url: string The URL of the source.
formaturi OpenPage { type, url } Action type “open_page” - Opens a specific URL from search results.
type: "open_page" The action type.
url: optional string or null The URL opened by the model.
formaturi FindInPage { pattern, type, url } Action type “find_in_page”: Searches for a pattern within a loaded page.
pattern: string The pattern or text to search for within the page.
type: "find_in_page" The action type.
url: optional string or null The URL of the page searched for the pattern, when available.
formaturi agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
FunctionCall { 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 or null 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 Direct or Program or null The execution context that produced this tool call.
One of the following: Direct { type } type: "direct" (default: "direct") Program { caller_id, type } caller_id: string The call ID of the program item that produced this tool call.
type: "program" (default: "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.
One of the following: "in_progress" "completed" "incomplete" FunctionCallOutput { output, type, id, 6 more } The output of a function tool call.
output: string or array of BetaResponseInputTextContent or BetaResponseInputImageContent or BetaResponseInputFileContent Text, image, or file output of the function tool call.
One of the following: string A JSON string of the output of the function tool call.
maxLength10485760 array of BetaResponseInputTextContent or BetaResponseInputImageContent or BetaResponseInputFileContent An array of content outputs (text, image, file) for the function tool call.
One of the following: BetaResponseInputTextContent { text, type, prompt_cache_breakpoint } A text input to the model.
text: string The text input to the model.
maxLength10485760 type: "input_text" (default: "input_text") The type of the input item. Always input_text.
prompt_cache_breakpoint: optional object or null Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.
mode: "explicit" (default: "explicit") The breakpoint mode. Always explicit.
ttl: optional "30m" or "12h" The minimum lifetime of this cache breakpoint. Defaults to the request TTL.
One of the following: "30m" "12h" BetaResponseInputImageContent { type, detail, file_id, 2 more } An image input to the model. Learn about image inputs
type: "input_image" (default: "input_image") The type of the input item. Always input_image.
detail: optional BetaImageDetail or null 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: optional string or null The ID of the file to be sent to the model.
image_url: optional string or null 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: optional object or null Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.
mode: "explicit" (default: "explicit") The breakpoint mode. Always explicit.
ttl: optional "30m" or "12h" The minimum lifetime of this cache breakpoint. Defaults to the request TTL.
One of the following: "30m" "12h" BetaResponseInputFileContent { type, detail, file_data, 4 more } A file input to the model.
type: "input_file" (default: "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.
One of the following: "auto" "low" "high" file_data: optional string or null The base64-encoded data of the file to be sent to the model.
maxLength73400320 file_id: optional string or null The ID of the file to be sent to the model.
file_url: optional string or null The URL of the file to be sent to the model.
formaturi filename: optional string or null The name of the file to be sent to the model.
prompt_cache_breakpoint: optional object or null Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.
mode: "explicit" (default: "explicit") The breakpoint mode. Always explicit.
ttl: optional "30m" or "12h" The minimum lifetime of this cache breakpoint. Defaults to the request TTL.
One of the following: "30m" "12h" type: "function_call_output" (default: "function_call_output") The type of the function tool call output. Always function_call_output.
id: optional string or null The unique ID of the function tool call output. Populated when this item is returned via API.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
call_id: optional string or null The unique ID of the function tool call generated by the model.
minLength1 maxLength64 caller: optional Direct or Program or null The execution context that produced this tool call.
One of the following: Direct { type } type: "direct" (default: "direct") The caller type. Always direct.
Program { caller_id, type } caller_id: string The call ID of the program item that produced this tool call.
minLength1 maxLength64 type: "program" (default: "program") The caller type. Always program.
name: optional string or null The name of the tool that produced the output.
minLength1 maxLength128 namespace: optional string or null The namespace of the tool that produced the output.
pattern^[a-zA-Z0-9_-]+$ minLength1 maxLength128 status: optional "in_progress" or "completed" or "incomplete" or null 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" AgentMessage { author, content, recipient, 3 more } A message routed between agents.
author: string The sending agent identity.
content: array of BetaResponseInputTextContent or BetaResponseInputImageContent or EncryptedContent Plaintext, image, or encrypted content sent between agents.
One of the following: BetaResponseInputTextContent { text, type, prompt_cache_breakpoint } A text input to the model.
text: string The text input to the model.
maxLength10485760 type: "input_text" (default: "input_text") The type of the input item. Always input_text.
prompt_cache_breakpoint: optional object or null Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.
mode: "explicit" (default: "explicit") The breakpoint mode. Always explicit.
ttl: optional "30m" or "12h" The minimum lifetime of this cache breakpoint. Defaults to the request TTL.
One of the following: "30m" "12h" BetaResponseInputImageContent { type, detail, file_id, 2 more } An image input to the model. Learn about image inputs
type: "input_image" (default: "input_image") The type of the input item. Always input_image.
detail: optional BetaImageDetail or null 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: optional string or null The ID of the file to be sent to the model.
image_url: optional string or null 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: optional object or null Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.
mode: "explicit" (default: "explicit") The breakpoint mode. Always explicit.
ttl: optional "30m" or "12h" The minimum lifetime of this cache breakpoint. Defaults to the request TTL.
One of the following: "30m" "12h" 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" (default: "encrypted_content") The type of the input item. Always encrypted_content.
recipient: string The destination agent identity.
type: "agent_message" (default: "agent_message") The item type. Always agent_message.
id: optional string or null The unique ID of this agent message item.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
MultiAgentCall { 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.
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" (default: "multi_agent_call") The item type. Always multi_agent_call.
id: optional string or null The unique ID of this multi-agent call.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
MultiAgentCallOutput { 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.
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 of { text, type, annotations } Text output returned by the multi-agent action.
text: string The text content.
maxLength10485760 type: "output_text" (default: "output_text") The content type. Always output_text.
annotations: optional array of FileCitation or URLCitation or ContainerFileCitation Citations associated with the text content.
One of the following: 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" (default: "file_citation") The citation type. Always file_citation.
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" (default: "url_citation") The citation type. Always url_citation.
url: string The URL of the cited resource.
formaturi 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" (default: "container_file_citation") The citation type. Always container_file_citation.
type: "multi_agent_call_output" (default: "multi_agent_call_output") The item type. Always multi_agent_call_output.
id: optional string or null The unique ID of this multi-agent call output.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
ToolSearchCall { arguments, type, id, 4 more } arguments: unknown The arguments supplied to the tool search call.
type: "tool_search_call" (default: "tool_search_call") The item type. Always tool_search_call.
id: optional string or null The unique ID of this tool search call.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
call_id: optional string or null The unique ID of the tool search call generated by the model.
minLength1 maxLength64 execution: optional "server" or "client" Whether tool search was executed by the server or by the client.
One of the following: "server" "client" status: optional "in_progress" or "completed" or "incomplete" or null The status of the tool search call.
One of the following: "in_progress" "completed" "incomplete" ToolSearchOutput { tools, type, id, 4 more } tools: array of Function or FileSearch or Computer or 13 more The loaded tool definitions returned by the tool search output.
One of the following: Function { name, parameters, strict, 6 more } Defines a function in your own code the model can choose to call. Learn more about function calling.
name: string The name of the function to call.
parameters: map[unknown] or null A JSON schema object describing the parameters of the function.
strict: boolean or null Whether strict parameter validation is enforced for this function tool.
type: "function" (default: "function") The type of the function tool. Always function.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
One of the following: "direct" "programmatic" async: optional boolean defer_loading: optional boolean Whether this function is deferred and loaded via tool search.
description: optional string or null A description of the function. Used by the model to determine whether or not to call the function.
output_schema: optional map[unknown] or null A JSON schema object describing the JSON value encoded in string outputs for this function.
FileSearch { type, vector_store_ids, filters, 2 more } A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
type: "file_search" (default: "file_search") The type of the file search tool. Always file_search.
vector_store_ids: array of string The IDs of the vector stores to search.
filters: optional ComparisonFilter or unknown or null A filter to apply.
One of the following: ComparisonFilter { key, type, value } A filter used to compare a specified attribute key to a given value using a defined comparison operation.
key: string The key to compare against the value.
type: "eq" or "ne" or "gt" or 5 more (default: "eq") Specifies the comparison operator: eq, ne, gt, gte, lt, lte, in, nin.
eq: equals
ne: not equal
gt: greater than
gte: greater than or equal
lt: less than
lte: less than or equal
in: in
nin: not in
One of the following: "eq" "ne" "gt" "gte" "lt" "lte" "in" "nin" value: string or number or boolean or array of string or number The value to compare against the attribute key; supports string, number, or boolean types.
One of the following: string number boolean array of string or number One of the following: string number BetaCompoundFilter = unknown Combine multiple filters using and or or.
max_num_results: optional integer The maximum number of results to return. This number should be between 1 and 50 inclusive.
ranking_options: optional { hybrid_search, ranker, score_threshold } Ranking options for search.
hybrid_search: optional { embedding_weight, text_weight } Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled.
embedding_weight: number The weight of the embedding in the reciprocal ranking fusion.
text_weight: number The weight of the text in the reciprocal ranking fusion.
ranker: optional "auto" or "default-2024-11-15" The ranker to use for the file search.
One of the following: "auto" "default-2024-11-15" score_threshold: optional number The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.
Computer { type } A tool that controls a virtual computer. Learn more about the computer tool.
type: "computer" (default: "computer") The type of the computer tool. Always computer.
ComputerUsePreview { display_height, display_width, environment, type } A tool that controls a virtual computer. Learn more about the computer tool.
display_height: integer The height of the computer display.
display_width: integer The width of the computer display.
environment: "windows" or "mac" or "linux" or 2 more The type of computer environment to control.
One of the following: "windows" "mac" "linux" "ubuntu" "browser" type: "computer_use_preview" (default: "computer_use_preview") The type of the computer use tool. Always computer_use_preview.
WebSearch { type, external_web_access, filters, 2 more } Search the Internet for sources related to the prompt. Learn more about the
web search tool.
type: "web_search" or "web_search_2025_08_26" (default: "web_search") The type of the web search tool. One of web_search or web_search_2025_08_26.
One of the following: "web_search" "web_search_2025_08_26" external_web_access: optional boolean (default: true) Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.
filters: optional object or null Filters for the search.
allowed_domains: optional array of string or null (default: []) Allowed domains for the search. If not provided, all domains are allowed.
Subdomains of the provided domains are allowed as well.
Example: ["pubmed.ncbi.nlm.nih.gov"]
search_context_size: optional "low" or "medium" or "high" (default: "medium") High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.
One of the following: "low" "medium" "high" user_location: optional object or null The approximate location of the user. If omitted or null, defaults to the
United States. To avoid this fallback, pass {"type": "approximate"} without
location fields. To localize results, provide the relevant location fields.
city: optional string or null Free text input for the city of the user, e.g. San Francisco.
country: optional string or null The two-letter ISO country code of the user, e.g. US.
region: optional string or null Free text input for the region of the user, e.g. California.
timezone: optional string or null The IANA timezone of the user, e.g. America/Los_Angeles.
type: optional "approximate" (default: "approximate") The type of location approximation. Always approximate.
Mcp { server_label, type, allowed_callers, 9 more } Give the model access to additional tools via remote Model Context Protocol
(MCP) servers. Learn more about MCP.
server_label: string A label for this MCP server, used to identify it in tool calls.
type: "mcp" The type of the MCP tool. Always mcp.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" allowed_tools: optional array of string or McpToolFilter or null List of allowed tool names or a filter object.
One of the following: McpAllowedTools = array of string A string array of allowed tool names
McpToolFilter { read_only, tool_names } A filter object to specify which tools are allowed.
read_only: optional boolean Indicates whether or not a tool modifies data or is read-only. If an
MCP server is annotated with readOnlyHint,
it will match this filter.
tool_names: optional array of string List of allowed tool names.
authorization: optional string An OAuth access token that can be used with a remote MCP server, either
with a custom MCP server URL or a service connector. Your application
must handle the OAuth authorization flow and provide the token here.
connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more Deprecated.
Identifier for service connectors, like those available in ChatGPT. One of
server_url, connector_id, or tunnel_id must be provided. Learn more
about service connectors here.
This field is deprecated for models released after September 1, 2026.
Use server_url to connect to a remote MCP server, or tunnel_id to
connect through a Secure MCP Tunnel.
Currently supported connector_id values are:
Dropbox: connector_dropbox
Gmail: connector_gmail
Google Calendar: connector_googlecalendar
Google Drive: connector_googledrive
Microsoft Teams: connector_microsoftteams
Outlook Calendar: connector_outlookcalendar
Outlook Email: connector_outlookemail
SharePoint: connector_sharepoint
One of the following: "connector_dropbox" "connector_gmail" "connector_googlecalendar" "connector_googledrive" "connector_microsoftteams" "connector_outlookcalendar" "connector_outlookemail" "connector_sharepoint" defer_loading: optional boolean Whether this MCP tool is deferred and discovered via tool search.
headers: optional map[string] or null Optional HTTP headers to send to the MCP server. Use for authentication
or other purposes.
require_approval: optional McpToolApprovalFilter or "always" or "never" or null (default: "always") Specify which of the MCP server’s tools require approval.
One of the following: McpToolApprovalFilter { always, never } Specify which of the MCP server’s tools require approval. Can be
always, never, or a filter object associated with tools
that require approval.
always: optional { read_only, tool_names } A filter object to specify which tools are allowed.
read_only: optional boolean Indicates whether or not a tool modifies data or is read-only. If an
MCP server is annotated with readOnlyHint,
it will match this filter.
tool_names: optional array of string List of allowed tool names.
never: optional { read_only, tool_names } A filter object to specify which tools are allowed.
read_only: optional boolean Indicates whether or not a tool modifies data or is read-only. If an
MCP server is annotated with readOnlyHint,
it will match this filter.
tool_names: optional array of string List of allowed tool names.
McpToolApprovalSetting = "always" or "never" Specify a single approval policy for all tools. One of always or
never. When set to always, all tools will require approval. When
set to never, all tools will not require approval.
One of the following: "always" "never" server_description: optional string Optional description of the MCP server, used to provide more context.
server_url: optional string The URL for the MCP server. One of server_url, connector_id, or
tunnel_id must be provided.
formaturi tunnel_id: optional string The Secure MCP Tunnel ID to use instead of a direct server URL. One of
server_url, connector_id, or tunnel_id must be provided.
pattern^tunnel_[a-z0-9]{32}$ CodeInterpreter { container, type, allowed_callers } A tool that runs Python code to help generate a response to a prompt.
container: string or CodeInterpreterToolAuto The code interpreter container. Can be a container ID or an object that
specifies uploaded file IDs to make available to your code, along with an
optional memory_limit setting.
One of the following: string The container ID.
CodeInterpreterToolAuto { type, file_ids, memory_limit, network_policy } Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.
type: "auto" (default: "auto") Always auto.
file_ids: optional array of string An optional list of uploaded files to make available to your code.
maxItems50 memory_limit: optional "1g" or "4g" or "16g" or "64g" or null The memory limit for the code interpreter container.
One of the following: "1g" "4g" "16g" "64g" network_policy: optional BetaContainerNetworkPolicyDisabled or BetaContainerNetworkPolicyAllowlist Network access policy for the container.
One of the following: BetaContainerNetworkPolicyDisabled { type } type: "disabled" (default: "disabled") Disable outbound network access. Always disabled.
BetaContainerNetworkPolicyAllowlist { allowed_domains, type, domain_secrets } allowed_domains: array of string A list of allowed domains when type is allowlist.
minItems1 type: "allowlist" (default: "allowlist") Allow outbound network access only to specified domains. Always allowlist.
domain_secrets: optional array of BetaContainerNetworkPolicyDomainSecret { domain, name, value } Optional domain-scoped secrets for allowlisted domains.
minItems1 domain: string The domain associated with the secret.
minLength1 name: string The name of the secret to inject for the domain.
minLength1 value: string The secret value to inject for the domain.
minLength1 maxLength10485760 type: "code_interpreter" The type of the code interpreter tool. Always code_interpreter.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" ProgrammaticToolCalling { type } type: "programmatic_tool_calling" (default: "programmatic_tool_calling") The type of the tool. Always programmatic_tool_calling.
ImageGeneration { type, action, background, 13 more } A tool that generates images using the GPT image models.
type: "image_generation" The type of the image generation tool. Always image_generation.
action: optional "generate" or "edit" or "auto" Whether to generate a new image or edit an existing image. Default: auto.
One of the following: "generate" "edit" "auto" background: optional "transparent" or "opaque" or "auto" (default: "auto") Set the background of the generated image. One of transparent, opaque,
or auto. gpt-image-2.5-sunburst and gpt-image-2.5-flare, including
their 2026-09-08 snapshots, support opaque and transparent
backgrounds. Transparent backgrounds are available for supported GPT Image
models. For gpt-image-2 and gpt-image-2-2026-04-21, this support is in
preview. When using transparent, set the output format to png or webp.
Default: auto.
One of the following: "transparent" "opaque" "auto" complexity: optional "low" or "medium" or "high" Computation spent planning the image, independently of rendering quality.
Overrides the outer response’s reasoning.effort for image generation.
When omitted, inherits a supported outer reasoning effort or uses the
image model’s configured default.
For SVG output, controls the reference image, not the SVG author’s
reasoning.
One of the following: "low" "medium" "high" frame_count: optional integer (default: 9) Number of GIF frames. Requires output_format to be gif. Default: 9.
minimum2 maximum16 frame_duration_ms: optional integer (default: 200) Duration of each GIF frame in milliseconds, rounded to 10 ms.
Requires output_format to be gif. Default: 200.
minimum20 maximum2000 input_fidelity: optional "high" or "low" or null Control how much effort the model will exert to match the style and features, especially facial features, of input images. Supports high and low on gpt-image-1.5; gpt-image-1-mini supports only low. For gpt-image-2, omit this parameter. Defaults to low on supported models.
One of the following: "high" "low" input_image_mask: optional { file_id, image_url } Optional mask for inpainting. Contains image_url
(string, optional) and file_id (string, optional).
file_id: optional string File ID for the mask image.
image_url: optional string Base64-encoded mask image.
model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-2" or 9 more The image generation model to use. One of gpt-image-1-mini,
gpt-image-1.5, gpt-image-2,
gpt-image-2-2026-04-21, gpt-image-2.5-sunburst,
gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare,
gpt-image-2.5-flare-2026-09-08, gpt-image-2.6-sunburst,
gpt-image-2.6-flare, or chatgpt-image-latest. Default:
gpt-image-2.6-sunburst.
gpt-image-1 was shut down on October 23, 2026. Use
gpt-image-2.5-sunburst or gpt-image-2.5-flare instead.
One of the following: string "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-2" or 9 more The image generation model to use. One of gpt-image-1-mini,
gpt-image-1.5, gpt-image-2,
gpt-image-2-2026-04-21, gpt-image-2.5-sunburst,
gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare,
gpt-image-2.5-flare-2026-09-08, gpt-image-2.6-sunburst,
gpt-image-2.6-flare, or chatgpt-image-latest. Default:
gpt-image-2.6-sunburst.
gpt-image-1 was shut down on October 23, 2026. Use
gpt-image-2.5-sunburst or gpt-image-2.5-flare instead.
One of the following: "gpt-image-1-mini" "gpt-image-2" "gpt-image-2-2026-04-21" "gpt-image-2.5-sunburst" "gpt-image-2.5-sunburst-2026-09-08" "gpt-image-2.5-flare" "gpt-image-2.5-flare-2026-09-08" "gpt-image-2.6-sunburst" "gpt-image-2.6-flare" "gpt-image-1.5" "chatgpt-image-latest" "gpt-image-1" Deprecated. GPT Image 1 was shut down on October 23, 2026. Use gpt-image-2.5-sunburst or gpt-image-2.5-flare instead.
moderation: optional "auto" or "low" (default: "auto") Moderation level for the generated image. Default: auto.
One of the following: "auto" "low" output_compression: optional integer (default: 100) Compression level for the output image. Default: 100.
minimum0 maximum100 output_format: optional "png" or "webp" or "jpeg" or 2 more (default: "png") The output format of the generated image. One of png, webp, jpeg,
gif, or svg. Default: png. GIF and SVG output require a model
that supports the selected format. GIF output does not support
partial image streaming (partial_images greater than 0),
input_image_mask, or custom output_compression.
Responses lifecycle events can still be streamed for GIF output.
One of the following: "png" "webp" "jpeg" "gif" "svg" partial_images: optional integer (default: 0) Number of partial images to generate in streaming mode, from 0 (default value) to 3.
minimum0 maximum3 quality: optional "low" or "medium" or "high" or 3 more (default: "auto") The quality of the generated image. The GPT image models support low,
medium, and high. gpt-image-2.5-sunburst and gpt-image-2.5-flare,
including their 2026-09-08 snapshots, also support xhigh and max.
Default: auto.
One of the following: "low" "medium" "high" "xhigh" "max" "auto" size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto" (default: "auto") The size of the generated images. For gpt-image-2, gpt-image-2-2026-04-21, gpt-image-2.5-sunburst, gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare, and gpt-image-2.5-flare-2026-09-08, arbitrary resolutions are supported as WIDTHxHEIGHT strings, for example 1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above 2560x1440 are experimental, and the maximum supported resolution is 3840x2160. The requested size must also satisfy the model’s current pixel and edge limits. The standard sizes 1024x1024, 1536x1024, and 1024x1536 are supported by the GPT image models; auto is supported for models that allow automatic sizing.
One of the following: string "1024x1024" or "1024x1536" or "1536x1024" or "auto" The size of the generated images. For gpt-image-2, gpt-image-2-2026-04-21, gpt-image-2.5-sunburst, gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare, and gpt-image-2.5-flare-2026-09-08, arbitrary resolutions are supported as WIDTHxHEIGHT strings, for example 1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above 2560x1440 are experimental, and the maximum supported resolution is 3840x2160. The requested size must also satisfy the model’s current pixel and edge limits. The standard sizes 1024x1024, 1536x1024, and 1024x1536 are supported by the GPT image models; auto is supported for models that allow automatic sizing.
One of the following: "1024x1024" "1024x1536" "1536x1024" "auto" svg: optional { model, reasoning } SVG author model settings. Requires output_format to be svg.
When SVG model selection is enabled, omitting this object uses the
outer response model. Otherwise, the default SVG author is used and
explicit model overrides are unavailable.
model: optional string minLength1 reasoning: optional object or null Reasoning effort for SVG authoring. When omitted, uses the author model’s default in both Images and Responses.
effort: optional "none" or "minimal" or "low" or 4 more Controls how much effort the model should spend on reasoning for this request.
One of the following: "none" "minimal" "low" "medium" "high" "xhigh" "max" LocalShell { type } A tool that allows the model to execute shell commands in a local environment.
type: "local_shell" (default: "local_shell") The type of the local shell tool. Always local_shell.
Shell { type, allowed_callers, environment } A tool that allows the model to execute shell commands.
type: "shell" (default: "shell") The type of the shell tool. Always shell.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" environment: optional BetaContainerAuto or BetaLocalEnvironment or BetaContainerReference or null One of the following: BetaContainerAuto { type, file_ids, memory_limit, 2 more } type: "container_auto" (default: "container_auto") Automatically creates a container for this request
file_ids: optional array of string An optional list of uploaded files to make available to your code.
maxItems50 memory_limit: optional "1g" or "4g" or "16g" or "64g" or null The memory limit for the container.
One of the following: "1g" "4g" "16g" "64g" network_policy: optional BetaContainerNetworkPolicyDisabled or BetaContainerNetworkPolicyAllowlist Network access policy for the container.
One of the following: BetaContainerNetworkPolicyDisabled { type } type: "disabled" (default: "disabled") Disable outbound network access. Always disabled.
BetaContainerNetworkPolicyAllowlist { allowed_domains, type, domain_secrets } allowed_domains: array of string A list of allowed domains when type is allowlist.
minItems1 type: "allowlist" (default: "allowlist") Allow outbound network access only to specified domains. Always allowlist.
domain_secrets: optional array of BetaContainerNetworkPolicyDomainSecret { domain, name, value } Optional domain-scoped secrets for allowlisted domains.
minItems1 domain: string The domain associated with the secret.
minLength1 name: string The name of the secret to inject for the domain.
minLength1 value: string The secret value to inject for the domain.
minLength1 maxLength10485760 skills: optional array of BetaSkillReference or BetaInlineSkill An optional list of skills referenced by id or inline data.
maxItems200 One of the following: BetaSkillReference { skill_id, type, version } skill_id: string The ID of the referenced skill.
minLength1 maxLength64 type: "skill_reference" (default: "skill_reference") References a skill created with the /v1/skills endpoint.
version: optional string Optional skill version. Use a positive integer or ‘latest’. Omit for default.
BetaInlineSkill { description, name, source, type } description: string The description of the skill.
name: string The name of the skill.
source: BetaInlineSkillSource { data, media_type, type } Inline skill payload
data: string Base64-encoded skill zip bundle.
minLength1 maxLength70254592 media_type: "application/zip" (default: "application/zip") The media type of the inline skill payload. Must be application/zip.
type: "base64" (default: "base64") The type of the inline skill source. Must be base64.
type: "inline" (default: "inline") Defines an inline skill for this request.
BetaLocalEnvironment { type, skills } type: "local" (default: "local") Use a local computer environment.
skills: optional array of BetaLocalSkill { description, name, path } An optional list of skills.
maxItems200 description: string The description of the skill.
name: string The name of the skill.
path: string The path to the directory containing the skill.
BetaContainerReference { container_id, type } container_id: string The ID of the referenced container.
type: "container_reference" (default: "container_reference") References a container created with the /v1/containers endpoint
Custom { name, type, allowed_callers, 4 more } A custom tool that processes input using a specified format. Learn more about custom tools
name: string The name of the custom tool, used to identify it in tool calls.
type: "custom" (default: "custom") The type of the custom tool. Always custom.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" async: optional boolean Whether the tool response can be returned asynchronously versus immediately returned on next response creation.
defer_loading: optional boolean Whether this tool should be deferred and discovered via tool search.
description: optional string Optional description of the custom tool, used to provide more context.
format: optional Text or Grammar The input format for the custom tool. Default is unconstrained text.
One of the following: Text { type } Unconstrained free-form text.
type: "text" (default: "text") Unconstrained text format. Always text.
Grammar { definition, syntax, type } A grammar defined by the user.
definition: string The grammar definition.
syntax: "lark" or "regex" The syntax of the grammar definition. One of lark or regex.
One of the following: "lark" "regex" type: "grammar" (default: "grammar") Grammar format. Always grammar.
BetaToolSearchOutputNamespaceTool { description, name, tools, type } Groups function/custom tools under a shared namespace.
description: string A description of the namespace shown to the model.
name: string The namespace name used in tool calls (for example, crm).
minLength1 tools: array of Function or Custom The function/custom tools loaded inside this namespace.
minItems1 One of the following: Function { name, type, allowed_callers, 6 more } name: string The name of the loaded function tool.
pattern^(?![\s\S]*[\r\n])[a-zA-Z0-9_.-]+$ minLength1 maxLength128 type: "function" (default: "function") allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" async: optional boolean Whether the tool response can be returned asynchronously versus immediately returned on next response creation.
defer_loading: optional boolean Whether this function should be deferred and discovered via tool search.
description: optional string or null output_schema: optional map[unknown] or null A JSON Schema describing the JSON value encoded in string outputs for this function tool. This does not describe content-array outputs.
parameters: optional unknown or null strict: optional boolean or null Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise.
Custom { name, type, allowed_callers, 4 more } A custom tool that processes input using a specified format. Learn more about custom tools
name: string The name of the custom tool, used to identify it in tool calls.
type: "custom" (default: "custom") The type of the custom tool. Always custom.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" async: optional boolean Whether the tool response can be returned asynchronously versus immediately returned on next response creation.
defer_loading: optional boolean Whether this tool should be deferred and discovered via tool search.
description: optional string Optional description of the custom tool, used to provide more context.
format: optional Text or Grammar The input format for the custom tool. Default is unconstrained text.
One of the following: Text { type } Unconstrained free-form text.
type: "text" (default: "text") Unconstrained text format. Always text.
Grammar { definition, syntax, type } A grammar defined by the user.
definition: string The grammar definition.
syntax: "lark" or "regex" The syntax of the grammar definition. One of lark or regex.
One of the following: "lark" "regex" type: "grammar" (default: "grammar") Grammar format. Always grammar.
type: "namespace" (default: "namespace") The type of the tool. Always namespace.
ToolSearch { type, description, execution, parameters } Hosted or BYOT tool search configuration for deferred tools.
type: "tool_search" (default: "tool_search") The type of the tool. Always tool_search.
description: optional string or null Description shown to the model for a client-executed tool search tool.
execution: optional "server" or "client" Whether tool search is executed by the server or by the client.
One of the following: "server" "client" parameters: optional unknown or null Parameter schema for a client-executed tool search tool.
WebSearchPreview { type, search_content_types, search_context_size, user_location } This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
type: "web_search_preview" or "web_search_preview_2025_03_11" (default: "web_search_preview") The type of the web search tool. One of web_search_preview or web_search_preview_2025_03_11.
One of the following: "web_search_preview" "web_search_preview_2025_03_11" search_content_types: optional array of "text" or "image" One of the following: "text" "image" search_context_size: optional "low" or "medium" or "high" High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.
One of the following: "low" "medium" "high" user_location: optional object or null The approximate location of the user. If omitted or null, defaults to the United States. To avoid this fallback, pass {"type": "approximate"} without location fields. To localize results, provide the relevant location fields.
type: "approximate" (default: "approximate") The type of location approximation. Always approximate.
city: optional string or null Free text input for the city of the user, e.g. San Francisco.
country: optional string or null The two-letter ISO country code of the user, e.g. US.
region: optional string or null Free text input for the region of the user, e.g. California.
timezone: optional string or null The IANA timezone of the user, e.g. America/Los_Angeles.
ApplyPatch { type, allowed_callers } Allows the assistant to create, delete, or update files using unified diffs.
type: "apply_patch" (default: "apply_patch") The type of the tool. Always apply_patch.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" type: "tool_search_output" (default: "tool_search_output") The item type. Always tool_search_output.
id: optional string or null The unique ID of this tool search output.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
call_id: optional string or null The unique ID of the tool search call generated by the model.
minLength1 maxLength64 execution: optional "server" or "client" Whether tool search was executed by the server or by the client.
One of the following: "server" "client" status: optional "in_progress" or "completed" or "incomplete" or null The status of the tool search output.
One of the following: "in_progress" "completed" "incomplete" AdditionalTools { role, tools, type, 2 more } role: "developer" (default: "developer") The role that provided the additional tools. Only developer is supported.
tools: array of Function or FileSearch or Computer or 13 more A list of additional tools made available at this item.
One of the following: Function { name, parameters, strict, 6 more } Defines a function in your own code the model can choose to call. Learn more about function calling.
name: string The name of the function to call.
parameters: map[unknown] or null A JSON schema object describing the parameters of the function.
strict: boolean or null Whether strict parameter validation is enforced for this function tool.
type: "function" (default: "function") The type of the function tool. Always function.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
One of the following: "direct" "programmatic" async: optional boolean defer_loading: optional boolean Whether this function is deferred and loaded via tool search.
description: optional string or null A description of the function. Used by the model to determine whether or not to call the function.
output_schema: optional map[unknown] or null A JSON schema object describing the JSON value encoded in string outputs for this function.
FileSearch { type, vector_store_ids, filters, 2 more } A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
type: "file_search" (default: "file_search") The type of the file search tool. Always file_search.
vector_store_ids: array of string The IDs of the vector stores to search.
filters: optional ComparisonFilter or unknown or null A filter to apply.
One of the following: ComparisonFilter { key, type, value } A filter used to compare a specified attribute key to a given value using a defined comparison operation.
key: string The key to compare against the value.
type: "eq" or "ne" or "gt" or 5 more (default: "eq") Specifies the comparison operator: eq, ne, gt, gte, lt, lte, in, nin.
eq: equals
ne: not equal
gt: greater than
gte: greater than or equal
lt: less than
lte: less than or equal
in: in
nin: not in
One of the following: "eq" "ne" "gt" "gte" "lt" "lte" "in" "nin" value: string or number or boolean or array of string or number The value to compare against the attribute key; supports string, number, or boolean types.
One of the following: string number boolean array of string or number One of the following: string number BetaCompoundFilter = unknown Combine multiple filters using and or or.
max_num_results: optional integer The maximum number of results to return. This number should be between 1 and 50 inclusive.
ranking_options: optional { hybrid_search, ranker, score_threshold } Ranking options for search.
hybrid_search: optional { embedding_weight, text_weight } Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled.
embedding_weight: number The weight of the embedding in the reciprocal ranking fusion.
text_weight: number The weight of the text in the reciprocal ranking fusion.
ranker: optional "auto" or "default-2024-11-15" The ranker to use for the file search.
One of the following: "auto" "default-2024-11-15" score_threshold: optional number The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.
Computer { type } A tool that controls a virtual computer. Learn more about the computer tool.
type: "computer" (default: "computer") The type of the computer tool. Always computer.
ComputerUsePreview { display_height, display_width, environment, type } A tool that controls a virtual computer. Learn more about the computer tool.
display_height: integer The height of the computer display.
display_width: integer The width of the computer display.
environment: "windows" or "mac" or "linux" or 2 more The type of computer environment to control.
One of the following: "windows" "mac" "linux" "ubuntu" "browser" type: "computer_use_preview" (default: "computer_use_preview") The type of the computer use tool. Always computer_use_preview.
WebSearch { type, external_web_access, filters, 2 more } Search the Internet for sources related to the prompt. Learn more about the
web search tool.
type: "web_search" or "web_search_2025_08_26" (default: "web_search") The type of the web search tool. One of web_search or web_search_2025_08_26.
One of the following: "web_search" "web_search_2025_08_26" external_web_access: optional boolean (default: true) Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.
filters: optional object or null Filters for the search.
allowed_domains: optional array of string or null (default: []) Allowed domains for the search. If not provided, all domains are allowed.
Subdomains of the provided domains are allowed as well.
Example: ["pubmed.ncbi.nlm.nih.gov"]
search_context_size: optional "low" or "medium" or "high" (default: "medium") High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.
One of the following: "low" "medium" "high" user_location: optional object or null The approximate location of the user. If omitted or null, defaults to the
United States. To avoid this fallback, pass {"type": "approximate"} without
location fields. To localize results, provide the relevant location fields.
city: optional string or null Free text input for the city of the user, e.g. San Francisco.
country: optional string or null The two-letter ISO country code of the user, e.g. US.
region: optional string or null Free text input for the region of the user, e.g. California.
timezone: optional string or null The IANA timezone of the user, e.g. America/Los_Angeles.
type: optional "approximate" (default: "approximate") The type of location approximation. Always approximate.
Mcp { server_label, type, allowed_callers, 9 more } Give the model access to additional tools via remote Model Context Protocol
(MCP) servers. Learn more about MCP.
server_label: string A label for this MCP server, used to identify it in tool calls.
type: "mcp" The type of the MCP tool. Always mcp.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" allowed_tools: optional array of string or McpToolFilter or null List of allowed tool names or a filter object.
One of the following: McpAllowedTools = array of string A string array of allowed tool names
McpToolFilter { read_only, tool_names } A filter object to specify which tools are allowed.
read_only: optional boolean Indicates whether or not a tool modifies data or is read-only. If an
MCP server is annotated with readOnlyHint,
it will match this filter.
tool_names: optional array of string List of allowed tool names.
authorization: optional string An OAuth access token that can be used with a remote MCP server, either
with a custom MCP server URL or a service connector. Your application
must handle the OAuth authorization flow and provide the token here.
connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more Deprecated.
Identifier for service connectors, like those available in ChatGPT. One of
server_url, connector_id, or tunnel_id must be provided. Learn more
about service connectors here.
This field is deprecated for models released after September 1, 2026.
Use server_url to connect to a remote MCP server, or tunnel_id to
connect through a Secure MCP Tunnel.
Currently supported connector_id values are:
Dropbox: connector_dropbox
Gmail: connector_gmail
Google Calendar: connector_googlecalendar
Google Drive: connector_googledrive
Microsoft Teams: connector_microsoftteams
Outlook Calendar: connector_outlookcalendar
Outlook Email: connector_outlookemail
SharePoint: connector_sharepoint
One of the following: "connector_dropbox" "connector_gmail" "connector_googlecalendar" "connector_googledrive" "connector_microsoftteams" "connector_outlookcalendar" "connector_outlookemail" "connector_sharepoint" defer_loading: optional boolean Whether this MCP tool is deferred and discovered via tool search.
headers: optional map[string] or null Optional HTTP headers to send to the MCP server. Use for authentication
or other purposes.
require_approval: optional McpToolApprovalFilter or "always" or "never" or null (default: "always") Specify which of the MCP server’s tools require approval.
One of the following: McpToolApprovalFilter { always, never } Specify which of the MCP server’s tools require approval. Can be
always, never, or a filter object associated with tools
that require approval.
always: optional { read_only, tool_names } A filter object to specify which tools are allowed.
read_only: optional boolean Indicates whether or not a tool modifies data or is read-only. If an
MCP server is annotated with readOnlyHint,
it will match this filter.
tool_names: optional array of string List of allowed tool names.
never: optional { read_only, tool_names } A filter object to specify which tools are allowed.
read_only: optional boolean Indicates whether or not a tool modifies data or is read-only. If an
MCP server is annotated with readOnlyHint,
it will match this filter.
tool_names: optional array of string List of allowed tool names.
McpToolApprovalSetting = "always" or "never" Specify a single approval policy for all tools. One of always or
never. When set to always, all tools will require approval. When
set to never, all tools will not require approval.
One of the following: "always" "never" server_description: optional string Optional description of the MCP server, used to provide more context.
server_url: optional string The URL for the MCP server. One of server_url, connector_id, or
tunnel_id must be provided.
formaturi tunnel_id: optional string The Secure MCP Tunnel ID to use instead of a direct server URL. One of
server_url, connector_id, or tunnel_id must be provided.
pattern^tunnel_[a-z0-9]{32}$ CodeInterpreter { container, type, allowed_callers } A tool that runs Python code to help generate a response to a prompt.
container: string or CodeInterpreterToolAuto The code interpreter container. Can be a container ID or an object that
specifies uploaded file IDs to make available to your code, along with an
optional memory_limit setting.
One of the following: string The container ID.
CodeInterpreterToolAuto { type, file_ids, memory_limit, network_policy } Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.
type: "auto" (default: "auto") Always auto.
file_ids: optional array of string An optional list of uploaded files to make available to your code.
maxItems50 memory_limit: optional "1g" or "4g" or "16g" or "64g" or null The memory limit for the code interpreter container.
One of the following: "1g" "4g" "16g" "64g" network_policy: optional BetaContainerNetworkPolicyDisabled or BetaContainerNetworkPolicyAllowlist Network access policy for the container.
One of the following: BetaContainerNetworkPolicyDisabled { type } type: "disabled" (default: "disabled") Disable outbound network access. Always disabled.
BetaContainerNetworkPolicyAllowlist { allowed_domains, type, domain_secrets } allowed_domains: array of string A list of allowed domains when type is allowlist.
minItems1 type: "allowlist" (default: "allowlist") Allow outbound network access only to specified domains. Always allowlist.
domain_secrets: optional array of BetaContainerNetworkPolicyDomainSecret { domain, name, value } Optional domain-scoped secrets for allowlisted domains.
minItems1 domain: string The domain associated with the secret.
minLength1 name: string The name of the secret to inject for the domain.
minLength1 value: string The secret value to inject for the domain.
minLength1 maxLength10485760 type: "code_interpreter" The type of the code interpreter tool. Always code_interpreter.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" ProgrammaticToolCalling { type } type: "programmatic_tool_calling" (default: "programmatic_tool_calling") The type of the tool. Always programmatic_tool_calling.
ImageGeneration { type, action, background, 13 more } A tool that generates images using the GPT image models.
type: "image_generation" The type of the image generation tool. Always image_generation.
action: optional "generate" or "edit" or "auto" Whether to generate a new image or edit an existing image. Default: auto.
One of the following: "generate" "edit" "auto" background: optional "transparent" or "opaque" or "auto" (default: "auto") Set the background of the generated image. One of transparent, opaque,
or auto. gpt-image-2.5-sunburst and gpt-image-2.5-flare, including
their 2026-09-08 snapshots, support opaque and transparent
backgrounds. Transparent backgrounds are available for supported GPT Image
models. For gpt-image-2 and gpt-image-2-2026-04-21, this support is in
preview. When using transparent, set the output format to png or webp.
Default: auto.
One of the following: "transparent" "opaque" "auto" complexity: optional "low" or "medium" or "high" Computation spent planning the image, independently of rendering quality.
Overrides the outer response’s reasoning.effort for image generation.
When omitted, inherits a supported outer reasoning effort or uses the
image model’s configured default.
For SVG output, controls the reference image, not the SVG author’s
reasoning.
One of the following: "low" "medium" "high" frame_count: optional integer (default: 9) Number of GIF frames. Requires output_format to be gif. Default: 9.
minimum2 maximum16 frame_duration_ms: optional integer (default: 200) Duration of each GIF frame in milliseconds, rounded to 10 ms.
Requires output_format to be gif. Default: 200.
minimum20 maximum2000 input_fidelity: optional "high" or "low" or null Control how much effort the model will exert to match the style and features, especially facial features, of input images. Supports high and low on gpt-image-1.5; gpt-image-1-mini supports only low. For gpt-image-2, omit this parameter. Defaults to low on supported models.
One of the following: "high" "low" input_image_mask: optional { file_id, image_url } Optional mask for inpainting. Contains image_url
(string, optional) and file_id (string, optional).
file_id: optional string File ID for the mask image.
image_url: optional string Base64-encoded mask image.
model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-2" or 9 more The image generation model to use. One of gpt-image-1-mini,
gpt-image-1.5, gpt-image-2,
gpt-image-2-2026-04-21, gpt-image-2.5-sunburst,
gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare,
gpt-image-2.5-flare-2026-09-08, gpt-image-2.6-sunburst,
gpt-image-2.6-flare, or chatgpt-image-latest. Default:
gpt-image-2.6-sunburst.
gpt-image-1 was shut down on October 23, 2026. Use
gpt-image-2.5-sunburst or gpt-image-2.5-flare instead.
One of the following: string "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-2" or 9 more The image generation model to use. One of gpt-image-1-mini,
gpt-image-1.5, gpt-image-2,
gpt-image-2-2026-04-21, gpt-image-2.5-sunburst,
gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare,
gpt-image-2.5-flare-2026-09-08, gpt-image-2.6-sunburst,
gpt-image-2.6-flare, or chatgpt-image-latest. Default:
gpt-image-2.6-sunburst.
gpt-image-1 was shut down on October 23, 2026. Use
gpt-image-2.5-sunburst or gpt-image-2.5-flare instead.
One of the following: "gpt-image-1-mini" "gpt-image-2" "gpt-image-2-2026-04-21" "gpt-image-2.5-sunburst" "gpt-image-2.5-sunburst-2026-09-08" "gpt-image-2.5-flare" "gpt-image-2.5-flare-2026-09-08" "gpt-image-2.6-sunburst" "gpt-image-2.6-flare" "gpt-image-1.5" "chatgpt-image-latest" "gpt-image-1" Deprecated. GPT Image 1 was shut down on October 23, 2026. Use gpt-image-2.5-sunburst or gpt-image-2.5-flare instead.
moderation: optional "auto" or "low" (default: "auto") Moderation level for the generated image. Default: auto.
One of the following: "auto" "low" output_compression: optional integer (default: 100) Compression level for the output image. Default: 100.
minimum0 maximum100 output_format: optional "png" or "webp" or "jpeg" or 2 more (default: "png") The output format of the generated image. One of png, webp, jpeg,
gif, or svg. Default: png. GIF and SVG output require a model
that supports the selected format. GIF output does not support
partial image streaming (partial_images greater than 0),
input_image_mask, or custom output_compression.
Responses lifecycle events can still be streamed for GIF output.
One of the following: "png" "webp" "jpeg" "gif" "svg" partial_images: optional integer (default: 0) Number of partial images to generate in streaming mode, from 0 (default value) to 3.
minimum0 maximum3 quality: optional "low" or "medium" or "high" or 3 more (default: "auto") The quality of the generated image. The GPT image models support low,
medium, and high. gpt-image-2.5-sunburst and gpt-image-2.5-flare,
including their 2026-09-08 snapshots, also support xhigh and max.
Default: auto.
One of the following: "low" "medium" "high" "xhigh" "max" "auto" size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto" (default: "auto") The size of the generated images. For gpt-image-2, gpt-image-2-2026-04-21, gpt-image-2.5-sunburst, gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare, and gpt-image-2.5-flare-2026-09-08, arbitrary resolutions are supported as WIDTHxHEIGHT strings, for example 1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above 2560x1440 are experimental, and the maximum supported resolution is 3840x2160. The requested size must also satisfy the model’s current pixel and edge limits. The standard sizes 1024x1024, 1536x1024, and 1024x1536 are supported by the GPT image models; auto is supported for models that allow automatic sizing.
One of the following: string "1024x1024" or "1024x1536" or "1536x1024" or "auto" The size of the generated images. For gpt-image-2, gpt-image-2-2026-04-21, gpt-image-2.5-sunburst, gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare, and gpt-image-2.5-flare-2026-09-08, arbitrary resolutions are supported as WIDTHxHEIGHT strings, for example 1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above 2560x1440 are experimental, and the maximum supported resolution is 3840x2160. The requested size must also satisfy the model’s current pixel and edge limits. The standard sizes 1024x1024, 1536x1024, and 1024x1536 are supported by the GPT image models; auto is supported for models that allow automatic sizing.
One of the following: "1024x1024" "1024x1536" "1536x1024" "auto" svg: optional { model, reasoning } SVG author model settings. Requires output_format to be svg.
When SVG model selection is enabled, omitting this object uses the
outer response model. Otherwise, the default SVG author is used and
explicit model overrides are unavailable.
model: optional string minLength1 reasoning: optional object or null Reasoning effort for SVG authoring. When omitted, uses the author model’s default in both Images and Responses.
effort: optional "none" or "minimal" or "low" or 4 more Controls how much effort the model should spend on reasoning for this request.
One of the following: "none" "minimal" "low" "medium" "high" "xhigh" "max" LocalShell { type } A tool that allows the model to execute shell commands in a local environment.
type: "local_shell" (default: "local_shell") The type of the local shell tool. Always local_shell.
Shell { type, allowed_callers, environment } A tool that allows the model to execute shell commands.
type: "shell" (default: "shell") The type of the shell tool. Always shell.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" environment: optional BetaContainerAuto or BetaLocalEnvironment or BetaContainerReference or null One of the following: BetaContainerAuto { type, file_ids, memory_limit, 2 more } type: "container_auto" (default: "container_auto") Automatically creates a container for this request
file_ids: optional array of string An optional list of uploaded files to make available to your code.
maxItems50 memory_limit: optional "1g" or "4g" or "16g" or "64g" or null The memory limit for the container.
One of the following: "1g" "4g" "16g" "64g" network_policy: optional BetaContainerNetworkPolicyDisabled or BetaContainerNetworkPolicyAllowlist Network access policy for the container.
One of the following: BetaContainerNetworkPolicyDisabled { type } type: "disabled" (default: "disabled") Disable outbound network access. Always disabled.
BetaContainerNetworkPolicyAllowlist { allowed_domains, type, domain_secrets } allowed_domains: array of string A list of allowed domains when type is allowlist.
minItems1 type: "allowlist" (default: "allowlist") Allow outbound network access only to specified domains. Always allowlist.
domain_secrets: optional array of BetaContainerNetworkPolicyDomainSecret { domain, name, value } Optional domain-scoped secrets for allowlisted domains.
minItems1 domain: string The domain associated with the secret.
minLength1 name: string The name of the secret to inject for the domain.
minLength1 value: string The secret value to inject for the domain.
minLength1 maxLength10485760 skills: optional array of BetaSkillReference or BetaInlineSkill An optional list of skills referenced by id or inline data.
maxItems200 One of the following: BetaSkillReference { skill_id, type, version } skill_id: string The ID of the referenced skill.
minLength1 maxLength64 type: "skill_reference" (default: "skill_reference") References a skill created with the /v1/skills endpoint.
version: optional string Optional skill version. Use a positive integer or ‘latest’. Omit for default.
BetaInlineSkill { description, name, source, type } description: string The description of the skill.
name: string The name of the skill.
source: BetaInlineSkillSource { data, media_type, type } Inline skill payload
data: string Base64-encoded skill zip bundle.
minLength1 maxLength70254592 media_type: "application/zip" (default: "application/zip") The media type of the inline skill payload. Must be application/zip.
type: "base64" (default: "base64") The type of the inline skill source. Must be base64.
type: "inline" (default: "inline") Defines an inline skill for this request.
BetaLocalEnvironment { type, skills } type: "local" (default: "local") Use a local computer environment.
skills: optional array of BetaLocalSkill { description, name, path } An optional list of skills.
maxItems200 description: string The description of the skill.
name: string The name of the skill.
path: string The path to the directory containing the skill.
BetaContainerReference { container_id, type } container_id: string The ID of the referenced container.
type: "container_reference" (default: "container_reference") References a container created with the /v1/containers endpoint
Custom { name, type, allowed_callers, 4 more } A custom tool that processes input using a specified format. Learn more about custom tools
name: string The name of the custom tool, used to identify it in tool calls.
type: "custom" (default: "custom") The type of the custom tool. Always custom.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" async: optional boolean Whether the tool response can be returned asynchronously versus immediately returned on next response creation.
defer_loading: optional boolean Whether this tool should be deferred and discovered via tool search.
description: optional string Optional description of the custom tool, used to provide more context.
format: optional Text or Grammar The input format for the custom tool. Default is unconstrained text.
One of the following: Text { type } Unconstrained free-form text.
type: "text" (default: "text") Unconstrained text format. Always text.
Grammar { definition, syntax, type } A grammar defined by the user.
definition: string The grammar definition.
syntax: "lark" or "regex" The syntax of the grammar definition. One of lark or regex.
One of the following: "lark" "regex" type: "grammar" (default: "grammar") Grammar format. Always grammar.
Namespace { description, name, tools, type } Groups function/custom tools under a shared namespace.
description: string A description of the namespace shown to the model.
name: string The namespace name used in tool calls (for example, crm).
minLength1 tools: array of Function or Custom The function/custom tools available inside this namespace.
minItems1 One of the following: Function { name, type, allowed_callers, 6 more } name: string pattern^[a-zA-Z0-9_-]+$ minLength1 maxLength128 type: "function" (default: "function") allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" async: optional boolean Whether the tool response can be returned asynchronously versus immediately returned on next response creation.
defer_loading: optional boolean Whether this function should be deferred and discovered via tool search.
description: optional string or null output_schema: optional map[unknown] or null A JSON Schema describing the JSON value encoded in string outputs for this function tool. This does not describe content-array outputs.
parameters: optional unknown or null strict: optional boolean or null Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise.
Custom { name, type, allowed_callers, 4 more } A custom tool that processes input using a specified format. Learn more about custom tools
name: string The name of the custom tool, used to identify it in tool calls.
type: "custom" (default: "custom") The type of the custom tool. Always custom.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" async: optional boolean Whether the tool response can be returned asynchronously versus immediately returned on next response creation.
defer_loading: optional boolean Whether this tool should be deferred and discovered via tool search.
description: optional string Optional description of the custom tool, used to provide more context.
format: optional Text or Grammar The input format for the custom tool. Default is unconstrained text.
One of the following: Text { type } Unconstrained free-form text.
type: "text" (default: "text") Unconstrained text format. Always text.
Grammar { definition, syntax, type } A grammar defined by the user.
definition: string The grammar definition.
syntax: "lark" or "regex" The syntax of the grammar definition. One of lark or regex.
One of the following: "lark" "regex" type: "grammar" (default: "grammar") Grammar format. Always grammar.
type: "namespace" (default: "namespace") The type of the tool. Always namespace.
ToolSearch { type, description, execution, parameters } Hosted or BYOT tool search configuration for deferred tools.
type: "tool_search" (default: "tool_search") The type of the tool. Always tool_search.
description: optional string or null Description shown to the model for a client-executed tool search tool.
execution: optional "server" or "client" Whether tool search is executed by the server or by the client.
One of the following: "server" "client" parameters: optional unknown or null Parameter schema for a client-executed tool search tool.
WebSearchPreview { type, search_content_types, search_context_size, user_location } This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
type: "web_search_preview" or "web_search_preview_2025_03_11" (default: "web_search_preview") The type of the web search tool. One of web_search_preview or web_search_preview_2025_03_11.
One of the following: "web_search_preview" "web_search_preview_2025_03_11" search_content_types: optional array of "text" or "image" One of the following: "text" "image" search_context_size: optional "low" or "medium" or "high" High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.
One of the following: "low" "medium" "high" user_location: optional object or null The approximate location of the user. If omitted or null, defaults to the United States. To avoid this fallback, pass {"type": "approximate"} without location fields. To localize results, provide the relevant location fields.
type: "approximate" (default: "approximate") The type of location approximation. Always approximate.
city: optional string or null Free text input for the city of the user, e.g. San Francisco.
country: optional string or null The two-letter ISO country code of the user, e.g. US.
region: optional string or null Free text input for the region of the user, e.g. California.
timezone: optional string or null The IANA timezone of the user, e.g. America/Los_Angeles.
ApplyPatch { type, allowed_callers } Allows the assistant to create, delete, or update files using unified diffs.
type: "apply_patch" (default: "apply_patch") The type of the tool. Always apply_patch.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" type: "additional_tools" (default: "additional_tools") The item type. Always additional_tools.
id: optional string or null The unique ID of this additional tools item.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
ConfigurationUpdate { type, id, agent, 2 more } An update to the conversation’s response configuration. Supply reasoning,
text, or both. Each setting stays in effect until a later update replaces it.
type: "configuration_update" (default: "configuration_update") The item type. Always configuration_update.
id: optional string or null The unique ID of the configuration update item.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
reasoning: optional { effort } Updates to reasoning configuration. Only effort is supported.
effort: optional "none" or "minimal" or "low" or 4 more or null (default: "medium") The reasoning effort to use for subsequent responses until another
configuration update replaces it.
One of the following: "none" "minimal" "low" "medium" "high" "xhigh" "max" text: optional { format } The text output configuration for subsequent responses.
format: Text or BetaResponseFormatTextJSONSchemaConfig Use a JSON schema for structured output or text to return to plain text.
One of the following: Text { type } Default response format. Used to generate text responses.
type: "text" The type of response format being defined. Always text.
BetaResponseFormatTextJSONSchemaConfig { name, schema, type, 2 more } JSON Schema response format. Used to generate structured JSON responses.
Learn more about Structured Outputs.
name: string The name of the response format. Must be a-z, A-Z, 0-9, or contain
underscores and dashes, with a maximum length of 64.
schema: map[unknown] The schema for the response format, described as a JSON Schema object.
Learn how to build JSON schemas here.
type: "json_schema" The type of response format being defined. Always json_schema.
description: optional string A description of what the response format is for, used by the model to
determine how to respond in the format.
strict: optional boolean or null (default: false) Whether to enable strict schema adherence when generating the output.
If set to true, the model will always follow the exact schema defined
in the schema field. Only a subset of JSON Schema is supported when
strict is true. To learn more, read the Structured Outputs
guide.
Reasoning { 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.
id: string The unique identifier of the reasoning content.
summary: array of { text, type } Reasoning summary content.
text: string A summary of the reasoning output from the model so far.
type: "summary_text" (default: "summary_text") The type of the object. Always summary_text.
type: "reasoning" The type of the object. Always reasoning.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
content: optional array of { text, type } Reasoning text content.
text: string The reasoning text from the model.
type: "reasoning_text" (default: "reasoning_text") The type of the reasoning text. Always reasoning_text.
encrypted_content: optional string or null The encrypted content of the reasoning item. This is populated by default
for reasoning items returned by POST /v1/responses and WebSocket
response.create requests.
When streaming, use the completed reasoning item and its
encrypted_content from the response.output_item.done event in
subsequent requests. The encrypted_content in
response.output_item.added may be incomplete. This is especially
important when store is false or when using Zero Data Retention.
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.
One of the following: "in_progress" "completed" "incomplete" Compaction { encrypted_content, type, id, agent } A compaction item generated by the v1/responses/compact API.
encrypted_content: string The encrypted content of the compaction summary.
maxLength104857600 type: "compaction" (default: "compaction") The type of the item. Always compaction.
id: optional string or null The ID of the compaction item.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
ImageGenerationCall { id, result, status, 10 more } An image generation request made by the model.
id: string The unique ID of the image generation call.
result: string or null The generated image encoded in base64.
status: "in_progress" or "completed" or "generating" or "failed" The status of the image generation call.
One of the following: "in_progress" "completed" "generating" "failed" type: "image_generation_call" The type of the image generation call. Always image_generation_call.
action: optional "generate" or "edit" or "auto" or null The action used for image generation.
One of the following: "generate" "edit" "auto" agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
background: optional "transparent" or "opaque" or "auto" or null The background setting used for generation.
One of the following: "transparent" "opaque" "auto" error: optional { code, message, param, 2 more } Details of a moderation failure, when available.
code: string or null The error code.
message: string A description of the error.
param: string or null The related request parameter.
type: string The error type.
moderation_details: optional { categories, moderation_stage } Public details for a moderation_blocked error, when available.
categories: array of string Public moderation categories. New category values may be added over time.
moderation_stage: "input" or "output" or "unknown" The stage where moderation blocked the image generation call.
One of the following: "input" "output" "unknown" output_format: optional "png" or "webp" or "jpeg" or 2 more or null The output format used for generation.
One of the following: "png" "webp" "jpeg" "gif" "svg" quality: optional "low" or "medium" or "high" or 3 more or null The quality of the image generated by the image generation tool call. One of low, medium, high, xhigh, max, or auto.
One of the following: "low" "medium" "high" "xhigh" "max" "auto" revised_prompt: optional string or null The prompt that was used after any model prompt rewriting.
size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or null The image dimensions as a WIDTHxHEIGHT string, for example 1536x864.
One of the following: string "1024x1024" or "1024x1536" or "1536x1024" The image dimensions as a WIDTHxHEIGHT string, for example 1536x864.
One of the following: "1024x1024" "1024x1536" "1536x1024" svg_usage: optional { input_tokens, model, output_tokens, 2 more } input_tokens: integer model: string output_tokens: integer reasoning_tokens: integer total_tokens: integer CodeInterpreterCall { id, code, container_id, 4 more } A tool call to run code.
id: string The unique ID of the code interpreter tool call.
code: string or null The code to run, or null if not available.
container_id: string The ID of the container used to run the code.
outputs: array of Logs or Image or null The outputs generated by the code interpreter, such as logs or images.
Can be null if no outputs are available.
One of the following: Logs { logs, type } The logs output from the code interpreter.
logs: string The logs output from the code interpreter.
type: "logs" (default: "logs") The type of the output. Always logs.
Image { type, url } The image output from the code interpreter.
type: "image" (default: "image") The type of the output. Always image.
url: string The URL of the image output from the code interpreter.
formaturi status: "in_progress" or "completed" or "incomplete" or 2 more The status of the code interpreter tool call. Valid values are in_progress, completed, incomplete, interpreting, and failed.
One of the following: "in_progress" "completed" "incomplete" "interpreting" "failed" type: "code_interpreter_call" (default: "code_interpreter_call") The type of the code interpreter tool call. Always code_interpreter_call.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
LocalShellCall { id, action, call_id, 3 more } A tool call to run a command on the local shell.
id: string The unique ID of the local shell call.
action: { command, env, type, 3 more } Execute a shell command on the server.
command: array of string The command to run.
env: map[string] Environment variables to set for the command.
type: "exec" (default: "exec") The type of the local shell action. Always exec.
timeout_ms: optional integer or null Optional timeout in milliseconds for the command.
user: optional string or null Optional user to run the command as.
working_directory: optional string or null Optional working directory to run the command in.
call_id: string The unique ID of the local shell tool call generated by the model.
status: "in_progress" or "completed" or "incomplete" The status of the local shell call.
One of the following: "in_progress" "completed" "incomplete" type: "local_shell_call" The type of the local shell call. Always local_shell_call.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
LocalShellCallOutput { id, output, type, 2 more } The output of a local shell tool call.
id: string The unique ID of the local shell tool call generated by the model.
output: string A JSON string of the output of the local shell tool call.
type: "local_shell_call_output" The type of the local shell tool call output. Always local_shell_call_output.
agent: optional object or null 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" or null The status of the item. One of in_progress, completed, or incomplete.
One of the following: "in_progress" "completed" "incomplete" ShellCall { action, call_id, type, 5 more } A tool representing a request to execute one or more shell commands.
action: { commands, max_output_length, timeout_ms } The shell commands and limits that describe how to run the tool call.
commands: array of string Ordered shell commands for the execution environment to run.
max_output_length: optional integer or null Maximum number of UTF-8 characters to capture from combined stdout and stderr output.
timeout_ms: optional integer or null Maximum wall-clock time in milliseconds to allow the shell commands to run.
call_id: string The unique ID of the shell tool call generated by the model.
minLength1 maxLength64 type: "shell_call" (default: "shell_call") The type of the item. Always shell_call.
id: optional string or null The unique ID of the shell tool call. Populated when this item is returned via API.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
caller: optional Direct or Program or null The execution context that produced this tool call.
One of the following: Direct { type } type: "direct" (default: "direct") The caller type. Always direct.
Program { caller_id, type } caller_id: string The call ID of the program item that produced this tool call.
minLength1 maxLength64 type: "program" (default: "program") The caller type. Always program.
environment: optional BetaLocalEnvironment or BetaContainerReference or null The environment to execute the shell commands in.
One of the following: BetaLocalEnvironment { type, skills } type: "local" (default: "local") Use a local computer environment.
skills: optional array of BetaLocalSkill { description, name, path } An optional list of skills.
maxItems200 description: string The description of the skill.
name: string The name of the skill.
path: string The path to the directory containing the skill.
BetaContainerReference { container_id, type } container_id: string The ID of the referenced container.
type: "container_reference" (default: "container_reference") References a container created with the /v1/containers endpoint
status: optional "in_progress" or "completed" or "incomplete" or null The status of the shell call. One of in_progress, completed, or incomplete.
One of the following: "in_progress" "completed" "incomplete" ShellCallOutput { call_id, output, type, 5 more } The streamed output items emitted by a shell tool call.
call_id: string The unique ID of the shell tool call generated by the model.
minLength1 maxLength64 output: array of BetaResponseFunctionShellCallOutputContent { outcome, stderr, stdout } Captured chunks of stdout and stderr output, along with their associated outcomes.
outcome: Timeout or Exit The exit or timeout outcome associated with this shell call.
One of the following: Timeout { type } Indicates that the shell call exceeded its configured time limit.
type: "timeout" (default: "timeout") The outcome type. Always timeout.
Exit { exit_code, type } Indicates that the shell commands finished and returned an exit code.
exit_code: integer The exit code returned by the shell process.
type: "exit" (default: "exit") The outcome type. Always exit.
stderr: string Captured stderr output for the shell call.
maxLength10485760 stdout: string Captured stdout output for the shell call.
maxLength10485760 type: "shell_call_output" (default: "shell_call_output") The type of the item. Always shell_call_output.
id: optional string or null The unique ID of the shell tool call output. Populated when this item is returned via API.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
caller: optional Direct or Program or null The execution context that produced this tool call.
One of the following: Direct { type } type: "direct" (default: "direct") The caller type. Always direct.
Program { caller_id, type } caller_id: string The call ID of the program item that produced this tool call.
minLength1 maxLength64 type: "program" (default: "program") The caller type. Always program.
max_output_length: optional integer or null The maximum number of UTF-8 characters captured for this shell call’s combined output.
status: optional "in_progress" or "completed" or "incomplete" or null The status of the shell call output.
One of the following: "in_progress" "completed" "incomplete" ApplyPatchCall { call_id, operation, status, 4 more } A tool call representing a request to create, delete, or update files using diff patches.
call_id: string The unique ID of the apply patch tool call generated by the model.
minLength1 maxLength64 operation: CreateFile or DeleteFile or UpdateFile The specific create, delete, or update instruction for the apply_patch tool call.
One of the following: CreateFile { diff, path, type } Instruction for creating a new file via the apply_patch tool.
diff: string Unified diff content to apply when creating the file.
maxLength10485760 path: string Path of the file to create relative to the workspace root.
minLength1 type: "create_file" (default: "create_file") The operation type. Always create_file.
DeleteFile { path, type } Instruction for deleting an existing file via the apply_patch tool.
path: string Path of the file to delete relative to the workspace root.
minLength1 type: "delete_file" (default: "delete_file") The operation type. Always delete_file.
UpdateFile { diff, path, type } Instruction for updating an existing file via the apply_patch tool.
diff: string Unified diff content to apply to the existing file.
maxLength10485760 path: string Path of the file to update relative to the workspace root.
minLength1 type: "update_file" (default: "update_file") The operation type. Always update_file.
status: "in_progress" or "completed" The status of the apply patch tool call. One of in_progress or completed.
One of the following: "in_progress" "completed" type: "apply_patch_call" (default: "apply_patch_call") The type of the item. Always apply_patch_call.
id: optional string or null The unique ID of the apply patch tool call. Populated when this item is returned via API.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
caller: optional Direct or Program or null The execution context that produced this tool call.
One of the following: Direct { type } type: "direct" (default: "direct") The caller type. Always direct.
Program { caller_id, type } caller_id: string The call ID of the program item that produced this tool call.
minLength1 maxLength64 type: "program" (default: "program") The caller type. Always program.
ApplyPatchCallOutput { call_id, status, type, 4 more } The streamed output emitted by an apply patch tool call.
call_id: string The unique ID of the apply patch tool call generated by the model.
minLength1 maxLength64 status: "completed" or "failed" The status of the apply patch tool call output. One of completed or failed.
One of the following: "completed" "failed" type: "apply_patch_call_output" (default: "apply_patch_call_output") The type of the item. Always apply_patch_call_output.
id: optional string or null The unique ID of the apply patch tool call output. Populated when this item is returned via API.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
caller: optional Direct or Program or null The execution context that produced this tool call.
One of the following: Direct { type } type: "direct" (default: "direct") The caller type. Always direct.
Program { caller_id, type } caller_id: string The call ID of the program item that produced this tool call.
minLength1 maxLength64 type: "program" (default: "program") The caller type. Always program.
output: optional string or null Optional human-readable log text from the apply patch tool (e.g., patch results or errors).
maxLength10485760 McpListTools { id, server_label, tools, 3 more } A list of tools available on an MCP server.
id: string The unique ID of the list.
server_label: string The label of the MCP server.
tools: array of { input_schema, name, annotations, description } The tools available on the server.
input_schema: unknown The JSON schema describing the tool’s input.
name: string The name of the tool.
annotations: optional unknown or null Additional annotations about the tool.
description: optional string or null The description of the tool.
type: "mcp_list_tools" The type of the item. Always mcp_list_tools.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
error: optional string or null Error message if the server could not list tools.
McpApprovalRequest { id, arguments, name, 3 more } A request for human approval of a tool invocation.
id: string The unique ID of the approval request.
arguments: string A JSON string of arguments for the tool.
name: string The name of the tool to run.
server_label: string The label of the MCP server making the request.
type: "mcp_approval_request" The type of the item. Always mcp_approval_request.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
McpApprovalResponse { approval_request_id, approve, type, 3 more } A response to an MCP approval request.
approval_request_id: string The ID of the approval request being answered.
approve: boolean Whether the request was approved.
type: "mcp_approval_response" The type of the item. Always mcp_approval_response.
id: optional string or null The unique ID of the approval response
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
reason: optional string or null Optional reason for the decision.
McpCall { id, arguments, name, 7 more } An invocation of a tool on an MCP server.
id: string The unique ID of the tool call.
arguments: string A JSON string of the arguments passed to the tool.
name: string The name of the tool that was run.
server_label: string The label of the MCP server running the tool.
type: "mcp_call" The type of the item. Always mcp_call.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
approval_request_id: optional string or null Unique identifier for the MCP tool call approval request.
Include this value in a subsequent mcp_approval_response input to approve or reject the corresponding tool call.
error: optional BetaMcpToolCallError or null The error from the tool call, if any.
One of the following: McpProtocolError { code, message, type } code: integer message: string type: "mcp_protocol_error" (default: "mcp_protocol_error") McpToolExecutionError { content, type } content: unknown type: "mcp_tool_execution_error" (default: "mcp_tool_execution_error") HTTPError { code, message, type } code: integer message: string type: "http_error" (default: "http_error") output: optional string or null The output from the tool call.
status: optional "in_progress" or "completed" or "incomplete" or 2 more The status of the tool call. One of in_progress, completed, incomplete, calling, or failed.
One of the following: "in_progress" "completed" "incomplete" "calling" "failed" CustomToolCallOutput { call_id, output, type, 3 more } The output of a custom tool call from your code, being sent back to the model.
call_id: string The call ID, used to map this custom tool call output to a custom tool call.
output: string or array of BetaResponseInputText or BetaResponseInputImage or BetaResponseInputFile The output from the custom tool call generated by your code.
Can be a string or an list of output content.
One of the following: StringOutput = string A string of the output of the custom tool call.
OutputContentList = array of BetaResponseInputText or BetaResponseInputImage or BetaResponseInputFile Text, image, or file output of the custom tool call.
One of the following: BetaResponseInputText { text, type, prompt_cache_breakpoint } A text input to the model.
text: string The text input to the model.
type: "input_text" (default: "input_text") The type of the input item. Always input_text.
prompt_cache_breakpoint: optional { mode, ttl } Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.
mode: "explicit" (default: "explicit") The breakpoint mode. Always explicit.
ttl: optional "30m" or "12h" The minimum lifetime of this cache breakpoint. Defaults to the request TTL.
One of the following: "30m" "12h" BetaResponseInputImage { detail, type, file_id, 2 more } An image input to the model. Learn about image inputs.
detail: BetaImageDetail 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" (default: "input_image") The type of the input item. Always input_image.
file_id: optional string or null The ID of the file to be sent to the model.
image_url: optional string or null 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: optional { mode, ttl } Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.
mode: "explicit" (default: "explicit") The breakpoint mode. Always explicit.
ttl: optional "30m" or "12h" The minimum lifetime of this cache breakpoint. Defaults to the request TTL.
One of the following: "30m" "12h" BetaResponseInputFile { type, detail, file_data, 4 more } A file input to the model.
type: "input_file" (default: "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.
One of the following: "auto" "low" "high" file_data: optional string The content of the file to be sent to the model.
file_id: optional string or null 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.
formaturi filename: optional string The name of the file to be sent to the model.
prompt_cache_breakpoint: optional { mode, ttl } Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.
mode: "explicit" (default: "explicit") The breakpoint mode. Always explicit.
ttl: optional "30m" or "12h" The minimum lifetime of this cache breakpoint. Defaults to the request TTL.
One of the following: "30m" "12h" type: "custom_tool_call_output" The type of the custom tool call output. Always custom_tool_call_output.
id: optional string The unique ID of the custom tool call output in the OpenAI platform.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
caller: optional Direct or Program or null The execution context that produced this tool call.
One of the following: Direct { type } type: "direct" (default: "direct") The caller type. Always direct.
Program { caller_id, type } caller_id: string The call ID of the program item that produced this tool call.
minLength1 maxLength64 type: "program" (default: "program") The caller type. Always program.
CustomToolCall { call_id, input, name, 6 more } A call to a custom tool created by the model.
call_id: string An identifier used to map this custom tool call to a tool call output.
input: string The input for the custom tool call generated by the model.
name: string The name of the custom tool being called.
type: "custom_tool_call" The type of the custom tool call. Always custom_tool_call.
id: optional string The unique ID of the custom tool call in the OpenAI platform.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
async: optional boolean Whether the custom tool call runs asynchronously.
caller: optional Direct or Program or null The execution context that produced this tool call.
One of the following: Direct { type } type: "direct" (default: "direct") Program { caller_id, type } caller_id: string The call ID of the program item that produced this tool call.
type: "program" (default: "program") namespace: optional string The namespace of the custom tool being called.
CompactionTrigger { type, id, agent } Compacts the current context. Must be the final input item.
type: "compaction_trigger" (default: "compaction_trigger") The type of the item. Always compaction_trigger.
id: optional string or null The unique ID of this compaction trigger.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
ItemReference { id, agent, type } An internal identifier for an item to reference.
id: string The ID of the item to reference.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
type: optional "item_reference" or null (default: "item_reference") The type of item to reference. Always item_reference.
Program { id, call_id, code, 3 more } id: string The unique ID of this program item.
call_id: string The stable call ID of the program item.
minLength1 maxLength64 code: string The JavaScript source executed by programmatic tool calling.
maxLength10485760 fingerprint: string Opaque program replay fingerprint that must be round-tripped.
maxLength10485760 type: "program" (default: "program") The item type. Always program.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
ProgramOutput { id, call_id, result, 3 more } id: string The unique ID of this program output item.
call_id: string The call ID of the program item.
minLength1 maxLength64 result: string The result produced by the program item.
maxLength10485760 status: "completed" or "incomplete" The terminal status of the program output.
One of the following: "completed" "incomplete" type: "program_output" (default: "program_output") The item type. Always program_output.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
metadata: map[string] or null Set of 16 key-value pairs that can be attached to an object. This can be
useful for storing additional information about the object in a structured
format, and querying for objects via API or the dashboard.
Keys are strings with a maximum length of 64 characters. Values are strings
with a maximum length of 512 characters.
model: "gpt-6-astra" or "gpt-6.1-sol" or "gpt-6.1-terra" or 109 more or string Model ID used to generate the response, like gpt-6-astra. OpenAI
offers a wide range of models with different capabilities, performance
characteristics, and price points. Refer to the model guide
to browse and compare available models.
One of the following: "gpt-6-astra" or "gpt-6.1-sol" or "gpt-6.1-terra" or 109 more Model ID used to generate the response, like gpt-6-astra. OpenAI
offers a wide range of models with different capabilities, performance
characteristics, and price points. Refer to the model guide
to browse and compare available models.
One of the following: "gpt-6-astra" "gpt-6.1-sol" "gpt-6.1-terra" "gpt-6-sol" "gpt-6-luna" "gpt-5.6-sol" "gpt-5.6-terra" "gpt-5.6-luna" "gpt-5.5" "gpt-5.5-2026-04-23" "gpt-5.4" "gpt-5.4-mini" "gpt-5.4-mini-2026-03-17" "gpt-5.2" "gpt-5.2-2025-12-11" "gpt-5.2-pro" "gpt-5.2-pro-2025-12-11" "gpt-5.5-pro" "gpt-5.5-pro-2026-04-23" "gpt-daybreak-blue-latest" "gpt-daybreak-red-latest" "gpt-5.6-cyber" "gpt-6-cyber" "gpt-rosalind-research" "gpt-6-rosalind" "gpt-5.4-nano" Deprecated. Announced shutdown date: 2027-04-01. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-5.4-nano-2026-03-17" Deprecated. Announced shutdown date: 2027-04-01. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-5.3-chat-latest" Deprecated. Announced shutdown date: 2026-08-10. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-5.2-chat-latest" Deprecated. Announced shutdown date: 2026-08-10. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-5.1" Deprecated. Announced shutdown date: 2027-04-01. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-5.1-2025-11-13" Deprecated. Announced shutdown date: 2027-04-01. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-5.1-codex" Deprecated. Announced shutdown date: 2026-07-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-5.1-mini" Deprecated. Not a supported model ID. Retained for SDK compatibility.
"gpt-5.1-chat-latest" Deprecated. Announced shutdown date: 2026-07-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-5" Deprecated. Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-5-mini" Deprecated. Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-5-nano" Deprecated. Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-5-2025-08-07" Deprecated. Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-5-mini-2025-08-07" Deprecated. Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-5-nano-2025-08-07" Deprecated. Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-5-chat-latest" Deprecated. Announced shutdown date: 2026-07-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4.1" Deprecated. Announced shutdown date: 2027-01-14. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4.1-mini" Deprecated. Announced shutdown date: 2027-01-14. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4.1-nano" Deprecated. Announced shutdown date: 2026-10-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4.1-2025-04-14" Deprecated. Announced shutdown date: 2027-01-14. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4.1-mini-2025-04-14" Deprecated. Announced shutdown date: 2027-01-14. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4.1-nano-2025-04-14" Deprecated. Announced shutdown date: 2026-10-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"o4-mini" Deprecated. Announced shutdown date: 2026-10-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"o4-mini-2025-04-16" Deprecated. Announced shutdown date: 2026-10-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"o3" Deprecated. Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"o3-2025-04-16" Deprecated. Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"o3-mini" Deprecated. Announced shutdown date: 2026-10-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"o3-mini-2025-01-31" Deprecated. Announced shutdown date: 2026-10-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"o1" Deprecated. Announced shutdown date: 2026-10-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"o1-2024-12-17" Deprecated. Announced shutdown date: 2026-10-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"o1-preview" Deprecated. Announced shutdown date: 2025-07-28. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"o1-preview-2024-09-12" Deprecated. Announced shutdown date: 2025-07-28. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"o1-mini" Deprecated. Announced shutdown date: 2025-10-27. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"o1-mini-2024-09-12" Deprecated. Announced shutdown date: 2025-10-27. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4o" Deprecated. Announced shutdown date: 2027-01-14. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4o-2024-11-20" Deprecated. Announced shutdown date: 2027-01-14. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4o-2024-08-06" Deprecated. Announced shutdown date: 2027-01-14. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4o-2024-05-13" Deprecated. Announced shutdown date: 2026-10-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-audio-mini" Deprecated. Announced shutdown date: 2027-01-20. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-audio-mini-2025-12-15" Deprecated. Announced shutdown date: 2027-01-20. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4o-audio-preview" Deprecated. Announced shutdown date: 2026-05-07. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4o-audio-preview-2024-10-01" Deprecated. Announced shutdown date: 2025-10-10. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4o-audio-preview-2024-12-17" Deprecated. Announced shutdown date: 2026-05-07. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4o-audio-preview-2025-06-03" Deprecated. Announced shutdown date: 2026-05-07. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4o-mini-audio-preview" Deprecated. Announced shutdown date: 2026-05-07. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4o-mini-audio-preview-2024-12-17" Deprecated. Announced shutdown date: 2026-05-07. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4o-search-preview" Deprecated. Announced shutdown date: 2026-07-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4o-mini-search-preview" Deprecated. Announced shutdown date: 2026-07-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4o-search-preview-2025-03-11" Deprecated. Announced shutdown date: 2026-07-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4o-mini-search-preview-2025-03-11" Deprecated. Announced shutdown date: 2026-07-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"chatgpt-4o-latest" Deprecated. Announced shutdown date: 2026-02-17. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"codex-mini-latest" Deprecated. Announced shutdown date: 2026-02-12. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4o-mini" Deprecated. Announced shutdown date: 2027-01-14. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4o-mini-2024-07-18" Deprecated. Announced shutdown date: 2027-01-14. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4-turbo" Deprecated. Announced shutdown date: 2026-10-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4-turbo-2024-04-09" Deprecated. Announced shutdown date: 2026-10-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4-0125-preview" Deprecated. Announced shutdown date: 2026-03-26. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4-turbo-preview" Deprecated. Announced shutdown date: 2026-03-26. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4-1106-preview" Deprecated. Announced shutdown date: 2026-10-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4-vision-preview" Deprecated. Announced shutdown date: 2024-12-06. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4" Deprecated. Announced shutdown date: 2026-10-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4-0314" Deprecated. Announced shutdown date: 2026-03-26. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4-0613" Deprecated. Announced shutdown date: 2026-10-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4-32k" Deprecated. Announced shutdown date: 2025-06-06. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4-32k-0314" Deprecated. Announced shutdown date: 2025-06-06. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-4-32k-0613" Deprecated. Announced shutdown date: 2025-06-06. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-3.5-turbo" Deprecated. Announced shutdown date: 2026-10-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-3.5-turbo-16k" Deprecated. Announced shutdown date: 2024-09-13. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-3.5-turbo-0301" Deprecated. Announced shutdown date: 2024-09-13. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-3.5-turbo-0613" Deprecated. Announced shutdown date: 2024-09-13. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-3.5-turbo-1106" Deprecated. Announced shutdown date: 2026-09-28. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-3.5-turbo-0125" Deprecated. Announced shutdown date: 2026-10-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-3.5-turbo-16k-0613" Deprecated. Announced shutdown date: 2024-09-13. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"o1-pro" Deprecated. Announced shutdown date: 2026-10-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"o1-pro-2025-03-19" Deprecated. Announced shutdown date: 2026-10-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"o3-pro" Deprecated. Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"o3-pro-2025-06-10" Deprecated. Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"o3-deep-research" Deprecated. Announced shutdown date: 2026-07-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"o3-deep-research-2025-06-26" Deprecated. Announced shutdown date: 2026-07-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"o4-mini-deep-research" Deprecated. Announced shutdown date: 2026-07-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"o4-mini-deep-research-2025-06-26" Deprecated. Announced shutdown date: 2026-07-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"computer-use-preview" Deprecated. Announced shutdown date: 2026-07-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"computer-use-preview-2025-03-11" Deprecated. Announced shutdown date: 2026-07-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-5-codex" Deprecated. Announced shutdown date: 2026-07-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-5-pro" Deprecated. Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-5-pro-2025-10-06" Deprecated. Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
"gpt-5.1-codex-max" Deprecated. Announced shutdown date: 2026-07-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements.
string object: "response" The object type of this resource - always set to response.
output: array of BetaResponseOutputItem An array of content items generated by the model.
The length and order of items in the output array is dependent
on the model’s response.
Rather than accessing the first item in the output array and
assuming it’s an assistant message with the content generated by
the model, you might consider using the output_text property where
supported in SDKs.
One of the following: BetaResponseOutputMessage { id, content, role, 4 more } An output message from the model.
id: string The unique ID of the output message.
content: array of BetaResponseOutputText or BetaResponseOutputRefusal The content of the output message.
One of the following: BetaResponseOutputText { annotations, logprobs, text, type } A text output from the model.
annotations: array of FileCitation or URLCitation or ContainerFileCitation or FilePath The annotations of the text output.
One of the following: 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 in the output text at which to insert the file citation.
type: "file_citation" (default: "file_citation") The type of the file citation. Always file_citation.
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" (default: "url_citation") The type of the URL citation. Always url_citation.
url: string The URL of the web resource.
formaturi 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" (default: "container_file_citation") The type of the container file citation. Always container_file_citation.
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.
logprobs: array of { token, bytes, logprob, top_logprobs } token: string bytes: array of number logprob: number top_logprobs: array of { token, bytes, logprob } token: string bytes: array of number logprob: number text: string The text output from the model.
type: "output_text" (default: "output_text") The type of the output text. Always output_text.
BetaResponseOutputRefusal { refusal, type } A refusal from the model.
refusal: string The refusal explanation from the model.
type: "refusal" (default: "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.
One of the following: "in_progress" "completed" "incomplete" type: "message" The type of the output message. Always message.
agent: optional object or null 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" or null 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" FileSearchCall { 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,
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: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
results: optional array of object or null The results of the file search tool call.
attributes: optional map[string or number or boolean] or null 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 maxLength512 number 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.
formatfloat text: optional string The text that was retrieved from the file.
FunctionCall { 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 or null 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 Direct or Program or null The execution context that produced this tool call.
One of the following: Direct { type } type: "direct" (default: "direct") Program { caller_id, type } caller_id: string The call ID of the program item that produced this tool call.
type: "program" (default: "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.
One of the following: "in_progress" "completed" "incomplete" FunctionCallOutput { id, output, status, 7 more } id: string The unique ID of the function call tool output.
output: string or array of BetaResponseInputText or BetaResponseInputImage or BetaResponseInputFile The output from the function call generated by your code.
Can be a string or an list of output content.
One of the following: StringOutput = string A string of the output of the function call.
OutputContentList = array of BetaResponseInputText or BetaResponseInputImage or BetaResponseInputFile Text, image, or file output of the function call.
One of the following: BetaResponseInputText { text, type, prompt_cache_breakpoint } A text input to the model.
text: string The text input to the model.
type: "input_text" (default: "input_text") The type of the input item. Always input_text.
prompt_cache_breakpoint: optional { mode, ttl } Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.
mode: "explicit" (default: "explicit") The breakpoint mode. Always explicit.
ttl: optional "30m" or "12h" The minimum lifetime of this cache breakpoint. Defaults to the request TTL.
One of the following: "30m" "12h" BetaResponseInputImage { detail, type, file_id, 2 more } An image input to the model. Learn about image inputs.
detail: BetaImageDetail 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" (default: "input_image") The type of the input item. Always input_image.
file_id: optional string or null The ID of the file to be sent to the model.
image_url: optional string or null 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: optional { mode, ttl } Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.
mode: "explicit" (default: "explicit") The breakpoint mode. Always explicit.
ttl: optional "30m" or "12h" The minimum lifetime of this cache breakpoint. Defaults to the request TTL.
One of the following: "30m" "12h" BetaResponseInputFile { type, detail, file_data, 4 more } A file input to the model.
type: "input_file" (default: "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.
One of the following: "auto" "low" "high" file_data: optional string The content of the file to be sent to the model.
file_id: optional string or null 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.
formaturi filename: optional string The name of the file to be sent to the model.
prompt_cache_breakpoint: optional { mode, ttl } Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.
mode: "explicit" (default: "explicit") The breakpoint mode. Always explicit.
ttl: optional "30m" or "12h" The minimum lifetime of this cache breakpoint. Defaults to the request TTL.
One of the following: "30m" "12h" 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.
One of the following: "in_progress" "completed" "incomplete" type: "function_call_output" The type of the function tool call output. Always function_call_output.
agent: optional object or null 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 Direct or Program or null The execution context that produced this tool call.
One of the following: Direct { type } type: "direct" (default: "direct") The caller type. Always direct.
Program { caller_id, type } caller_id: string The call ID of the program item that produced this tool call.
minLength1 maxLength64 type: "program" (default: "program") The caller type. Always program.
created_by: optional string The identifier of the actor that created the item.
name: optional string The name of the tool that produced the output.
namespace: optional string The namespace of the tool that produced the output.
AgentMessage { id, author, content, 3 more } id: string The unique ID of the agent message.
author: string The sending agent identity.
content: array of BetaResponseInputText or BetaResponseOutputText or Text or 7 more Encrypted content sent between agents.
One of the following: BetaResponseInputText { text, type, prompt_cache_breakpoint } A text input to the model.
text: string The text input to the model.
type: "input_text" (default: "input_text") The type of the input item. Always input_text.
prompt_cache_breakpoint: optional { mode, ttl } Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.
mode: "explicit" (default: "explicit") The breakpoint mode. Always explicit.
ttl: optional "30m" or "12h" The minimum lifetime of this cache breakpoint. Defaults to the request TTL.
One of the following: "30m" "12h" BetaResponseOutputText { annotations, logprobs, text, type } A text output from the model.
annotations: array of FileCitation or URLCitation or ContainerFileCitation or FilePath The annotations of the text output.
One of the following: 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 in the output text at which to insert the file citation.
type: "file_citation" (default: "file_citation") The type of the file citation. Always file_citation.
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" (default: "url_citation") The type of the URL citation. Always url_citation.
url: string The URL of the web resource.
formaturi 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" (default: "container_file_citation") The type of the container file citation. Always container_file_citation.
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.
logprobs: array of { token, bytes, logprob, top_logprobs } token: string bytes: array of number logprob: number top_logprobs: array of { token, bytes, logprob } token: string bytes: array of number logprob: number text: string The text output from the model.
type: "output_text" (default: "output_text") The type of the output text. Always output_text.
Text { text, type } A text content.
text: string type: "text" (default: "text") SummaryText { text, type } A summary text from the model.
text: string A summary of the reasoning output from the model so far.
type: "summary_text" (default: "summary_text") The type of the object. Always summary_text.
ReasoningText { text, type } Reasoning text from the model.
text: string The reasoning text from the model.
type: "reasoning_text" (default: "reasoning_text") The type of the reasoning text. Always reasoning_text.
BetaResponseOutputRefusal { refusal, type } A refusal from the model.
refusal: string The refusal explanation from the model.
type: "refusal" (default: "refusal") The type of the refusal. Always refusal.
BetaResponseInputImage { detail, type, file_id, 2 more } An image input to the model. Learn about image inputs.
detail: BetaImageDetail 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" (default: "input_image") The type of the input item. Always input_image.
file_id: optional string or null The ID of the file to be sent to the model.
image_url: optional string or null 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: optional { mode, ttl } Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.
mode: "explicit" (default: "explicit") The breakpoint mode. Always explicit.
ttl: optional "30m" or "12h" The minimum lifetime of this cache breakpoint. Defaults to the request TTL.
One of the following: "30m" "12h" ComputerScreenshot { detail, file_id, image_url, 2 more } A screenshot of a computer.
detail: BetaImageDetail The detail level of the screenshot 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 or null The identifier of an uploaded file that contains the screenshot.
image_url: string or null The URL of the screenshot image.
formaturi type: "computer_screenshot" (default: "computer_screenshot") Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
prompt_cache_breakpoint: optional { mode, ttl } Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.
mode: "explicit" (default: "explicit") The breakpoint mode. Always explicit.
ttl: optional "30m" or "12h" The minimum lifetime of this cache breakpoint. Defaults to the request TTL.
One of the following: "30m" "12h" BetaResponseInputFile { type, detail, file_data, 4 more } A file input to the model.
type: "input_file" (default: "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.
One of the following: "auto" "low" "high" file_data: optional string The content of the file to be sent to the model.
file_id: optional string or null 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.
formaturi filename: optional string The name of the file to be sent to the model.
prompt_cache_breakpoint: optional { mode, ttl } Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.
mode: "explicit" (default: "explicit") The breakpoint mode. Always explicit.
ttl: optional "30m" or "12h" The minimum lifetime of this cache breakpoint. Defaults to the request TTL.
One of the following: "30m" "12h" EncryptedContent { encrypted_content, type } Opaque encrypted content that Responses API decrypts inside trusted model execution.
encrypted_content: string Opaque encrypted content.
type: "encrypted_content" (default: "encrypted_content") The type of the input item. Always encrypted_content.
recipient: string The destination agent identity.
type: "agent_message" (default: "agent_message") The type of the item. Always agent_message.
agent: optional { agent_name } The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
MultiAgentCall { id, action, arguments, 3 more } id: string The unique ID of the multi-agent call item.
action: "spawn_agent" or "interrupt_agent" or "list_agents" or 3 more The multi-agent action to execute.
One of the following: "spawn_agent" "interrupt_agent" "list_agents" "send_message" "followup_task" "wait_agent" arguments: string The JSON string of arguments generated for the action.
call_id: string The unique ID linking this call to its output.
type: "multi_agent_call" (default: "multi_agent_call") The type of the multi-agent call. Always multi_agent_call.
agent: optional { agent_name } The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
MultiAgentCallOutput { id, action, call_id, 3 more } id: string The unique ID of the multi-agent call output item.
action: "spawn_agent" or "interrupt_agent" or "list_agents" or 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.
output: array of BetaResponseOutputText { annotations, logprobs, text, type } Text output returned by the multi-agent action.
annotations: array of FileCitation or URLCitation or ContainerFileCitation or FilePath The annotations of the text output.
One of the following: 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 in the output text at which to insert the file citation.
type: "file_citation" (default: "file_citation") The type of the file citation. Always file_citation.
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" (default: "url_citation") The type of the URL citation. Always url_citation.
url: string The URL of the web resource.
formaturi 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" (default: "container_file_citation") The type of the container file citation. Always container_file_citation.
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.
logprobs: array of { token, bytes, logprob, top_logprobs } token: string bytes: array of number logprob: number top_logprobs: array of { token, bytes, logprob } token: string bytes: array of number logprob: number text: string The text output from the model.
type: "output_text" (default: "output_text") The type of the output text. Always output_text.
type: "multi_agent_call_output" (default: "multi_agent_call_output") The type of the multi-agent result. Always multi_agent_call_output.
agent: optional { agent_name } The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
WebSearchCall { id, status, type, 2 more } The results of a web search tool call. See the
web search guide for more information.
id: string The unique ID of the web search tool call.
status: "in_progress" or "searching" or "completed" or 2 more The status of the web search tool call.
One of the following: "in_progress" "searching" "completed" "failed" "incomplete" type: "web_search_call" The type of the web search tool call. Always web_search_call.
action: optional Search or OpenPage or FindInPage An object describing the specific action taken in this web search call.
Includes details on how the model used the web (search, open_page, find_in_page).
One of the following: Search { type, queries, query, sources } Action type “search” - Performs a web search query.
type: "search" The action type.
queries: optional array of string The search queries.
query: optional string Deprecated.
The search query.
sources: optional array of { type, url } The sources used in the search.
type: "url" The type of source. Always url.
url: string The URL of the source.
formaturi OpenPage { type, url } Action type “open_page” - Opens a specific URL from search results.
type: "open_page" The action type.
url: optional string or null The URL opened by the model.
formaturi FindInPage { pattern, type, url } Action type “find_in_page”: Searches for a pattern within a loaded page.
pattern: string The pattern or text to search for within the page.
type: "find_in_page" The action type.
url: optional string or null The URL of the page searched for the pattern, when available.
formaturi agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
ComputerCall { 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 { id, code, message } The pending safety checks for the computer call.
id: string The ID of the pending safety check.
code: optional string or null The type of the pending safety check.
message: optional string or null 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.
One of the following: "in_progress" "completed" "incomplete" type: "computer_call" (default: "computer_call") The type of the computer call. Always computer_call.
action: optional BetaComputerAction A click action.
One of the following: Click { 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.
One of the following: "left" "right" "wheel" "back" "forward" type: "click" (default: "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: optional array of string or null The keys being held while clicking.
DoubleClick { keys, type, x, y } A double click action.
keys: array of string or null The keys being held while double-clicking.
type: "double_click" (default: "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.
Drag { path, type, keys } A drag action.
path: array of { 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" (default: "drag") Specifies the event type. For a drag action, this property is always set to drag.
keys: optional array of string or null The keys being held while dragging the mouse.
Keypress { 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" (default: "keypress") Specifies the event type. For a keypress action, this property is always set to keypress.
Move { type, x, y, keys } A mouse move action.
type: "move" (default: "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: optional array of string or null The keys being held while moving the mouse.
Screenshot { type } A screenshot action.
type: "screenshot" (default: "screenshot") Specifies the event type. For a screenshot action, this property is always set to screenshot.
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" (default: "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: optional array of string or null The keys being held while scrolling.
Type { text, type } An action to type in text.
text: string The text to type.
type: "type" (default: "type") Specifies the event type. For a type action, this property is always set to type.
Wait { type } A wait action.
type: "wait" (default: "wait") Specifies the event type. For a wait action, this property is always set to wait.
actions: optional 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: Click { 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.
One of the following: "left" "right" "wheel" "back" "forward" type: "click" (default: "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: optional array of string or null The keys being held while clicking.
DoubleClick { keys, type, x, y } A double click action.
keys: array of string or null The keys being held while double-clicking.
type: "double_click" (default: "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.
Drag { path, type, keys } A drag action.
path: array of { 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" (default: "drag") Specifies the event type. For a drag action, this property is always set to drag.
keys: optional array of string or null The keys being held while dragging the mouse.
Keypress { 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" (default: "keypress") Specifies the event type. For a keypress action, this property is always set to keypress.
Move { type, x, y, keys } A mouse move action.
type: "move" (default: "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: optional array of string or null The keys being held while moving the mouse.
Screenshot { type } A screenshot action.
type: "screenshot" (default: "screenshot") Specifies the event type. For a screenshot action, this property is always set to screenshot.
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" (default: "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: optional array of string or null The keys being held while scrolling.
Type { text, type } An action to type in text.
text: string The text to type.
type: "type" (default: "type") Specifies the event type. For a type action, this property is always set to type.
Wait { type } A wait action.
type: "wait" (default: "wait") Specifies the event type. For a wait action, this property is always set to wait.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
ComputerCallOutput { id, call_id, output, 5 more } id: string The ID of the computer tool call output.
call_id: string The ID of the computer tool call that produced the output.
output: BetaResponseComputerToolCallOutputScreenshot { type, file_id, image_url } A computer screenshot image used with the computer use tool.
type: "computer_screenshot" (default: "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.
formaturi status: "completed" or "incomplete" or "failed" or "in_progress" 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: "completed" "incomplete" "failed" "in_progress" type: "computer_call_output" (default: "computer_call_output") The type of the computer tool call output. Always computer_call_output.
acknowledged_safety_checks: optional array of { 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 or null The type of the pending safety check.
message: optional string or null Details about the pending safety check.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
created_by: optional string The identifier of the actor that created the item.
Reasoning { 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.
id: string The unique identifier of the reasoning content.
summary: array of { text, type } Reasoning summary content.
text: string A summary of the reasoning output from the model so far.
type: "summary_text" (default: "summary_text") The type of the object. Always summary_text.
type: "reasoning" The type of the object. Always reasoning.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
content: optional array of { text, type } Reasoning text content.
text: string The reasoning text from the model.
type: "reasoning_text" (default: "reasoning_text") The type of the reasoning text. Always reasoning_text.
encrypted_content: optional string or null The encrypted content of the reasoning item. This is populated by default
for reasoning items returned by POST /v1/responses and WebSocket
response.create requests.
When streaming, use the completed reasoning item and its
encrypted_content from the response.output_item.done event in
subsequent requests. The encrypted_content in
response.output_item.added may be incomplete. This is especially
important when store is false or when using Zero Data Retention.
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.
One of the following: "in_progress" "completed" "incomplete" Program { id, call_id, code, 3 more } id: string The unique ID of the program item.
call_id: string The stable call ID of the program item.
code: string The JavaScript source executed by programmatic tool calling.
fingerprint: string Opaque program replay fingerprint that must be round-tripped.
type: "program" (default: "program") The type of the item. Always program.
agent: optional { agent_name } The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
ProgramOutput { id, call_id, result, 3 more } id: string The unique ID of the program output item.
call_id: string The call ID of the program item.
result: string The result produced by the program item.
status: "completed" or "incomplete" The terminal status of the program output item.
One of the following: "completed" "incomplete" type: "program_output" (default: "program_output") The type of the item. Always program_output.
agent: optional { agent_name } The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
ToolSearchCall { id, arguments, call_id, 5 more } id: string The unique ID of the tool search call item.
arguments: unknown Arguments used for the tool search call.
call_id: string or null The unique ID of the tool search call generated by the model.
execution: "server" or "client" Whether tool search was executed by the server or by the client.
One of the following: "server" "client" status: "in_progress" or "completed" or "incomplete" The status of the tool search call item that was recorded.
One of the following: "in_progress" "completed" "incomplete" type: "tool_search_call" (default: "tool_search_call") The type of the item. Always tool_search_call.
agent: optional { agent_name } The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
created_by: optional string The identifier of the actor that created the item.
ToolSearchOutput { id, call_id, execution, 5 more } id: string The unique ID of the tool search output item.
call_id: string or null The unique ID of the tool search call generated by the model.
execution: "server" or "client" Whether tool search was executed by the server or by the client.
One of the following: "server" "client" status: "in_progress" or "completed" or "incomplete" The status of the tool search output item that was recorded.
One of the following: "in_progress" "completed" "incomplete" tools: array of Function or FileSearch or Computer or 13 more The loaded tool definitions returned by tool search.
One of the following: Function { name, parameters, strict, 6 more } Defines a function in your own code the model can choose to call. Learn more about function calling.
name: string The name of the function to call.
parameters: map[unknown] or null A JSON schema object describing the parameters of the function.
strict: boolean or null Whether strict parameter validation is enforced for this function tool.
type: "function" (default: "function") The type of the function tool. Always function.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
One of the following: "direct" "programmatic" async: optional boolean defer_loading: optional boolean Whether this function is deferred and loaded via tool search.
description: optional string or null A description of the function. Used by the model to determine whether or not to call the function.
output_schema: optional map[unknown] or null A JSON schema object describing the JSON value encoded in string outputs for this function.
FileSearch { type, vector_store_ids, filters, 2 more } A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
type: "file_search" (default: "file_search") The type of the file search tool. Always file_search.
vector_store_ids: array of string The IDs of the vector stores to search.
filters: optional ComparisonFilter or unknown or null A filter to apply.
One of the following: ComparisonFilter { key, type, value } A filter used to compare a specified attribute key to a given value using a defined comparison operation.
key: string The key to compare against the value.
type: "eq" or "ne" or "gt" or 5 more (default: "eq") Specifies the comparison operator: eq, ne, gt, gte, lt, lte, in, nin.
eq: equals
ne: not equal
gt: greater than
gte: greater than or equal
lt: less than
lte: less than or equal
in: in
nin: not in
One of the following: "eq" "ne" "gt" "gte" "lt" "lte" "in" "nin" value: string or number or boolean or array of string or number The value to compare against the attribute key; supports string, number, or boolean types.
One of the following: string number boolean array of string or number One of the following: string number BetaCompoundFilter = unknown Combine multiple filters using and or or.
max_num_results: optional integer The maximum number of results to return. This number should be between 1 and 50 inclusive.
ranking_options: optional { hybrid_search, ranker, score_threshold } Ranking options for search.
hybrid_search: optional { embedding_weight, text_weight } Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled.
embedding_weight: number The weight of the embedding in the reciprocal ranking fusion.
text_weight: number The weight of the text in the reciprocal ranking fusion.
ranker: optional "auto" or "default-2024-11-15" The ranker to use for the file search.
One of the following: "auto" "default-2024-11-15" score_threshold: optional number The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.
Computer { type } A tool that controls a virtual computer. Learn more about the computer tool.
type: "computer" (default: "computer") The type of the computer tool. Always computer.
ComputerUsePreview { display_height, display_width, environment, type } A tool that controls a virtual computer. Learn more about the computer tool.
display_height: integer The height of the computer display.
display_width: integer The width of the computer display.
environment: "windows" or "mac" or "linux" or 2 more The type of computer environment to control.
One of the following: "windows" "mac" "linux" "ubuntu" "browser" type: "computer_use_preview" (default: "computer_use_preview") The type of the computer use tool. Always computer_use_preview.
WebSearch { type, external_web_access, filters, 2 more } Search the Internet for sources related to the prompt. Learn more about the
web search tool.
type: "web_search" or "web_search_2025_08_26" (default: "web_search") The type of the web search tool. One of web_search or web_search_2025_08_26.
One of the following: "web_search" "web_search_2025_08_26" external_web_access: optional boolean (default: true) Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.
filters: optional object or null Filters for the search.
allowed_domains: optional array of string or null (default: []) Allowed domains for the search. If not provided, all domains are allowed.
Subdomains of the provided domains are allowed as well.
Example: ["pubmed.ncbi.nlm.nih.gov"]
search_context_size: optional "low" or "medium" or "high" (default: "medium") High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.
One of the following: "low" "medium" "high" user_location: optional object or null The approximate location of the user. If omitted or null, defaults to the
United States. To avoid this fallback, pass {"type": "approximate"} without
location fields. To localize results, provide the relevant location fields.
city: optional string or null Free text input for the city of the user, e.g. San Francisco.
country: optional string or null The two-letter ISO country code of the user, e.g. US.
region: optional string or null Free text input for the region of the user, e.g. California.
timezone: optional string or null The IANA timezone of the user, e.g. America/Los_Angeles.
type: optional "approximate" (default: "approximate") The type of location approximation. Always approximate.
Mcp { server_label, type, allowed_callers, 9 more } Give the model access to additional tools via remote Model Context Protocol
(MCP) servers. Learn more about MCP.
server_label: string A label for this MCP server, used to identify it in tool calls.
type: "mcp" The type of the MCP tool. Always mcp.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" allowed_tools: optional array of string or McpToolFilter or null List of allowed tool names or a filter object.
One of the following: McpAllowedTools = array of string A string array of allowed tool names
McpToolFilter { read_only, tool_names } A filter object to specify which tools are allowed.
read_only: optional boolean Indicates whether or not a tool modifies data or is read-only. If an
MCP server is annotated with readOnlyHint,
it will match this filter.
tool_names: optional array of string List of allowed tool names.
authorization: optional string An OAuth access token that can be used with a remote MCP server, either
with a custom MCP server URL or a service connector. Your application
must handle the OAuth authorization flow and provide the token here.
connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more Deprecated.
Identifier for service connectors, like those available in ChatGPT. One of
server_url, connector_id, or tunnel_id must be provided. Learn more
about service connectors here.
This field is deprecated for models released after September 1, 2026.
Use server_url to connect to a remote MCP server, or tunnel_id to
connect through a Secure MCP Tunnel.
Currently supported connector_id values are:
Dropbox: connector_dropbox
Gmail: connector_gmail
Google Calendar: connector_googlecalendar
Google Drive: connector_googledrive
Microsoft Teams: connector_microsoftteams
Outlook Calendar: connector_outlookcalendar
Outlook Email: connector_outlookemail
SharePoint: connector_sharepoint
One of the following: "connector_dropbox" "connector_gmail" "connector_googlecalendar" "connector_googledrive" "connector_microsoftteams" "connector_outlookcalendar" "connector_outlookemail" "connector_sharepoint" defer_loading: optional boolean Whether this MCP tool is deferred and discovered via tool search.
headers: optional map[string] or null Optional HTTP headers to send to the MCP server. Use for authentication
or other purposes.
require_approval: optional McpToolApprovalFilter or "always" or "never" or null (default: "always") Specify which of the MCP server’s tools require approval.
One of the following: McpToolApprovalFilter { always, never } Specify which of the MCP server’s tools require approval. Can be
always, never, or a filter object associated with tools
that require approval.
always: optional { read_only, tool_names } A filter object to specify which tools are allowed.
read_only: optional boolean Indicates whether or not a tool modifies data or is read-only. If an
MCP server is annotated with readOnlyHint,
it will match this filter.
tool_names: optional array of string List of allowed tool names.
never: optional { read_only, tool_names } A filter object to specify which tools are allowed.
read_only: optional boolean Indicates whether or not a tool modifies data or is read-only. If an
MCP server is annotated with readOnlyHint,
it will match this filter.
tool_names: optional array of string List of allowed tool names.
McpToolApprovalSetting = "always" or "never" Specify a single approval policy for all tools. One of always or
never. When set to always, all tools will require approval. When
set to never, all tools will not require approval.
One of the following: "always" "never" server_description: optional string Optional description of the MCP server, used to provide more context.
server_url: optional string The URL for the MCP server. One of server_url, connector_id, or
tunnel_id must be provided.
formaturi tunnel_id: optional string The Secure MCP Tunnel ID to use instead of a direct server URL. One of
server_url, connector_id, or tunnel_id must be provided.
pattern^tunnel_[a-z0-9]{32}$ CodeInterpreter { container, type, allowed_callers } A tool that runs Python code to help generate a response to a prompt.
container: string or CodeInterpreterToolAuto The code interpreter container. Can be a container ID or an object that
specifies uploaded file IDs to make available to your code, along with an
optional memory_limit setting.
One of the following: string The container ID.
CodeInterpreterToolAuto { type, file_ids, memory_limit, network_policy } Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.
type: "auto" (default: "auto") Always auto.
file_ids: optional array of string An optional list of uploaded files to make available to your code.
maxItems50 memory_limit: optional "1g" or "4g" or "16g" or "64g" or null The memory limit for the code interpreter container.
One of the following: "1g" "4g" "16g" "64g" network_policy: optional BetaContainerNetworkPolicyDisabled or BetaContainerNetworkPolicyAllowlist Network access policy for the container.
One of the following: BetaContainerNetworkPolicyDisabled { type } type: "disabled" (default: "disabled") Disable outbound network access. Always disabled.
BetaContainerNetworkPolicyAllowlist { allowed_domains, type, domain_secrets } allowed_domains: array of string A list of allowed domains when type is allowlist.
minItems1 type: "allowlist" (default: "allowlist") Allow outbound network access only to specified domains. Always allowlist.
domain_secrets: optional array of BetaContainerNetworkPolicyDomainSecret { domain, name, value } Optional domain-scoped secrets for allowlisted domains.
minItems1 domain: string The domain associated with the secret.
minLength1 name: string The name of the secret to inject for the domain.
minLength1 value: string The secret value to inject for the domain.
minLength1 maxLength10485760 type: "code_interpreter" The type of the code interpreter tool. Always code_interpreter.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" ProgrammaticToolCalling { type } type: "programmatic_tool_calling" (default: "programmatic_tool_calling") The type of the tool. Always programmatic_tool_calling.
ImageGeneration { type, action, background, 13 more } A tool that generates images using the GPT image models.
type: "image_generation" The type of the image generation tool. Always image_generation.
action: optional "generate" or "edit" or "auto" Whether to generate a new image or edit an existing image. Default: auto.
One of the following: "generate" "edit" "auto" background: optional "transparent" or "opaque" or "auto" (default: "auto") Set the background of the generated image. One of transparent, opaque,
or auto. gpt-image-2.5-sunburst and gpt-image-2.5-flare, including
their 2026-09-08 snapshots, support opaque and transparent
backgrounds. Transparent backgrounds are available for supported GPT Image
models. For gpt-image-2 and gpt-image-2-2026-04-21, this support is in
preview. When using transparent, set the output format to png or webp.
Default: auto.
One of the following: "transparent" "opaque" "auto" complexity: optional "low" or "medium" or "high" Computation spent planning the image, independently of rendering quality.
Overrides the outer response’s reasoning.effort for image generation.
When omitted, inherits a supported outer reasoning effort or uses the
image model’s configured default.
For SVG output, controls the reference image, not the SVG author’s
reasoning.
One of the following: "low" "medium" "high" frame_count: optional integer (default: 9) Number of GIF frames. Requires output_format to be gif. Default: 9.
minimum2 maximum16 frame_duration_ms: optional integer (default: 200) Duration of each GIF frame in milliseconds, rounded to 10 ms.
Requires output_format to be gif. Default: 200.
minimum20 maximum2000 input_fidelity: optional "high" or "low" or null Control how much effort the model will exert to match the style and features, especially facial features, of input images. Supports high and low on gpt-image-1.5; gpt-image-1-mini supports only low. For gpt-image-2, omit this parameter. Defaults to low on supported models.
One of the following: "high" "low" input_image_mask: optional { file_id, image_url } Optional mask for inpainting. Contains image_url
(string, optional) and file_id (string, optional).
file_id: optional string File ID for the mask image.
image_url: optional string Base64-encoded mask image.
model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-2" or 9 more The image generation model to use. One of gpt-image-1-mini,
gpt-image-1.5, gpt-image-2,
gpt-image-2-2026-04-21, gpt-image-2.5-sunburst,
gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare,
gpt-image-2.5-flare-2026-09-08, gpt-image-2.6-sunburst,
gpt-image-2.6-flare, or chatgpt-image-latest. Default:
gpt-image-2.6-sunburst.
gpt-image-1 was shut down on October 23, 2026. Use
gpt-image-2.5-sunburst or gpt-image-2.5-flare instead.
One of the following: string "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-2" or 9 more The image generation model to use. One of gpt-image-1-mini,
gpt-image-1.5, gpt-image-2,
gpt-image-2-2026-04-21, gpt-image-2.5-sunburst,
gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare,
gpt-image-2.5-flare-2026-09-08, gpt-image-2.6-sunburst,
gpt-image-2.6-flare, or chatgpt-image-latest. Default:
gpt-image-2.6-sunburst.
gpt-image-1 was shut down on October 23, 2026. Use
gpt-image-2.5-sunburst or gpt-image-2.5-flare instead.
One of the following: "gpt-image-1-mini" "gpt-image-2" "gpt-image-2-2026-04-21" "gpt-image-2.5-sunburst" "gpt-image-2.5-sunburst-2026-09-08" "gpt-image-2.5-flare" "gpt-image-2.5-flare-2026-09-08" "gpt-image-2.6-sunburst" "gpt-image-2.6-flare" "gpt-image-1.5" "chatgpt-image-latest" "gpt-image-1" Deprecated. GPT Image 1 was shut down on October 23, 2026. Use gpt-image-2.5-sunburst or gpt-image-2.5-flare instead.
moderation: optional "auto" or "low" (default: "auto") Moderation level for the generated image. Default: auto.
One of the following: "auto" "low" output_compression: optional integer (default: 100) Compression level for the output image. Default: 100.
minimum0 maximum100 output_format: optional "png" or "webp" or "jpeg" or 2 more (default: "png") The output format of the generated image. One of png, webp, jpeg,
gif, or svg. Default: png. GIF and SVG output require a model
that supports the selected format. GIF output does not support
partial image streaming (partial_images greater than 0),
input_image_mask, or custom output_compression.
Responses lifecycle events can still be streamed for GIF output.
One of the following: "png" "webp" "jpeg" "gif" "svg" partial_images: optional integer (default: 0) Number of partial images to generate in streaming mode, from 0 (default value) to 3.
minimum0 maximum3 quality: optional "low" or "medium" or "high" or 3 more (default: "auto") The quality of the generated image. The GPT image models support low,
medium, and high. gpt-image-2.5-sunburst and gpt-image-2.5-flare,
including their 2026-09-08 snapshots, also support xhigh and max.
Default: auto.
One of the following: "low" "medium" "high" "xhigh" "max" "auto" size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto" (default: "auto") The size of the generated images. For gpt-image-2, gpt-image-2-2026-04-21, gpt-image-2.5-sunburst, gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare, and gpt-image-2.5-flare-2026-09-08, arbitrary resolutions are supported as WIDTHxHEIGHT strings, for example 1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above 2560x1440 are experimental, and the maximum supported resolution is 3840x2160. The requested size must also satisfy the model’s current pixel and edge limits. The standard sizes 1024x1024, 1536x1024, and 1024x1536 are supported by the GPT image models; auto is supported for models that allow automatic sizing.
One of the following: string "1024x1024" or "1024x1536" or "1536x1024" or "auto" The size of the generated images. For gpt-image-2, gpt-image-2-2026-04-21, gpt-image-2.5-sunburst, gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare, and gpt-image-2.5-flare-2026-09-08, arbitrary resolutions are supported as WIDTHxHEIGHT strings, for example 1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above 2560x1440 are experimental, and the maximum supported resolution is 3840x2160. The requested size must also satisfy the model’s current pixel and edge limits. The standard sizes 1024x1024, 1536x1024, and 1024x1536 are supported by the GPT image models; auto is supported for models that allow automatic sizing.
One of the following: "1024x1024" "1024x1536" "1536x1024" "auto" svg: optional { model, reasoning } SVG author model settings. Requires output_format to be svg.
When SVG model selection is enabled, omitting this object uses the
outer response model. Otherwise, the default SVG author is used and
explicit model overrides are unavailable.
model: optional string minLength1 reasoning: optional object or null Reasoning effort for SVG authoring. When omitted, uses the author model’s default in both Images and Responses.
effort: optional "none" or "minimal" or "low" or 4 more Controls how much effort the model should spend on reasoning for this request.
One of the following: "none" "minimal" "low" "medium" "high" "xhigh" "max" LocalShell { type } A tool that allows the model to execute shell commands in a local environment.
type: "local_shell" (default: "local_shell") The type of the local shell tool. Always local_shell.
Shell { type, allowed_callers, environment } A tool that allows the model to execute shell commands.
type: "shell" (default: "shell") The type of the shell tool. Always shell.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" environment: optional BetaContainerAuto or BetaLocalEnvironment or BetaContainerReference or null One of the following: BetaContainerAuto { type, file_ids, memory_limit, 2 more } type: "container_auto" (default: "container_auto") Automatically creates a container for this request
file_ids: optional array of string An optional list of uploaded files to make available to your code.
maxItems50 memory_limit: optional "1g" or "4g" or "16g" or "64g" or null The memory limit for the container.
One of the following: "1g" "4g" "16g" "64g" network_policy: optional BetaContainerNetworkPolicyDisabled or BetaContainerNetworkPolicyAllowlist Network access policy for the container.
One of the following: BetaContainerNetworkPolicyDisabled { type } type: "disabled" (default: "disabled") Disable outbound network access. Always disabled.
BetaContainerNetworkPolicyAllowlist { allowed_domains, type, domain_secrets } allowed_domains: array of string A list of allowed domains when type is allowlist.
minItems1 type: "allowlist" (default: "allowlist") Allow outbound network access only to specified domains. Always allowlist.
domain_secrets: optional array of BetaContainerNetworkPolicyDomainSecret { domain, name, value } Optional domain-scoped secrets for allowlisted domains.
minItems1 domain: string The domain associated with the secret.
minLength1 name: string The name of the secret to inject for the domain.
minLength1 value: string The secret value to inject for the domain.
minLength1 maxLength10485760 skills: optional array of BetaSkillReference or BetaInlineSkill An optional list of skills referenced by id or inline data.
maxItems200 One of the following: BetaSkillReference { skill_id, type, version } skill_id: string The ID of the referenced skill.
minLength1 maxLength64 type: "skill_reference" (default: "skill_reference") References a skill created with the /v1/skills endpoint.
version: optional string Optional skill version. Use a positive integer or ‘latest’. Omit for default.
BetaInlineSkill { description, name, source, type } description: string The description of the skill.
name: string The name of the skill.
source: BetaInlineSkillSource { data, media_type, type } Inline skill payload
data: string Base64-encoded skill zip bundle.
minLength1 maxLength70254592 media_type: "application/zip" (default: "application/zip") The media type of the inline skill payload. Must be application/zip.
type: "base64" (default: "base64") The type of the inline skill source. Must be base64.
type: "inline" (default: "inline") Defines an inline skill for this request.
BetaLocalEnvironment { type, skills } type: "local" (default: "local") Use a local computer environment.
skills: optional array of BetaLocalSkill { description, name, path } An optional list of skills.
maxItems200 description: string The description of the skill.
name: string The name of the skill.
path: string The path to the directory containing the skill.
BetaContainerReference { container_id, type } container_id: string The ID of the referenced container.
type: "container_reference" (default: "container_reference") References a container created with the /v1/containers endpoint
Custom { name, type, allowed_callers, 4 more } A custom tool that processes input using a specified format. Learn more about custom tools
name: string The name of the custom tool, used to identify it in tool calls.
type: "custom" (default: "custom") The type of the custom tool. Always custom.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" async: optional boolean Whether the tool response can be returned asynchronously versus immediately returned on next response creation.
defer_loading: optional boolean Whether this tool should be deferred and discovered via tool search.
description: optional string Optional description of the custom tool, used to provide more context.
format: optional Text or Grammar The input format for the custom tool. Default is unconstrained text.
One of the following: Text { type } Unconstrained free-form text.
type: "text" (default: "text") Unconstrained text format. Always text.
Grammar { definition, syntax, type } A grammar defined by the user.
definition: string The grammar definition.
syntax: "lark" or "regex" The syntax of the grammar definition. One of lark or regex.
One of the following: "lark" "regex" type: "grammar" (default: "grammar") Grammar format. Always grammar.
Namespace { description, name, tools, type } Groups function/custom tools under a shared namespace.
description: string A description of the namespace shown to the model.
name: string The namespace name used in tool calls (for example, crm).
minLength1 tools: array of Function or Custom The function/custom tools available inside this namespace.
minItems1 One of the following: Function { name, type, allowed_callers, 6 more } name: string pattern^[a-zA-Z0-9_-]+$ minLength1 maxLength128 type: "function" (default: "function") allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" async: optional boolean Whether the tool response can be returned asynchronously versus immediately returned on next response creation.
defer_loading: optional boolean Whether this function should be deferred and discovered via tool search.
description: optional string or null output_schema: optional map[unknown] or null A JSON Schema describing the JSON value encoded in string outputs for this function tool. This does not describe content-array outputs.
parameters: optional unknown or null strict: optional boolean or null Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise.
Custom { name, type, allowed_callers, 4 more } A custom tool that processes input using a specified format. Learn more about custom tools
name: string The name of the custom tool, used to identify it in tool calls.
type: "custom" (default: "custom") The type of the custom tool. Always custom.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" async: optional boolean Whether the tool response can be returned asynchronously versus immediately returned on next response creation.
defer_loading: optional boolean Whether this tool should be deferred and discovered via tool search.
description: optional string Optional description of the custom tool, used to provide more context.
format: optional Text or Grammar The input format for the custom tool. Default is unconstrained text.
One of the following: Text { type } Unconstrained free-form text.
type: "text" (default: "text") Unconstrained text format. Always text.
Grammar { definition, syntax, type } A grammar defined by the user.
definition: string The grammar definition.
syntax: "lark" or "regex" The syntax of the grammar definition. One of lark or regex.
One of the following: "lark" "regex" type: "grammar" (default: "grammar") Grammar format. Always grammar.
type: "namespace" (default: "namespace") The type of the tool. Always namespace.
ToolSearch { type, description, execution, parameters } Hosted or BYOT tool search configuration for deferred tools.
type: "tool_search" (default: "tool_search") The type of the tool. Always tool_search.
description: optional string or null Description shown to the model for a client-executed tool search tool.
execution: optional "server" or "client" Whether tool search is executed by the server or by the client.
One of the following: "server" "client" parameters: optional unknown or null Parameter schema for a client-executed tool search tool.
WebSearchPreview { type, search_content_types, search_context_size, user_location } This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
type: "web_search_preview" or "web_search_preview_2025_03_11" (default: "web_search_preview") The type of the web search tool. One of web_search_preview or web_search_preview_2025_03_11.
One of the following: "web_search_preview" "web_search_preview_2025_03_11" search_content_types: optional array of "text" or "image" One of the following: "text" "image" search_context_size: optional "low" or "medium" or "high" High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.
One of the following: "low" "medium" "high" user_location: optional object or null The approximate location of the user. If omitted or null, defaults to the United States. To avoid this fallback, pass {"type": "approximate"} without location fields. To localize results, provide the relevant location fields.
type: "approximate" (default: "approximate") The type of location approximation. Always approximate.
city: optional string or null Free text input for the city of the user, e.g. San Francisco.
country: optional string or null The two-letter ISO country code of the user, e.g. US.
region: optional string or null Free text input for the region of the user, e.g. California.
timezone: optional string or null The IANA timezone of the user, e.g. America/Los_Angeles.
ApplyPatch { type, allowed_callers } Allows the assistant to create, delete, or update files using unified diffs.
type: "apply_patch" (default: "apply_patch") The type of the tool. Always apply_patch.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" type: "tool_search_output" (default: "tool_search_output") The type of the item. Always tool_search_output.
agent: optional { agent_name } The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
created_by: optional string The identifier of the actor that created the item.
AdditionalTools { id, role, tools, 2 more } id: string The unique ID of the additional tools item.
role: "unknown" or "user" or "assistant" or 5 more The role that provided the additional tools.
One of the following: "unknown" "user" "assistant" "system" "critic" "discriminator" "developer" "tool" tools: array of Function or FileSearch or Computer or 13 more The additional tool definitions made available at this item.
One of the following: Function { name, parameters, strict, 6 more } Defines a function in your own code the model can choose to call. Learn more about function calling.
name: string The name of the function to call.
parameters: map[unknown] or null A JSON schema object describing the parameters of the function.
strict: boolean or null Whether strict parameter validation is enforced for this function tool.
type: "function" (default: "function") The type of the function tool. Always function.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
One of the following: "direct" "programmatic" async: optional boolean defer_loading: optional boolean Whether this function is deferred and loaded via tool search.
description: optional string or null A description of the function. Used by the model to determine whether or not to call the function.
output_schema: optional map[unknown] or null A JSON schema object describing the JSON value encoded in string outputs for this function.
FileSearch { type, vector_store_ids, filters, 2 more } A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
type: "file_search" (default: "file_search") The type of the file search tool. Always file_search.
vector_store_ids: array of string The IDs of the vector stores to search.
filters: optional ComparisonFilter or unknown or null A filter to apply.
One of the following: ComparisonFilter { key, type, value } A filter used to compare a specified attribute key to a given value using a defined comparison operation.
key: string The key to compare against the value.
type: "eq" or "ne" or "gt" or 5 more (default: "eq") Specifies the comparison operator: eq, ne, gt, gte, lt, lte, in, nin.
eq: equals
ne: not equal
gt: greater than
gte: greater than or equal
lt: less than
lte: less than or equal
in: in
nin: not in
One of the following: "eq" "ne" "gt" "gte" "lt" "lte" "in" "nin" value: string or number or boolean or array of string or number The value to compare against the attribute key; supports string, number, or boolean types.
One of the following: string number boolean array of string or number One of the following: string number BetaCompoundFilter = unknown Combine multiple filters using and or or.
max_num_results: optional integer The maximum number of results to return. This number should be between 1 and 50 inclusive.
ranking_options: optional { hybrid_search, ranker, score_threshold } Ranking options for search.
hybrid_search: optional { embedding_weight, text_weight } Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled.
embedding_weight: number The weight of the embedding in the reciprocal ranking fusion.
text_weight: number The weight of the text in the reciprocal ranking fusion.
ranker: optional "auto" or "default-2024-11-15" The ranker to use for the file search.
One of the following: "auto" "default-2024-11-15" score_threshold: optional number The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.
Computer { type } A tool that controls a virtual computer. Learn more about the computer tool.
type: "computer" (default: "computer") The type of the computer tool. Always computer.
ComputerUsePreview { display_height, display_width, environment, type } A tool that controls a virtual computer. Learn more about the computer tool.
display_height: integer The height of the computer display.
display_width: integer The width of the computer display.
environment: "windows" or "mac" or "linux" or 2 more The type of computer environment to control.
One of the following: "windows" "mac" "linux" "ubuntu" "browser" type: "computer_use_preview" (default: "computer_use_preview") The type of the computer use tool. Always computer_use_preview.
WebSearch { type, external_web_access, filters, 2 more } Search the Internet for sources related to the prompt. Learn more about the
web search tool.
type: "web_search" or "web_search_2025_08_26" (default: "web_search") The type of the web search tool. One of web_search or web_search_2025_08_26.
One of the following: "web_search" "web_search_2025_08_26" external_web_access: optional boolean (default: true) Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.
filters: optional object or null Filters for the search.
allowed_domains: optional array of string or null (default: []) Allowed domains for the search. If not provided, all domains are allowed.
Subdomains of the provided domains are allowed as well.
Example: ["pubmed.ncbi.nlm.nih.gov"]
search_context_size: optional "low" or "medium" or "high" (default: "medium") High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.
One of the following: "low" "medium" "high" user_location: optional object or null The approximate location of the user. If omitted or null, defaults to the
United States. To avoid this fallback, pass {"type": "approximate"} without
location fields. To localize results, provide the relevant location fields.
city: optional string or null Free text input for the city of the user, e.g. San Francisco.
country: optional string or null The two-letter ISO country code of the user, e.g. US.
region: optional string or null Free text input for the region of the user, e.g. California.
timezone: optional string or null The IANA timezone of the user, e.g. America/Los_Angeles.
type: optional "approximate" (default: "approximate") The type of location approximation. Always approximate.
Mcp { server_label, type, allowed_callers, 9 more } Give the model access to additional tools via remote Model Context Protocol
(MCP) servers. Learn more about MCP.
server_label: string A label for this MCP server, used to identify it in tool calls.
type: "mcp" The type of the MCP tool. Always mcp.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" allowed_tools: optional array of string or McpToolFilter or null List of allowed tool names or a filter object.
One of the following: McpAllowedTools = array of string A string array of allowed tool names
McpToolFilter { read_only, tool_names } A filter object to specify which tools are allowed.
read_only: optional boolean Indicates whether or not a tool modifies data or is read-only. If an
MCP server is annotated with readOnlyHint,
it will match this filter.
tool_names: optional array of string List of allowed tool names.
authorization: optional string An OAuth access token that can be used with a remote MCP server, either
with a custom MCP server URL or a service connector. Your application
must handle the OAuth authorization flow and provide the token here.
connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more Deprecated.
Identifier for service connectors, like those available in ChatGPT. One of
server_url, connector_id, or tunnel_id must be provided. Learn more
about service connectors here.
This field is deprecated for models released after September 1, 2026.
Use server_url to connect to a remote MCP server, or tunnel_id to
connect through a Secure MCP Tunnel.
Currently supported connector_id values are:
Dropbox: connector_dropbox
Gmail: connector_gmail
Google Calendar: connector_googlecalendar
Google Drive: connector_googledrive
Microsoft Teams: connector_microsoftteams
Outlook Calendar: connector_outlookcalendar
Outlook Email: connector_outlookemail
SharePoint: connector_sharepoint
One of the following: "connector_dropbox" "connector_gmail" "connector_googlecalendar" "connector_googledrive" "connector_microsoftteams" "connector_outlookcalendar" "connector_outlookemail" "connector_sharepoint" defer_loading: optional boolean Whether this MCP tool is deferred and discovered via tool search.
headers: optional map[string] or null Optional HTTP headers to send to the MCP server. Use for authentication
or other purposes.
require_approval: optional McpToolApprovalFilter or "always" or "never" or null (default: "always") Specify which of the MCP server’s tools require approval.
One of the following: McpToolApprovalFilter { always, never } Specify which of the MCP server’s tools require approval. Can be
always, never, or a filter object associated with tools
that require approval.
always: optional { read_only, tool_names } A filter object to specify which tools are allowed.
read_only: optional boolean Indicates whether or not a tool modifies data or is read-only. If an
MCP server is annotated with readOnlyHint,
it will match this filter.
tool_names: optional array of string List of allowed tool names.
never: optional { read_only, tool_names } A filter object to specify which tools are allowed.
read_only: optional boolean Indicates whether or not a tool modifies data or is read-only. If an
MCP server is annotated with readOnlyHint,
it will match this filter.
tool_names: optional array of string List of allowed tool names.
McpToolApprovalSetting = "always" or "never" Specify a single approval policy for all tools. One of always or
never. When set to always, all tools will require approval. When
set to never, all tools will not require approval.
One of the following: "always" "never" server_description: optional string Optional description of the MCP server, used to provide more context.
server_url: optional string The URL for the MCP server. One of server_url, connector_id, or
tunnel_id must be provided.
formaturi tunnel_id: optional string The Secure MCP Tunnel ID to use instead of a direct server URL. One of
server_url, connector_id, or tunnel_id must be provided.
pattern^tunnel_[a-z0-9]{32}$ CodeInterpreter { container, type, allowed_callers } A tool that runs Python code to help generate a response to a prompt.
container: string or CodeInterpreterToolAuto The code interpreter container. Can be a container ID or an object that
specifies uploaded file IDs to make available to your code, along with an
optional memory_limit setting.
One of the following: string The container ID.
CodeInterpreterToolAuto { type, file_ids, memory_limit, network_policy } Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.
type: "auto" (default: "auto") Always auto.
file_ids: optional array of string An optional list of uploaded files to make available to your code.
maxItems50 memory_limit: optional "1g" or "4g" or "16g" or "64g" or null The memory limit for the code interpreter container.
One of the following: "1g" "4g" "16g" "64g" network_policy: optional BetaContainerNetworkPolicyDisabled or BetaContainerNetworkPolicyAllowlist Network access policy for the container.
One of the following: BetaContainerNetworkPolicyDisabled { type } type: "disabled" (default: "disabled") Disable outbound network access. Always disabled.
BetaContainerNetworkPolicyAllowlist { allowed_domains, type, domain_secrets } allowed_domains: array of string A list of allowed domains when type is allowlist.
minItems1 type: "allowlist" (default: "allowlist") Allow outbound network access only to specified domains. Always allowlist.
domain_secrets: optional array of BetaContainerNetworkPolicyDomainSecret { domain, name, value } Optional domain-scoped secrets for allowlisted domains.
minItems1 domain: string The domain associated with the secret.
minLength1 name: string The name of the secret to inject for the domain.
minLength1 value: string The secret value to inject for the domain.
minLength1 maxLength10485760 type: "code_interpreter" The type of the code interpreter tool. Always code_interpreter.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" ProgrammaticToolCalling { type } type: "programmatic_tool_calling" (default: "programmatic_tool_calling") The type of the tool. Always programmatic_tool_calling.
ImageGeneration { type, action, background, 13 more } A tool that generates images using the GPT image models.
type: "image_generation" The type of the image generation tool. Always image_generation.
action: optional "generate" or "edit" or "auto" Whether to generate a new image or edit an existing image. Default: auto.
One of the following: "generate" "edit" "auto" background: optional "transparent" or "opaque" or "auto" (default: "auto") Set the background of the generated image. One of transparent, opaque,
or auto. gpt-image-2.5-sunburst and gpt-image-2.5-flare, including
their 2026-09-08 snapshots, support opaque and transparent
backgrounds. Transparent backgrounds are available for supported GPT Image
models. For gpt-image-2 and gpt-image-2-2026-04-21, this support is in
preview. When using transparent, set the output format to png or webp.
Default: auto.
One of the following: "transparent" "opaque" "auto" complexity: optional "low" or "medium" or "high" Computation spent planning the image, independently of rendering quality.
Overrides the outer response’s reasoning.effort for image generation.
When omitted, inherits a supported outer reasoning effort or uses the
image model’s configured default.
For SVG output, controls the reference image, not the SVG author’s
reasoning.
One of the following: "low" "medium" "high" frame_count: optional integer (default: 9) Number of GIF frames. Requires output_format to be gif. Default: 9.
minimum2 maximum16 frame_duration_ms: optional integer (default: 200) Duration of each GIF frame in milliseconds, rounded to 10 ms.
Requires output_format to be gif. Default: 200.
minimum20 maximum2000 input_fidelity: optional "high" or "low" or null Control how much effort the model will exert to match the style and features, especially facial features, of input images. Supports high and low on gpt-image-1.5; gpt-image-1-mini supports only low. For gpt-image-2, omit this parameter. Defaults to low on supported models.
One of the following: "high" "low" input_image_mask: optional { file_id, image_url } Optional mask for inpainting. Contains image_url
(string, optional) and file_id (string, optional).
file_id: optional string File ID for the mask image.
image_url: optional string Base64-encoded mask image.
model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-2" or 9 more The image generation model to use. One of gpt-image-1-mini,
gpt-image-1.5, gpt-image-2,
gpt-image-2-2026-04-21, gpt-image-2.5-sunburst,
gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare,
gpt-image-2.5-flare-2026-09-08, gpt-image-2.6-sunburst,
gpt-image-2.6-flare, or chatgpt-image-latest. Default:
gpt-image-2.6-sunburst.
gpt-image-1 was shut down on October 23, 2026. Use
gpt-image-2.5-sunburst or gpt-image-2.5-flare instead.
One of the following: string "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-2" or 9 more The image generation model to use. One of gpt-image-1-mini,
gpt-image-1.5, gpt-image-2,
gpt-image-2-2026-04-21, gpt-image-2.5-sunburst,
gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare,
gpt-image-2.5-flare-2026-09-08, gpt-image-2.6-sunburst,
gpt-image-2.6-flare, or chatgpt-image-latest. Default:
gpt-image-2.6-sunburst.
gpt-image-1 was shut down on October 23, 2026. Use
gpt-image-2.5-sunburst or gpt-image-2.5-flare instead.
One of the following: "gpt-image-1-mini" "gpt-image-2" "gpt-image-2-2026-04-21" "gpt-image-2.5-sunburst" "gpt-image-2.5-sunburst-2026-09-08" "gpt-image-2.5-flare" "gpt-image-2.5-flare-2026-09-08" "gpt-image-2.6-sunburst" "gpt-image-2.6-flare" "gpt-image-1.5" "chatgpt-image-latest" "gpt-image-1" Deprecated. GPT Image 1 was shut down on October 23, 2026. Use gpt-image-2.5-sunburst or gpt-image-2.5-flare instead.
moderation: optional "auto" or "low" (default: "auto") Moderation level for the generated image. Default: auto.
One of the following: "auto" "low" output_compression: optional integer (default: 100) Compression level for the output image. Default: 100.
minimum0 maximum100 output_format: optional "png" or "webp" or "jpeg" or 2 more (default: "png") The output format of the generated image. One of png, webp, jpeg,
gif, or svg. Default: png. GIF and SVG output require a model
that supports the selected format. GIF output does not support
partial image streaming (partial_images greater than 0),
input_image_mask, or custom output_compression.
Responses lifecycle events can still be streamed for GIF output.
One of the following: "png" "webp" "jpeg" "gif" "svg" partial_images: optional integer (default: 0) Number of partial images to generate in streaming mode, from 0 (default value) to 3.
minimum0 maximum3 quality: optional "low" or "medium" or "high" or 3 more (default: "auto") The quality of the generated image. The GPT image models support low,
medium, and high. gpt-image-2.5-sunburst and gpt-image-2.5-flare,
including their 2026-09-08 snapshots, also support xhigh and max.
Default: auto.
One of the following: "low" "medium" "high" "xhigh" "max" "auto" size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto" (default: "auto") The size of the generated images. For gpt-image-2, gpt-image-2-2026-04-21, gpt-image-2.5-sunburst, gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare, and gpt-image-2.5-flare-2026-09-08, arbitrary resolutions are supported as WIDTHxHEIGHT strings, for example 1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above 2560x1440 are experimental, and the maximum supported resolution is 3840x2160. The requested size must also satisfy the model’s current pixel and edge limits. The standard sizes 1024x1024, 1536x1024, and 1024x1536 are supported by the GPT image models; auto is supported for models that allow automatic sizing.
One of the following: string "1024x1024" or "1024x1536" or "1536x1024" or "auto" The size of the generated images. For gpt-image-2, gpt-image-2-2026-04-21, gpt-image-2.5-sunburst, gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare, and gpt-image-2.5-flare-2026-09-08, arbitrary resolutions are supported as WIDTHxHEIGHT strings, for example 1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above 2560x1440 are experimental, and the maximum supported resolution is 3840x2160. The requested size must also satisfy the model’s current pixel and edge limits. The standard sizes 1024x1024, 1536x1024, and 1024x1536 are supported by the GPT image models; auto is supported for models that allow automatic sizing.
One of the following: "1024x1024" "1024x1536" "1536x1024" "auto" svg: optional { model, reasoning } SVG author model settings. Requires output_format to be svg.
When SVG model selection is enabled, omitting this object uses the
outer response model. Otherwise, the default SVG author is used and
explicit model overrides are unavailable.
model: optional string minLength1 reasoning: optional object or null Reasoning effort for SVG authoring. When omitted, uses the author model’s default in both Images and Responses.
effort: optional "none" or "minimal" or "low" or 4 more Controls how much effort the model should spend on reasoning for this request.
One of the following: "none" "minimal" "low" "medium" "high" "xhigh" "max" LocalShell { type } A tool that allows the model to execute shell commands in a local environment.
type: "local_shell" (default: "local_shell") The type of the local shell tool. Always local_shell.
Shell { type, allowed_callers, environment } A tool that allows the model to execute shell commands.
type: "shell" (default: "shell") The type of the shell tool. Always shell.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" environment: optional BetaContainerAuto or BetaLocalEnvironment or BetaContainerReference or null One of the following: BetaContainerAuto { type, file_ids, memory_limit, 2 more } type: "container_auto" (default: "container_auto") Automatically creates a container for this request
file_ids: optional array of string An optional list of uploaded files to make available to your code.
maxItems50 memory_limit: optional "1g" or "4g" or "16g" or "64g" or null The memory limit for the container.
One of the following: "1g" "4g" "16g" "64g" network_policy: optional BetaContainerNetworkPolicyDisabled or BetaContainerNetworkPolicyAllowlist Network access policy for the container.
One of the following: BetaContainerNetworkPolicyDisabled { type } type: "disabled" (default: "disabled") Disable outbound network access. Always disabled.
BetaContainerNetworkPolicyAllowlist { allowed_domains, type, domain_secrets } allowed_domains: array of string A list of allowed domains when type is allowlist.
minItems1 type: "allowlist" (default: "allowlist") Allow outbound network access only to specified domains. Always allowlist.
domain_secrets: optional array of BetaContainerNetworkPolicyDomainSecret { domain, name, value } Optional domain-scoped secrets for allowlisted domains.
minItems1 domain: string The domain associated with the secret.
minLength1 name: string The name of the secret to inject for the domain.
minLength1 value: string The secret value to inject for the domain.
minLength1 maxLength10485760 skills: optional array of BetaSkillReference or BetaInlineSkill An optional list of skills referenced by id or inline data.
maxItems200 One of the following: BetaSkillReference { skill_id, type, version } skill_id: string The ID of the referenced skill.
minLength1 maxLength64 type: "skill_reference" (default: "skill_reference") References a skill created with the /v1/skills endpoint.
version: optional string Optional skill version. Use a positive integer or ‘latest’. Omit for default.
BetaInlineSkill { description, name, source, type } description: string The description of the skill.
name: string The name of the skill.
source: BetaInlineSkillSource { data, media_type, type } Inline skill payload
data: string Base64-encoded skill zip bundle.
minLength1 maxLength70254592 media_type: "application/zip" (default: "application/zip") The media type of the inline skill payload. Must be application/zip.
type: "base64" (default: "base64") The type of the inline skill source. Must be base64.
type: "inline" (default: "inline") Defines an inline skill for this request.
BetaLocalEnvironment { type, skills } type: "local" (default: "local") Use a local computer environment.
skills: optional array of BetaLocalSkill { description, name, path } An optional list of skills.
maxItems200 description: string The description of the skill.
name: string The name of the skill.
path: string The path to the directory containing the skill.
BetaContainerReference { container_id, type } container_id: string The ID of the referenced container.
type: "container_reference" (default: "container_reference") References a container created with the /v1/containers endpoint
Custom { name, type, allowed_callers, 4 more } A custom tool that processes input using a specified format. Learn more about custom tools
name: string The name of the custom tool, used to identify it in tool calls.
type: "custom" (default: "custom") The type of the custom tool. Always custom.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" async: optional boolean Whether the tool response can be returned asynchronously versus immediately returned on next response creation.
defer_loading: optional boolean Whether this tool should be deferred and discovered via tool search.
description: optional string Optional description of the custom tool, used to provide more context.
format: optional Text or Grammar The input format for the custom tool. Default is unconstrained text.
One of the following: Text { type } Unconstrained free-form text.
type: "text" (default: "text") Unconstrained text format. Always text.
Grammar { definition, syntax, type } A grammar defined by the user.
definition: string The grammar definition.
syntax: "lark" or "regex" The syntax of the grammar definition. One of lark or regex.
One of the following: "lark" "regex" type: "grammar" (default: "grammar") Grammar format. Always grammar.
Namespace { description, name, tools, type } Groups function/custom tools under a shared namespace.
description: string A description of the namespace shown to the model.
name: string The namespace name used in tool calls (for example, crm).
minLength1 tools: array of Function or Custom The function/custom tools available inside this namespace.
minItems1 One of the following: Function { name, type, allowed_callers, 6 more } name: string pattern^[a-zA-Z0-9_-]+$ minLength1 maxLength128 type: "function" (default: "function") allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" async: optional boolean Whether the tool response can be returned asynchronously versus immediately returned on next response creation.
defer_loading: optional boolean Whether this function should be deferred and discovered via tool search.
description: optional string or null output_schema: optional map[unknown] or null A JSON Schema describing the JSON value encoded in string outputs for this function tool. This does not describe content-array outputs.
parameters: optional unknown or null strict: optional boolean or null Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise.
Custom { name, type, allowed_callers, 4 more } A custom tool that processes input using a specified format. Learn more about custom tools
name: string The name of the custom tool, used to identify it in tool calls.
type: "custom" (default: "custom") The type of the custom tool. Always custom.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" async: optional boolean Whether the tool response can be returned asynchronously versus immediately returned on next response creation.
defer_loading: optional boolean Whether this tool should be deferred and discovered via tool search.
description: optional string Optional description of the custom tool, used to provide more context.
format: optional Text or Grammar The input format for the custom tool. Default is unconstrained text.
One of the following: Text { type } Unconstrained free-form text.
type: "text" (default: "text") Unconstrained text format. Always text.
Grammar { definition, syntax, type } A grammar defined by the user.
definition: string The grammar definition.
syntax: "lark" or "regex" The syntax of the grammar definition. One of lark or regex.
One of the following: "lark" "regex" type: "grammar" (default: "grammar") Grammar format. Always grammar.
type: "namespace" (default: "namespace") The type of the tool. Always namespace.
ToolSearch { type, description, execution, parameters } Hosted or BYOT tool search configuration for deferred tools.
type: "tool_search" (default: "tool_search") The type of the tool. Always tool_search.
description: optional string or null Description shown to the model for a client-executed tool search tool.
execution: optional "server" or "client" Whether tool search is executed by the server or by the client.
One of the following: "server" "client" parameters: optional unknown or null Parameter schema for a client-executed tool search tool.
WebSearchPreview { type, search_content_types, search_context_size, user_location } This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
type: "web_search_preview" or "web_search_preview_2025_03_11" (default: "web_search_preview") The type of the web search tool. One of web_search_preview or web_search_preview_2025_03_11.
One of the following: "web_search_preview" "web_search_preview_2025_03_11" search_content_types: optional array of "text" or "image" One of the following: "text" "image" search_context_size: optional "low" or "medium" or "high" High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.
One of the following: "low" "medium" "high" user_location: optional object or null The approximate location of the user. If omitted or null, defaults to the United States. To avoid this fallback, pass {"type": "approximate"} without location fields. To localize results, provide the relevant location fields.
type: "approximate" (default: "approximate") The type of location approximation. Always approximate.
city: optional string or null Free text input for the city of the user, e.g. San Francisco.
country: optional string or null The two-letter ISO country code of the user, e.g. US.
region: optional string or null Free text input for the region of the user, e.g. California.
timezone: optional string or null The IANA timezone of the user, e.g. America/Los_Angeles.
ApplyPatch { type, allowed_callers } Allows the assistant to create, delete, or update files using unified diffs.
type: "apply_patch" (default: "apply_patch") The type of the tool. Always apply_patch.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" type: "additional_tools" (default: "additional_tools") The type of the item. Always additional_tools.
agent: optional { agent_name } The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
Compaction { id, encrypted_content, type, 2 more } A compaction item generated by the v1/responses/compact API.
id: string The unique ID of the compaction item.
encrypted_content: string The encrypted content that was produced by compaction.
type: "compaction" (default: "compaction") The type of the item. Always compaction.
agent: optional { agent_name } The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
created_by: optional string The identifier of the actor that created the item.
ImageGenerationCall { id, result, status, 10 more } An image generation request made by the model.
id: string The unique ID of the image generation call.
result: string or null The generated image encoded in base64.
status: "in_progress" or "completed" or "generating" or "failed" The status of the image generation call.
One of the following: "in_progress" "completed" "generating" "failed" type: "image_generation_call" The type of the image generation call. Always image_generation_call.
action: optional "generate" or "edit" or "auto" or null The action used for image generation.
One of the following: "generate" "edit" "auto" agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
background: optional "transparent" or "opaque" or "auto" or null The background setting used for generation.
One of the following: "transparent" "opaque" "auto" error: optional { code, message, param, 2 more } Details of a moderation failure, when available.
code: string or null The error code.
message: string A description of the error.
param: string or null The related request parameter.
type: string The error type.
moderation_details: optional { categories, moderation_stage } Public details for a moderation_blocked error, when available.
categories: array of string Public moderation categories. New category values may be added over time.
moderation_stage: "input" or "output" or "unknown" The stage where moderation blocked the image generation call.
One of the following: "input" "output" "unknown" output_format: optional "png" or "webp" or "jpeg" or 2 more or null The output format used for generation.
One of the following: "png" "webp" "jpeg" "gif" "svg" quality: optional "low" or "medium" or "high" or 3 more or null The quality of the image generated by the image generation tool call. One of low, medium, high, xhigh, max, or auto.
One of the following: "low" "medium" "high" "xhigh" "max" "auto" revised_prompt: optional string or null The prompt that was used after any model prompt rewriting.
size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or null The image dimensions as a WIDTHxHEIGHT string, for example 1536x864.
One of the following: string "1024x1024" or "1024x1536" or "1536x1024" The image dimensions as a WIDTHxHEIGHT string, for example 1536x864.
One of the following: "1024x1024" "1024x1536" "1536x1024" svg_usage: optional { input_tokens, model, output_tokens, 2 more } input_tokens: integer model: string output_tokens: integer reasoning_tokens: integer total_tokens: integer CodeInterpreterCall { id, code, container_id, 4 more } A tool call to run code.
id: string The unique ID of the code interpreter tool call.
code: string or null The code to run, or null if not available.
container_id: string The ID of the container used to run the code.
outputs: array of Logs or Image or null The outputs generated by the code interpreter, such as logs or images.
Can be null if no outputs are available.
One of the following: Logs { logs, type } The logs output from the code interpreter.
logs: string The logs output from the code interpreter.
type: "logs" (default: "logs") The type of the output. Always logs.
Image { type, url } The image output from the code interpreter.
type: "image" (default: "image") The type of the output. Always image.
url: string The URL of the image output from the code interpreter.
formaturi status: "in_progress" or "completed" or "incomplete" or 2 more The status of the code interpreter tool call. Valid values are in_progress, completed, incomplete, interpreting, and failed.
One of the following: "in_progress" "completed" "incomplete" "interpreting" "failed" type: "code_interpreter_call" (default: "code_interpreter_call") The type of the code interpreter tool call. Always code_interpreter_call.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
LocalShellCall { id, action, call_id, 3 more } A tool call to run a command on the local shell.
id: string The unique ID of the local shell call.
action: { command, env, type, 3 more } Execute a shell command on the server.
command: array of string The command to run.
env: map[string] Environment variables to set for the command.
type: "exec" (default: "exec") The type of the local shell action. Always exec.
timeout_ms: optional integer or null Optional timeout in milliseconds for the command.
user: optional string or null Optional user to run the command as.
working_directory: optional string or null Optional working directory to run the command in.
call_id: string The unique ID of the local shell tool call generated by the model.
status: "in_progress" or "completed" or "incomplete" The status of the local shell call.
One of the following: "in_progress" "completed" "incomplete" type: "local_shell_call" The type of the local shell call. Always local_shell_call.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
LocalShellCallOutput { id, output, type, 2 more } The output of a local shell tool call.
id: string The unique ID of the local shell tool call generated by the model.
output: string A JSON string of the output of the local shell tool call.
type: "local_shell_call_output" The type of the local shell tool call output. Always local_shell_call_output.
agent: optional object or null 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" or null The status of the item. One of in_progress, completed, or incomplete.
One of the following: "in_progress" "completed" "incomplete" ShellCall { id, action, call_id, 6 more } A tool call that executes one or more shell commands in a managed environment.
id: string The unique ID of the shell tool call. Populated when this item is returned via API.
action: { commands, max_output_length, timeout_ms } The shell commands and limits that describe how to run the tool call.
commands: array of string max_output_length: integer or null Optional maximum number of characters to return from each command.
timeout_ms: integer or null Optional timeout in milliseconds for the commands.
call_id: string The unique ID of the shell tool call generated by the model.
environment: BetaResponseLocalEnvironment or BetaResponseContainerReference or null Represents the use of a local environment to perform shell actions.
One of the following: BetaResponseLocalEnvironment { type } Represents the use of a local environment to perform shell actions.
type: "local" (default: "local") The environment type. Always local.
BetaResponseContainerReference { container_id, type } Represents a container created with /v1/containers.
container_id: string type: "container_reference" (default: "container_reference") The environment type. Always container_reference.
status: "in_progress" or "completed" or "incomplete" The status of the shell call. One of in_progress, completed, or incomplete.
One of the following: "in_progress" "completed" "incomplete" type: "shell_call" (default: "shell_call") The type of the item. Always shell_call.
agent: optional { agent_name } The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
caller: optional Direct or Program or null The execution context that produced this tool call.
One of the following: Direct { type } type: "direct" (default: "direct") Program { caller_id, type } caller_id: string The call ID of the program item that produced this tool call.
type: "program" (default: "program") created_by: optional string The ID of the entity that created this tool call.
ShellCallOutput { id, call_id, max_output_length, 6 more } The output of a shell tool call that was emitted.
id: string The unique ID of the shell call output. Populated when this item is returned via API.
call_id: string The unique ID of the shell tool call generated by the model.
max_output_length: integer or null The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output.
output: array of { outcome, stderr, stdout, created_by } An array of shell call output contents
outcome: Timeout or Exit Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk.
One of the following: Timeout { type } Indicates that the shell call exceeded its configured time limit.
type: "timeout" (default: "timeout") The outcome type. Always timeout.
Exit { exit_code, type } Indicates that the shell commands finished and returned an exit code.
exit_code: integer Exit code from the shell process.
type: "exit" (default: "exit") The outcome type. Always exit.
stderr: string The standard error output that was captured.
stdout: string The standard output that was captured.
created_by: optional string The identifier of the actor that created the item.
status: "in_progress" or "completed" or "incomplete" The status of the shell call output. One of in_progress, completed, or incomplete.
One of the following: "in_progress" "completed" "incomplete" type: "shell_call_output" (default: "shell_call_output") The type of the shell call output. Always shell_call_output.
agent: optional { agent_name } The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
caller: optional Direct or Program or null The execution context that produced this tool call.
One of the following: Direct { type } type: "direct" (default: "direct") Program { caller_id, type } caller_id: string The call ID of the program item that produced this tool call.
type: "program" (default: "program") created_by: optional string The identifier of the actor that created the item.
ApplyPatchCall { id, call_id, operation, 5 more } A tool call that applies file diffs by creating, deleting, or updating files.
id: string The unique ID of the apply patch tool call. Populated when this item is returned via API.
call_id: string The unique ID of the apply patch tool call generated by the model.
operation: CreateFile or DeleteFile or UpdateFile One of the create_file, delete_file, or update_file operations applied via apply_patch.
One of the following: CreateFile { diff, path, type } Instruction describing how to create a file via the apply_patch tool.
diff: string Diff to apply.
path: string Path of the file to create.
type: "create_file" (default: "create_file") Create a new file with the provided diff.
DeleteFile { path, type } Instruction describing how to delete a file via the apply_patch tool.
path: string Path of the file to delete.
type: "delete_file" (default: "delete_file") Delete the specified file.
UpdateFile { diff, path, type } Instruction describing how to update a file via the apply_patch tool.
diff: string Diff to apply.
path: string Path of the file to update.
type: "update_file" (default: "update_file") Update an existing file with the provided diff.
status: "in_progress" or "completed" The status of the apply patch tool call. One of in_progress or completed.
One of the following: "in_progress" "completed" type: "apply_patch_call" (default: "apply_patch_call") The type of the item. Always apply_patch_call.
agent: optional { agent_name } The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
caller: optional Direct or Program or null The execution context that produced this tool call.
One of the following: Direct { type } type: "direct" (default: "direct") Program { caller_id, type } caller_id: string The call ID of the program item that produced this tool call.
type: "program" (default: "program") created_by: optional string The ID of the entity that created this tool call.
ApplyPatchCallOutput { id, call_id, status, 5 more } The output emitted by an apply patch tool call.
id: string The unique ID of the apply patch tool call output. Populated when this item is returned via API.
call_id: string The unique ID of the apply patch tool call generated by the model.
status: "completed" or "failed" The status of the apply patch tool call output. One of completed or failed.
One of the following: "completed" "failed" type: "apply_patch_call_output" (default: "apply_patch_call_output") The type of the item. Always apply_patch_call_output.
agent: optional { agent_name } The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
caller: optional Direct or Program or null The execution context that produced this tool call.
One of the following: Direct { type } type: "direct" (default: "direct") Program { caller_id, type } caller_id: string The call ID of the program item that produced this tool call.
type: "program" (default: "program") created_by: optional string The ID of the entity that created this tool call output.
output: optional string or null Optional textual output returned by the apply patch tool.
McpCall { id, arguments, name, 7 more } An invocation of a tool on an MCP server.
id: string The unique ID of the tool call.
arguments: string A JSON string of the arguments passed to the tool.
name: string The name of the tool that was run.
server_label: string The label of the MCP server running the tool.
type: "mcp_call" The type of the item. Always mcp_call.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
approval_request_id: optional string or null Unique identifier for the MCP tool call approval request.
Include this value in a subsequent mcp_approval_response input to approve or reject the corresponding tool call.
error: optional BetaMcpToolCallError or null The error from the tool call, if any.
One of the following: McpProtocolError { code, message, type } code: integer message: string type: "mcp_protocol_error" (default: "mcp_protocol_error") McpToolExecutionError { content, type } content: unknown type: "mcp_tool_execution_error" (default: "mcp_tool_execution_error") HTTPError { code, message, type } code: integer message: string type: "http_error" (default: "http_error") output: optional string or null The output from the tool call.
status: optional "in_progress" or "completed" or "incomplete" or 2 more The status of the tool call. One of in_progress, completed, incomplete, calling, or failed.
One of the following: "in_progress" "completed" "incomplete" "calling" "failed" McpListTools { id, server_label, tools, 3 more } A list of tools available on an MCP server.
id: string The unique ID of the list.
server_label: string The label of the MCP server.
tools: array of { input_schema, name, annotations, description } The tools available on the server.
input_schema: unknown The JSON schema describing the tool’s input.
name: string The name of the tool.
annotations: optional unknown or null Additional annotations about the tool.
description: optional string or null The description of the tool.
type: "mcp_list_tools" The type of the item. Always mcp_list_tools.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
error: optional string or null Error message if the server could not list tools.
McpApprovalRequest { id, arguments, name, 3 more } A request for human approval of a tool invocation.
id: string The unique ID of the approval request.
arguments: string A JSON string of arguments for the tool.
name: string The name of the tool to run.
server_label: string The label of the MCP server making the request.
type: "mcp_approval_request" The type of the item. Always mcp_approval_request.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
McpApprovalResponse { id, approval_request_id, approve, 3 more } A response to an MCP approval request.
id: string The unique ID of the approval response
approval_request_id: string The ID of the approval request being answered.
approve: boolean Whether the request was approved.
type: "mcp_approval_response" The type of the item. Always mcp_approval_response.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
reason: optional string or null Optional reason for the decision.
CustomToolCall { call_id, input, name, 6 more } A call to a custom tool created by the model.
call_id: string An identifier used to map this custom tool call to a tool call output.
input: string The input for the custom tool call generated by the model.
name: string The name of the custom tool being called.
type: "custom_tool_call" The type of the custom tool call. Always custom_tool_call.
id: optional string The unique ID of the custom tool call in the OpenAI platform.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
async: optional boolean Whether the custom tool call runs asynchronously.
caller: optional Direct or Program or null The execution context that produced this tool call.
One of the following: Direct { type } type: "direct" (default: "direct") Program { caller_id, type } caller_id: string The call ID of the program item that produced this tool call.
type: "program" (default: "program") namespace: optional string The namespace of the custom tool being called.
CustomToolCallOutput { id, call_id, output, 5 more } id: string The unique ID of the custom tool call output item.
call_id: string The call ID, used to map this custom tool call output to a custom tool call.
output: string or array of BetaResponseInputText or BetaResponseInputImage or BetaResponseInputFile The output from the custom tool call generated by your code.
Can be a string or an list of output content.
One of the following: StringOutput = string A string of the output of the custom tool call.
OutputContentList = array of BetaResponseInputText or BetaResponseInputImage or BetaResponseInputFile Text, image, or file output of the custom tool call.
One of the following: BetaResponseInputText { text, type, prompt_cache_breakpoint } A text input to the model.
text: string The text input to the model.
type: "input_text" (default: "input_text") The type of the input item. Always input_text.
prompt_cache_breakpoint: optional { mode, ttl } Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.
mode: "explicit" (default: "explicit") The breakpoint mode. Always explicit.
ttl: optional "30m" or "12h" The minimum lifetime of this cache breakpoint. Defaults to the request TTL.
One of the following: "30m" "12h" BetaResponseInputImage { detail, type, file_id, 2 more } An image input to the model. Learn about image inputs.
detail: BetaImageDetail 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" (default: "input_image") The type of the input item. Always input_image.
file_id: optional string or null The ID of the file to be sent to the model.
image_url: optional string or null 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: optional { mode, ttl } Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.
mode: "explicit" (default: "explicit") The breakpoint mode. Always explicit.
ttl: optional "30m" or "12h" The minimum lifetime of this cache breakpoint. Defaults to the request TTL.
One of the following: "30m" "12h" BetaResponseInputFile { type, detail, file_data, 4 more } A file input to the model.
type: "input_file" (default: "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.
One of the following: "auto" "low" "high" file_data: optional string The content of the file to be sent to the model.
file_id: optional string or null 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.
formaturi filename: optional string The name of the file to be sent to the model.
prompt_cache_breakpoint: optional { mode, ttl } Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.
mode: "explicit" (default: "explicit") The breakpoint mode. Always explicit.
ttl: optional "30m" or "12h" The minimum lifetime of this cache breakpoint. Defaults to the request TTL.
One of the following: "30m" "12h" 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.
One of the following: "in_progress" "completed" "incomplete" type: "custom_tool_call_output" The type of the custom tool call output. Always custom_tool_call_output.
agent: optional object or null The agent that produced this item.
agent_name: string The canonical name of the agent that produced this item.
caller: optional Direct or Program or null The execution context that produced this tool call.
One of the following: Direct { type } type: "direct" (default: "direct") The caller type. Always direct.
Program { caller_id, type } caller_id: string The call ID of the program item that produced this tool call.
minLength1 maxLength64 type: "program" (default: "program") The caller type. Always program.
created_by: optional string The identifier of the actor that created the item.
parallel_tool_calls: boolean (default: true) Whether to allow the model to run tool calls in parallel.
temperature: number or null (default: 1) What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.
We generally recommend altering this or top_p but not both.
minimum0 maximum2 tool_choice: BetaToolChoiceOptions or BetaToolChoiceAllowed or BetaToolChoiceTypes or 6 more How the model should select which tool (or tools) to use when generating
a response. See the tools parameter to see how to specify which tools
the model can call.
One of the following: BetaToolChoiceOptions = "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.
One of the following: "none" "auto" "required" BetaToolChoiceAllowed { mode, tools, type } Constrains the tools available to the model to a pre-defined set.
mode: "auto" or "required" Constrains the tools available to the model to a pre-defined set.
auto allows the model to pick from among the allowed tools and generate a
message.
required requires the model to call one or more of the allowed tools.
One of the following: "auto" "required" tools: array of map[unknown] A list of tool definitions that the model should be allowed to call.
For the Responses API, the list of tool definitions might look like:
[
{ "type": "function", "name": "get_weather" },
{ "type": "mcp", "server_label": "deepwiki" },
{ "type": "image_generation" }
]
type: "allowed_tools" Allowed tool configuration type. Always allowed_tools.
BetaToolChoiceTypes { type } Indicates that the model should use a built-in tool to generate a response.
Learn more about built-in tools.
type: "file_search" or "web_search_preview" or "computer" or 5 more The type of hosted tool the model should to use. Learn more about
built-in tools.
Allowed values are:
file_search
web_search_preview
computer
computer_use_preview
computer_use
code_interpreter
image_generation
One of the following: "file_search" "web_search_preview" "computer" "computer_use_preview" "computer_use" "web_search_preview_2025_03_11" "image_generation" "code_interpreter" BetaToolChoiceFunction { name, type } Use this option to force the model to call a specific function.
name: string The name of the function to call.
type: "function" For function calling, the type is always function.
BetaToolChoiceMcp { server_label, type, name } Use this option to force the model to call a specific tool on a remote MCP server.
server_label: string The label of the MCP server to use.
type: "mcp" For MCP tools, the type is always mcp.
name: optional string or null The name of the tool to call on the server.
BetaToolChoiceCustom { name, type } Use this option to force the model to call a specific custom tool.
name: string The name of the custom tool to call.
type: "custom" For custom tool calling, the type is always custom.
BetaSpecificProgrammaticToolCallingParam { type } type: "programmatic_tool_calling" (default: "programmatic_tool_calling") The tool to call. Always programmatic_tool_calling.
BetaToolChoiceApplyPatch { type } Forces the model to call the apply_patch tool when executing a tool call.
type: "apply_patch" (default: "apply_patch") The tool to call. Always apply_patch.
BetaToolChoiceShell { type } Forces the model to call the shell tool when a tool call is required.
type: "shell" (default: "shell") The tool to call. Always shell.
tools: array of Function or FileSearch or Computer or 13 more An array of tools the model may call while generating a response. You
can specify which tool to use by setting the tool_choice parameter.
We support the following categories of tools:
Built-in tools: Tools that are provided by OpenAI that extend the
model’s capabilities, like web search
or file search. Learn more about
built-in tools.
MCP Tools: Integrations with third-party systems via custom MCP servers
or predefined connectors such as Google Drive and SharePoint. Learn more about
MCP Tools.
Function calls (custom tools): Functions that are defined by you,
enabling the model to call your own code with strongly typed arguments
and outputs. Learn more about
function calling. You can also use
custom tools to call your own code.
One of the following: Function { name, parameters, strict, 6 more } Defines a function in your own code the model can choose to call. Learn more about function calling.
name: string The name of the function to call.
parameters: map[unknown] or null A JSON schema object describing the parameters of the function.
strict: boolean or null Whether strict parameter validation is enforced for this function tool.
type: "function" (default: "function") The type of the function tool. Always function.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
One of the following: "direct" "programmatic" async: optional boolean defer_loading: optional boolean Whether this function is deferred and loaded via tool search.
description: optional string or null A description of the function. Used by the model to determine whether or not to call the function.
output_schema: optional map[unknown] or null A JSON schema object describing the JSON value encoded in string outputs for this function.
FileSearch { type, vector_store_ids, filters, 2 more } A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
type: "file_search" (default: "file_search") The type of the file search tool. Always file_search.
vector_store_ids: array of string The IDs of the vector stores to search.
filters: optional ComparisonFilter or unknown or null A filter to apply.
One of the following: ComparisonFilter { key, type, value } A filter used to compare a specified attribute key to a given value using a defined comparison operation.
key: string The key to compare against the value.
type: "eq" or "ne" or "gt" or 5 more (default: "eq") Specifies the comparison operator: eq, ne, gt, gte, lt, lte, in, nin.
eq: equals
ne: not equal
gt: greater than
gte: greater than or equal
lt: less than
lte: less than or equal
in: in
nin: not in
One of the following: "eq" "ne" "gt" "gte" "lt" "lte" "in" "nin" value: string or number or boolean or array of string or number The value to compare against the attribute key; supports string, number, or boolean types.
One of the following: string number boolean array of string or number One of the following: string number BetaCompoundFilter = unknown Combine multiple filters using and or or.
max_num_results: optional integer The maximum number of results to return. This number should be between 1 and 50 inclusive.
ranking_options: optional { hybrid_search, ranker, score_threshold } Ranking options for search.
hybrid_search: optional { embedding_weight, text_weight } Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled.
embedding_weight: number The weight of the embedding in the reciprocal ranking fusion.
text_weight: number The weight of the text in the reciprocal ranking fusion.
ranker: optional "auto" or "default-2024-11-15" The ranker to use for the file search.
One of the following: "auto" "default-2024-11-15" score_threshold: optional number The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.
Computer { type } A tool that controls a virtual computer. Learn more about the computer tool.
type: "computer" (default: "computer") The type of the computer tool. Always computer.
ComputerUsePreview { display_height, display_width, environment, type } A tool that controls a virtual computer. Learn more about the computer tool.
display_height: integer The height of the computer display.
display_width: integer The width of the computer display.
environment: "windows" or "mac" or "linux" or 2 more The type of computer environment to control.
One of the following: "windows" "mac" "linux" "ubuntu" "browser" type: "computer_use_preview" (default: "computer_use_preview") The type of the computer use tool. Always computer_use_preview.
WebSearch { type, external_web_access, filters, 2 more } Search the Internet for sources related to the prompt. Learn more about the
web search tool.
type: "web_search" or "web_search_2025_08_26" (default: "web_search") The type of the web search tool. One of web_search or web_search_2025_08_26.
One of the following: "web_search" "web_search_2025_08_26" external_web_access: optional boolean (default: true) Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.
filters: optional object or null Filters for the search.
allowed_domains: optional array of string or null (default: []) Allowed domains for the search. If not provided, all domains are allowed.
Subdomains of the provided domains are allowed as well.
Example: ["pubmed.ncbi.nlm.nih.gov"]
search_context_size: optional "low" or "medium" or "high" (default: "medium") High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.
One of the following: "low" "medium" "high" user_location: optional object or null The approximate location of the user. If omitted or null, defaults to the
United States. To avoid this fallback, pass {"type": "approximate"} without
location fields. To localize results, provide the relevant location fields.
city: optional string or null Free text input for the city of the user, e.g. San Francisco.
country: optional string or null The two-letter ISO country code of the user, e.g. US.
region: optional string or null Free text input for the region of the user, e.g. California.
timezone: optional string or null The IANA timezone of the user, e.g. America/Los_Angeles.
type: optional "approximate" (default: "approximate") The type of location approximation. Always approximate.
Mcp { server_label, type, allowed_callers, 9 more } Give the model access to additional tools via remote Model Context Protocol
(MCP) servers. Learn more about MCP.
server_label: string A label for this MCP server, used to identify it in tool calls.
type: "mcp" The type of the MCP tool. Always mcp.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" allowed_tools: optional array of string or McpToolFilter or null List of allowed tool names or a filter object.
One of the following: McpAllowedTools = array of string A string array of allowed tool names
McpToolFilter { read_only, tool_names } A filter object to specify which tools are allowed.
read_only: optional boolean Indicates whether or not a tool modifies data or is read-only. If an
MCP server is annotated with readOnlyHint,
it will match this filter.
tool_names: optional array of string List of allowed tool names.
authorization: optional string An OAuth access token that can be used with a remote MCP server, either
with a custom MCP server URL or a service connector. Your application
must handle the OAuth authorization flow and provide the token here.
connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more Deprecated.
Identifier for service connectors, like those available in ChatGPT. One of
server_url, connector_id, or tunnel_id must be provided. Learn more
about service connectors here.
This field is deprecated for models released after September 1, 2026.
Use server_url to connect to a remote MCP server, or tunnel_id to
connect through a Secure MCP Tunnel.
Currently supported connector_id values are:
Dropbox: connector_dropbox
Gmail: connector_gmail
Google Calendar: connector_googlecalendar
Google Drive: connector_googledrive
Microsoft Teams: connector_microsoftteams
Outlook Calendar: connector_outlookcalendar
Outlook Email: connector_outlookemail
SharePoint: connector_sharepoint
One of the following: "connector_dropbox" "connector_gmail" "connector_googlecalendar" "connector_googledrive" "connector_microsoftteams" "connector_outlookcalendar" "connector_outlookemail" "connector_sharepoint" defer_loading: optional boolean Whether this MCP tool is deferred and discovered via tool search.
headers: optional map[string] or null Optional HTTP headers to send to the MCP server. Use for authentication
or other purposes.
require_approval: optional McpToolApprovalFilter or "always" or "never" or null (default: "always") Specify which of the MCP server’s tools require approval.
One of the following: McpToolApprovalFilter { always, never } Specify which of the MCP server’s tools require approval. Can be
always, never, or a filter object associated with tools
that require approval.
always: optional { read_only, tool_names } A filter object to specify which tools are allowed.
read_only: optional boolean Indicates whether or not a tool modifies data or is read-only. If an
MCP server is annotated with readOnlyHint,
it will match this filter.
tool_names: optional array of string List of allowed tool names.
never: optional { read_only, tool_names } A filter object to specify which tools are allowed.
read_only: optional boolean Indicates whether or not a tool modifies data or is read-only. If an
MCP server is annotated with readOnlyHint,
it will match this filter.
tool_names: optional array of string List of allowed tool names.
McpToolApprovalSetting = "always" or "never" Specify a single approval policy for all tools. One of always or
never. When set to always, all tools will require approval. When
set to never, all tools will not require approval.
One of the following: "always" "never" server_description: optional string Optional description of the MCP server, used to provide more context.
server_url: optional string The URL for the MCP server. One of server_url, connector_id, or
tunnel_id must be provided.
formaturi tunnel_id: optional string The Secure MCP Tunnel ID to use instead of a direct server URL. One of
server_url, connector_id, or tunnel_id must be provided.
pattern^tunnel_[a-z0-9]{32}$ CodeInterpreter { container, type, allowed_callers } A tool that runs Python code to help generate a response to a prompt.
container: string or CodeInterpreterToolAuto The code interpreter container. Can be a container ID or an object that
specifies uploaded file IDs to make available to your code, along with an
optional memory_limit setting.
One of the following: string The container ID.
CodeInterpreterToolAuto { type, file_ids, memory_limit, network_policy } Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.
type: "auto" (default: "auto") Always auto.
file_ids: optional array of string An optional list of uploaded files to make available to your code.
maxItems50 memory_limit: optional "1g" or "4g" or "16g" or "64g" or null The memory limit for the code interpreter container.
One of the following: "1g" "4g" "16g" "64g" network_policy: optional BetaContainerNetworkPolicyDisabled or BetaContainerNetworkPolicyAllowlist Network access policy for the container.
One of the following: BetaContainerNetworkPolicyDisabled { type } type: "disabled" (default: "disabled") Disable outbound network access. Always disabled.
BetaContainerNetworkPolicyAllowlist { allowed_domains, type, domain_secrets } allowed_domains: array of string A list of allowed domains when type is allowlist.
minItems1 type: "allowlist" (default: "allowlist") Allow outbound network access only to specified domains. Always allowlist.
domain_secrets: optional array of BetaContainerNetworkPolicyDomainSecret { domain, name, value } Optional domain-scoped secrets for allowlisted domains.
minItems1 domain: string The domain associated with the secret.
minLength1 name: string The name of the secret to inject for the domain.
minLength1 value: string The secret value to inject for the domain.
minLength1 maxLength10485760 type: "code_interpreter" The type of the code interpreter tool. Always code_interpreter.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" ProgrammaticToolCalling { type } type: "programmatic_tool_calling" (default: "programmatic_tool_calling") The type of the tool. Always programmatic_tool_calling.
ImageGeneration { type, action, background, 13 more } A tool that generates images using the GPT image models.
type: "image_generation" The type of the image generation tool. Always image_generation.
action: optional "generate" or "edit" or "auto" Whether to generate a new image or edit an existing image. Default: auto.
One of the following: "generate" "edit" "auto" background: optional "transparent" or "opaque" or "auto" (default: "auto") Set the background of the generated image. One of transparent, opaque,
or auto. gpt-image-2.5-sunburst and gpt-image-2.5-flare, including
their 2026-09-08 snapshots, support opaque and transparent
backgrounds. Transparent backgrounds are available for supported GPT Image
models. For gpt-image-2 and gpt-image-2-2026-04-21, this support is in
preview. When using transparent, set the output format to png or webp.
Default: auto.
One of the following: "transparent" "opaque" "auto" complexity: optional "low" or "medium" or "high" Computation spent planning the image, independently of rendering quality.
Overrides the outer response’s reasoning.effort for image generation.
When omitted, inherits a supported outer reasoning effort or uses the
image model’s configured default.
For SVG output, controls the reference image, not the SVG author’s
reasoning.
One of the following: "low" "medium" "high" frame_count: optional integer (default: 9) Number of GIF frames. Requires output_format to be gif. Default: 9.
minimum2 maximum16 frame_duration_ms: optional integer (default: 200) Duration of each GIF frame in milliseconds, rounded to 10 ms.
Requires output_format to be gif. Default: 200.
minimum20 maximum2000 input_fidelity: optional "high" or "low" or null Control how much effort the model will exert to match the style and features, especially facial features, of input images. Supports high and low on gpt-image-1.5; gpt-image-1-mini supports only low. For gpt-image-2, omit this parameter. Defaults to low on supported models.
One of the following: "high" "low" input_image_mask: optional { file_id, image_url } Optional mask for inpainting. Contains image_url
(string, optional) and file_id (string, optional).
file_id: optional string File ID for the mask image.
image_url: optional string Base64-encoded mask image.
model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-2" or 9 more The image generation model to use. One of gpt-image-1-mini,
gpt-image-1.5, gpt-image-2,
gpt-image-2-2026-04-21, gpt-image-2.5-sunburst,
gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare,
gpt-image-2.5-flare-2026-09-08, gpt-image-2.6-sunburst,
gpt-image-2.6-flare, or chatgpt-image-latest. Default:
gpt-image-2.6-sunburst.
gpt-image-1 was shut down on October 23, 2026. Use
gpt-image-2.5-sunburst or gpt-image-2.5-flare instead.
One of the following: string "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-2" or 9 more The image generation model to use. One of gpt-image-1-mini,
gpt-image-1.5, gpt-image-2,
gpt-image-2-2026-04-21, gpt-image-2.5-sunburst,
gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare,
gpt-image-2.5-flare-2026-09-08, gpt-image-2.6-sunburst,
gpt-image-2.6-flare, or chatgpt-image-latest. Default:
gpt-image-2.6-sunburst.
gpt-image-1 was shut down on October 23, 2026. Use
gpt-image-2.5-sunburst or gpt-image-2.5-flare instead.
One of the following: "gpt-image-1-mini" "gpt-image-2" "gpt-image-2-2026-04-21" "gpt-image-2.5-sunburst" "gpt-image-2.5-sunburst-2026-09-08" "gpt-image-2.5-flare" "gpt-image-2.5-flare-2026-09-08" "gpt-image-2.6-sunburst" "gpt-image-2.6-flare" "gpt-image-1.5" "chatgpt-image-latest" "gpt-image-1" Deprecated. GPT Image 1 was shut down on October 23, 2026. Use gpt-image-2.5-sunburst or gpt-image-2.5-flare instead.
moderation: optional "auto" or "low" (default: "auto") Moderation level for the generated image. Default: auto.
One of the following: "auto" "low" output_compression: optional integer (default: 100) Compression level for the output image. Default: 100.
minimum0 maximum100 output_format: optional "png" or "webp" or "jpeg" or 2 more (default: "png") The output format of the generated image. One of png, webp, jpeg,
gif, or svg. Default: png. GIF and SVG output require a model
that supports the selected format. GIF output does not support
partial image streaming (partial_images greater than 0),
input_image_mask, or custom output_compression.
Responses lifecycle events can still be streamed for GIF output.
One of the following: "png" "webp" "jpeg" "gif" "svg" partial_images: optional integer (default: 0) Number of partial images to generate in streaming mode, from 0 (default value) to 3.
minimum0 maximum3 quality: optional "low" or "medium" or "high" or 3 more (default: "auto") The quality of the generated image. The GPT image models support low,
medium, and high. gpt-image-2.5-sunburst and gpt-image-2.5-flare,
including their 2026-09-08 snapshots, also support xhigh and max.
Default: auto.
One of the following: "low" "medium" "high" "xhigh" "max" "auto" size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto" (default: "auto") The size of the generated images. For gpt-image-2, gpt-image-2-2026-04-21, gpt-image-2.5-sunburst, gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare, and gpt-image-2.5-flare-2026-09-08, arbitrary resolutions are supported as WIDTHxHEIGHT strings, for example 1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above 2560x1440 are experimental, and the maximum supported resolution is 3840x2160. The requested size must also satisfy the model’s current pixel and edge limits. The standard sizes 1024x1024, 1536x1024, and 1024x1536 are supported by the GPT image models; auto is supported for models that allow automatic sizing.
One of the following: string "1024x1024" or "1024x1536" or "1536x1024" or "auto" The size of the generated images. For gpt-image-2, gpt-image-2-2026-04-21, gpt-image-2.5-sunburst, gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare, and gpt-image-2.5-flare-2026-09-08, arbitrary resolutions are supported as WIDTHxHEIGHT strings, for example 1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above 2560x1440 are experimental, and the maximum supported resolution is 3840x2160. The requested size must also satisfy the model’s current pixel and edge limits. The standard sizes 1024x1024, 1536x1024, and 1024x1536 are supported by the GPT image models; auto is supported for models that allow automatic sizing.
One of the following: "1024x1024" "1024x1536" "1536x1024" "auto" svg: optional { model, reasoning } SVG author model settings. Requires output_format to be svg.
When SVG model selection is enabled, omitting this object uses the
outer response model. Otherwise, the default SVG author is used and
explicit model overrides are unavailable.
model: optional string minLength1 reasoning: optional object or null Reasoning effort for SVG authoring. When omitted, uses the author model’s default in both Images and Responses.
effort: optional "none" or "minimal" or "low" or 4 more Controls how much effort the model should spend on reasoning for this request.
One of the following: "none" "minimal" "low" "medium" "high" "xhigh" "max" LocalShell { type } A tool that allows the model to execute shell commands in a local environment.
type: "local_shell" (default: "local_shell") The type of the local shell tool. Always local_shell.
Shell { type, allowed_callers, environment } A tool that allows the model to execute shell commands.
type: "shell" (default: "shell") The type of the shell tool. Always shell.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" environment: optional BetaContainerAuto or BetaLocalEnvironment or BetaContainerReference or null One of the following: BetaContainerAuto { type, file_ids, memory_limit, 2 more } type: "container_auto" (default: "container_auto") Automatically creates a container for this request
file_ids: optional array of string An optional list of uploaded files to make available to your code.
maxItems50 memory_limit: optional "1g" or "4g" or "16g" or "64g" or null The memory limit for the container.
One of the following: "1g" "4g" "16g" "64g" network_policy: optional BetaContainerNetworkPolicyDisabled or BetaContainerNetworkPolicyAllowlist Network access policy for the container.
One of the following: BetaContainerNetworkPolicyDisabled { type } type: "disabled" (default: "disabled") Disable outbound network access. Always disabled.
BetaContainerNetworkPolicyAllowlist { allowed_domains, type, domain_secrets } allowed_domains: array of string A list of allowed domains when type is allowlist.
minItems1 type: "allowlist" (default: "allowlist") Allow outbound network access only to specified domains. Always allowlist.
domain_secrets: optional array of BetaContainerNetworkPolicyDomainSecret { domain, name, value } Optional domain-scoped secrets for allowlisted domains.
minItems1 domain: string The domain associated with the secret.
minLength1 name: string The name of the secret to inject for the domain.
minLength1 value: string The secret value to inject for the domain.
minLength1 maxLength10485760 skills: optional array of BetaSkillReference or BetaInlineSkill An optional list of skills referenced by id or inline data.
maxItems200 One of the following: BetaSkillReference { skill_id, type, version } skill_id: string The ID of the referenced skill.
minLength1 maxLength64 type: "skill_reference" (default: "skill_reference") References a skill created with the /v1/skills endpoint.
version: optional string Optional skill version. Use a positive integer or ‘latest’. Omit for default.
BetaInlineSkill { description, name, source, type } description: string The description of the skill.
name: string The name of the skill.
source: BetaInlineSkillSource { data, media_type, type } Inline skill payload
data: string Base64-encoded skill zip bundle.
minLength1 maxLength70254592 media_type: "application/zip" (default: "application/zip") The media type of the inline skill payload. Must be application/zip.
type: "base64" (default: "base64") The type of the inline skill source. Must be base64.
type: "inline" (default: "inline") Defines an inline skill for this request.
BetaLocalEnvironment { type, skills } type: "local" (default: "local") Use a local computer environment.
skills: optional array of BetaLocalSkill { description, name, path } An optional list of skills.
maxItems200 description: string The description of the skill.
name: string The name of the skill.
path: string The path to the directory containing the skill.
BetaContainerReference { container_id, type } container_id: string The ID of the referenced container.
type: "container_reference" (default: "container_reference") References a container created with the /v1/containers endpoint
Custom { name, type, allowed_callers, 4 more } A custom tool that processes input using a specified format. Learn more about custom tools
name: string The name of the custom tool, used to identify it in tool calls.
type: "custom" (default: "custom") The type of the custom tool. Always custom.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" async: optional boolean Whether the tool response can be returned asynchronously versus immediately returned on next response creation.
defer_loading: optional boolean Whether this tool should be deferred and discovered via tool search.
description: optional string Optional description of the custom tool, used to provide more context.
format: optional Text or Grammar The input format for the custom tool. Default is unconstrained text.
One of the following: Text { type } Unconstrained free-form text.
type: "text" (default: "text") Unconstrained text format. Always text.
Grammar { definition, syntax, type } A grammar defined by the user.
definition: string The grammar definition.
syntax: "lark" or "regex" The syntax of the grammar definition. One of lark or regex.
One of the following: "lark" "regex" type: "grammar" (default: "grammar") Grammar format. Always grammar.
Namespace { description, name, tools, type } Groups function/custom tools under a shared namespace.
description: string A description of the namespace shown to the model.
name: string The namespace name used in tool calls (for example, crm).
minLength1 tools: array of Function or Custom The function/custom tools available inside this namespace.
minItems1 One of the following: Function { name, type, allowed_callers, 6 more } name: string pattern^[a-zA-Z0-9_-]+$ minLength1 maxLength128 type: "function" (default: "function") allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" async: optional boolean Whether the tool response can be returned asynchronously versus immediately returned on next response creation.
defer_loading: optional boolean Whether this function should be deferred and discovered via tool search.
description: optional string or null output_schema: optional map[unknown] or null A JSON Schema describing the JSON value encoded in string outputs for this function tool. This does not describe content-array outputs.
parameters: optional unknown or null strict: optional boolean or null Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise.
Custom { name, type, allowed_callers, 4 more } A custom tool that processes input using a specified format. Learn more about custom tools
name: string The name of the custom tool, used to identify it in tool calls.
type: "custom" (default: "custom") The type of the custom tool. Always custom.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" async: optional boolean Whether the tool response can be returned asynchronously versus immediately returned on next response creation.
defer_loading: optional boolean Whether this tool should be deferred and discovered via tool search.
description: optional string Optional description of the custom tool, used to provide more context.
format: optional Text or Grammar The input format for the custom tool. Default is unconstrained text.
One of the following: Text { type } Unconstrained free-form text.
type: "text" (default: "text") Unconstrained text format. Always text.
Grammar { definition, syntax, type } A grammar defined by the user.
definition: string The grammar definition.
syntax: "lark" or "regex" The syntax of the grammar definition. One of lark or regex.
One of the following: "lark" "regex" type: "grammar" (default: "grammar") Grammar format. Always grammar.
type: "namespace" (default: "namespace") The type of the tool. Always namespace.
ToolSearch { type, description, execution, parameters } Hosted or BYOT tool search configuration for deferred tools.
type: "tool_search" (default: "tool_search") The type of the tool. Always tool_search.
description: optional string or null Description shown to the model for a client-executed tool search tool.
execution: optional "server" or "client" Whether tool search is executed by the server or by the client.
One of the following: "server" "client" parameters: optional unknown or null Parameter schema for a client-executed tool search tool.
WebSearchPreview { type, search_content_types, search_context_size, user_location } This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
type: "web_search_preview" or "web_search_preview_2025_03_11" (default: "web_search_preview") The type of the web search tool. One of web_search_preview or web_search_preview_2025_03_11.
One of the following: "web_search_preview" "web_search_preview_2025_03_11" search_content_types: optional array of "text" or "image" One of the following: "text" "image" search_context_size: optional "low" or "medium" or "high" High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.
One of the following: "low" "medium" "high" user_location: optional object or null The approximate location of the user. If omitted or null, defaults to the United States. To avoid this fallback, pass {"type": "approximate"} without location fields. To localize results, provide the relevant location fields.
type: "approximate" (default: "approximate") The type of location approximation. Always approximate.
city: optional string or null Free text input for the city of the user, e.g. San Francisco.
country: optional string or null The two-letter ISO country code of the user, e.g. US.
region: optional string or null Free text input for the region of the user, e.g. California.
timezone: optional string or null The IANA timezone of the user, e.g. America/Los_Angeles.
ApplyPatch { type, allowed_callers } Allows the assistant to create, delete, or update files using unified diffs.
type: "apply_patch" (default: "apply_patch") The type of the tool. Always apply_patch.
allowed_callers: optional array of "direct" or "programmatic" or null The tool invocation context(s).
minItems1 One of the following: "direct" "programmatic" top_p: number or null (default: 1) An alternative to sampling with temperature, called nucleus sampling,
where the model considers the results of the tokens with top_p probability
mass. So 0.1 means only the tokens comprising the top 10% probability mass
are considered.
We generally recommend altering this or temperature but not both.
minimum0 maximum1 background: optional boolean or null (default: false) Whether to run the model response in the background.
Learn more.
completed_at: optional number or null Unix timestamp (in seconds) of when this Response was completed.
Only present when the status is completed.
formatunixtime conversation: optional object or null The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation.
id: string The unique ID of the conversation that this response was associated with.
image: optional { context_compression } context_compression: "enabled" or "disabled" Effective image context optimization policy.
One of the following: "enabled" "disabled" input_transformations: optional array of { id, action, reason, type } Reasoning inputs withheld from the model, in input order.
id: string The original reasoning item ID.
action: "removed" (default: "removed") reason: "organization_mismatch" or "end_user_mismatch" or "model_mismatch" or 2 more One of the following: "organization_mismatch" "end_user_mismatch" "model_mismatch" "prefix_mismatch" "turn_boundary" type: "reasoning" (default: "reasoning") max_output_tokens: optional integer or null An upper bound for the number of tokens that can be generated for a response, including visible output tokens and reasoning tokens.
max_tool_calls: optional integer or null The maximum number of total calls to built-in tools that can be processed in a response. This maximum number applies across all built-in tool calls, not per individual tool. Any further attempts to call a tool by the model will be ignored.
moderation: optional object or null Moderation results for the response input and output, if moderated completions were requested.
input: ModerationResult or Error Moderation for the response input.
One of the following: ModerationResult { categories, category_applied_input_types, category_scores, 3 more } A moderation result produced for the response input or output.
categories: map[boolean] A dictionary of moderation categories to booleans, True if the input is flagged under this category.
category_applied_input_types: map[array of "text" or "image"] Which modalities of input are reflected by the score for each category.
One of the following: "text" "image" category_scores: map[number] A dictionary of moderation categories to scores.
flagged: boolean A boolean indicating whether the content was flagged by any category.
model: string The moderation model that produced this result.
type: "moderation_result" (default: "moderation_result") The object type, which was always moderation_result for successful moderation results.
Error { code, message, type } An error produced while attempting moderation for the response input or output.
code: string The error code.
message: string The error message.
type: "error" (default: "error") The object type, which was always error for moderation failures.
output: ModerationResult or Error Moderation for the response output.
One of the following: ModerationResult { categories, category_applied_input_types, category_scores, 3 more } A moderation result produced for the response input or output.
categories: map[boolean] A dictionary of moderation categories to booleans, True if the input is flagged under this category.
category_applied_input_types: map[array of "text" or "image"] Which modalities of input are reflected by the score for each category.
One of the following: "text" "image" category_scores: map[number] A dictionary of moderation categories to scores.
flagged: boolean A boolean indicating whether the content was flagged by any category.
model: string The moderation model that produced this result.
type: "moderation_result" (default: "moderation_result") The object type, which was always moderation_result for successful moderation results.
Error { code, message, type } An error produced while attempting moderation for the response input or output.
code: string The error code.
message: string The error message.
type: "error" (default: "error") The object type, which was always error for moderation failures.
output_text: optional string or null SDK-only convenience property that contains the aggregated text output
from all output_text items in the output array, if any are present.
Supported in the Python and JavaScript SDKs.
previous_response_id: optional string or null The unique ID of the previous response to the model. Use this to
create multi-turn conversations. Learn more about
conversation state. Cannot be used in conjunction with conversation.
prompt: optional BetaResponsePrompt or null Reference to a prompt template and its variables.
Learn more.
id: string The unique identifier of the prompt template to use.
variables: optional map[string or BetaResponseInputText or BetaResponseInputImage or BetaResponseInputFile] or null Optional map of values to substitute in for variables in your
prompt. The substitution values can either be strings, or other
Response input types like images or files.
One of the following: string BetaResponseInputText { text, type, prompt_cache_breakpoint } A text input to the model.
text: string The text input to the model.
type: "input_text" (default: "input_text") The type of the input item. Always input_text.
prompt_cache_breakpoint: optional { mode, ttl } Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.
mode: "explicit" (default: "explicit") The breakpoint mode. Always explicit.
ttl: optional "30m" or "12h" The minimum lifetime of this cache breakpoint. Defaults to the request TTL.
One of the following: "30m" "12h" BetaResponseInputImage { detail, type, file_id, 2 more } An image input to the model. Learn about image inputs.
detail: BetaImageDetail 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" (default: "input_image") The type of the input item. Always input_image.
file_id: optional string or null The ID of the file to be sent to the model.
image_url: optional string or null 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: optional { mode, ttl } Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.
mode: "explicit" (default: "explicit") The breakpoint mode. Always explicit.
ttl: optional "30m" or "12h" The minimum lifetime of this cache breakpoint. Defaults to the request TTL.
One of the following: "30m" "12h" BetaResponseInputFile { type, detail, file_data, 4 more } A file input to the model.
type: "input_file" (default: "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.
One of the following: "auto" "low" "high" file_data: optional string The content of the file to be sent to the model.
file_id: optional string or null 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.
formaturi filename: optional string The name of the file to be sent to the model.
prompt_cache_breakpoint: optional { mode, ttl } Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.
mode: "explicit" (default: "explicit") The breakpoint mode. Always explicit.
ttl: optional "30m" or "12h" The minimum lifetime of this cache breakpoint. Defaults to the request TTL.
One of the following: "30m" "12h" version: optional string or null Optional version of the prompt template.
prompt_cache_diagnostics: optional CacheMiss or CacheHit or ComparisonResponseNotFound or Unavailable Prompt cache diagnostics requested for this response.
One of the following: CacheMiss { cache_missed_tokens, reason, type, comparison_reusable_tokens } cache_missed_tokens: integer The estimated number of input tokens affected after the first detected divergence.
reason: "model_changed" or "prompt_cache_key_changed" or "tools_changed" or 6 more The reason prompt cache reuse did not occur.
One of the following: "model_changed" "prompt_cache_key_changed" "tools_changed" "text_format_changed" "reasoning_effort_changed" "verbosity_changed" "context_compacted" "input_changed" "service_tier_changed" type: "cache_miss" (default: "cache_miss") comparison_reusable_tokens: optional integer The raw token count of the reusable prefix in the compared response.
CacheHit { type } type: "cache_hit" (default: "cache_hit") ComparisonResponseNotFound { type } type: "comparison_response_not_found" (default: "comparison_response_not_found") Unavailable { type } type: "unavailable" (default: "unavailable") prompt_cache_key: optional string or null Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more.
prompt_cache_options: optional { mode, ttl, comparison_response_id } The prompt-caching options that were applied to the response. Supported for gpt-5.6 and later models.
mode: "implicit" or "explicit" Whether implicit prompt-cache breakpoints were enabled.
One of the following: "implicit" "explicit" ttl: "30m" or "12h" The minimum lifetime applied to each cache breakpoint.
One of the following: "30m" "12h" comparison_response_id: optional string or null The response ID supplied as the prompt cache diagnostics comparison.
prompt_cache_retention: optional "in_memory" or "24h" or null Deprecated.
Deprecated. Use prompt_cache_options.ttl instead.
The retention policy for the prompt cache. Set to 24h to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. Learn more.
This field expresses a maximum retention policy, while
prompt_cache_options.ttl expresses a minimum cache lifetime. The two
fields are independent and do not interact.
For gpt-5.5, gpt-5.5-pro, and future models, only 24h is supported.
For older models that support both in_memory and 24h, the default depends on your organization’s data retention policy:
Organizations without ZDR enabled default to 24h.
Organizations with ZDR enabled default to in_memory when prompt_cache_retention is not specified.
One of the following: "in_memory" "24h" reasoning: optional object or null Configuration options for
reasoning models.
context: optional "auto" or "current_turn" or "all_turns" or null Controls which reasoning items are rendered back to the model on later turns.
If omitted or set to auto, the model determines the context mode. The
gpt-5.6 model family defaults to all_turns; earlier models default to
current_turn.
When returned on a response, this is the effective reasoning context mode
used for the response.
One of the following: "auto" "current_turn" "all_turns" effort: optional "none" or "minimal" or "low" or 4 more or null (default: "medium") Constrains effort on reasoning for reasoning models. Currently supported
values are none, minimal, low, medium, high, xhigh, and max.
Reducing reasoning effort can result in faster responses and fewer tokens
used on reasoning in a response. Not all reasoning models support every
value. See the
reasoning guide
for model-specific support.
One of the following: "none" "minimal" "low" "medium" "high" "xhigh" "max" generate_summary: optional "auto" or "concise" or "detailed" or null Deprecated.
Deprecated: use summary instead.
A summary of the reasoning performed by the model. This can be
useful for debugging and understanding the model’s reasoning process.
One of auto, concise, or detailed.
One of the following: "auto" "concise" "detailed" mode: optional string or "standard" or "pro" Controls the reasoning execution mode for the request.
When returned on a response, this is the effective execution mode.
One of the following: string "standard" or "pro" Controls the reasoning execution mode for the request.
When returned on a response, this is the effective execution mode.
One of the following: "standard" "pro" summary: optional "auto" or "concise" or "detailed" or null A summary of the reasoning performed by the model. This can be
useful for debugging and understanding the model’s reasoning process.
One of auto, concise, or detailed.
concise is supported for computer-use-preview models and all reasoning models after gpt-5.
One of the following: "auto" "concise" "detailed" safety_identifier: optional string or null A stable identifier used to help detect users of your application that may be violating OpenAI’s usage policies.
The IDs should be a string that uniquely identifies each user, with a maximum length of 128 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. Learn more.
maxLength128 service_tier: optional BetaServiceTier or null (default: "auto") Specifies the processing type used for serving the request.
If set to ‘auto’, then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use ‘default’.
If set to ‘default’, then the request will be processed with the standard pricing and performance for the selected model.
If set to ‘flex’, then the request will be processed with the Flex Processing service tier.
To opt-in to Fast mode at the request level, include the service_tier=fast or service_tier=priority parameter for Responses or Chat Completions. The response will show service_tier=priority regardless of if you specify service_tier=fast or priority in your request.
If set to ‘ultrafast’, then the request will be processed with the access-controlled Ultrafast Processing service tier. This tier is currently available for gpt-5.6-sol; a response served through it will show service_tier=ultrafast.
When not set, the default behavior is ‘auto’.
When the service_tier parameter is set, the response body will include the service_tier value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.
One of the following: "auto" "default" "flex" "scale" "priority" "fast" "ultrafast" status: optional BetaResponseStatus The status of the response generation. One of completed, failed,
in_progress, cancelled, queued, or incomplete.
One of the following: "completed" "failed" "in_progress" "cancelled" "queued" "incomplete" text: optional BetaResponseTextConfig { format, verbosity } Configuration options for a text response from the model. Can be plain
text or structured JSON data. Learn more:
Text inputs and outputs
Structured Outputs
format: optional BetaResponseFormatTextConfig 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.
One of the following: Text { type } Default response format. Used to generate text responses.
type: "text" The type of response format being defined. Always text.
BetaResponseFormatTextJSONSchemaConfig { name, schema, type, 2 more } JSON Schema response format. Used to generate structured JSON responses.
Learn more about Structured Outputs.
name: string The name of the response format. Must be a-z, A-Z, 0-9, or contain
underscores and dashes, with a maximum length of 64.
schema: map[unknown] The schema for the response format, described as a JSON Schema object.
Learn how to build JSON schemas here.
type: "json_schema" The type of response format being defined. Always json_schema.
description: optional string A description of what the response format is for, used by the model to
determine how to respond in the format.
strict: optional boolean or null (default: false) Whether to enable strict schema adherence when generating the output.
If set to true, the model will always follow the exact schema defined
in the schema field. Only a subset of JSON Schema is supported when
strict is true. To learn more, read the Structured Outputs
guide.
JSONObject { type } JSON object response format. An older method of generating JSON responses.
Using json_schema is recommended for models that support it. Note that the
model will not generate JSON without a system or user message instructing it
to do so.
type: "json_object" The type of response format being defined. Always json_object.
verbosity: optional "low" or "medium" or "high" or null (default: "medium") Constrains the verbosity of the model’s response. Lower values will result in
more concise responses, while higher values will result in more verbose responses.
Currently supported values are low, medium, and high. The default is
medium.
One of the following: "low" "medium" "high" tool_usage: optional { image_gen, web_search } Usage reported by hosted tools, separate from base model usage. The field
can be omitted when tool usage is unavailable. When present, tool families
with no recorded usage have zero counts.
image_gen sums available token counts across image generation calls.
Calls with missing or incomplete usage records may be skipped. Output
token details and cached input counts can be omitted. An omitted cache
count means cache usage is unknown.
web_search.num_requests counts billable searches. Discounted searches
and actions such as opening a page are excluded. Use billing records to
reconcile final charges.
image_gen: { input_tokens, input_tokens_details, output_tokens, 4 more } Aggregated usage statistics for image generation tool calls.
input_tokens: integer The number of tokens (images and text) in the input prompt.
input_tokens_details: { image_tokens, text_tokens } The input tokens detailed information for the image generation.
image_tokens: integer The number of image tokens in the input prompt.
text_tokens: integer The number of text tokens in the input prompt.
output_tokens: integer The number of output tokens generated by the model.
total_tokens: integer The total number of tokens (images and text) used for the image generation.
cached_tokens: optional integer cached_tokens_details: optional { cached_image_tokens, cached_text_tokens } cached_image_tokens: integer cached_text_tokens: integer output_tokens_details: optional { image_tokens, text_tokens } The output token details for the image generation.
image_tokens: integer The number of image output tokens generated by the model.
text_tokens: integer The number of text output tokens generated by the model.
web_search: { num_requests } Aggregated billable usage statistics for web search tool calls.
num_requests: integer The number of billable web search requests issued.
top_logprobs: optional integer or null An integer between 0 and 20 specifying the maximum number of most likely
tokens to return at each token position, each with an associated log
probability. In some cases, the number of returned tokens may be fewer than
requested.
minimum0 maximum20 truncation: optional "auto" or "disabled" or null (default: "disabled") The truncation strategy to use for the model response.
auto: If the input to this Response exceeds
the model’s context window size, the model will truncate the
response to fit the context window by dropping items from the beginning of the conversation.
On some models, trimming can begin earlier because the API subtracts the model’s
maximum output allowance from its input limit, even if you set a lower max_output_tokens.
disabled (default): If the input size will exceed the context window
size for a model, the request will fail with a 400 error.
One of the following: "auto" "disabled" usage: optional BetaResponseUsage or null Represents token usage details including input tokens, output tokens,
a breakdown of output tokens, and the total tokens used.
input_tokens: integer The number of input tokens.
input_tokens_details: { cache_write_tokens, cached_tokens, cache_write_tokens_details } A detailed breakdown of the input tokens.
cache_write_tokens: integer The number of input tokens that were written to the cache.
cached_tokens: integer The number of tokens that were retrieved from the cache.
More on prompt caching.
cache_write_tokens_details: optional { ttl_12h_tokens, ttl_30m_tokens } ttl_12h_tokens: integer The number of input tokens written with 12-hour retention.
ttl_30m_tokens: integer The number of input tokens written with 30-minute retention.
output_tokens: integer The number of output tokens.
output_tokens_details: { reasoning_tokens } A detailed breakdown of the output tokens.
reasoning_tokens: integer The number of reasoning tokens.
total_tokens: integer The total number of tokens used.
user: optional string or null Deprecated.
This field is being replaced by safety_identifier and prompt_cache_key. Use prompt_cache_key instead to maintain caching optimizations.
A stable identifier for your end-users.
Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. Learn more.
Returns Examples
Response example
{
"id": "resp_67cb71b351908190a308f3859487620d06981a8637e6bc44",
"object": "response",
"access_programs": null,
"created_at": 1741386163,
"status": "cancelled",
"background": true,
"completed_at": null,
"error": null,
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"model": "gpt-6-astra",
"output": [
{
"type": "message",
"id": "msg_67cb71b3c2b0819084d481baaaf148f206981a8637e6bc44",
"status": "in_progress",
"role": "assistant",
"content": [
{
"type": "output_text",
"text": "Silent circuits hum, \nThoughts emerge in data streams— \nDigital dawn breaks.",
"annotations": [],
"logprobs": []
}
]
}
],
"parallel_tool_calls": true,
"previous_response_id": null,
"reasoning": {
"effort": null,
"summary": null
},
"store": true,
"temperature": 1.0,
"text": {
"format": {
"type": "text"
}
},
"tool_choice": "auto",
"tools": [],
"top_p": 1.0,
"truncation": "disabled",
"usage": null,
"user": null,
"metadata": {}
}