API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Responses

Create a model response

Response responses().create(ResponseCreateParamsparams = ResponseCreateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

POST/responses

Get a model response

Response responses().retrieve(ResponseRetrieveParamsparams = ResponseRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/responses/{response_id}

Delete a model response

responses().delete(ResponseDeleteParamsparams = ResponseDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

DELETE/responses/{response_id}

Cancel a response

Response responses().cancel(ResponseCancelParamsparams = ResponseCancelParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

POST/responses/{response_id}/cancel

Compact a response

CompactedResponse responses().compact(ResponseCompactParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/responses/compact

ModelsExpand Collapse

class ApplyPatchTool:

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

JsonValue; type "apply_patch"constant"apply_patch"constant

The type of the tool. Always apply_patch.

class CompactedResponse:

String id

The unique identifier for the compacted response.

long createdAt

Unix timestamp (in seconds) when the compacted conversation was created.

JsonValue; object_ "response.compaction"constant"response.compaction"constant

The object type. Always response.compaction.

List<ResponseOutputItem> output

The compacted list of output items. This is a list of all user messages, followed by a single compaction item.

One of the following:

class ResponseOutputMessage:

An output message from the model.

String id

The unique ID of the output message.

List<Content> content

The content of the output message.

One of the following:

class ResponseOutputText:

A text output from the model.

List<Annotation> annotations

The annotations of the text output.

One of the following:

class FileCitation:

A citation to a file.

String fileId

The ID of the file.

String filename

The filename of the file cited.

long index

The index of the file in the list of files.

JsonValue; type "file_citation"constant"file_citation"constant

The type of the file citation. Always file_citation.

class UrlCitation:

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

long endIndex

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

long startIndex

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

String title

The title of the web resource.

JsonValue; type "url_citation"constant"url_citation"constant

The type of the URL citation. Always url_citation.

String url

The URL of the web resource.

class ContainerFileCitation:

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

String containerId

The ID of the container file.

long endIndex

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

String fileId

The ID of the file.

String filename

The filename of the container file cited.

long startIndex

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

JsonValue; type "container_file_citation"constant"container_file_citation"constant

The type of the container file citation. Always container_file_citation.

class FilePath:

A path to a file.

String fileId

The ID of the file.

long index

The index of the file in the list of files.

JsonValue; type "file_path"constant"file_path"constant

The type of the file path. Always file_path.

String text

The text output from the model.

JsonValue; type "output_text"constant"output_text"constant

The type of the output text. Always output_text.

Optional<List<Logprob>> logprobs

String token

List<long> bytes

double logprob

List<TopLogprob> topLogprobs

String token

List<long> bytes

double logprob

class ResponseOutputRefusal:

A refusal from the model.

String refusal

The refusal explanation from the model.

JsonValue; type "refusal"constant"refusal"constant

The type of the refusal. Always refusal.

JsonValue; role "assistant"constant"assistant"constant

The role of the output message. Always assistant.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "message"constant"message"constant

The type of the output message. Always message.

Optional<Phase> phase

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("commentary")

FINAL_ANSWER("final_answer")

class ResponseFileSearchToolCall:

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

String id

The unique ID of the file search tool call.

List<String> queries

The queries used to search for files.

Status status

The status of the file search tool call. One of in_progress, searching, incomplete or failed,

One of the following:

IN_PROGRESS("in_progress")

SEARCHING("searching")

COMPLETED("completed")

INCOMPLETE("incomplete")

FAILED("failed")

JsonValue; type "file_search_call"constant"file_search_call"constant

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

Optional<List<Result>> results

The results of the file search tool call.

Optional<Attributes> attributes

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

double

boolean

Optional<String> fileId

The unique ID of the file.

Optional<String> filename

The name of the file.

Optional<Double> score

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

formatfloat

Optional<String> text

The text that was retrieved from the file.

class ResponseFunctionToolCall:

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

String arguments

A JSON string of the arguments to pass to the function.

String callId

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

String name

The name of the function to run.

JsonValue; type "function_call"constant"function_call"constant

The type of the function tool call. Always function_call.

Optional<String> id

The unique ID of the function tool call.

Optional<String> namespace

The namespace of the function to run.

Optional<Status> status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseFunctionToolCallOutputItem:

String id

The unique ID of the function call tool output.

String callId

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

Output output

The output from the function call generated by your code. Can be a string or an list of output content.

One of the following:

String

List<FunctionAndCustomToolCallOutput>

One of the following:

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputImage:

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

Detail detail

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("low")

HIGH("high")

AUTO("auto")

ORIGINAL("original")

JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<String> fileId

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

Optional<String> imageUrl

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

class ResponseInputFile:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

Optional<Detail> detail

The detail level of the file to be sent to the model. Use low for the default rendering behavior, or high to render the file at higher quality. Defaults to low.

One of the following:

LOW("low")

HIGH("high")

Optional<String> fileData

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

Optional<String> fileId

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

Optional<String> fileUrl

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

Optional<String> filename

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

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "function_call_output"constant"function_call_output"constant

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

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseFunctionWebSearch:

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

String id

The unique ID of the web search tool call.

Action action

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:

class Search:

Action type “search” - Performs a web search query.

String query

[DEPRECATED] The search query.

JsonValue; type "search"constant"search"constant

The action type.

Optional<List<String>> queries

The search queries.

Optional<List<Source>> sources

The sources used in the search.

JsonValue; type "url"constant"url"constant

The type of source. Always url.

String url

The URL of the source.

class OpenPage:

Action type “open_page” - Opens a specific URL from search results.

JsonValue; type "open_page"constant"open_page"constant

The action type.

Optional<String> url

The URL opened by the model.

formaturi

class FindInPage:

Action type “find_in_page”: Searches for a pattern within a loaded page.

String pattern

The pattern or text to search for within the page.

JsonValue; type "find_in_page"constant"find_in_page"constant

The action type.

String url

The URL of the page searched for the pattern.

formaturi

Status status

The status of the web search tool call.

One of the following:

IN_PROGRESS("in_progress")

SEARCHING("searching")

COMPLETED("completed")

FAILED("failed")

JsonValue; type "web_search_call"constant"web_search_call"constant

The type of the web search tool call. Always web_search_call.

class ResponseComputerToolCall:

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

String id

The unique ID of the computer call.

String callId

An identifier used when responding to the tool call with output.

List<PendingSafetyCheck> pendingSafetyChecks

The pending safety checks for the computer call.

String id

The ID of the pending safety check.

Optional<String> code

The type of the pending safety check.

Optional<String> message

Details about the pending safety check.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

Type type

The type of the computer call. Always computer_call.

Optional<Action> action

A click action.

One of the following:

class Click:

A click action.

Button button

Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.

One of the following:

LEFT("left")

RIGHT("right")

WHEEL("wheel")

BACK("back")

FORWARD("forward")

JsonValue; type "click"constant"click"constant

Specifies the event type. For a click action, this property is always click.

long x

The x-coordinate where the click occurred.

long y

The y-coordinate where the click occurred.

Optional<List<String>> keys

The keys being held while clicking.

class DoubleClick:

A double click action.

Optional<List<String>> keys

The keys being held while double-clicking.

JsonValue; type "double_click"constant"double_click"constant

Specifies the event type. For a double click action, this property is always set to double_click.

long x

The x-coordinate where the double click occurred.

long y

The y-coordinate where the double click occurred.

class Drag:

A drag action.

List<Path> path

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

long x

The x-coordinate.

long y

The y-coordinate.

JsonValue; type "drag"constant"drag"constant

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

Optional<List<String>> keys

The keys being held while dragging the mouse.

class Keypress:

A collection of keypresses the model would like to perform.

List<String> keys

The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key.

JsonValue; type "keypress"constant"keypress"constant

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

class Move:

A mouse move action.

JsonValue; type "move"constant"move"constant

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

long x

The x-coordinate to move to.

long y

The y-coordinate to move to.

Optional<List<String>> keys

The keys being held while moving the mouse.

JsonValue;

JsonValue; type "screenshot"constant"screenshot"constant

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

class Scroll:

A scroll action.

long scrollX

The horizontal scroll distance.

long scrollY

The vertical scroll distance.

JsonValue; type "scroll"constant"scroll"constant

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

long x

The x-coordinate where the scroll occurred.

long y

The y-coordinate where the scroll occurred.

Optional<List<String>> keys

The keys being held while scrolling.

class Type:

An action to type in text.

String text

The text to type.

JsonValue; type "type"constant"type"constant

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

JsonValue;

JsonValue; type "wait"constant"wait"constant

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

Optional<List<ComputerAction>> actions

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

class ResponseComputerToolCallOutputItem:

String id

The unique ID of the computer call tool output.

String callId

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

ResponseComputerToolCallOutputScreenshot output

A computer screenshot image used with the computer use tool.

Status status

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("completed")

INCOMPLETE("incomplete")

FAILED("failed")

IN_PROGRESS("in_progress")

JsonValue; type "computer_call_output"constant"computer_call_output"constant

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

Optional<List<AcknowledgedSafetyCheck>> acknowledgedSafetyChecks

The safety checks reported by the API that have been acknowledged by the developer.

String id

The ID of the pending safety check.

Optional<String> code

The type of the pending safety check.

Optional<String> message

Details about the pending safety check.

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseReasoningItem:

A description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your input to the Responses API for subsequent turns of a conversation if you are manually managing context.

String id

The unique identifier of the reasoning content.

List<Summary> summary

Reasoning summary content.

String text

A summary of the reasoning output from the model so far.

JsonValue; type "summary_text"constant"summary_text"constant

The type of the object. Always summary_text.

JsonValue; type "reasoning"constant"reasoning"constant

The type of the object. Always reasoning.

Optional<List<Content>> content

Reasoning text content.

String text

The reasoning text from the model.

JsonValue; type "reasoning_text"constant"reasoning_text"constant

The type of the reasoning text. Always reasoning_text.

Optional<String> encryptedContent

The encrypted content of the reasoning item - populated when a response is generated with reasoning.encrypted_content in the include parameter.

Optional<Status> status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseToolSearchCall:

String id

The unique ID of the tool search call item.

JsonValue arguments

Arguments used for the tool search call.

Optional<String> callId

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

Execution execution

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

One of the following:

SERVER("server")

CLIENT("client")

Status status

The status of the tool search call item that was recorded.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "tool_search_call"constant"tool_search_call"constant

The type of the item. Always tool_search_call.

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseToolSearchOutputItem:

String id

The unique ID of the tool search output item.

Optional<String> callId

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

Execution execution

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

One of the following:

SERVER("server")

CLIENT("client")

Status status

The status of the tool search output item that was recorded.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

List<Tool> tools

The loaded tool definitions returned by tool search.

One of the following:

class FunctionTool:

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

String name

The name of the function to call.

Optional<Parameters> parameters

A JSON schema object describing the parameters of the function.

Optional<Boolean> strict

Whether to enforce strict parameter validation. Default true.

JsonValue; type "function"constant"function"constant

The type of the function tool. Always function.

Optional<Boolean> deferLoading

Whether this function is deferred and loaded via tool search.

Optional<String> description

A description of the function. Used by the model to determine whether or not to call the function.

class FileSearchTool:

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

JsonValue; type "file_search"constant"file_search"constant

The type of the file search tool. Always file_search.

List<String> vectorStoreIds

The IDs of the vector stores to search.

Optional<Filters> filters

A filter to apply.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

class CompoundFilter:

Combine multiple filters using and or or.

List<Filter> filters

Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

JsonValue

Type type

Type of operation: and or or.

One of the following:

AND("and")

OR("or")

Optional<Long> maxNumResults

The maximum number of results to return. This number should be between 1 and 50 inclusive.

Optional<RankingOptions> rankingOptions

Ranking options for search.

Optional<HybridSearch> hybridSearch

Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled.

double embeddingWeight

The weight of the embedding in the reciprocal ranking fusion.

double textWeight

The weight of the text in the reciprocal ranking fusion.

Optional<Ranker> ranker

The ranker to use for the file search.

One of the following:

AUTO("auto")

DEFAULT_2024_11_15("default-2024-11-15")

Optional<Double> scoreThreshold

The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.

class ComputerTool:

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

JsonValue; type "computer"constant"computer"constant

The type of the computer tool. Always computer.

class ComputerUsePreviewTool:

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

long displayHeight

The height of the computer display.

long displayWidth

The width of the computer display.

Environment environment

The type of computer environment to control.

One of the following:

WINDOWS("windows")

MAC("mac")

LINUX("linux")

UBUNTU("ubuntu")

BROWSER("browser")

JsonValue; type "computer_use_preview"constant"computer_use_preview"constant

The type of the computer use tool. Always computer_use_preview.

class WebSearchTool:

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

Type type

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")

WEB_SEARCH_2025_08_26("web_search_2025_08_26")

Optional<Filters> filters

Filters for the search.

Optional<List<String>> allowedDomains

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

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The approximate location of the user.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

Optional<Type> type

The type of location approximation. Always approximate.

Mcp

String serverLabel

A label for this MCP server, used to identify it in tool calls.

JsonValue; type "mcp"constant"mcp"constant

The type of the MCP tool. Always mcp.

Optional<AllowedTools> allowedTools

List of allowed tool names or a filter object.

One of the following:

List<String>

class McpToolFilter:

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<String> authorization

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.

Optional<ConnectorId> connectorId

Identifier for service connectors, like those available in ChatGPT. One of server_url or connector_id must be provided. Learn more about service connectors here.

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_dropbox")

CONNECTOR_GMAIL("connector_gmail")

CONNECTOR_GOOGLECALENDAR("connector_googlecalendar")

CONNECTOR_GOOGLEDRIVE("connector_googledrive")

CONNECTOR_MICROSOFTTEAMS("connector_microsoftteams")

CONNECTOR_OUTLOOKCALENDAR("connector_outlookcalendar")

CONNECTOR_OUTLOOKEMAIL("connector_outlookemail")

CONNECTOR_SHAREPOINT("connector_sharepoint")

Optional<Boolean> deferLoading

Whether this MCP tool is deferred and discovered via tool search.

Optional<Headers> headers

Optional HTTP headers to send to the MCP server. Use for authentication or other purposes.

Optional<RequireApproval> requireApproval

Specify which of the MCP server’s tools require approval.

One of the following:

class McpToolApprovalFilter:

Specify which of the MCP server’s tools require approval. Can be always, never, or a filter object associated with tools that require approval.

Optional<Always> always

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<Never> never

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

enum McpToolApprovalSetting:

Specify a single approval policy for all tools. One of always or never. When set to always, all tools will require approval. When set to never, all tools will not require approval.

ALWAYS("always")

NEVER("never")

Optional<String> serverDescription

Optional description of the MCP server, used to provide more context.

Optional<String> serverUrl

The URL for the MCP server. One of server_url or connector_id must be provided.

CodeInterpreter

Container container

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

class CodeInterpreterToolAuto:

Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.

JsonValue; type "auto"constant"auto"constant

Always auto.

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the code interpreter container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

JsonValue; type "code_interpreter"constant"code_interpreter"constant

The type of the code interpreter tool. Always code_interpreter.

ImageGeneration

JsonValue; type "image_generation"constant"image_generation"constant

The type of the image generation tool. Always image_generation.

Optional<Action> action

Whether to generate a new image or edit an existing image. Default: auto.

One of the following:

GENERATE("generate")

EDIT("edit")

AUTO("auto")

Optional<Background> background

Background type for the generated image. One of transparent, opaque, or auto. Default: auto.

One of the following:

TRANSPARENT("transparent")

OPAQUE("opaque")

AUTO("auto")

Optional<InputFidelity> inputFidelity

Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1 and gpt-image-1.5 and later models, unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.

One of the following:

HIGH("high")

LOW("low")

Optional<InputImageMask> inputImageMask

Optional mask for inpainting. Contains image_url (string, optional) and file_id (string, optional).

Optional<String> fileId

File ID for the mask image.

Optional<String> imageUrl

Base64-encoded mask image.

Optional<Model> model

The image generation model to use. Default: gpt-image-1.

One of the following:

GPT_IMAGE_1("gpt-image-1")

GPT_IMAGE_1_MINI("gpt-image-1-mini")

GPT_IMAGE_1_5("gpt-image-1.5")

Optional<Moderation> moderation

Moderation level for the generated image. Default: auto.

One of the following:

AUTO("auto")

LOW("low")

Optional<Long> outputCompression

Compression level for the output image. Default: 100.

minimum0

maximum100

Optional<OutputFormat> outputFormat

The output format of the generated image. One of png, webp, or jpeg. Default: png.

One of the following:

PNG("png")

WEBP("webp")

JPEG("jpeg")

Optional<Long> partialImages

Number of partial images to generate in streaming mode, from 0 (default value) to 3.

minimum0

maximum3

Optional<Quality> quality

The quality of the generated image. One of low, medium, high, or auto. Default: auto.

One of the following:

LOW("low")

MEDIUM("medium")

HIGH("high")

AUTO("auto")

Optional<Size> size

The size of the generated image. One of 1024x1024, 1024x1536, 1536x1024, or auto. Default: auto.

One of the following:

_1024X1024("1024x1024")

_1024X1536("1024x1536")

_1536X1024("1536x1024")

AUTO("auto")

JsonValue;

JsonValue; type "local_shell"constant"local_shell"constant

The type of the local shell tool. Always local_shell.

class FunctionShellTool:

A tool that allows the model to execute shell commands.

JsonValue; type "shell"constant"shell"constant

The type of the shell tool. Always shell.

Optional<Environment> environment

One of the following:

class ContainerAuto:

JsonValue; type "container_auto"constant"container_auto"constant

Automatically creates a container for this request

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

Optional<List<Skill>> skills

An optional list of skills referenced by id or inline data.

One of the following:

class SkillReference:

String skillId

The ID of the referenced skill.

maxLength64

minLength1

JsonValue; type "skill_reference"constant"skill_reference"constant

References a skill created with the /v1/skills endpoint.

Optional<String> version

Optional skill version. Use a positive integer or ‘latest’. Omit for default.

class InlineSkill:

String description

The description of the skill.

String name

The name of the skill.

InlineSkillSource source

Inline skill payload

JsonValue; type "inline"constant"inline"constant

Defines an inline skill for this request.

class LocalEnvironment:

JsonValue; type "local"constant"local"constant

Use a local computer environment.

Optional<List<LocalSkill>> skills

An optional list of skills.

String description

The description of the skill.

String name

The name of the skill.

String path

The path to the directory containing the skill.

class ContainerReference:

String containerId

The ID of the referenced container.

JsonValue; type "container_reference"constant"container_reference"constant

References a container created with the /v1/containers endpoint

class CustomTool:

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

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

class NamespaceTool:

Groups function/custom tools under a shared namespace.

String description

A description of the namespace shown to the model.

minLength1

String name

The namespace name used in tool calls (for example, crm).

minLength1

List<Tool> tools

The function/custom tools available inside this namespace.

One of the following:

class Function:

String name

maxLength128

minLength1

JsonValue; type "function"constant"function"constant

Optional<Boolean> deferLoading

Whether this function should be deferred and discovered via tool search.

Optional<String> description

Optional<JsonValue> parameters

Optional<Boolean> strict

class CustomTool:

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

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

JsonValue; type "namespace"constant"namespace"constant

The type of the tool. Always namespace.

class ToolSearchTool:

Hosted or BYOT tool search configuration for deferred tools.

JsonValue; type "tool_search"constant"tool_search"constant

The type of the tool. Always tool_search.

Optional<String> description

Description shown to the model for a client-executed tool search tool.

Optional<Execution> execution

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

One of the following:

SERVER("server")

CLIENT("client")

Optional<JsonValue> parameters

Parameter schema for a client-executed tool search tool.

class WebSearchPreviewTool:

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

Type type

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")

WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")

Optional<List<SearchContentType>> searchContentTypes

One of the following:

TEXT("text")

IMAGE("image")

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The user’s location.

JsonValue; type "approximate"constant"approximate"constant

The type of location approximation. Always approximate.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

class ApplyPatchTool:

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

JsonValue; type "apply_patch"constant"apply_patch"constant

The type of the tool. Always apply_patch.

JsonValue; type "tool_search_output"constant"tool_search_output"constant

The type of the item. Always tool_search_output.

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseCompactionItem:

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

String id

The unique ID of the compaction item.

String encryptedContent

The encrypted content that was produced by compaction.

JsonValue; type "compaction"constant"compaction"constant

The type of the item. Always compaction.

Optional<String> createdBy

The identifier of the actor that created the item.

ImageGenerationCall

String id

The unique ID of the image generation call.

Optional<String> result

The generated image encoded in base64.

Status status

The status of the image generation call.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

GENERATING("generating")

FAILED("failed")

JsonValue; type "image_generation_call"constant"image_generation_call"constant

The type of the image generation call. Always image_generation_call.

class ResponseCodeInterpreterToolCall:

A tool call to run code.

String id

The unique ID of the code interpreter tool call.

Optional<String> code

The code to run, or null if not available.

String containerId

The ID of the container used to run the code.

Optional<List<Output>> outputs

The outputs generated by the code interpreter, such as logs or images. Can be null if no outputs are available.

One of the following:

class Logs:

The logs output from the code interpreter.

String logs

The logs output from the code interpreter.

JsonValue; type "logs"constant"logs"constant

The type of the output. Always logs.

class Image:

The image output from the code interpreter.

JsonValue; type "image"constant"image"constant

The type of the output. Always image.

String url

The URL of the image output from the code interpreter.

Status status

The status of the code interpreter tool call. Valid values are in_progress, completed, incomplete, interpreting, and failed.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

INTERPRETING("interpreting")

FAILED("failed")

JsonValue; type "code_interpreter_call"constant"code_interpreter_call"constant

The type of the code interpreter tool call. Always code_interpreter_call.

LocalShellCall

String id

The unique ID of the local shell call.

Action action

Execute a shell command on the server.

List<String> command

The command to run.

Env env

Environment variables to set for the command.

JsonValue; type "exec"constant"exec"constant

The type of the local shell action. Always exec.

Optional<Long> timeoutMs

Optional timeout in milliseconds for the command.

Optional<String> user

Optional user to run the command as.

Optional<String> workingDirectory

Optional working directory to run the command in.

String callId

The unique ID of the local shell tool call generated by the model.

Status status

The status of the local shell call.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "local_shell_call"constant"local_shell_call"constant

The type of the local shell call. Always local_shell_call.

LocalShellCallOutput

String id

The unique ID of the local shell tool call generated by the model.

String output

A JSON string of the output of the local shell tool call.

JsonValue; type "local_shell_call_output"constant"local_shell_call_output"constant

The type of the local shell tool call output. Always local_shell_call_output.

Optional<Status> status

The status of the item. One of in_progress, completed, or incomplete.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseFunctionShellToolCall:

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

String id

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

Action action

The shell commands and limits that describe how to run the tool call.

List<String> commands

Optional<Long> maxOutputLength

Optional maximum number of characters to return from each command.

Optional<Long> timeoutMs

Optional timeout in milliseconds for the commands.

String callId

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

Optional<Environment> environment

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

One of the following:

class ResponseLocalEnvironment:

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

JsonValue; type "local"constant"local"constant

The environment type. Always local.

class ResponseContainerReference:

Represents a container created with /v1/containers.

String containerId

JsonValue; type "container_reference"constant"container_reference"constant

The environment type. Always container_reference.

Status status

The status of the shell call. One of in_progress, completed, or incomplete.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "shell_call"constant"shell_call"constant

The type of the item. Always shell_call.

Optional<String> createdBy

The ID of the entity that created this tool call.

class ResponseFunctionShellToolCallOutput:

The output of a shell tool call that was emitted.

String id

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

String callId

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

Optional<Long> maxOutputLength

The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output.

List<Output> output

An array of shell call output contents

Outcome outcome

Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk.

One of the following:

JsonValue;

JsonValue; type "timeout"constant"timeout"constant

The outcome type. Always timeout.

class Exit:

Indicates that the shell commands finished and returned an exit code.

long exitCode

Exit code from the shell process.

JsonValue; type "exit"constant"exit"constant

The outcome type. Always exit.

String stderr

The standard error output that was captured.

String stdout

The standard output that was captured.

Optional<String> createdBy

The identifier of the actor that created the item.

Status status

The status of the shell call output. One of in_progress, completed, or incomplete.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "shell_call_output"constant"shell_call_output"constant

The type of the shell call output. Always shell_call_output.

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseApplyPatchToolCall:

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

String id

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

String callId

The unique ID of the apply patch tool call generated by the model.

Operation operation

One of the create_file, delete_file, or update_file operations applied via apply_patch.

One of the following:

class CreateFile:

Instruction describing how to create a file via the apply_patch tool.

String diff

Diff to apply.

String path

Path of the file to create.

JsonValue; type "create_file"constant"create_file"constant

Create a new file with the provided diff.

class DeleteFile:

Instruction describing how to delete a file via the apply_patch tool.

String path

Path of the file to delete.

JsonValue; type "delete_file"constant"delete_file"constant

Delete the specified file.

class UpdateFile:

Instruction describing how to update a file via the apply_patch tool.

String diff

Diff to apply.

String path

Path of the file to update.

JsonValue; type "update_file"constant"update_file"constant

Update an existing file with the provided diff.

Status status

The status of the apply patch tool call. One of in_progress or completed.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

JsonValue; type "apply_patch_call"constant"apply_patch_call"constant

The type of the item. Always apply_patch_call.

Optional<String> createdBy

The ID of the entity that created this tool call.

class ResponseApplyPatchToolCallOutput:

The output emitted by an apply patch tool call.

String id

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

String callId

The unique ID of the apply patch tool call generated by the model.

Status status

The status of the apply patch tool call output. One of completed or failed.

One of the following:

COMPLETED("completed")

FAILED("failed")

JsonValue; type "apply_patch_call_output"constant"apply_patch_call_output"constant

The type of the item. Always apply_patch_call_output.

Optional<String> createdBy

The ID of the entity that created this tool call output.

Optional<String> output

Optional textual output returned by the apply patch tool.

McpCall

String id

The unique ID of the tool call.

String arguments

A JSON string of the arguments passed to the tool.

String name

The name of the tool that was run.

String serverLabel

The label of the MCP server running the tool.

JsonValue; type "mcp_call"constant"mcp_call"constant

The type of the item. Always mcp_call.

Optional<String> approvalRequestId

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.

Optional<String> error

The error from the tool call, if any.

Optional<String> output

The output from the tool call.

Optional<Status> status

The status of the tool call. One of in_progress, completed, incomplete, calling, or failed.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

CALLING("calling")

FAILED("failed")

McpListTools

String id

The unique ID of the list.

String serverLabel

The label of the MCP server.

List<Tool> tools

The tools available on the server.

JsonValue inputSchema

The JSON schema describing the tool’s input.

String name

The name of the tool.

Optional<JsonValue> annotations

Additional annotations about the tool.

Optional<String> description

The description of the tool.

JsonValue; type "mcp_list_tools"constant"mcp_list_tools"constant

The type of the item. Always mcp_list_tools.

Optional<String> error

Error message if the server could not list tools.

McpApprovalRequest

String id

The unique ID of the approval request.

String arguments

A JSON string of arguments for the tool.

String name

The name of the tool to run.

String serverLabel

The label of the MCP server making the request.

JsonValue; type "mcp_approval_request"constant"mcp_approval_request"constant

The type of the item. Always mcp_approval_request.

McpApprovalResponse

String id

The unique ID of the approval response

String approvalRequestId

The ID of the approval request being answered.

boolean approve

Whether the request was approved.

JsonValue; type "mcp_approval_response"constant"mcp_approval_response"constant

The type of the item. Always mcp_approval_response.

Optional<String> reason

Optional reason for the decision.

class ResponseCustomToolCall:

A call to a custom tool created by the model.

String callId

An identifier used to map this custom tool call to a tool call output.

String input

The input for the custom tool call generated by the model.

String name

The name of the custom tool being called.

JsonValue; type "custom_tool_call"constant"custom_tool_call"constant

The type of the custom tool call. Always custom_tool_call.

Optional<String> id

The unique ID of the custom tool call in the OpenAI platform.

Optional<String> namespace

The namespace of the custom tool being called.

class ResponseCustomToolCallOutputItem:

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

String id

The unique ID of the custom tool call output item.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

Optional<String> createdBy

The identifier of the actor that created the item.

ResponseUsage usage

Token accounting for the compaction pass, including cached, reasoning, and total tokens.

class ComputerAction: A class that can be one of several variants.union

A click action.

Click

Button button

Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.

One of the following:

LEFT("left")

RIGHT("right")

WHEEL("wheel")

BACK("back")

FORWARD("forward")

JsonValue; type "click"constant"click"constant

Specifies the event type. For a click action, this property is always click.

long x

The x-coordinate where the click occurred.

long y

The y-coordinate where the click occurred.

Optional<List<String>> keys

The keys being held while clicking.

DoubleClick

Optional<List<String>> keys

The keys being held while double-clicking.

JsonValue; type "double_click"constant"double_click"constant

Specifies the event type. For a double click action, this property is always set to double_click.

long x

The x-coordinate where the double click occurred.

long y

The y-coordinate where the double click occurred.

Drag

List<Path> path

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

long x

The x-coordinate.

long y

The y-coordinate.

JsonValue; type "drag"constant"drag"constant

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

Optional<List<String>> keys

The keys being held while dragging the mouse.

Keypress

List<String> keys

The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key.

JsonValue; type "keypress"constant"keypress"constant

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

Move

JsonValue; type "move"constant"move"constant

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

long x

The x-coordinate to move to.

long y

The y-coordinate to move to.

Optional<List<String>> keys

The keys being held while moving the mouse.

JsonValue;

JsonValue; type "screenshot"constant"screenshot"constant

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

Scroll

long scrollX

The horizontal scroll distance.

long scrollY

The vertical scroll distance.

JsonValue; type "scroll"constant"scroll"constant

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

long x

The x-coordinate where the scroll occurred.

long y

The y-coordinate where the scroll occurred.

Optional<List<String>> keys

The keys being held while scrolling.

Type

String text

The text to type.

JsonValue; type "type"constant"type"constant

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

JsonValue;

JsonValue; type "wait"constant"wait"constant

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

class ComputerTool:

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

JsonValue; type "computer"constant"computer"constant

The type of the computer tool. Always computer.

class ComputerUsePreviewTool:

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

long displayHeight

The height of the computer display.

long displayWidth

The width of the computer display.

Environment environment

The type of computer environment to control.

One of the following:

WINDOWS("windows")

MAC("mac")

LINUX("linux")

UBUNTU("ubuntu")

BROWSER("browser")

JsonValue; type "computer_use_preview"constant"computer_use_preview"constant

The type of the computer use tool. Always computer_use_preview.

class ContainerAuto:

JsonValue; type "container_auto"constant"container_auto"constant

Automatically creates a container for this request

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

Optional<List<Skill>> skills

An optional list of skills referenced by id or inline data.

One of the following:

class SkillReference:

String skillId

The ID of the referenced skill.

maxLength64

minLength1

JsonValue; type "skill_reference"constant"skill_reference"constant

References a skill created with the /v1/skills endpoint.

Optional<String> version

Optional skill version. Use a positive integer or ‘latest’. Omit for default.

class InlineSkill:

String description

The description of the skill.

String name

The name of the skill.

InlineSkillSource source

Inline skill payload

JsonValue; type "inline"constant"inline"constant

Defines an inline skill for this request.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyDomainSecret:

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

class ContainerReference:

String containerId

The ID of the referenced container.

JsonValue; type "container_reference"constant"container_reference"constant

References a container created with the /v1/containers endpoint

class CustomTool:

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

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

class EasyInputMessage:

A message input to the model with a role indicating instruction following hierarchy. Instructions given with the developer or system role take precedence over instructions given with the user role. Messages with the assistant role are presumed to have been generated by the model in previous interactions.

Content content

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

One of the following:

String

List<ResponseInputContent>

One of the following:

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputImage:

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

Detail detail

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("low")

HIGH("high")

AUTO("auto")

ORIGINAL("original")

JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<String> fileId

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

Optional<String> imageUrl

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

class ResponseInputFile:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

Optional<Detail> detail

The detail level of the file to be sent to the model. Use low for the default rendering behavior, or high to render the file at higher quality. Defaults to low.

One of the following:

LOW("low")

HIGH("high")

Optional<String> fileData

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

Optional<String> fileId

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

Optional<String> fileUrl

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

Optional<String> filename

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

Role role

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

One of the following:

USER("user")

ASSISTANT("assistant")

SYSTEM("system")

DEVELOPER("developer")

Optional<Phase> phase

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("commentary")

FINAL_ANSWER("final_answer")

Optional<Type> type

The type of the message input. Always message.

class FileSearchTool:

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

JsonValue; type "file_search"constant"file_search"constant

The type of the file search tool. Always file_search.

List<String> vectorStoreIds

The IDs of the vector stores to search.

Optional<Filters> filters

A filter to apply.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

class CompoundFilter:

Combine multiple filters using and or or.

List<Filter> filters

Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

JsonValue

Type type

Type of operation: and or or.

One of the following:

AND("and")

OR("or")

Optional<Long> maxNumResults

The maximum number of results to return. This number should be between 1 and 50 inclusive.

Optional<RankingOptions> rankingOptions

Ranking options for search.

Optional<HybridSearch> hybridSearch

Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled.

double embeddingWeight

The weight of the embedding in the reciprocal ranking fusion.

double textWeight

The weight of the text in the reciprocal ranking fusion.

Optional<Ranker> ranker

The ranker to use for the file search.

One of the following:

AUTO("auto")

DEFAULT_2024_11_15("default-2024-11-15")

Optional<Double> scoreThreshold

The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.

class FunctionShellTool:

A tool that allows the model to execute shell commands.

JsonValue; type "shell"constant"shell"constant

The type of the shell tool. Always shell.

Optional<Environment> environment

One of the following:

class ContainerAuto:

JsonValue; type "container_auto"constant"container_auto"constant

Automatically creates a container for this request

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

Optional<List<Skill>> skills

An optional list of skills referenced by id or inline data.

One of the following:

class SkillReference:

String skillId

The ID of the referenced skill.

maxLength64

minLength1

JsonValue; type "skill_reference"constant"skill_reference"constant

References a skill created with the /v1/skills endpoint.

Optional<String> version

Optional skill version. Use a positive integer or ‘latest’. Omit for default.

class InlineSkill:

String description

The description of the skill.

String name

The name of the skill.

InlineSkillSource source

Inline skill payload

JsonValue; type "inline"constant"inline"constant

Defines an inline skill for this request.

class LocalEnvironment:

JsonValue; type "local"constant"local"constant

Use a local computer environment.

Optional<List<LocalSkill>> skills

An optional list of skills.

String description

The description of the skill.

String name

The name of the skill.

String path

The path to the directory containing the skill.

class ContainerReference:

String containerId

The ID of the referenced container.

JsonValue; type "container_reference"constant"container_reference"constant

References a container created with the /v1/containers endpoint

class FunctionTool:

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

String name

The name of the function to call.

Optional<Parameters> parameters

A JSON schema object describing the parameters of the function.

Optional<Boolean> strict

Whether to enforce strict parameter validation. Default true.

JsonValue; type "function"constant"function"constant

The type of the function tool. Always function.

Optional<Boolean> deferLoading

Whether this function is deferred and loaded via tool search.

Optional<String> description

A description of the function. Used by the model to determine whether or not to call the function.

class InlineSkill:

String description

The description of the skill.

String name

The name of the skill.

InlineSkillSource source

Inline skill payload

JsonValue; type "inline"constant"inline"constant

Defines an inline skill for this request.

class InlineSkillSource:

Inline skill payload

String data

Base64-encoded skill zip bundle.

maxLength70254592

minLength1

JsonValue; mediaType "application/zip"constant"application/zip"constant

The media type of the inline skill payload. Must be application/zip.

JsonValue; type "base64"constant"base64"constant

The type of the inline skill source. Must be base64.

class LocalEnvironment:

JsonValue; type "local"constant"local"constant

Use a local computer environment.

Optional<List<LocalSkill>> skills

An optional list of skills.

String description

The description of the skill.

String name

The name of the skill.

String path

The path to the directory containing the skill.

class LocalSkill:

String description

The description of the skill.

String name

The name of the skill.

String path

The path to the directory containing the skill.

class NamespaceTool:

Groups function/custom tools under a shared namespace.

String description

A description of the namespace shown to the model.

minLength1

String name

The namespace name used in tool calls (for example, crm).

minLength1

List<Tool> tools

The function/custom tools available inside this namespace.

One of the following:

class Function:

String name

maxLength128

minLength1

JsonValue; type "function"constant"function"constant

Optional<Boolean> deferLoading

Whether this function should be deferred and discovered via tool search.

Optional<String> description

Optional<JsonValue> parameters

Optional<Boolean> strict

class CustomTool:

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

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

JsonValue; type "namespace"constant"namespace"constant

The type of the tool. Always namespace.

class Response:

String id

Unique identifier for this Response.

double createdAt

Unix timestamp (in seconds) of when this Response was created.

Optional<ResponseError> error

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

Optional<IncompleteDetails> incompleteDetails

Details about why the response is incomplete.

Optional<Reason> reason

The reason why the response is incomplete.

One of the following:

MAX_OUTPUT_TOKENS("max_output_tokens")

CONTENT_FILTER("content_filter")

Optional<Instructions> instructions

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

List<ResponseInputItem>

One of the following:

class EasyInputMessage:

A message input to the model with a role indicating instruction following hierarchy. Instructions given with the developer or system role take precedence over instructions given with the user role. Messages with the assistant role are presumed to have been generated by the model in previous interactions.

Content content

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

One of the following:

String

List<ResponseInputContent>

One of the following:

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputImage:

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

Detail detail

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("low")

HIGH("high")

AUTO("auto")

ORIGINAL("original")

JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<String> fileId

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

Optional<String> imageUrl

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

class ResponseInputFile:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

Optional<Detail> detail

The detail level of the file to be sent to the model. Use low for the default rendering behavior, or high to render the file at higher quality. Defaults to low.

One of the following:

LOW("low")

HIGH("high")

Optional<String> fileData

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

Optional<String> fileId

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

Optional<String> fileUrl

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

Optional<String> filename

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

Role role

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

One of the following:

USER("user")

ASSISTANT("assistant")

SYSTEM("system")

DEVELOPER("developer")

Optional<Phase> phase

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("commentary")

FINAL_ANSWER("final_answer")

Optional<Type> type

The type of the message input. Always message.

Message

List<ResponseInputContent> content

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

Role role

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

One of the following:

USER("user")

SYSTEM("system")

DEVELOPER("developer")

Optional<Status> status

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

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

Optional<Type> type

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

class ResponseOutputMessage:

An output message from the model.

String id

The unique ID of the output message.

List<Content> content

The content of the output message.

One of the following:

class ResponseOutputText:

A text output from the model.

List<Annotation> annotations

The annotations of the text output.

One of the following:

class FileCitation:

A citation to a file.

String fileId

The ID of the file.

String filename

The filename of the file cited.

long index

The index of the file in the list of files.

JsonValue; type "file_citation"constant"file_citation"constant

The type of the file citation. Always file_citation.

class UrlCitation:

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

long endIndex

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

long startIndex

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

String title

The title of the web resource.

JsonValue; type "url_citation"constant"url_citation"constant

The type of the URL citation. Always url_citation.

String url

The URL of the web resource.

class ContainerFileCitation:

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

String containerId

The ID of the container file.

long endIndex

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

String fileId

The ID of the file.

String filename

The filename of the container file cited.

long startIndex

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

JsonValue; type "container_file_citation"constant"container_file_citation"constant

The type of the container file citation. Always container_file_citation.

class FilePath:

A path to a file.

String fileId

The ID of the file.

long index

The index of the file in the list of files.

JsonValue; type "file_path"constant"file_path"constant

The type of the file path. Always file_path.

String text

The text output from the model.

JsonValue; type "output_text"constant"output_text"constant

The type of the output text. Always output_text.

Optional<List<Logprob>> logprobs

String token

List<long> bytes

double logprob

List<TopLogprob> topLogprobs

String token

List<long> bytes

double logprob

class ResponseOutputRefusal:

A refusal from the model.

String refusal

The refusal explanation from the model.

JsonValue; type "refusal"constant"refusal"constant

The type of the refusal. Always refusal.

JsonValue; role "assistant"constant"assistant"constant

The role of the output message. Always assistant.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "message"constant"message"constant

The type of the output message. Always message.

Optional<Phase> phase

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("commentary")

FINAL_ANSWER("final_answer")

class ResponseFileSearchToolCall:

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

String id

The unique ID of the file search tool call.

List<String> queries

The queries used to search for files.

Status status

The status of the file search tool call. One of in_progress, searching, incomplete or failed,

One of the following:

IN_PROGRESS("in_progress")

SEARCHING("searching")

COMPLETED("completed")

INCOMPLETE("incomplete")

FAILED("failed")

JsonValue; type "file_search_call"constant"file_search_call"constant

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

Optional<List<Result>> results

The results of the file search tool call.

Optional<Attributes> attributes

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

double

boolean

Optional<String> fileId

The unique ID of the file.

Optional<String> filename

The name of the file.

Optional<Double> score

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

formatfloat

Optional<String> text

The text that was retrieved from the file.

class ResponseComputerToolCall:

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

String id

The unique ID of the computer call.

String callId

An identifier used when responding to the tool call with output.

List<PendingSafetyCheck> pendingSafetyChecks

The pending safety checks for the computer call.

String id

The ID of the pending safety check.

Optional<String> code

The type of the pending safety check.

Optional<String> message

Details about the pending safety check.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

Type type

The type of the computer call. Always computer_call.

Optional<Action> action

A click action.

One of the following:

class Click:

A click action.

Button button

Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.

One of the following:

LEFT("left")

RIGHT("right")

WHEEL("wheel")

BACK("back")

FORWARD("forward")

JsonValue; type "click"constant"click"constant

Specifies the event type. For a click action, this property is always click.

long x

The x-coordinate where the click occurred.

long y

The y-coordinate where the click occurred.

Optional<List<String>> keys

The keys being held while clicking.

class DoubleClick:

A double click action.

Optional<List<String>> keys

The keys being held while double-clicking.

JsonValue; type "double_click"constant"double_click"constant

Specifies the event type. For a double click action, this property is always set to double_click.

long x

The x-coordinate where the double click occurred.

long y

The y-coordinate where the double click occurred.

class Drag:

A drag action.

List<Path> path

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

long x

The x-coordinate.

long y

The y-coordinate.

JsonValue; type "drag"constant"drag"constant

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

Optional<List<String>> keys

The keys being held while dragging the mouse.

class Keypress:

A collection of keypresses the model would like to perform.

List<String> keys

The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key.

JsonValue; type "keypress"constant"keypress"constant

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

class Move:

A mouse move action.

JsonValue; type "move"constant"move"constant

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

long x

The x-coordinate to move to.

long y

The y-coordinate to move to.

Optional<List<String>> keys

The keys being held while moving the mouse.

JsonValue;

JsonValue; type "screenshot"constant"screenshot"constant

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

class Scroll:

A scroll action.

long scrollX

The horizontal scroll distance.

long scrollY

The vertical scroll distance.

JsonValue; type "scroll"constant"scroll"constant

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

long x

The x-coordinate where the scroll occurred.

long y

The y-coordinate where the scroll occurred.

Optional<List<String>> keys

The keys being held while scrolling.

class Type:

An action to type in text.

String text

The text to type.

JsonValue; type "type"constant"type"constant

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

JsonValue;

JsonValue; type "wait"constant"wait"constant

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

Optional<List<ComputerAction>> actions

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

ComputerCallOutput

String callId

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

maxLength64

minLength1

ResponseComputerToolCallOutputScreenshot output

A computer screenshot image used with the computer use tool.

JsonValue; type "computer_call_output"constant"computer_call_output"constant

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

Optional<String> id

The ID of the computer tool call output.

Optional<List<AcknowledgedSafetyCheck>> acknowledgedSafetyChecks

The safety checks reported by the API that have been acknowledged by the developer.

String id

The ID of the pending safety check.

Optional<String> code

The type of the pending safety check.

Optional<String> message

Details about the pending safety check.

Optional<Status> status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseFunctionWebSearch:

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

String id

The unique ID of the web search tool call.

Action action

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:

class Search:

Action type “search” - Performs a web search query.

String query

[DEPRECATED] The search query.

JsonValue; type "search"constant"search"constant

The action type.

Optional<List<String>> queries

The search queries.

Optional<List<Source>> sources

The sources used in the search.

JsonValue; type "url"constant"url"constant

The type of source. Always url.

String url

The URL of the source.

class OpenPage:

Action type “open_page” - Opens a specific URL from search results.

JsonValue; type "open_page"constant"open_page"constant

The action type.

Optional<String> url

The URL opened by the model.

formaturi

class FindInPage:

Action type “find_in_page”: Searches for a pattern within a loaded page.

String pattern

The pattern or text to search for within the page.

JsonValue; type "find_in_page"constant"find_in_page"constant

The action type.

String url

The URL of the page searched for the pattern.

formaturi

Status status

The status of the web search tool call.

One of the following:

IN_PROGRESS("in_progress")

SEARCHING("searching")

COMPLETED("completed")

FAILED("failed")

JsonValue; type "web_search_call"constant"web_search_call"constant

The type of the web search tool call. Always web_search_call.

class ResponseFunctionToolCall:

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

String arguments

A JSON string of the arguments to pass to the function.

String callId

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

String name

The name of the function to run.

JsonValue; type "function_call"constant"function_call"constant

The type of the function tool call. Always function_call.

Optional<String> id

The unique ID of the function tool call.

Optional<String> namespace

The namespace of the function to run.

Optional<Status> status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

FunctionCallOutput

String callId

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

maxLength64

minLength1

Output output

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

One of the following:

String

List<ResponseFunctionCallOutputItem>

One of the following:

class ResponseInputTextContent:

A text input to the model.

String text

The text input to the model.

maxLength10485760

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputImageContent:

An image input to the model. Learn about image inputs

JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<Detail> detail

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("low")

HIGH("high")

AUTO("auto")

ORIGINAL("original")

Optional<String> fileId

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

Optional<String> imageUrl

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

maxLength20971520

class ResponseInputFileContent:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

Optional<Detail> detail

The detail level of the file to be sent to the model. Use low for the default rendering behavior, or high to render the file at higher quality. Defaults to low.

One of the following:

LOW("low")

HIGH("high")

Optional<String> fileData

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

maxLength73400320

Optional<String> fileId

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

Optional<String> fileUrl

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

Optional<String> filename

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

JsonValue; type "function_call_output"constant"function_call_output"constant

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

Optional<String> id

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

Optional<Status> status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

ToolSearchCall

JsonValue arguments

The arguments supplied to the tool search call.

JsonValue; type "tool_search_call"constant"tool_search_call"constant

The item type. Always tool_search_call.

Optional<String> id

The unique ID of this tool search call.

Optional<String> callId

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

maxLength64

minLength1

Optional<Execution> execution

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

One of the following:

SERVER("server")

CLIENT("client")

Optional<Status> status

The status of the tool search call.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseToolSearchOutputItemParam:

List<Tool> tools

The loaded tool definitions returned by the tool search output.

One of the following:

class FunctionTool:

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

String name

The name of the function to call.

Optional<Parameters> parameters

A JSON schema object describing the parameters of the function.

Optional<Boolean> strict

Whether to enforce strict parameter validation. Default true.

JsonValue; type "function"constant"function"constant

The type of the function tool. Always function.

Optional<Boolean> deferLoading

Whether this function is deferred and loaded via tool search.

Optional<String> description

A description of the function. Used by the model to determine whether or not to call the function.

class FileSearchTool:

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

JsonValue; type "file_search"constant"file_search"constant

The type of the file search tool. Always file_search.

List<String> vectorStoreIds

The IDs of the vector stores to search.

Optional<Filters> filters

A filter to apply.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

class CompoundFilter:

Combine multiple filters using and or or.

List<Filter> filters

Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

JsonValue

Type type

Type of operation: and or or.

One of the following:

AND("and")

OR("or")

Optional<Long> maxNumResults

The maximum number of results to return. This number should be between 1 and 50 inclusive.

Optional<RankingOptions> rankingOptions

Ranking options for search.

Optional<HybridSearch> hybridSearch

Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled.

double embeddingWeight

The weight of the embedding in the reciprocal ranking fusion.

double textWeight

The weight of the text in the reciprocal ranking fusion.

Optional<Ranker> ranker

The ranker to use for the file search.

One of the following:

AUTO("auto")

DEFAULT_2024_11_15("default-2024-11-15")

Optional<Double> scoreThreshold

The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.

class ComputerTool:

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

JsonValue; type "computer"constant"computer"constant

The type of the computer tool. Always computer.

class ComputerUsePreviewTool:

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

long displayHeight

The height of the computer display.

long displayWidth

The width of the computer display.

Environment environment

The type of computer environment to control.

One of the following:

WINDOWS("windows")

MAC("mac")

LINUX("linux")

UBUNTU("ubuntu")

BROWSER("browser")

JsonValue; type "computer_use_preview"constant"computer_use_preview"constant

The type of the computer use tool. Always computer_use_preview.

class WebSearchTool:

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

Type type

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")

WEB_SEARCH_2025_08_26("web_search_2025_08_26")

Optional<Filters> filters

Filters for the search.

Optional<List<String>> allowedDomains

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

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The approximate location of the user.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

Optional<Type> type

The type of location approximation. Always approximate.

Mcp

String serverLabel

A label for this MCP server, used to identify it in tool calls.

JsonValue; type "mcp"constant"mcp"constant

The type of the MCP tool. Always mcp.

Optional<AllowedTools> allowedTools

List of allowed tool names or a filter object.

One of the following:

List<String>

class McpToolFilter:

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<String> authorization

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.

Optional<ConnectorId> connectorId

Identifier for service connectors, like those available in ChatGPT. One of server_url or connector_id must be provided. Learn more about service connectors here.

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_dropbox")

CONNECTOR_GMAIL("connector_gmail")

CONNECTOR_GOOGLECALENDAR("connector_googlecalendar")

CONNECTOR_GOOGLEDRIVE("connector_googledrive")

CONNECTOR_MICROSOFTTEAMS("connector_microsoftteams")

CONNECTOR_OUTLOOKCALENDAR("connector_outlookcalendar")

CONNECTOR_OUTLOOKEMAIL("connector_outlookemail")

CONNECTOR_SHAREPOINT("connector_sharepoint")

Optional<Boolean> deferLoading

Whether this MCP tool is deferred and discovered via tool search.

Optional<Headers> headers

Optional HTTP headers to send to the MCP server. Use for authentication or other purposes.

Optional<RequireApproval> requireApproval

Specify which of the MCP server’s tools require approval.

One of the following:

class McpToolApprovalFilter:

Specify which of the MCP server’s tools require approval. Can be always, never, or a filter object associated with tools that require approval.

Optional<Always> always

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<Never> never

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

enum McpToolApprovalSetting:

Specify a single approval policy for all tools. One of always or never. When set to always, all tools will require approval. When set to never, all tools will not require approval.

ALWAYS("always")

NEVER("never")

Optional<String> serverDescription

Optional description of the MCP server, used to provide more context.

Optional<String> serverUrl

The URL for the MCP server. One of server_url or connector_id must be provided.

CodeInterpreter

Container container

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

class CodeInterpreterToolAuto:

Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.

JsonValue; type "auto"constant"auto"constant

Always auto.

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the code interpreter container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

JsonValue; type "code_interpreter"constant"code_interpreter"constant

The type of the code interpreter tool. Always code_interpreter.

ImageGeneration

JsonValue; type "image_generation"constant"image_generation"constant

The type of the image generation tool. Always image_generation.

Optional<Action> action

Whether to generate a new image or edit an existing image. Default: auto.

One of the following:

GENERATE("generate")

EDIT("edit")

AUTO("auto")

Optional<Background> background

Background type for the generated image. One of transparent, opaque, or auto. Default: auto.

One of the following:

TRANSPARENT("transparent")

OPAQUE("opaque")

AUTO("auto")

Optional<InputFidelity> inputFidelity

Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1 and gpt-image-1.5 and later models, unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.

One of the following:

HIGH("high")

LOW("low")

Optional<InputImageMask> inputImageMask

Optional mask for inpainting. Contains image_url (string, optional) and file_id (string, optional).

Optional<String> fileId

File ID for the mask image.

Optional<String> imageUrl

Base64-encoded mask image.

Optional<Model> model

The image generation model to use. Default: gpt-image-1.

One of the following:

GPT_IMAGE_1("gpt-image-1")

GPT_IMAGE_1_MINI("gpt-image-1-mini")

GPT_IMAGE_1_5("gpt-image-1.5")

Optional<Moderation> moderation

Moderation level for the generated image. Default: auto.

One of the following:

AUTO("auto")

LOW("low")

Optional<Long> outputCompression

Compression level for the output image. Default: 100.

minimum0

maximum100

Optional<OutputFormat> outputFormat

The output format of the generated image. One of png, webp, or jpeg. Default: png.

One of the following:

PNG("png")

WEBP("webp")

JPEG("jpeg")

Optional<Long> partialImages

Number of partial images to generate in streaming mode, from 0 (default value) to 3.

minimum0

maximum3

Optional<Quality> quality

The quality of the generated image. One of low, medium, high, or auto. Default: auto.

One of the following:

LOW("low")

MEDIUM("medium")

HIGH("high")

AUTO("auto")

Optional<Size> size

The size of the generated image. One of 1024x1024, 1024x1536, 1536x1024, or auto. Default: auto.

One of the following:

_1024X1024("1024x1024")

_1024X1536("1024x1536")

_1536X1024("1536x1024")

AUTO("auto")

JsonValue;

JsonValue; type "local_shell"constant"local_shell"constant

The type of the local shell tool. Always local_shell.

class FunctionShellTool:

A tool that allows the model to execute shell commands.

JsonValue; type "shell"constant"shell"constant

The type of the shell tool. Always shell.

Optional<Environment> environment

One of the following:

class ContainerAuto:

JsonValue; type "container_auto"constant"container_auto"constant

Automatically creates a container for this request

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

Optional<List<Skill>> skills

An optional list of skills referenced by id or inline data.

One of the following:

class SkillReference:

String skillId

The ID of the referenced skill.

maxLength64

minLength1

JsonValue; type "skill_reference"constant"skill_reference"constant

References a skill created with the /v1/skills endpoint.

Optional<String> version

Optional skill version. Use a positive integer or ‘latest’. Omit for default.

class InlineSkill:

String description

The description of the skill.

String name

The name of the skill.

InlineSkillSource source

Inline skill payload

JsonValue; type "inline"constant"inline"constant

Defines an inline skill for this request.

class LocalEnvironment:

JsonValue; type "local"constant"local"constant

Use a local computer environment.

Optional<List<LocalSkill>> skills

An optional list of skills.

String description

The description of the skill.

String name

The name of the skill.

String path

The path to the directory containing the skill.

class ContainerReference:

String containerId

The ID of the referenced container.

JsonValue; type "container_reference"constant"container_reference"constant

References a container created with the /v1/containers endpoint

class CustomTool:

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

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

class NamespaceTool:

Groups function/custom tools under a shared namespace.

String description

A description of the namespace shown to the model.

minLength1

String name

The namespace name used in tool calls (for example, crm).

minLength1

List<Tool> tools

The function/custom tools available inside this namespace.

One of the following:

class Function:

String name

maxLength128

minLength1

JsonValue; type "function"constant"function"constant

Optional<Boolean> deferLoading

Whether this function should be deferred and discovered via tool search.

Optional<String> description

Optional<JsonValue> parameters

Optional<Boolean> strict

class CustomTool:

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

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

JsonValue; type "namespace"constant"namespace"constant

The type of the tool. Always namespace.

class ToolSearchTool:

Hosted or BYOT tool search configuration for deferred tools.

JsonValue; type "tool_search"constant"tool_search"constant

The type of the tool. Always tool_search.

Optional<String> description

Description shown to the model for a client-executed tool search tool.

Optional<Execution> execution

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

One of the following:

SERVER("server")

CLIENT("client")

Optional<JsonValue> parameters

Parameter schema for a client-executed tool search tool.

class WebSearchPreviewTool:

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

Type type

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")

WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")

Optional<List<SearchContentType>> searchContentTypes

One of the following:

TEXT("text")

IMAGE("image")

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The user’s location.

JsonValue; type "approximate"constant"approximate"constant

The type of location approximation. Always approximate.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

class ApplyPatchTool:

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

JsonValue; type "apply_patch"constant"apply_patch"constant

The type of the tool. Always apply_patch.

JsonValue; type "tool_search_output"constant"tool_search_output"constant

The item type. Always tool_search_output.

Optional<String> id

The unique ID of this tool search output.

Optional<String> callId

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

maxLength64

minLength1

Optional<Execution> execution

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

One of the following:

SERVER("server")

CLIENT("client")

Optional<Status> status

The status of the tool search output.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseReasoningItem:

A description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your input to the Responses API for subsequent turns of a conversation if you are manually managing context.

String id

The unique identifier of the reasoning content.

List<Summary> summary

Reasoning summary content.

String text

A summary of the reasoning output from the model so far.

JsonValue; type "summary_text"constant"summary_text"constant

The type of the object. Always summary_text.

JsonValue; type "reasoning"constant"reasoning"constant

The type of the object. Always reasoning.

Optional<List<Content>> content

Reasoning text content.

String text

The reasoning text from the model.

JsonValue; type "reasoning_text"constant"reasoning_text"constant

The type of the reasoning text. Always reasoning_text.

Optional<String> encryptedContent

The encrypted content of the reasoning item - populated when a response is generated with reasoning.encrypted_content in the include parameter.

Optional<Status> status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseCompactionItemParam:

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

String encryptedContent

The encrypted content of the compaction summary.

maxLength10485760

JsonValue; type "compaction"constant"compaction"constant

The type of the item. Always compaction.

Optional<String> id

The ID of the compaction item.

ImageGenerationCall

String id

The unique ID of the image generation call.

Optional<String> result

The generated image encoded in base64.

Status status

The status of the image generation call.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

GENERATING("generating")

FAILED("failed")

JsonValue; type "image_generation_call"constant"image_generation_call"constant

The type of the image generation call. Always image_generation_call.

class ResponseCodeInterpreterToolCall:

A tool call to run code.

String id

The unique ID of the code interpreter tool call.

Optional<String> code

The code to run, or null if not available.

String containerId

The ID of the container used to run the code.

Optional<List<Output>> outputs

The outputs generated by the code interpreter, such as logs or images. Can be null if no outputs are available.

One of the following:

class Logs:

The logs output from the code interpreter.

String logs

The logs output from the code interpreter.

JsonValue; type "logs"constant"logs"constant

The type of the output. Always logs.

class Image:

The image output from the code interpreter.

JsonValue; type "image"constant"image"constant

The type of the output. Always image.

String url

The URL of the image output from the code interpreter.

Status status

The status of the code interpreter tool call. Valid values are in_progress, completed, incomplete, interpreting, and failed.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

INTERPRETING("interpreting")

FAILED("failed")

JsonValue; type "code_interpreter_call"constant"code_interpreter_call"constant

The type of the code interpreter tool call. Always code_interpreter_call.

LocalShellCall

String id

The unique ID of the local shell call.

Action action

Execute a shell command on the server.

List<String> command

The command to run.

Env env

Environment variables to set for the command.

JsonValue; type "exec"constant"exec"constant

The type of the local shell action. Always exec.

Optional<Long> timeoutMs

Optional timeout in milliseconds for the command.

Optional<String> user

Optional user to run the command as.

Optional<String> workingDirectory

Optional working directory to run the command in.

String callId

The unique ID of the local shell tool call generated by the model.

Status status

The status of the local shell call.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "local_shell_call"constant"local_shell_call"constant

The type of the local shell call. Always local_shell_call.

LocalShellCallOutput

String id

The unique ID of the local shell tool call generated by the model.

String output

A JSON string of the output of the local shell tool call.

JsonValue; type "local_shell_call_output"constant"local_shell_call_output"constant

The type of the local shell tool call output. Always local_shell_call_output.

Optional<Status> status

The status of the item. One of in_progress, completed, or incomplete.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

ShellCall

Action action

The shell commands and limits that describe how to run the tool call.

List<String> commands

Ordered shell commands for the execution environment to run.

Optional<Long> maxOutputLength

Maximum number of UTF-8 characters to capture from combined stdout and stderr output.

Optional<Long> timeoutMs

Maximum wall-clock time in milliseconds to allow the shell commands to run.

String callId

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

maxLength64

minLength1

JsonValue; type "shell_call"constant"shell_call"constant

The type of the item. Always shell_call.

Optional<String> id

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

Optional<Environment> environment

The environment to execute the shell commands in.

One of the following:

class LocalEnvironment:

JsonValue; type "local"constant"local"constant

Use a local computer environment.

Optional<List<LocalSkill>> skills

An optional list of skills.

String description

The description of the skill.

String name

The name of the skill.

String path

The path to the directory containing the skill.

class ContainerReference:

String containerId

The ID of the referenced container.

JsonValue; type "container_reference"constant"container_reference"constant

References a container created with the /v1/containers endpoint

Optional<Status> status

The status of the shell call. One of in_progress, completed, or incomplete.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

ShellCallOutput

String callId

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

maxLength64

minLength1

List<ResponseFunctionShellCallOutputContent> output

Captured chunks of stdout and stderr output, along with their associated outcomes.

Outcome outcome

The exit or timeout outcome associated with this shell call.

One of the following:

JsonValue;

JsonValue; type "timeout"constant"timeout"constant

The outcome type. Always timeout.

class Exit:

Indicates that the shell commands finished and returned an exit code.

long exitCode

The exit code returned by the shell process.

JsonValue; type "exit"constant"exit"constant

The outcome type. Always exit.

String stderr

Captured stderr output for the shell call.

maxLength10485760

String stdout

Captured stdout output for the shell call.

maxLength10485760

JsonValue; type "shell_call_output"constant"shell_call_output"constant

The type of the item. Always shell_call_output.

Optional<String> id

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

Optional<Long> maxOutputLength

The maximum number of UTF-8 characters captured for this shell call’s combined output.

Optional<Status> status

The status of the shell call output.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

ApplyPatchCall

String callId

The unique ID of the apply patch tool call generated by the model.

maxLength64

minLength1

Operation operation

The specific create, delete, or update instruction for the apply_patch tool call.

One of the following:

class CreateFile:

Instruction for creating a new file via the apply_patch tool.

String diff

Unified diff content to apply when creating the file.

maxLength10485760

String path

Path of the file to create relative to the workspace root.

minLength1

JsonValue; type "create_file"constant"create_file"constant

The operation type. Always create_file.

class DeleteFile:

Instruction for deleting an existing file via the apply_patch tool.

String path

Path of the file to delete relative to the workspace root.

minLength1

JsonValue; type "delete_file"constant"delete_file"constant

The operation type. Always delete_file.

class UpdateFile:

Instruction for updating an existing file via the apply_patch tool.

String diff

Unified diff content to apply to the existing file.

maxLength10485760

String path

Path of the file to update relative to the workspace root.

minLength1

JsonValue; type "update_file"constant"update_file"constant

The operation type. Always update_file.

Status status

The status of the apply patch tool call. One of in_progress or completed.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

JsonValue; type "apply_patch_call"constant"apply_patch_call"constant

The type of the item. Always apply_patch_call.

Optional<String> id

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

ApplyPatchCallOutput

String callId

The unique ID of the apply patch tool call generated by the model.

maxLength64

minLength1

Status status

The status of the apply patch tool call output. One of completed or failed.

One of the following:

COMPLETED("completed")

FAILED("failed")

JsonValue; type "apply_patch_call_output"constant"apply_patch_call_output"constant

The type of the item. Always apply_patch_call_output.

Optional<String> id

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

Optional<String> output

Optional human-readable log text from the apply patch tool (e.g., patch results or errors).

maxLength10485760

McpListTools

String id

The unique ID of the list.

String serverLabel

The label of the MCP server.

List<Tool> tools

The tools available on the server.

JsonValue inputSchema

The JSON schema describing the tool’s input.

String name

The name of the tool.

Optional<JsonValue> annotations

Additional annotations about the tool.

Optional<String> description

The description of the tool.

JsonValue; type "mcp_list_tools"constant"mcp_list_tools"constant

The type of the item. Always mcp_list_tools.

Optional<String> error

Error message if the server could not list tools.

McpApprovalRequest

String id

The unique ID of the approval request.

String arguments

A JSON string of arguments for the tool.

String name

The name of the tool to run.

String serverLabel

The label of the MCP server making the request.

JsonValue; type "mcp_approval_request"constant"mcp_approval_request"constant

The type of the item. Always mcp_approval_request.

McpApprovalResponse

String approvalRequestId

The ID of the approval request being answered.

boolean approve

Whether the request was approved.

JsonValue; type "mcp_approval_response"constant"mcp_approval_response"constant

The type of the item. Always mcp_approval_response.

Optional<String> id

The unique ID of the approval response

Optional<String> reason

Optional reason for the decision.

McpCall

String id

The unique ID of the tool call.

String arguments

A JSON string of the arguments passed to the tool.

String name

The name of the tool that was run.

String serverLabel

The label of the MCP server running the tool.

JsonValue; type "mcp_call"constant"mcp_call"constant

The type of the item. Always mcp_call.

Optional<String> approvalRequestId

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.

Optional<String> error

The error from the tool call, if any.

Optional<String> output

The output from the tool call.

Optional<Status> status

The status of the tool call. One of in_progress, completed, incomplete, calling, or failed.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

CALLING("calling")

FAILED("failed")

class ResponseCustomToolCallOutput:

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

String callId

The call ID, used to map this custom tool call output to a custom tool call.

Output output

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:

String

List<FunctionAndCustomToolCallOutput>

One of the following:

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputImage:

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

Detail detail

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("low")

HIGH("high")

AUTO("auto")

ORIGINAL("original")

JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<String> fileId

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

Optional<String> imageUrl

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

class ResponseInputFile:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

Optional<Detail> detail

The detail level of the file to be sent to the model. Use low for the default rendering behavior, or high to render the file at higher quality. Defaults to low.

One of the following:

LOW("low")

HIGH("high")

Optional<String> fileData

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

Optional<String> fileId

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

Optional<String> fileUrl

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

Optional<String> filename

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

JsonValue; type "custom_tool_call_output"constant"custom_tool_call_output"constant

The type of the custom tool call output. Always custom_tool_call_output.

Optional<String> id

The unique ID of the custom tool call output in the OpenAI platform.

class ResponseCustomToolCall:

A call to a custom tool created by the model.

String callId

An identifier used to map this custom tool call to a tool call output.

String input

The input for the custom tool call generated by the model.

String name

The name of the custom tool being called.

JsonValue; type "custom_tool_call"constant"custom_tool_call"constant

The type of the custom tool call. Always custom_tool_call.

Optional<String> id

The unique ID of the custom tool call in the OpenAI platform.

Optional<String> namespace

The namespace of the custom tool being called.

ItemReference

String id

The ID of the item to reference.

Optional<Type> type

The type of item to reference. Always item_reference.

Optional<Metadata> metadata

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

ResponsesModel model

Model ID used to generate the response, like gpt-4o or o3. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.

JsonValue; object_ "response"constant"response"constant

The object type of this resource - always set to response.

List<ResponseOutputItem> output

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:

class ResponseOutputMessage:

An output message from the model.

String id

The unique ID of the output message.

List<Content> content

The content of the output message.

One of the following:

class ResponseOutputText:

A text output from the model.

List<Annotation> annotations

The annotations of the text output.

One of the following:

class FileCitation:

A citation to a file.

String fileId

The ID of the file.

String filename

The filename of the file cited.

long index

The index of the file in the list of files.

JsonValue; type "file_citation"constant"file_citation"constant

The type of the file citation. Always file_citation.

class UrlCitation:

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

long endIndex

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

long startIndex

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

String title

The title of the web resource.

JsonValue; type "url_citation"constant"url_citation"constant

The type of the URL citation. Always url_citation.

String url

The URL of the web resource.

class ContainerFileCitation:

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

String containerId

The ID of the container file.

long endIndex

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

String fileId

The ID of the file.

String filename

The filename of the container file cited.

long startIndex

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

JsonValue; type "container_file_citation"constant"container_file_citation"constant

The type of the container file citation. Always container_file_citation.

class FilePath:

A path to a file.

String fileId

The ID of the file.

long index

The index of the file in the list of files.

JsonValue; type "file_path"constant"file_path"constant

The type of the file path. Always file_path.

String text

The text output from the model.

JsonValue; type "output_text"constant"output_text"constant

The type of the output text. Always output_text.

Optional<List<Logprob>> logprobs

String token

List<long> bytes

double logprob

List<TopLogprob> topLogprobs

String token

List<long> bytes

double logprob

class ResponseOutputRefusal:

A refusal from the model.

String refusal

The refusal explanation from the model.

JsonValue; type "refusal"constant"refusal"constant

The type of the refusal. Always refusal.

JsonValue; role "assistant"constant"assistant"constant

The role of the output message. Always assistant.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "message"constant"message"constant

The type of the output message. Always message.

Optional<Phase> phase

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("commentary")

FINAL_ANSWER("final_answer")

class ResponseFileSearchToolCall:

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

String id

The unique ID of the file search tool call.

List<String> queries

The queries used to search for files.

Status status

The status of the file search tool call. One of in_progress, searching, incomplete or failed,

One of the following:

IN_PROGRESS("in_progress")

SEARCHING("searching")

COMPLETED("completed")

INCOMPLETE("incomplete")

FAILED("failed")

JsonValue; type "file_search_call"constant"file_search_call"constant

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

Optional<List<Result>> results

The results of the file search tool call.

Optional<Attributes> attributes

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

double

boolean

Optional<String> fileId

The unique ID of the file.

Optional<String> filename

The name of the file.

Optional<Double> score

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

formatfloat

Optional<String> text

The text that was retrieved from the file.

class ResponseFunctionToolCall:

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

String arguments

A JSON string of the arguments to pass to the function.

String callId

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

String name

The name of the function to run.

JsonValue; type "function_call"constant"function_call"constant

The type of the function tool call. Always function_call.

Optional<String> id

The unique ID of the function tool call.

Optional<String> namespace

The namespace of the function to run.

Optional<Status> status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseFunctionToolCallOutputItem:

String id

The unique ID of the function call tool output.

String callId

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

Output output

The output from the function call generated by your code. Can be a string or an list of output content.

One of the following:

String

List<FunctionAndCustomToolCallOutput>

One of the following:

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputImage:

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

Detail detail

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("low")

HIGH("high")

AUTO("auto")

ORIGINAL("original")

JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<String> fileId

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

Optional<String> imageUrl

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

class ResponseInputFile:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

Optional<Detail> detail

The detail level of the file to be sent to the model. Use low for the default rendering behavior, or high to render the file at higher quality. Defaults to low.

One of the following:

LOW("low")

HIGH("high")

Optional<String> fileData

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

Optional<String> fileId

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

Optional<String> fileUrl

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

Optional<String> filename

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

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "function_call_output"constant"function_call_output"constant

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

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseFunctionWebSearch:

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

String id

The unique ID of the web search tool call.

Action action

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:

class Search:

Action type “search” - Performs a web search query.

String query

[DEPRECATED] The search query.

JsonValue; type "search"constant"search"constant

The action type.

Optional<List<String>> queries

The search queries.

Optional<List<Source>> sources

The sources used in the search.

JsonValue; type "url"constant"url"constant

The type of source. Always url.

String url

The URL of the source.

class OpenPage:

Action type “open_page” - Opens a specific URL from search results.

JsonValue; type "open_page"constant"open_page"constant

The action type.

Optional<String> url

The URL opened by the model.

formaturi

class FindInPage:

Action type “find_in_page”: Searches for a pattern within a loaded page.

String pattern

The pattern or text to search for within the page.

JsonValue; type "find_in_page"constant"find_in_page"constant

The action type.

String url

The URL of the page searched for the pattern.

formaturi

Status status

The status of the web search tool call.

One of the following:

IN_PROGRESS("in_progress")

SEARCHING("searching")

COMPLETED("completed")

FAILED("failed")

JsonValue; type "web_search_call"constant"web_search_call"constant

The type of the web search tool call. Always web_search_call.

class ResponseComputerToolCall:

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

String id

The unique ID of the computer call.

String callId

An identifier used when responding to the tool call with output.

List<PendingSafetyCheck> pendingSafetyChecks

The pending safety checks for the computer call.

String id

The ID of the pending safety check.

Optional<String> code

The type of the pending safety check.

Optional<String> message

Details about the pending safety check.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

Type type

The type of the computer call. Always computer_call.

Optional<Action> action

A click action.

One of the following:

class Click:

A click action.

Button button

Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.

One of the following:

LEFT("left")

RIGHT("right")

WHEEL("wheel")

BACK("back")

FORWARD("forward")

JsonValue; type "click"constant"click"constant

Specifies the event type. For a click action, this property is always click.

long x

The x-coordinate where the click occurred.

long y

The y-coordinate where the click occurred.

Optional<List<String>> keys

The keys being held while clicking.

class DoubleClick:

A double click action.

Optional<List<String>> keys

The keys being held while double-clicking.

JsonValue; type "double_click"constant"double_click"constant

Specifies the event type. For a double click action, this property is always set to double_click.

long x

The x-coordinate where the double click occurred.

long y

The y-coordinate where the double click occurred.

class Drag:

A drag action.

List<Path> path

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

long x

The x-coordinate.

long y

The y-coordinate.

JsonValue; type "drag"constant"drag"constant

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

Optional<List<String>> keys

The keys being held while dragging the mouse.

class Keypress:

A collection of keypresses the model would like to perform.

List<String> keys

The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key.

JsonValue; type "keypress"constant"keypress"constant

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

class Move:

A mouse move action.

JsonValue; type "move"constant"move"constant

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

long x

The x-coordinate to move to.

long y

The y-coordinate to move to.

Optional<List<String>> keys

The keys being held while moving the mouse.

JsonValue;

JsonValue; type "screenshot"constant"screenshot"constant

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

class Scroll:

A scroll action.

long scrollX

The horizontal scroll distance.

long scrollY

The vertical scroll distance.

JsonValue; type "scroll"constant"scroll"constant

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

long x

The x-coordinate where the scroll occurred.

long y

The y-coordinate where the scroll occurred.

Optional<List<String>> keys

The keys being held while scrolling.

class Type:

An action to type in text.

String text

The text to type.

JsonValue; type "type"constant"type"constant

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

JsonValue;

JsonValue; type "wait"constant"wait"constant

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

Optional<List<ComputerAction>> actions

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

class ResponseComputerToolCallOutputItem:

String id

The unique ID of the computer call tool output.

String callId

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

ResponseComputerToolCallOutputScreenshot output

A computer screenshot image used with the computer use tool.

Status status

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("completed")

INCOMPLETE("incomplete")

FAILED("failed")

IN_PROGRESS("in_progress")

JsonValue; type "computer_call_output"constant"computer_call_output"constant

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

Optional<List<AcknowledgedSafetyCheck>> acknowledgedSafetyChecks

The safety checks reported by the API that have been acknowledged by the developer.

String id

The ID of the pending safety check.

Optional<String> code

The type of the pending safety check.

Optional<String> message

Details about the pending safety check.

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseReasoningItem:

A description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your input to the Responses API for subsequent turns of a conversation if you are manually managing context.

String id

The unique identifier of the reasoning content.

List<Summary> summary

Reasoning summary content.

String text

A summary of the reasoning output from the model so far.

JsonValue; type "summary_text"constant"summary_text"constant

The type of the object. Always summary_text.

JsonValue; type "reasoning"constant"reasoning"constant

The type of the object. Always reasoning.

Optional<List<Content>> content

Reasoning text content.

String text

The reasoning text from the model.

JsonValue; type "reasoning_text"constant"reasoning_text"constant

The type of the reasoning text. Always reasoning_text.

Optional<String> encryptedContent

The encrypted content of the reasoning item - populated when a response is generated with reasoning.encrypted_content in the include parameter.

Optional<Status> status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseToolSearchCall:

String id

The unique ID of the tool search call item.

JsonValue arguments

Arguments used for the tool search call.

Optional<String> callId

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

Execution execution

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

One of the following:

SERVER("server")

CLIENT("client")

Status status

The status of the tool search call item that was recorded.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "tool_search_call"constant"tool_search_call"constant

The type of the item. Always tool_search_call.

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseToolSearchOutputItem:

String id

The unique ID of the tool search output item.

Optional<String> callId

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

Execution execution

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

One of the following:

SERVER("server")

CLIENT("client")

Status status

The status of the tool search output item that was recorded.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

List<Tool> tools

The loaded tool definitions returned by tool search.

One of the following:

class FunctionTool:

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

String name

The name of the function to call.

Optional<Parameters> parameters

A JSON schema object describing the parameters of the function.

Optional<Boolean> strict

Whether to enforce strict parameter validation. Default true.

JsonValue; type "function"constant"function"constant

The type of the function tool. Always function.

Optional<Boolean> deferLoading

Whether this function is deferred and loaded via tool search.

Optional<String> description

A description of the function. Used by the model to determine whether or not to call the function.

class FileSearchTool:

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

JsonValue; type "file_search"constant"file_search"constant

The type of the file search tool. Always file_search.

List<String> vectorStoreIds

The IDs of the vector stores to search.

Optional<Filters> filters

A filter to apply.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

class CompoundFilter:

Combine multiple filters using and or or.

List<Filter> filters

Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

JsonValue

Type type

Type of operation: and or or.

One of the following:

AND("and")

OR("or")

Optional<Long> maxNumResults

The maximum number of results to return. This number should be between 1 and 50 inclusive.

Optional<RankingOptions> rankingOptions

Ranking options for search.

Optional<HybridSearch> hybridSearch

Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled.

double embeddingWeight

The weight of the embedding in the reciprocal ranking fusion.

double textWeight

The weight of the text in the reciprocal ranking fusion.

Optional<Ranker> ranker

The ranker to use for the file search.

One of the following:

AUTO("auto")

DEFAULT_2024_11_15("default-2024-11-15")

Optional<Double> scoreThreshold

The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.

class ComputerTool:

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

JsonValue; type "computer"constant"computer"constant

The type of the computer tool. Always computer.

class ComputerUsePreviewTool:

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

long displayHeight

The height of the computer display.

long displayWidth

The width of the computer display.

Environment environment

The type of computer environment to control.

One of the following:

WINDOWS("windows")

MAC("mac")

LINUX("linux")

UBUNTU("ubuntu")

BROWSER("browser")

JsonValue; type "computer_use_preview"constant"computer_use_preview"constant

The type of the computer use tool. Always computer_use_preview.

class WebSearchTool:

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

Type type

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")

WEB_SEARCH_2025_08_26("web_search_2025_08_26")

Optional<Filters> filters

Filters for the search.

Optional<List<String>> allowedDomains

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

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The approximate location of the user.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

Optional<Type> type

The type of location approximation. Always approximate.

Mcp

String serverLabel

A label for this MCP server, used to identify it in tool calls.

JsonValue; type "mcp"constant"mcp"constant

The type of the MCP tool. Always mcp.

Optional<AllowedTools> allowedTools

List of allowed tool names or a filter object.

One of the following:

List<String>

class McpToolFilter:

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<String> authorization

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.

Optional<ConnectorId> connectorId

Identifier for service connectors, like those available in ChatGPT. One of server_url or connector_id must be provided. Learn more about service connectors here.

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_dropbox")

CONNECTOR_GMAIL("connector_gmail")

CONNECTOR_GOOGLECALENDAR("connector_googlecalendar")

CONNECTOR_GOOGLEDRIVE("connector_googledrive")

CONNECTOR_MICROSOFTTEAMS("connector_microsoftteams")

CONNECTOR_OUTLOOKCALENDAR("connector_outlookcalendar")

CONNECTOR_OUTLOOKEMAIL("connector_outlookemail")

CONNECTOR_SHAREPOINT("connector_sharepoint")

Optional<Boolean> deferLoading

Whether this MCP tool is deferred and discovered via tool search.

Optional<Headers> headers

Optional HTTP headers to send to the MCP server. Use for authentication or other purposes.

Optional<RequireApproval> requireApproval

Specify which of the MCP server’s tools require approval.

One of the following:

class McpToolApprovalFilter:

Specify which of the MCP server’s tools require approval. Can be always, never, or a filter object associated with tools that require approval.

Optional<Always> always

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<Never> never

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

enum McpToolApprovalSetting:

Specify a single approval policy for all tools. One of always or never. When set to always, all tools will require approval. When set to never, all tools will not require approval.

ALWAYS("always")

NEVER("never")

Optional<String> serverDescription

Optional description of the MCP server, used to provide more context.

Optional<String> serverUrl

The URL for the MCP server. One of server_url or connector_id must be provided.

CodeInterpreter

Container container

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

class CodeInterpreterToolAuto:

Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.

JsonValue; type "auto"constant"auto"constant

Always auto.

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the code interpreter container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

JsonValue; type "code_interpreter"constant"code_interpreter"constant

The type of the code interpreter tool. Always code_interpreter.

ImageGeneration

JsonValue; type "image_generation"constant"image_generation"constant

The type of the image generation tool. Always image_generation.

Optional<Action> action

Whether to generate a new image or edit an existing image. Default: auto.

One of the following:

GENERATE("generate")

EDIT("edit")

AUTO("auto")

Optional<Background> background

Background type for the generated image. One of transparent, opaque, or auto. Default: auto.

One of the following:

TRANSPARENT("transparent")

OPAQUE("opaque")

AUTO("auto")

Optional<InputFidelity> inputFidelity

Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1 and gpt-image-1.5 and later models, unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.

One of the following:

HIGH("high")

LOW("low")

Optional<InputImageMask> inputImageMask

Optional mask for inpainting. Contains image_url (string, optional) and file_id (string, optional).

Optional<String> fileId

File ID for the mask image.

Optional<String> imageUrl

Base64-encoded mask image.

Optional<Model> model

The image generation model to use. Default: gpt-image-1.

One of the following:

GPT_IMAGE_1("gpt-image-1")

GPT_IMAGE_1_MINI("gpt-image-1-mini")

GPT_IMAGE_1_5("gpt-image-1.5")

Optional<Moderation> moderation

Moderation level for the generated image. Default: auto.

One of the following:

AUTO("auto")

LOW("low")

Optional<Long> outputCompression

Compression level for the output image. Default: 100.

minimum0

maximum100

Optional<OutputFormat> outputFormat

The output format of the generated image. One of png, webp, or jpeg. Default: png.

One of the following:

PNG("png")

WEBP("webp")

JPEG("jpeg")

Optional<Long> partialImages

Number of partial images to generate in streaming mode, from 0 (default value) to 3.

minimum0

maximum3

Optional<Quality> quality

The quality of the generated image. One of low, medium, high, or auto. Default: auto.

One of the following:

LOW("low")

MEDIUM("medium")

HIGH("high")

AUTO("auto")

Optional<Size> size

The size of the generated image. One of 1024x1024, 1024x1536, 1536x1024, or auto. Default: auto.

One of the following:

_1024X1024("1024x1024")

_1024X1536("1024x1536")

_1536X1024("1536x1024")

AUTO("auto")

JsonValue;

JsonValue; type "local_shell"constant"local_shell"constant

The type of the local shell tool. Always local_shell.

class FunctionShellTool:

A tool that allows the model to execute shell commands.

JsonValue; type "shell"constant"shell"constant

The type of the shell tool. Always shell.

Optional<Environment> environment

One of the following:

class ContainerAuto:

JsonValue; type "container_auto"constant"container_auto"constant

Automatically creates a container for this request

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

Optional<List<Skill>> skills

An optional list of skills referenced by id or inline data.

One of the following:

class SkillReference:

String skillId

The ID of the referenced skill.

maxLength64

minLength1

JsonValue; type "skill_reference"constant"skill_reference"constant

References a skill created with the /v1/skills endpoint.

Optional<String> version

Optional skill version. Use a positive integer or ‘latest’. Omit for default.

class InlineSkill:

String description

The description of the skill.

String name

The name of the skill.

InlineSkillSource source

Inline skill payload

JsonValue; type "inline"constant"inline"constant

Defines an inline skill for this request.

class LocalEnvironment:

JsonValue; type "local"constant"local"constant

Use a local computer environment.

Optional<List<LocalSkill>> skills

An optional list of skills.

String description

The description of the skill.

String name

The name of the skill.

String path

The path to the directory containing the skill.

class ContainerReference:

String containerId

The ID of the referenced container.

JsonValue; type "container_reference"constant"container_reference"constant

References a container created with the /v1/containers endpoint

class CustomTool:

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

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

class NamespaceTool:

Groups function/custom tools under a shared namespace.

String description

A description of the namespace shown to the model.

minLength1

String name

The namespace name used in tool calls (for example, crm).

minLength1

List<Tool> tools

The function/custom tools available inside this namespace.

One of the following:

class Function:

String name

maxLength128

minLength1

JsonValue; type "function"constant"function"constant

Optional<Boolean> deferLoading

Whether this function should be deferred and discovered via tool search.

Optional<String> description

Optional<JsonValue> parameters

Optional<Boolean> strict

class CustomTool:

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

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

JsonValue; type "namespace"constant"namespace"constant

The type of the tool. Always namespace.

class ToolSearchTool:

Hosted or BYOT tool search configuration for deferred tools.

JsonValue; type "tool_search"constant"tool_search"constant

The type of the tool. Always tool_search.

Optional<String> description

Description shown to the model for a client-executed tool search tool.

Optional<Execution> execution

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

One of the following:

SERVER("server")

CLIENT("client")

Optional<JsonValue> parameters

Parameter schema for a client-executed tool search tool.

class WebSearchPreviewTool:

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

Type type

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")

WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")

Optional<List<SearchContentType>> searchContentTypes

One of the following:

TEXT("text")

IMAGE("image")

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The user’s location.

JsonValue; type "approximate"constant"approximate"constant

The type of location approximation. Always approximate.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

class ApplyPatchTool:

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

JsonValue; type "apply_patch"constant"apply_patch"constant

The type of the tool. Always apply_patch.

JsonValue; type "tool_search_output"constant"tool_search_output"constant

The type of the item. Always tool_search_output.

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseCompactionItem:

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

String id

The unique ID of the compaction item.

String encryptedContent

The encrypted content that was produced by compaction.

JsonValue; type "compaction"constant"compaction"constant

The type of the item. Always compaction.

Optional<String> createdBy

The identifier of the actor that created the item.

ImageGenerationCall

String id

The unique ID of the image generation call.

Optional<String> result

The generated image encoded in base64.

Status status

The status of the image generation call.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

GENERATING("generating")

FAILED("failed")

JsonValue; type "image_generation_call"constant"image_generation_call"constant

The type of the image generation call. Always image_generation_call.

class ResponseCodeInterpreterToolCall:

A tool call to run code.

String id

The unique ID of the code interpreter tool call.

Optional<String> code

The code to run, or null if not available.

String containerId

The ID of the container used to run the code.

Optional<List<Output>> outputs

The outputs generated by the code interpreter, such as logs or images. Can be null if no outputs are available.

One of the following:

class Logs:

The logs output from the code interpreter.

String logs

The logs output from the code interpreter.

JsonValue; type "logs"constant"logs"constant

The type of the output. Always logs.

class Image:

The image output from the code interpreter.

JsonValue; type "image"constant"image"constant

The type of the output. Always image.

String url

The URL of the image output from the code interpreter.

Status status

The status of the code interpreter tool call. Valid values are in_progress, completed, incomplete, interpreting, and failed.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

INTERPRETING("interpreting")

FAILED("failed")

JsonValue; type "code_interpreter_call"constant"code_interpreter_call"constant

The type of the code interpreter tool call. Always code_interpreter_call.

LocalShellCall

String id

The unique ID of the local shell call.

Action action

Execute a shell command on the server.

List<String> command

The command to run.

Env env

Environment variables to set for the command.

JsonValue; type "exec"constant"exec"constant

The type of the local shell action. Always exec.

Optional<Long> timeoutMs

Optional timeout in milliseconds for the command.

Optional<String> user

Optional user to run the command as.

Optional<String> workingDirectory

Optional working directory to run the command in.

String callId

The unique ID of the local shell tool call generated by the model.

Status status

The status of the local shell call.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "local_shell_call"constant"local_shell_call"constant

The type of the local shell call. Always local_shell_call.

LocalShellCallOutput

String id

The unique ID of the local shell tool call generated by the model.

String output

A JSON string of the output of the local shell tool call.

JsonValue; type "local_shell_call_output"constant"local_shell_call_output"constant

The type of the local shell tool call output. Always local_shell_call_output.

Optional<Status> status

The status of the item. One of in_progress, completed, or incomplete.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseFunctionShellToolCall:

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

String id

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

Action action

The shell commands and limits that describe how to run the tool call.

List<String> commands

Optional<Long> maxOutputLength

Optional maximum number of characters to return from each command.

Optional<Long> timeoutMs

Optional timeout in milliseconds for the commands.

String callId

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

Optional<Environment> environment

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

One of the following:

class ResponseLocalEnvironment:

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

JsonValue; type "local"constant"local"constant

The environment type. Always local.

class ResponseContainerReference:

Represents a container created with /v1/containers.

String containerId

JsonValue; type "container_reference"constant"container_reference"constant

The environment type. Always container_reference.

Status status

The status of the shell call. One of in_progress, completed, or incomplete.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "shell_call"constant"shell_call"constant

The type of the item. Always shell_call.

Optional<String> createdBy

The ID of the entity that created this tool call.

class ResponseFunctionShellToolCallOutput:

The output of a shell tool call that was emitted.

String id

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

String callId

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

Optional<Long> maxOutputLength

The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output.

List<Output> output

An array of shell call output contents

Outcome outcome

Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk.

One of the following:

JsonValue;

JsonValue; type "timeout"constant"timeout"constant

The outcome type. Always timeout.

class Exit:

Indicates that the shell commands finished and returned an exit code.

long exitCode

Exit code from the shell process.

JsonValue; type "exit"constant"exit"constant

The outcome type. Always exit.

String stderr

The standard error output that was captured.

String stdout

The standard output that was captured.

Optional<String> createdBy

The identifier of the actor that created the item.

Status status

The status of the shell call output. One of in_progress, completed, or incomplete.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "shell_call_output"constant"shell_call_output"constant

The type of the shell call output. Always shell_call_output.

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseApplyPatchToolCall:

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

String id

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

String callId

The unique ID of the apply patch tool call generated by the model.

Operation operation

One of the create_file, delete_file, or update_file operations applied via apply_patch.

One of the following:

class CreateFile:

Instruction describing how to create a file via the apply_patch tool.

String diff

Diff to apply.

String path

Path of the file to create.

JsonValue; type "create_file"constant"create_file"constant

Create a new file with the provided diff.

class DeleteFile:

Instruction describing how to delete a file via the apply_patch tool.

String path

Path of the file to delete.

JsonValue; type "delete_file"constant"delete_file"constant

Delete the specified file.

class UpdateFile:

Instruction describing how to update a file via the apply_patch tool.

String diff

Diff to apply.

String path

Path of the file to update.

JsonValue; type "update_file"constant"update_file"constant

Update an existing file with the provided diff.

Status status

The status of the apply patch tool call. One of in_progress or completed.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

JsonValue; type "apply_patch_call"constant"apply_patch_call"constant

The type of the item. Always apply_patch_call.

Optional<String> createdBy

The ID of the entity that created this tool call.

class ResponseApplyPatchToolCallOutput:

The output emitted by an apply patch tool call.

String id

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

String callId

The unique ID of the apply patch tool call generated by the model.

Status status

The status of the apply patch tool call output. One of completed or failed.

One of the following:

COMPLETED("completed")

FAILED("failed")

JsonValue; type "apply_patch_call_output"constant"apply_patch_call_output"constant

The type of the item. Always apply_patch_call_output.

Optional<String> createdBy

The ID of the entity that created this tool call output.

Optional<String> output

Optional textual output returned by the apply patch tool.

McpCall

String id

The unique ID of the tool call.

String arguments

A JSON string of the arguments passed to the tool.

String name

The name of the tool that was run.

String serverLabel

The label of the MCP server running the tool.

JsonValue; type "mcp_call"constant"mcp_call"constant

The type of the item. Always mcp_call.

Optional<String> approvalRequestId

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.

Optional<String> error

The error from the tool call, if any.

Optional<String> output

The output from the tool call.

Optional<Status> status

The status of the tool call. One of in_progress, completed, incomplete, calling, or failed.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

CALLING("calling")

FAILED("failed")

McpListTools

String id

The unique ID of the list.

String serverLabel

The label of the MCP server.

List<Tool> tools

The tools available on the server.

JsonValue inputSchema

The JSON schema describing the tool’s input.

String name

The name of the tool.

Optional<JsonValue> annotations

Additional annotations about the tool.

Optional<String> description

The description of the tool.

JsonValue; type "mcp_list_tools"constant"mcp_list_tools"constant

The type of the item. Always mcp_list_tools.

Optional<String> error

Error message if the server could not list tools.

McpApprovalRequest

String id

The unique ID of the approval request.

String arguments

A JSON string of arguments for the tool.

String name

The name of the tool to run.

String serverLabel

The label of the MCP server making the request.

JsonValue; type "mcp_approval_request"constant"mcp_approval_request"constant

The type of the item. Always mcp_approval_request.

McpApprovalResponse

String id

The unique ID of the approval response

String approvalRequestId

The ID of the approval request being answered.

boolean approve

Whether the request was approved.

JsonValue; type "mcp_approval_response"constant"mcp_approval_response"constant

The type of the item. Always mcp_approval_response.

Optional<String> reason

Optional reason for the decision.

class ResponseCustomToolCall:

A call to a custom tool created by the model.

String callId

An identifier used to map this custom tool call to a tool call output.

String input

The input for the custom tool call generated by the model.

String name

The name of the custom tool being called.

JsonValue; type "custom_tool_call"constant"custom_tool_call"constant

The type of the custom tool call. Always custom_tool_call.

Optional<String> id

The unique ID of the custom tool call in the OpenAI platform.

Optional<String> namespace

The namespace of the custom tool being called.

class ResponseCustomToolCallOutputItem:

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

String id

The unique ID of the custom tool call output item.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

Optional<String> createdBy

The identifier of the actor that created the item.

boolean parallelToolCalls

Whether to allow the model to run tool calls in parallel.

Optional<Double> temperature

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

ToolChoice toolChoice

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:

enum ToolChoiceOptions:

Controls which (if any) tool is called by the model.

none means the model will not call any tool and instead generates a message.

auto means the model can pick between generating a message or calling one or more tools.

required means the model must call one or more tools.

NONE("none")

AUTO("auto")

REQUIRED("required")

class ToolChoiceAllowed:

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

Mode mode

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("auto")

REQUIRED("required")

List<Tool> tools

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

JsonValue; type "allowed_tools"constant"allowed_tools"constant

Allowed tool configuration type. Always allowed_tools.

class ToolChoiceTypes:

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

Type type

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("file_search")

WEB_SEARCH_PREVIEW("web_search_preview")

COMPUTER("computer")

COMPUTER_USE_PREVIEW("computer_use_preview")

COMPUTER_USE("computer_use")

WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")

IMAGE_GENERATION("image_generation")

CODE_INTERPRETER("code_interpreter")

class ToolChoiceFunction:

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

String name

The name of the function to call.

JsonValue; type "function"constant"function"constant

For function calling, the type is always function.

class ToolChoiceMcp:

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

String serverLabel

The label of the MCP server to use.

JsonValue; type "mcp"constant"mcp"constant

For MCP tools, the type is always mcp.

Optional<String> name

The name of the tool to call on the server.

class ToolChoiceCustom:

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

String name

The name of the custom tool to call.

JsonValue; type "custom"constant"custom"constant

For custom tool calling, the type is always custom.

class ToolChoiceApplyPatch:

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

JsonValue; type "apply_patch"constant"apply_patch"constant

The tool to call. Always apply_patch.

class ToolChoiceShell:

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

JsonValue; type "shell"constant"shell"constant

The tool to call. Always shell.

List<Tool> tools

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:

class FunctionTool:

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

String name

The name of the function to call.

Optional<Parameters> parameters

A JSON schema object describing the parameters of the function.

Optional<Boolean> strict

Whether to enforce strict parameter validation. Default true.

JsonValue; type "function"constant"function"constant

The type of the function tool. Always function.

Optional<Boolean> deferLoading

Whether this function is deferred and loaded via tool search.

Optional<String> description

A description of the function. Used by the model to determine whether or not to call the function.

class FileSearchTool:

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

JsonValue; type "file_search"constant"file_search"constant

The type of the file search tool. Always file_search.

List<String> vectorStoreIds

The IDs of the vector stores to search.

Optional<Filters> filters

A filter to apply.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

class CompoundFilter:

Combine multiple filters using and or or.

List<Filter> filters

Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

JsonValue

Type type

Type of operation: and or or.

One of the following:

AND("and")

OR("or")

Optional<Long> maxNumResults

The maximum number of results to return. This number should be between 1 and 50 inclusive.

Optional<RankingOptions> rankingOptions

Ranking options for search.

Optional<HybridSearch> hybridSearch

Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled.

double embeddingWeight

The weight of the embedding in the reciprocal ranking fusion.

double textWeight

The weight of the text in the reciprocal ranking fusion.

Optional<Ranker> ranker

The ranker to use for the file search.

One of the following:

AUTO("auto")

DEFAULT_2024_11_15("default-2024-11-15")

Optional<Double> scoreThreshold

The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.

class ComputerTool:

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

JsonValue; type "computer"constant"computer"constant

The type of the computer tool. Always computer.

class ComputerUsePreviewTool:

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

long displayHeight

The height of the computer display.

long displayWidth

The width of the computer display.

Environment environment

The type of computer environment to control.

One of the following:

WINDOWS("windows")

MAC("mac")

LINUX("linux")

UBUNTU("ubuntu")

BROWSER("browser")

JsonValue; type "computer_use_preview"constant"computer_use_preview"constant

The type of the computer use tool. Always computer_use_preview.

class WebSearchTool:

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

Type type

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")

WEB_SEARCH_2025_08_26("web_search_2025_08_26")

Optional<Filters> filters

Filters for the search.

Optional<List<String>> allowedDomains

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

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The approximate location of the user.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

Optional<Type> type

The type of location approximation. Always approximate.

Mcp

String serverLabel

A label for this MCP server, used to identify it in tool calls.

JsonValue; type "mcp"constant"mcp"constant

The type of the MCP tool. Always mcp.

Optional<AllowedTools> allowedTools

List of allowed tool names or a filter object.

One of the following:

List<String>

class McpToolFilter:

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<String> authorization

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.

Optional<ConnectorId> connectorId

Identifier for service connectors, like those available in ChatGPT. One of server_url or connector_id must be provided. Learn more about service connectors here.

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_dropbox")

CONNECTOR_GMAIL("connector_gmail")

CONNECTOR_GOOGLECALENDAR("connector_googlecalendar")

CONNECTOR_GOOGLEDRIVE("connector_googledrive")

CONNECTOR_MICROSOFTTEAMS("connector_microsoftteams")

CONNECTOR_OUTLOOKCALENDAR("connector_outlookcalendar")

CONNECTOR_OUTLOOKEMAIL("connector_outlookemail")

CONNECTOR_SHAREPOINT("connector_sharepoint")

Optional<Boolean> deferLoading

Whether this MCP tool is deferred and discovered via tool search.

Optional<Headers> headers

Optional HTTP headers to send to the MCP server. Use for authentication or other purposes.

Optional<RequireApproval> requireApproval

Specify which of the MCP server’s tools require approval.

One of the following:

class McpToolApprovalFilter:

Specify which of the MCP server’s tools require approval. Can be always, never, or a filter object associated with tools that require approval.

Optional<Always> always

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<Never> never

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

enum McpToolApprovalSetting:

Specify a single approval policy for all tools. One of always or never. When set to always, all tools will require approval. When set to never, all tools will not require approval.

ALWAYS("always")

NEVER("never")

Optional<String> serverDescription

Optional description of the MCP server, used to provide more context.

Optional<String> serverUrl

The URL for the MCP server. One of server_url or connector_id must be provided.

CodeInterpreter

Container container

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

class CodeInterpreterToolAuto:

Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.

JsonValue; type "auto"constant"auto"constant

Always auto.

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the code interpreter container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

JsonValue; type "code_interpreter"constant"code_interpreter"constant

The type of the code interpreter tool. Always code_interpreter.

ImageGeneration

JsonValue; type "image_generation"constant"image_generation"constant

The type of the image generation tool. Always image_generation.

Optional<Action> action

Whether to generate a new image or edit an existing image. Default: auto.

One of the following:

GENERATE("generate")

EDIT("edit")

AUTO("auto")

Optional<Background> background

Background type for the generated image. One of transparent, opaque, or auto. Default: auto.

One of the following:

TRANSPARENT("transparent")

OPAQUE("opaque")

AUTO("auto")

Optional<InputFidelity> inputFidelity

Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1 and gpt-image-1.5 and later models, unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.

One of the following:

HIGH("high")

LOW("low")

Optional<InputImageMask> inputImageMask

Optional mask for inpainting. Contains image_url (string, optional) and file_id (string, optional).

Optional<String> fileId

File ID for the mask image.

Optional<String> imageUrl

Base64-encoded mask image.

Optional<Model> model

The image generation model to use. Default: gpt-image-1.

One of the following:

GPT_IMAGE_1("gpt-image-1")

GPT_IMAGE_1_MINI("gpt-image-1-mini")

GPT_IMAGE_1_5("gpt-image-1.5")

Optional<Moderation> moderation

Moderation level for the generated image. Default: auto.

One of the following:

AUTO("auto")

LOW("low")

Optional<Long> outputCompression

Compression level for the output image. Default: 100.

minimum0

maximum100

Optional<OutputFormat> outputFormat

The output format of the generated image. One of png, webp, or jpeg. Default: png.

One of the following:

PNG("png")

WEBP("webp")

JPEG("jpeg")

Optional<Long> partialImages

Number of partial images to generate in streaming mode, from 0 (default value) to 3.

minimum0

maximum3

Optional<Quality> quality

The quality of the generated image. One of low, medium, high, or auto. Default: auto.

One of the following:

LOW("low")

MEDIUM("medium")

HIGH("high")

AUTO("auto")

Optional<Size> size

The size of the generated image. One of 1024x1024, 1024x1536, 1536x1024, or auto. Default: auto.

One of the following:

_1024X1024("1024x1024")

_1024X1536("1024x1536")

_1536X1024("1536x1024")

AUTO("auto")

JsonValue;

JsonValue; type "local_shell"constant"local_shell"constant

The type of the local shell tool. Always local_shell.

class FunctionShellTool:

A tool that allows the model to execute shell commands.

JsonValue; type "shell"constant"shell"constant

The type of the shell tool. Always shell.

Optional<Environment> environment

One of the following:

class ContainerAuto:

JsonValue; type "container_auto"constant"container_auto"constant

Automatically creates a container for this request

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

Optional<List<Skill>> skills

An optional list of skills referenced by id or inline data.

One of the following:

class SkillReference:

String skillId

The ID of the referenced skill.

maxLength64

minLength1

JsonValue; type "skill_reference"constant"skill_reference"constant

References a skill created with the /v1/skills endpoint.

Optional<String> version

Optional skill version. Use a positive integer or ‘latest’. Omit for default.

class InlineSkill:

String description

The description of the skill.

String name

The name of the skill.

InlineSkillSource source

Inline skill payload

JsonValue; type "inline"constant"inline"constant

Defines an inline skill for this request.

class LocalEnvironment:

JsonValue; type "local"constant"local"constant

Use a local computer environment.

Optional<List<LocalSkill>> skills

An optional list of skills.

String description

The description of the skill.

String name

The name of the skill.

String path

The path to the directory containing the skill.

class ContainerReference:

String containerId

The ID of the referenced container.

JsonValue; type "container_reference"constant"container_reference"constant

References a container created with the /v1/containers endpoint

class CustomTool:

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

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

class NamespaceTool:

Groups function/custom tools under a shared namespace.

String description

A description of the namespace shown to the model.

minLength1

String name

The namespace name used in tool calls (for example, crm).

minLength1

List<Tool> tools

The function/custom tools available inside this namespace.

One of the following:

class Function:

String name

maxLength128

minLength1

JsonValue; type "function"constant"function"constant

Optional<Boolean> deferLoading

Whether this function should be deferred and discovered via tool search.

Optional<String> description

Optional<JsonValue> parameters

Optional<Boolean> strict

class CustomTool:

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

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

JsonValue; type "namespace"constant"namespace"constant

The type of the tool. Always namespace.

class ToolSearchTool:

Hosted or BYOT tool search configuration for deferred tools.

JsonValue; type "tool_search"constant"tool_search"constant

The type of the tool. Always tool_search.

Optional<String> description

Description shown to the model for a client-executed tool search tool.

Optional<Execution> execution

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

One of the following:

SERVER("server")

CLIENT("client")

Optional<JsonValue> parameters

Parameter schema for a client-executed tool search tool.

class WebSearchPreviewTool:

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

Type type

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")

WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")

Optional<List<SearchContentType>> searchContentTypes

One of the following:

TEXT("text")

IMAGE("image")

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The user’s location.

JsonValue; type "approximate"constant"approximate"constant

The type of location approximation. Always approximate.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

class ApplyPatchTool:

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

JsonValue; type "apply_patch"constant"apply_patch"constant

The type of the tool. Always apply_patch.

Optional<Double> topP

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

Optional<Boolean> background

Whether to run the model response in the background. Learn more.

Optional<Double> completedAt

Unix timestamp (in seconds) of when this Response was completed. Only present when the status is completed.

Optional<Conversation> conversation

The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation.

String id

The unique ID of the conversation that this response was associated with.

Optional<Long> maxOutputTokens

An upper bound for the number of tokens that can be generated for a response, including visible output tokens and reasoning tokens.

Optional<Long> maxToolCalls

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.

Optional<String> previousResponseId

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.

Optional<ResponsePrompt> prompt

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

Optional<String> promptCacheKey

Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more.

Optional<PromptCacheRetention> promptCacheRetention

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.

One of the following:

IN_MEMORY("in_memory")

_24H("24h")

Optional<Reasoning> reasoning

gpt-5 and o-series models only

Configuration options for reasoning models.

Optional<String> safetyIdentifier

A stable identifier used to help detect users of your application that may be violating OpenAI’s usage policies. The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. Learn more.

maxLength64

Optional<ServiceTier> serviceTier

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’ or ‘priority’, then the request will be processed with the corresponding service tier.
• When not set, the default behavior is ‘auto’.

When the service_tier parameter is set, the response body will include the service_tier value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.

One of the following:

AUTO("auto")

DEFAULT("default")

FLEX("flex")

SCALE("scale")

PRIORITY("priority")

Optional<ResponseStatus> status

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

Optional<ResponseTextConfig> text

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

Optional<Long> topLogprobs

An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability.

minimum0

maximum20

Optional<Truncation> truncation

The truncation strategy to use for the model response.

• auto: If the input to this Response exceeds the model’s context window size, the model will truncate the response to fit the context window by dropping items from the beginning of the conversation.
• disabled (default): If the input size will exceed the context window size for a model, the request will fail with a 400 error.

One of the following:

AUTO("auto")

DISABLED("disabled")

Optional<ResponseUsage> usage

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

DeprecatedOptional<String> user

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.

class ResponseApplyPatchToolCall:

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

String id

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

String callId

The unique ID of the apply patch tool call generated by the model.

Operation operation

One of the create_file, delete_file, or update_file operations applied via apply_patch.

One of the following:

class CreateFile:

Instruction describing how to create a file via the apply_patch tool.

String diff

Diff to apply.

String path

Path of the file to create.

JsonValue; type "create_file"constant"create_file"constant

Create a new file with the provided diff.

class DeleteFile:

Instruction describing how to delete a file via the apply_patch tool.

String path

Path of the file to delete.

JsonValue; type "delete_file"constant"delete_file"constant

Delete the specified file.

class UpdateFile:

Instruction describing how to update a file via the apply_patch tool.

String diff

Diff to apply.

String path

Path of the file to update.

JsonValue; type "update_file"constant"update_file"constant

Update an existing file with the provided diff.

Status status

The status of the apply patch tool call. One of in_progress or completed.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

JsonValue; type "apply_patch_call"constant"apply_patch_call"constant

The type of the item. Always apply_patch_call.

Optional<String> createdBy

The ID of the entity that created this tool call.

class ResponseApplyPatchToolCallOutput:

The output emitted by an apply patch tool call.

String id

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

String callId

The unique ID of the apply patch tool call generated by the model.

Status status

The status of the apply patch tool call output. One of completed or failed.

One of the following:

COMPLETED("completed")

FAILED("failed")

JsonValue; type "apply_patch_call_output"constant"apply_patch_call_output"constant

The type of the item. Always apply_patch_call_output.

Optional<String> createdBy

The ID of the entity that created this tool call output.

Optional<String> output

Optional textual output returned by the apply patch tool.

class ResponseAudioDeltaEvent:

Emitted when there is a partial audio response.

String delta

A chunk of Base64 encoded response audio bytes.

long sequenceNumber

A sequence number for this chunk of the stream response.

JsonValue; type "response.audio.delta"constant"response.audio.delta"constant

The type of the event. Always response.audio.delta.

class ResponseAudioDoneEvent:

Emitted when the audio response is complete.

long sequenceNumber

The sequence number of the delta.

JsonValue; type "response.audio.done"constant"response.audio.done"constant

The type of the event. Always response.audio.done.

class ResponseAudioTranscriptDeltaEvent:

Emitted when there is a partial transcript of audio.

String delta

The partial transcript of the audio response.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.audio.transcript.delta"constant"response.audio.transcript.delta"constant

The type of the event. Always response.audio.transcript.delta.

class ResponseAudioTranscriptDoneEvent:

Emitted when the full audio transcript is completed.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.audio.transcript.done"constant"response.audio.transcript.done"constant

The type of the event. Always response.audio.transcript.done.

class ResponseCodeInterpreterCallCodeDeltaEvent:

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

String delta

The partial code snippet being streamed by the code interpreter.

String itemId

The unique identifier of the code interpreter tool call item.

long outputIndex

The index of the output item in the response for which the code is being streamed.

long sequenceNumber

The sequence number of this event, used to order streaming events.

JsonValue; type "response.code_interpreter_call_code.delta"constant"response.code_interpreter_call_code.delta"constant

The type of the event. Always response.code_interpreter_call_code.delta.

class ResponseCodeInterpreterCallCodeDoneEvent:

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

String code

The final code snippet output by the code interpreter.

String itemId

The unique identifier of the code interpreter tool call item.

long outputIndex

The index of the output item in the response for which the code is finalized.

long sequenceNumber

The sequence number of this event, used to order streaming events.

JsonValue; type "response.code_interpreter_call_code.done"constant"response.code_interpreter_call_code.done"constant

The type of the event. Always response.code_interpreter_call_code.done.

class ResponseCodeInterpreterCallCompletedEvent:

Emitted when the code interpreter call is completed.

String itemId

The unique identifier of the code interpreter tool call item.

long outputIndex

The index of the output item in the response for which the code interpreter call is completed.

long sequenceNumber

The sequence number of this event, used to order streaming events.

JsonValue; type "response.code_interpreter_call.completed"constant"response.code_interpreter_call.completed"constant

The type of the event. Always response.code_interpreter_call.completed.

class ResponseCodeInterpreterCallInProgressEvent:

Emitted when a code interpreter call is in progress.

String itemId

The unique identifier of the code interpreter tool call item.

long outputIndex

The index of the output item in the response for which the code interpreter call is in progress.

long sequenceNumber

The sequence number of this event, used to order streaming events.

JsonValue; type "response.code_interpreter_call.in_progress"constant"response.code_interpreter_call.in_progress"constant

The type of the event. Always response.code_interpreter_call.in_progress.

class ResponseCodeInterpreterCallInterpretingEvent:

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

String itemId

The unique identifier of the code interpreter tool call item.

long outputIndex

The index of the output item in the response for which the code interpreter is interpreting code.

long sequenceNumber

The sequence number of this event, used to order streaming events.

JsonValue; type "response.code_interpreter_call.interpreting"constant"response.code_interpreter_call.interpreting"constant

The type of the event. Always response.code_interpreter_call.interpreting.

class ResponseCodeInterpreterToolCall:

A tool call to run code.

String id

The unique ID of the code interpreter tool call.

Optional<String> code

The code to run, or null if not available.

String containerId

The ID of the container used to run the code.

Optional<List<Output>> outputs

The outputs generated by the code interpreter, such as logs or images. Can be null if no outputs are available.

One of the following:

class Logs:

The logs output from the code interpreter.

String logs

The logs output from the code interpreter.

JsonValue; type "logs"constant"logs"constant

The type of the output. Always logs.

class Image:

The image output from the code interpreter.

JsonValue; type "image"constant"image"constant

The type of the output. Always image.

String url

The URL of the image output from the code interpreter.

Status status

The status of the code interpreter tool call. Valid values are in_progress, completed, incomplete, interpreting, and failed.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

INTERPRETING("interpreting")

FAILED("failed")

JsonValue; type "code_interpreter_call"constant"code_interpreter_call"constant

The type of the code interpreter tool call. Always code_interpreter_call.

class ResponseCompactionItem:

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

String id

The unique ID of the compaction item.

String encryptedContent

The encrypted content that was produced by compaction.

JsonValue; type "compaction"constant"compaction"constant

The type of the item. Always compaction.

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseCompactionItemParam:

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

String encryptedContent

The encrypted content of the compaction summary.

maxLength10485760

JsonValue; type "compaction"constant"compaction"constant

The type of the item. Always compaction.

Optional<String> id

The ID of the compaction item.

class ResponseCompletedEvent:

Emitted when the model response is complete.

Response response

Properties of the completed response.

long sequenceNumber

The sequence number for this event.

JsonValue; type "response.completed"constant"response.completed"constant

The type of the event. Always response.completed.

class ResponseComputerToolCall:

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

String id

The unique ID of the computer call.

String callId

An identifier used when responding to the tool call with output.

List<PendingSafetyCheck> pendingSafetyChecks

The pending safety checks for the computer call.

String id

The ID of the pending safety check.

Optional<String> code

The type of the pending safety check.

Optional<String> message

Details about the pending safety check.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

Type type

The type of the computer call. Always computer_call.

Optional<Action> action

A click action.

One of the following:

class Click:

A click action.

Button button

Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.

One of the following:

LEFT("left")

RIGHT("right")

WHEEL("wheel")

BACK("back")

FORWARD("forward")

JsonValue; type "click"constant"click"constant

Specifies the event type. For a click action, this property is always click.

long x

The x-coordinate where the click occurred.

long y

The y-coordinate where the click occurred.

Optional<List<String>> keys

The keys being held while clicking.

class DoubleClick:

A double click action.

Optional<List<String>> keys

The keys being held while double-clicking.

JsonValue; type "double_click"constant"double_click"constant

Specifies the event type. For a double click action, this property is always set to double_click.

long x

The x-coordinate where the double click occurred.

long y

The y-coordinate where the double click occurred.

class Drag:

A drag action.

List<Path> path

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

long x

The x-coordinate.

long y

The y-coordinate.

JsonValue; type "drag"constant"drag"constant

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

Optional<List<String>> keys

The keys being held while dragging the mouse.

class Keypress:

A collection of keypresses the model would like to perform.

List<String> keys

The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key.

JsonValue; type "keypress"constant"keypress"constant

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

class Move:

A mouse move action.

JsonValue; type "move"constant"move"constant

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

long x

The x-coordinate to move to.

long y

The y-coordinate to move to.

Optional<List<String>> keys

The keys being held while moving the mouse.

JsonValue;

JsonValue; type "screenshot"constant"screenshot"constant

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

class Scroll:

A scroll action.

long scrollX

The horizontal scroll distance.

long scrollY

The vertical scroll distance.

JsonValue; type "scroll"constant"scroll"constant

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

long x

The x-coordinate where the scroll occurred.

long y

The y-coordinate where the scroll occurred.

Optional<List<String>> keys

The keys being held while scrolling.

class Type:

An action to type in text.

String text

The text to type.

JsonValue; type "type"constant"type"constant

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

JsonValue;

JsonValue; type "wait"constant"wait"constant

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

Optional<List<ComputerAction>> actions

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

class ResponseComputerToolCallOutputItem:

String id

The unique ID of the computer call tool output.

String callId

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

ResponseComputerToolCallOutputScreenshot output

A computer screenshot image used with the computer use tool.

Status status

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("completed")

INCOMPLETE("incomplete")

FAILED("failed")

IN_PROGRESS("in_progress")

JsonValue; type "computer_call_output"constant"computer_call_output"constant

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

Optional<List<AcknowledgedSafetyCheck>> acknowledgedSafetyChecks

The safety checks reported by the API that have been acknowledged by the developer.

String id

The ID of the pending safety check.

Optional<String> code

The type of the pending safety check.

Optional<String> message

Details about the pending safety check.

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseComputerToolCallOutputScreenshot:

A computer screenshot image used with the computer use tool.

JsonValue; type "computer_screenshot"constant"computer_screenshot"constant

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

Optional<String> fileId

The identifier of an uploaded file that contains the screenshot.

Optional<String> imageUrl

The URL of the screenshot image.

class ResponseContainerReference:

Represents a container created with /v1/containers.

String containerId

JsonValue; type "container_reference"constant"container_reference"constant

The environment type. Always container_reference.

class ResponseContent: A class that can be one of several variants.union

Multi-modal input and output contents.

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputImage:

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

Detail detail

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("low")

HIGH("high")

AUTO("auto")

ORIGINAL("original")

JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<String> fileId

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

Optional<String> imageUrl

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

class ResponseInputFile:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

Optional<Detail> detail

The detail level of the file to be sent to the model. Use low for the default rendering behavior, or high to render the file at higher quality. Defaults to low.

One of the following:

LOW("low")

HIGH("high")

Optional<String> fileData

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

Optional<String> fileId

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

Optional<String> fileUrl

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

Optional<String> filename

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

class ResponseOutputText:

A text output from the model.

List<Annotation> annotations

The annotations of the text output.

One of the following:

class FileCitation:

A citation to a file.

String fileId

The ID of the file.

String filename

The filename of the file cited.

long index

The index of the file in the list of files.

JsonValue; type "file_citation"constant"file_citation"constant

The type of the file citation. Always file_citation.

class UrlCitation:

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

long endIndex

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

long startIndex

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

String title

The title of the web resource.

JsonValue; type "url_citation"constant"url_citation"constant

The type of the URL citation. Always url_citation.

String url

The URL of the web resource.

class ContainerFileCitation:

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

String containerId

The ID of the container file.

long endIndex

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

String fileId

The ID of the file.

String filename

The filename of the container file cited.

long startIndex

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

JsonValue; type "container_file_citation"constant"container_file_citation"constant

The type of the container file citation. Always container_file_citation.

class FilePath:

A path to a file.

String fileId

The ID of the file.

long index

The index of the file in the list of files.

JsonValue; type "file_path"constant"file_path"constant

The type of the file path. Always file_path.

String text

The text output from the model.

JsonValue; type "output_text"constant"output_text"constant

The type of the output text. Always output_text.

Optional<List<Logprob>> logprobs

String token

List<long> bytes

double logprob

List<TopLogprob> topLogprobs

String token

List<long> bytes

double logprob

class ResponseOutputRefusal:

A refusal from the model.

String refusal

The refusal explanation from the model.

JsonValue; type "refusal"constant"refusal"constant

The type of the refusal. Always refusal.

ReasoningTextContent

String text

The reasoning text from the model.

JsonValue; type "reasoning_text"constant"reasoning_text"constant

The type of the reasoning text. Always reasoning_text.

class ResponseContentPartAddedEvent:

Emitted when a new content part is added.

long contentIndex

The index of the content part that was added.

String itemId

The ID of the output item that the content part was added to.

long outputIndex

The index of the output item that the content part was added to.

Part part

The content part that was added.

One of the following:

class ResponseOutputText:

A text output from the model.

List<Annotation> annotations

The annotations of the text output.

One of the following:

class FileCitation:

A citation to a file.

String fileId

The ID of the file.

String filename

The filename of the file cited.

long index

The index of the file in the list of files.

JsonValue; type "file_citation"constant"file_citation"constant

The type of the file citation. Always file_citation.

class UrlCitation:

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

long endIndex

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

long startIndex

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

String title

The title of the web resource.

JsonValue; type "url_citation"constant"url_citation"constant

The type of the URL citation. Always url_citation.

String url

The URL of the web resource.

class ContainerFileCitation:

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

String containerId

The ID of the container file.

long endIndex

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

String fileId

The ID of the file.

String filename

The filename of the container file cited.

long startIndex

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

JsonValue; type "container_file_citation"constant"container_file_citation"constant

The type of the container file citation. Always container_file_citation.

class FilePath:

A path to a file.

String fileId

The ID of the file.

long index

The index of the file in the list of files.

JsonValue; type "file_path"constant"file_path"constant

The type of the file path. Always file_path.

String text

The text output from the model.

JsonValue; type "output_text"constant"output_text"constant

The type of the output text. Always output_text.

Optional<List<Logprob>> logprobs

String token

List<long> bytes

double logprob

List<TopLogprob> topLogprobs

String token

List<long> bytes

double logprob

class ResponseOutputRefusal:

A refusal from the model.

String refusal

The refusal explanation from the model.

JsonValue; type "refusal"constant"refusal"constant

The type of the refusal. Always refusal.

class ReasoningText:

Reasoning text from the model.

String text

The reasoning text from the model.

JsonValue; type "reasoning_text"constant"reasoning_text"constant

The type of the reasoning text. Always reasoning_text.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.content_part.added"constant"response.content_part.added"constant

The type of the event. Always response.content_part.added.

class ResponseContentPartDoneEvent:

Emitted when a content part is done.

long contentIndex

The index of the content part that is done.

String itemId

The ID of the output item that the content part was added to.

long outputIndex

The index of the output item that the content part was added to.

Part part

The content part that is done.

One of the following:

class ResponseOutputText:

A text output from the model.

List<Annotation> annotations

The annotations of the text output.

One of the following:

class FileCitation:

A citation to a file.

String fileId

The ID of the file.

String filename

The filename of the file cited.

long index

The index of the file in the list of files.

JsonValue; type "file_citation"constant"file_citation"constant

The type of the file citation. Always file_citation.

class UrlCitation:

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

long endIndex

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

long startIndex

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

String title

The title of the web resource.

JsonValue; type "url_citation"constant"url_citation"constant

The type of the URL citation. Always url_citation.

String url

The URL of the web resource.

class ContainerFileCitation:

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

String containerId

The ID of the container file.

long endIndex

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

String fileId

The ID of the file.

String filename

The filename of the container file cited.

long startIndex

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

JsonValue; type "container_file_citation"constant"container_file_citation"constant

The type of the container file citation. Always container_file_citation.

class FilePath:

A path to a file.

String fileId

The ID of the file.

long index

The index of the file in the list of files.

JsonValue; type "file_path"constant"file_path"constant

The type of the file path. Always file_path.

String text

The text output from the model.

JsonValue; type "output_text"constant"output_text"constant

The type of the output text. Always output_text.

Optional<List<Logprob>> logprobs

String token

List<long> bytes

double logprob

List<TopLogprob> topLogprobs

String token

List<long> bytes

double logprob

class ResponseOutputRefusal:

A refusal from the model.

String refusal

The refusal explanation from the model.

JsonValue; type "refusal"constant"refusal"constant

The type of the refusal. Always refusal.

class ReasoningText:

Reasoning text from the model.

String text

The reasoning text from the model.

JsonValue; type "reasoning_text"constant"reasoning_text"constant

The type of the reasoning text. Always reasoning_text.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.content_part.done"constant"response.content_part.done"constant

The type of the event. Always response.content_part.done.

class ResponseConversationParam:

The conversation that this response belongs to.

String id

The unique ID of the conversation.

class ResponseCreatedEvent:

An event that is emitted when a response is created.

Response response

The response that was created.

long sequenceNumber

The sequence number for this event.

JsonValue; type "response.created"constant"response.created"constant

The type of the event. Always response.created.

class ResponseCustomToolCall:

A call to a custom tool created by the model.

String callId

An identifier used to map this custom tool call to a tool call output.

String input

The input for the custom tool call generated by the model.

String name

The name of the custom tool being called.

JsonValue; type "custom_tool_call"constant"custom_tool_call"constant

The type of the custom tool call. Always custom_tool_call.

Optional<String> id

The unique ID of the custom tool call in the OpenAI platform.

Optional<String> namespace

The namespace of the custom tool being called.

class ResponseCustomToolCallInputDeltaEvent:

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

String delta

The incremental input data (delta) for the custom tool call.

String itemId

Unique identifier for the API item associated with this event.

long outputIndex

The index of the output this delta applies to.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.custom_tool_call_input.delta"constant"response.custom_tool_call_input.delta"constant

The event type identifier.

class ResponseCustomToolCallInputDoneEvent:

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

String input

The complete input data for the custom tool call.

String itemId

Unique identifier for the API item associated with this event.

long outputIndex

The index of the output this event applies to.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.custom_tool_call_input.done"constant"response.custom_tool_call_input.done"constant

The event type identifier.

class ResponseCustomToolCallItem:

A call to a custom tool created by the model.

String id

The unique ID of the custom tool call item.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseCustomToolCallOutput:

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

String callId

The call ID, used to map this custom tool call output to a custom tool call.

Output output

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:

String

List<FunctionAndCustomToolCallOutput>

One of the following:

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputImage:

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

Detail detail

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("low")

HIGH("high")

AUTO("auto")

ORIGINAL("original")

JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<String> fileId

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

Optional<String> imageUrl

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

class ResponseInputFile:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

Optional<Detail> detail

The detail level of the file to be sent to the model. Use low for the default rendering behavior, or high to render the file at higher quality. Defaults to low.

One of the following:

LOW("low")

HIGH("high")

Optional<String> fileData

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

Optional<String> fileId

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

Optional<String> fileUrl

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

Optional<String> filename

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

JsonValue; type "custom_tool_call_output"constant"custom_tool_call_output"constant

The type of the custom tool call output. Always custom_tool_call_output.

Optional<String> id

The unique ID of the custom tool call output in the OpenAI platform.

class ResponseCustomToolCallOutputItem:

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

String id

The unique ID of the custom tool call output item.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseError:

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

Code code

The error code for the response.

One of the following:

SERVER_ERROR("server_error")

RATE_LIMIT_EXCEEDED("rate_limit_exceeded")

INVALID_PROMPT("invalid_prompt")

VECTOR_STORE_TIMEOUT("vector_store_timeout")

INVALID_IMAGE("invalid_image")

INVALID_IMAGE_FORMAT("invalid_image_format")

INVALID_BASE64_IMAGE("invalid_base64_image")

INVALID_IMAGE_URL("invalid_image_url")

IMAGE_TOO_LARGE("image_too_large")

IMAGE_TOO_SMALL("image_too_small")

IMAGE_PARSE_ERROR("image_parse_error")

IMAGE_CONTENT_POLICY_VIOLATION("image_content_policy_violation")

INVALID_IMAGE_MODE("invalid_image_mode")

IMAGE_FILE_TOO_LARGE("image_file_too_large")

UNSUPPORTED_IMAGE_MEDIA_TYPE("unsupported_image_media_type")

EMPTY_IMAGE_FILE("empty_image_file")

FAILED_TO_DOWNLOAD_IMAGE("failed_to_download_image")

IMAGE_FILE_NOT_FOUND("image_file_not_found")

String message

A human-readable description of the error.

class ResponseErrorEvent:

Emitted when an error occurs.

Optional<String> code

The error code.

String message

The error message.

Optional<String> param

The error parameter.

long sequenceNumber

The sequence number of this event.

JsonValue; type "error"constant"error"constant

The type of the event. Always error.

class ResponseFailedEvent:

An event that is emitted when a response fails.

Response response

The response that failed.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.failed"constant"response.failed"constant

The type of the event. Always response.failed.

class ResponseFileSearchCallCompletedEvent:

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

String itemId

The ID of the output item that the file search call is initiated.

long outputIndex

The index of the output item that the file search call is initiated.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.file_search_call.completed"constant"response.file_search_call.completed"constant

The type of the event. Always response.file_search_call.completed.

class ResponseFileSearchCallInProgressEvent:

Emitted when a file search call is initiated.

String itemId

The ID of the output item that the file search call is initiated.

long outputIndex

The index of the output item that the file search call is initiated.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.file_search_call.in_progress"constant"response.file_search_call.in_progress"constant

The type of the event. Always response.file_search_call.in_progress.

class ResponseFileSearchCallSearchingEvent:

Emitted when a file search is currently searching.

String itemId

The ID of the output item that the file search call is initiated.

long outputIndex

The index of the output item that the file search call is searching.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.file_search_call.searching"constant"response.file_search_call.searching"constant

The type of the event. Always response.file_search_call.searching.

class ResponseFileSearchToolCall:

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

String id

The unique ID of the file search tool call.

List<String> queries

The queries used to search for files.

Status status

The status of the file search tool call. One of in_progress, searching, incomplete or failed,

One of the following:

IN_PROGRESS("in_progress")

SEARCHING("searching")

COMPLETED("completed")

INCOMPLETE("incomplete")

FAILED("failed")

JsonValue; type "file_search_call"constant"file_search_call"constant

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

Optional<List<Result>> results

The results of the file search tool call.

Optional<Attributes> attributes

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

double

boolean

Optional<String> fileId

The unique ID of the file.

Optional<String> filename

The name of the file.

Optional<Double> score

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

formatfloat

Optional<String> text

The text that was retrieved from the file.

class ResponseFormatTextConfig: A class that can be one of several variants.union

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.

class ResponseFormatText:

Default response format. Used to generate text responses.

JsonValue; type "text"constant"text"constant

The type of response format being defined. Always text.

class ResponseFormatTextJsonSchemaConfig:

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

String name

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 schema

The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas here.

JsonValue; type "json_schema"constant"json_schema"constant

The type of response format being defined. Always json_schema.

Optional<String> description

A description of what the response format is for, used by the model to determine how to respond in the format.

Optional<Boolean> strict

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.

class ResponseFormatJsonObject:

JSON object response format. An older method of generating JSON responses. Using json_schema is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so.

JsonValue; type "json_object"constant"json_object"constant

The type of response format being defined. Always json_object.

class ResponseFormatTextJsonSchemaConfig:

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

String name

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 schema

The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas here.

JsonValue; type "json_schema"constant"json_schema"constant

The type of response format being defined. Always json_schema.

Optional<String> description

A description of what the response format is for, used by the model to determine how to respond in the format.

Optional<Boolean> strict

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.

class ResponseFunctionCallArgumentsDeltaEvent:

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

String delta

The function-call arguments delta that is added.

String itemId

The ID of the output item that the function-call arguments delta is added to.

long outputIndex

The index of the output item that the function-call arguments delta is added to.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.function_call_arguments.delta"constant"response.function_call_arguments.delta"constant

The type of the event. Always response.function_call_arguments.delta.

class ResponseFunctionCallArgumentsDoneEvent:

Emitted when function-call arguments are finalized.

String arguments

The function-call arguments.

String itemId

The ID of the item.

String name

The name of the function that was called.

long outputIndex

The index of the output item.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.function_call_arguments.done"constant"response.function_call_arguments.done"constant

class ResponseFunctionCallOutputItem: A class that can be one of several variants.union

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

class ResponseInputTextContent:

A text input to the model.

String text

The text input to the model.

maxLength10485760

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputImageContent:

An image input to the model. Learn about image inputs

JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<Detail> detail

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("low")

HIGH("high")

AUTO("auto")

ORIGINAL("original")

Optional<String> fileId

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

Optional<String> imageUrl

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

maxLength20971520

class ResponseInputFileContent:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

Optional<Detail> detail

The detail level of the file to be sent to the model. Use low for the default rendering behavior, or high to render the file at higher quality. Defaults to low.

One of the following:

LOW("low")

HIGH("high")

Optional<String> fileData

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

maxLength73400320

Optional<String> fileId

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

Optional<String> fileUrl

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

Optional<String> filename

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

class ResponseFunctionShellCallOutputContent:

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

Outcome outcome

The exit or timeout outcome associated with this shell call.

One of the following:

JsonValue;

JsonValue; type "timeout"constant"timeout"constant

The outcome type. Always timeout.

class Exit:

Indicates that the shell commands finished and returned an exit code.

long exitCode

The exit code returned by the shell process.

JsonValue; type "exit"constant"exit"constant

The outcome type. Always exit.

String stderr

Captured stderr output for the shell call.

maxLength10485760

String stdout

Captured stdout output for the shell call.

maxLength10485760

class ResponseFunctionShellToolCall:

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

String id

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

Action action

The shell commands and limits that describe how to run the tool call.

List<String> commands

Optional<Long> maxOutputLength

Optional maximum number of characters to return from each command.

Optional<Long> timeoutMs

Optional timeout in milliseconds for the commands.

String callId

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

Optional<Environment> environment

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

One of the following:

class ResponseLocalEnvironment:

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

JsonValue; type "local"constant"local"constant

The environment type. Always local.

class ResponseContainerReference:

Represents a container created with /v1/containers.

String containerId

JsonValue; type "container_reference"constant"container_reference"constant

The environment type. Always container_reference.

Status status

The status of the shell call. One of in_progress, completed, or incomplete.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "shell_call"constant"shell_call"constant

The type of the item. Always shell_call.

Optional<String> createdBy

The ID of the entity that created this tool call.

class ResponseFunctionShellToolCallOutput:

The output of a shell tool call that was emitted.

String id

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

String callId

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

Optional<Long> maxOutputLength

The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output.

List<Output> output

An array of shell call output contents

Outcome outcome

Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk.

One of the following:

JsonValue;

JsonValue; type "timeout"constant"timeout"constant

The outcome type. Always timeout.

class Exit:

Indicates that the shell commands finished and returned an exit code.

long exitCode

Exit code from the shell process.

JsonValue; type "exit"constant"exit"constant

The outcome type. Always exit.

String stderr

The standard error output that was captured.

String stdout

The standard output that was captured.

Optional<String> createdBy

The identifier of the actor that created the item.

Status status

The status of the shell call output. One of in_progress, completed, or incomplete.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "shell_call_output"constant"shell_call_output"constant

The type of the shell call output. Always shell_call_output.

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseFunctionToolCall:

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

String arguments

A JSON string of the arguments to pass to the function.

String callId

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

String name

The name of the function to run.

JsonValue; type "function_call"constant"function_call"constant

The type of the function tool call. Always function_call.

Optional<String> id

The unique ID of the function tool call.

Optional<String> namespace

The namespace of the function to run.

Optional<Status> status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseFunctionToolCallItem:

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

String id

The unique ID of the function tool call.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseFunctionToolCallOutputItem:

String id

The unique ID of the function call tool output.

String callId

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

Output output

The output from the function call generated by your code. Can be a string or an list of output content.

One of the following:

String

List<FunctionAndCustomToolCallOutput>

One of the following:

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputImage:

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

Detail detail

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("low")

HIGH("high")

AUTO("auto")

ORIGINAL("original")

JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<String> fileId

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

Optional<String> imageUrl

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

class ResponseInputFile:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

Optional<Detail> detail

The detail level of the file to be sent to the model. Use low for the default rendering behavior, or high to render the file at higher quality. Defaults to low.

One of the following:

LOW("low")

HIGH("high")

Optional<String> fileData

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

Optional<String> fileId

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

Optional<String> fileUrl

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

Optional<String> filename

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

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "function_call_output"constant"function_call_output"constant

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

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseFunctionWebSearch:

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

String id

The unique ID of the web search tool call.

Action action

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:

class Search:

Action type “search” - Performs a web search query.

String query

[DEPRECATED] The search query.

JsonValue; type "search"constant"search"constant

The action type.

Optional<List<String>> queries

The search queries.

Optional<List<Source>> sources

The sources used in the search.

JsonValue; type "url"constant"url"constant

The type of source. Always url.

String url

The URL of the source.

class OpenPage:

Action type “open_page” - Opens a specific URL from search results.

JsonValue; type "open_page"constant"open_page"constant

The action type.

Optional<String> url

The URL opened by the model.

formaturi

class FindInPage:

Action type “find_in_page”: Searches for a pattern within a loaded page.

String pattern

The pattern or text to search for within the page.

JsonValue; type "find_in_page"constant"find_in_page"constant

The action type.

String url

The URL of the page searched for the pattern.

formaturi

Status status

The status of the web search tool call.

One of the following:

IN_PROGRESS("in_progress")

SEARCHING("searching")

COMPLETED("completed")

FAILED("failed")

JsonValue; type "web_search_call"constant"web_search_call"constant

The type of the web search tool call. Always web_search_call.

class ResponseImageGenCallCompletedEvent:

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

String itemId

The unique identifier of the image generation item being processed.

long outputIndex

The index of the output item in the response’s output array.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.image_generation_call.completed"constant"response.image_generation_call.completed"constant

The type of the event. Always ‘response.image_generation_call.completed’.

class ResponseImageGenCallGeneratingEvent:

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

String itemId

The unique identifier of the image generation item being processed.

long outputIndex

The index of the output item in the response’s output array.

long sequenceNumber

The sequence number of the image generation item being processed.

JsonValue; type "response.image_generation_call.generating"constant"response.image_generation_call.generating"constant

The type of the event. Always ‘response.image_generation_call.generating’.

class ResponseImageGenCallInProgressEvent:

Emitted when an image generation tool call is in progress.

String itemId

The unique identifier of the image generation item being processed.

long outputIndex

The index of the output item in the response’s output array.

long sequenceNumber

The sequence number of the image generation item being processed.

JsonValue; type "response.image_generation_call.in_progress"constant"response.image_generation_call.in_progress"constant

The type of the event. Always ‘response.image_generation_call.in_progress’.

class ResponseImageGenCallPartialImageEvent:

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

String itemId

The unique identifier of the image generation item being processed.

long outputIndex

The index of the output item in the response’s output array.

String partialImageB64

Base64-encoded partial image data, suitable for rendering as an image.

long partialImageIndex

0-based index for the partial image (backend is 1-based, but this is 0-based for the user).

long sequenceNumber

The sequence number of the image generation item being processed.

JsonValue; type "response.image_generation_call.partial_image"constant"response.image_generation_call.partial_image"constant

The type of the event. Always ‘response.image_generation_call.partial_image’.

class ResponseInProgressEvent:

Emitted when the response is in progress.

Response response

The response that is in progress.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.in_progress"constant"response.in_progress"constant

The type of the event. Always response.in_progress.

enum ResponseIncludable:

Specify additional output data to include in the model response. Currently supported values are:

• web_search_call.action.sources: Include the sources of the web search tool call.
• code_interpreter_call.outputs: Includes the outputs of python code execution in code interpreter tool call items.
• computer_call_output.output.image_url: Include image urls from the computer call output.
• file_search_call.results: Include the search results of the file search tool call.
• message.input_image.image_url: Include image urls from the input message.
• message.output_text.logprobs: Include logprobs with assistant messages.
• reasoning.encrypted_content: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the store parameter is set to false, or when an organization is enrolled in the zero data retention program).

FILE_SEARCH_CALL_RESULTS("file_search_call.results")

WEB_SEARCH_CALL_RESULTS("web_search_call.results")

WEB_SEARCH_CALL_ACTION_SOURCES("web_search_call.action.sources")

MESSAGE_INPUT_IMAGE_IMAGE_URL("message.input_image.image_url")

COMPUTER_CALL_OUTPUT_OUTPUT_IMAGE_URL("computer_call_output.output.image_url")

CODE_INTERPRETER_CALL_OUTPUTS("code_interpreter_call.outputs")

REASONING_ENCRYPTED_CONTENT("reasoning.encrypted_content")

MESSAGE_OUTPUT_TEXT_LOGPROBS("message.output_text.logprobs")

class ResponseIncompleteEvent:

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

Response response

The response that was incomplete.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.incomplete"constant"response.incomplete"constant

The type of the event. Always response.incomplete.

class ResponseInputAudio:

An audio input to the model.

InputAudio inputAudio

String data

Base64-encoded audio data.

Format format

The format of the audio data. Currently supported formats are mp3 and wav.

One of the following:

MP3("mp3")

WAV("wav")

JsonValue; type "input_audio"constant"input_audio"constant

The type of the input item. Always input_audio.

class ResponseInputContent: A class that can be one of several variants.union

A text input to the model.

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputImage:

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

Detail detail

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("low")

HIGH("high")

AUTO("auto")

ORIGINAL("original")

JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<String> fileId

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

Optional<String> imageUrl

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

class ResponseInputFile:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

Optional<Detail> detail

The detail level of the file to be sent to the model. Use low for the default rendering behavior, or high to render the file at higher quality. Defaults to low.

One of the following:

LOW("low")

HIGH("high")

Optional<String> fileData

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

Optional<String> fileId

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

Optional<String> fileUrl

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

Optional<String> filename

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

class ResponseInputFile:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

Optional<Detail> detail

The detail level of the file to be sent to the model. Use low for the default rendering behavior, or high to render the file at higher quality. Defaults to low.

One of the following:

LOW("low")

HIGH("high")

Optional<String> fileData

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

Optional<String> fileId

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

Optional<String> fileUrl

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

Optional<String> filename

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

class ResponseInputFileContent:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

Optional<Detail> detail

The detail level of the file to be sent to the model. Use low for the default rendering behavior, or high to render the file at higher quality. Defaults to low.

One of the following:

LOW("low")

HIGH("high")

Optional<String> fileData

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

maxLength73400320

Optional<String> fileId

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

Optional<String> fileUrl

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

Optional<String> filename

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

class ResponseInputImage:

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

Detail detail

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("low")

HIGH("high")

AUTO("auto")

ORIGINAL("original")

JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<String> fileId

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

Optional<String> imageUrl

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

class ResponseInputImageContent:

An image input to the model. Learn about image inputs

JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<Detail> detail

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("low")

HIGH("high")

AUTO("auto")

ORIGINAL("original")

Optional<String> fileId

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

Optional<String> imageUrl

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

maxLength20971520

class ResponseInputItem: A class that can be one of several variants.union

A message input to the model with a role indicating instruction following hierarchy. Instructions given with the developer or system role take precedence over instructions given with the user role. Messages with the assistant role are presumed to have been generated by the model in previous interactions.

class EasyInputMessage:

A message input to the model with a role indicating instruction following hierarchy. Instructions given with the developer or system role take precedence over instructions given with the user role. Messages with the assistant role are presumed to have been generated by the model in previous interactions.

Content content

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

One of the following:

String

List<ResponseInputContent>

One of the following:

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputImage:

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

Detail detail

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("low")

HIGH("high")

AUTO("auto")

ORIGINAL("original")

JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<String> fileId

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

Optional<String> imageUrl

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

class ResponseInputFile:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

Optional<Detail> detail

The detail level of the file to be sent to the model. Use low for the default rendering behavior, or high to render the file at higher quality. Defaults to low.

One of the following:

LOW("low")

HIGH("high")

Optional<String> fileData

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

Optional<String> fileId

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

Optional<String> fileUrl

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

Optional<String> filename

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

Role role

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

One of the following:

USER("user")

ASSISTANT("assistant")

SYSTEM("system")

DEVELOPER("developer")

Optional<Phase> phase

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("commentary")

FINAL_ANSWER("final_answer")

Optional<Type> type

The type of the message input. Always message.

Message

List<ResponseInputContent> content

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

Role role

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

One of the following:

USER("user")

SYSTEM("system")

DEVELOPER("developer")

Optional<Status> status

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

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

Optional<Type> type

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

class ResponseOutputMessage:

An output message from the model.

String id

The unique ID of the output message.

List<Content> content

The content of the output message.

One of the following:

class ResponseOutputText:

A text output from the model.

List<Annotation> annotations

The annotations of the text output.

One of the following:

class FileCitation:

A citation to a file.

String fileId

The ID of the file.

String filename

The filename of the file cited.

long index

The index of the file in the list of files.

JsonValue; type "file_citation"constant"file_citation"constant

The type of the file citation. Always file_citation.

class UrlCitation:

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

long endIndex

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

long startIndex

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

String title

The title of the web resource.

JsonValue; type "url_citation"constant"url_citation"constant

The type of the URL citation. Always url_citation.

String url

The URL of the web resource.

class ContainerFileCitation:

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

String containerId

The ID of the container file.

long endIndex

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

String fileId

The ID of the file.

String filename

The filename of the container file cited.

long startIndex

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

JsonValue; type "container_file_citation"constant"container_file_citation"constant

The type of the container file citation. Always container_file_citation.

class FilePath:

A path to a file.

String fileId

The ID of the file.

long index

The index of the file in the list of files.

JsonValue; type "file_path"constant"file_path"constant

The type of the file path. Always file_path.

String text

The text output from the model.

JsonValue; type "output_text"constant"output_text"constant

The type of the output text. Always output_text.

Optional<List<Logprob>> logprobs

String token

List<long> bytes

double logprob

List<TopLogprob> topLogprobs

String token

List<long> bytes

double logprob

class ResponseOutputRefusal:

A refusal from the model.

String refusal

The refusal explanation from the model.

JsonValue; type "refusal"constant"refusal"constant

The type of the refusal. Always refusal.

JsonValue; role "assistant"constant"assistant"constant

The role of the output message. Always assistant.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "message"constant"message"constant

The type of the output message. Always message.

Optional<Phase> phase

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("commentary")

FINAL_ANSWER("final_answer")

class ResponseFileSearchToolCall:

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

String id

The unique ID of the file search tool call.

List<String> queries

The queries used to search for files.

Status status

The status of the file search tool call. One of in_progress, searching, incomplete or failed,

One of the following:

IN_PROGRESS("in_progress")

SEARCHING("searching")

COMPLETED("completed")

INCOMPLETE("incomplete")

FAILED("failed")

JsonValue; type "file_search_call"constant"file_search_call"constant

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

Optional<List<Result>> results

The results of the file search tool call.

Optional<Attributes> attributes

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

double

boolean

Optional<String> fileId

The unique ID of the file.

Optional<String> filename

The name of the file.

Optional<Double> score

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

formatfloat

Optional<String> text

The text that was retrieved from the file.

class ResponseComputerToolCall:

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

String id

The unique ID of the computer call.

String callId

An identifier used when responding to the tool call with output.

List<PendingSafetyCheck> pendingSafetyChecks

The pending safety checks for the computer call.

String id

The ID of the pending safety check.

Optional<String> code

The type of the pending safety check.

Optional<String> message

Details about the pending safety check.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

Type type

The type of the computer call. Always computer_call.

Optional<Action> action

A click action.

One of the following:

class Click:

A click action.

Button button

Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.

One of the following:

LEFT("left")

RIGHT("right")

WHEEL("wheel")

BACK("back")

FORWARD("forward")

JsonValue; type "click"constant"click"constant

Specifies the event type. For a click action, this property is always click.

long x

The x-coordinate where the click occurred.

long y

The y-coordinate where the click occurred.

Optional<List<String>> keys

The keys being held while clicking.

class DoubleClick:

A double click action.

Optional<List<String>> keys

The keys being held while double-clicking.

JsonValue; type "double_click"constant"double_click"constant

Specifies the event type. For a double click action, this property is always set to double_click.

long x

The x-coordinate where the double click occurred.

long y

The y-coordinate where the double click occurred.

class Drag:

A drag action.

List<Path> path

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

long x

The x-coordinate.

long y

The y-coordinate.

JsonValue; type "drag"constant"drag"constant

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

Optional<List<String>> keys

The keys being held while dragging the mouse.

class Keypress:

A collection of keypresses the model would like to perform.

List<String> keys

The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key.

JsonValue; type "keypress"constant"keypress"constant

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

class Move:

A mouse move action.

JsonValue; type "move"constant"move"constant

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

long x

The x-coordinate to move to.

long y

The y-coordinate to move to.

Optional<List<String>> keys

The keys being held while moving the mouse.

JsonValue;

JsonValue; type "screenshot"constant"screenshot"constant

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

class Scroll:

A scroll action.

long scrollX

The horizontal scroll distance.

long scrollY

The vertical scroll distance.

JsonValue; type "scroll"constant"scroll"constant

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

long x

The x-coordinate where the scroll occurred.

long y

The y-coordinate where the scroll occurred.

Optional<List<String>> keys

The keys being held while scrolling.

class Type:

An action to type in text.

String text

The text to type.

JsonValue; type "type"constant"type"constant

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

JsonValue;

JsonValue; type "wait"constant"wait"constant

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

Optional<List<ComputerAction>> actions

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

ComputerCallOutput

String callId

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

maxLength64

minLength1

ResponseComputerToolCallOutputScreenshot output

A computer screenshot image used with the computer use tool.

JsonValue; type "computer_call_output"constant"computer_call_output"constant

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

Optional<String> id

The ID of the computer tool call output.

Optional<List<AcknowledgedSafetyCheck>> acknowledgedSafetyChecks

The safety checks reported by the API that have been acknowledged by the developer.

String id

The ID of the pending safety check.

Optional<String> code

The type of the pending safety check.

Optional<String> message

Details about the pending safety check.

Optional<Status> status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseFunctionWebSearch:

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

String id

The unique ID of the web search tool call.

Action action

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:

class Search:

Action type “search” - Performs a web search query.

String query

[DEPRECATED] The search query.

JsonValue; type "search"constant"search"constant

The action type.

Optional<List<String>> queries

The search queries.

Optional<List<Source>> sources

The sources used in the search.

JsonValue; type "url"constant"url"constant

The type of source. Always url.

String url

The URL of the source.

class OpenPage:

Action type “open_page” - Opens a specific URL from search results.

JsonValue; type "open_page"constant"open_page"constant

The action type.

Optional<String> url

The URL opened by the model.

formaturi

class FindInPage:

Action type “find_in_page”: Searches for a pattern within a loaded page.

String pattern

The pattern or text to search for within the page.

JsonValue; type "find_in_page"constant"find_in_page"constant

The action type.

String url

The URL of the page searched for the pattern.

formaturi

Status status

The status of the web search tool call.

One of the following:

IN_PROGRESS("in_progress")

SEARCHING("searching")

COMPLETED("completed")

FAILED("failed")

JsonValue; type "web_search_call"constant"web_search_call"constant

The type of the web search tool call. Always web_search_call.

class ResponseFunctionToolCall:

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

String arguments

A JSON string of the arguments to pass to the function.

String callId

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

String name

The name of the function to run.

JsonValue; type "function_call"constant"function_call"constant

The type of the function tool call. Always function_call.

Optional<String> id

The unique ID of the function tool call.

Optional<String> namespace

The namespace of the function to run.

Optional<Status> status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

FunctionCallOutput

String callId

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

maxLength64

minLength1

Output output

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

One of the following:

String

List<ResponseFunctionCallOutputItem>

One of the following:

class ResponseInputTextContent:

A text input to the model.

String text

The text input to the model.

maxLength10485760

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputImageContent:

An image input to the model. Learn about image inputs

JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<Detail> detail

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("low")

HIGH("high")

AUTO("auto")

ORIGINAL("original")

Optional<String> fileId

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

Optional<String> imageUrl

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

maxLength20971520

class ResponseInputFileContent:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

Optional<Detail> detail

The detail level of the file to be sent to the model. Use low for the default rendering behavior, or high to render the file at higher quality. Defaults to low.

One of the following:

LOW("low")

HIGH("high")

Optional<String> fileData

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

maxLength73400320

Optional<String> fileId

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

Optional<String> fileUrl

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

Optional<String> filename

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

JsonValue; type "function_call_output"constant"function_call_output"constant

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

Optional<String> id

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

Optional<Status> status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

ToolSearchCall

JsonValue arguments

The arguments supplied to the tool search call.

JsonValue; type "tool_search_call"constant"tool_search_call"constant

The item type. Always tool_search_call.

Optional<String> id

The unique ID of this tool search call.

Optional<String> callId

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

maxLength64

minLength1

Optional<Execution> execution

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

One of the following:

SERVER("server")

CLIENT("client")

Optional<Status> status

The status of the tool search call.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseToolSearchOutputItemParam:

List<Tool> tools

The loaded tool definitions returned by the tool search output.

One of the following:

class FunctionTool:

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

String name

The name of the function to call.

Optional<Parameters> parameters

A JSON schema object describing the parameters of the function.

Optional<Boolean> strict

Whether to enforce strict parameter validation. Default true.

JsonValue; type "function"constant"function"constant

The type of the function tool. Always function.

Optional<Boolean> deferLoading

Whether this function is deferred and loaded via tool search.

Optional<String> description

A description of the function. Used by the model to determine whether or not to call the function.

class FileSearchTool:

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

JsonValue; type "file_search"constant"file_search"constant

The type of the file search tool. Always file_search.

List<String> vectorStoreIds

The IDs of the vector stores to search.

Optional<Filters> filters

A filter to apply.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

class CompoundFilter:

Combine multiple filters using and or or.

List<Filter> filters

Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

JsonValue

Type type

Type of operation: and or or.

One of the following:

AND("and")

OR("or")

Optional<Long> maxNumResults

The maximum number of results to return. This number should be between 1 and 50 inclusive.

Optional<RankingOptions> rankingOptions

Ranking options for search.

Optional<HybridSearch> hybridSearch

Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled.

double embeddingWeight

The weight of the embedding in the reciprocal ranking fusion.

double textWeight

The weight of the text in the reciprocal ranking fusion.

Optional<Ranker> ranker

The ranker to use for the file search.

One of the following:

AUTO("auto")

DEFAULT_2024_11_15("default-2024-11-15")

Optional<Double> scoreThreshold

The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.

class ComputerTool:

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

JsonValue; type "computer"constant"computer"constant

The type of the computer tool. Always computer.

class ComputerUsePreviewTool:

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

long displayHeight

The height of the computer display.

long displayWidth

The width of the computer display.

Environment environment

The type of computer environment to control.

One of the following:

WINDOWS("windows")

MAC("mac")

LINUX("linux")

UBUNTU("ubuntu")

BROWSER("browser")

JsonValue; type "computer_use_preview"constant"computer_use_preview"constant

The type of the computer use tool. Always computer_use_preview.

class WebSearchTool:

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

Type type

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")

WEB_SEARCH_2025_08_26("web_search_2025_08_26")

Optional<Filters> filters

Filters for the search.

Optional<List<String>> allowedDomains

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

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The approximate location of the user.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

Optional<Type> type

The type of location approximation. Always approximate.

Mcp

String serverLabel

A label for this MCP server, used to identify it in tool calls.

JsonValue; type "mcp"constant"mcp"constant

The type of the MCP tool. Always mcp.

Optional<AllowedTools> allowedTools

List of allowed tool names or a filter object.

One of the following:

List<String>

class McpToolFilter:

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<String> authorization

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.

Optional<ConnectorId> connectorId

Identifier for service connectors, like those available in ChatGPT. One of server_url or connector_id must be provided. Learn more about service connectors here.

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_dropbox")

CONNECTOR_GMAIL("connector_gmail")

CONNECTOR_GOOGLECALENDAR("connector_googlecalendar")

CONNECTOR_GOOGLEDRIVE("connector_googledrive")

CONNECTOR_MICROSOFTTEAMS("connector_microsoftteams")

CONNECTOR_OUTLOOKCALENDAR("connector_outlookcalendar")

CONNECTOR_OUTLOOKEMAIL("connector_outlookemail")

CONNECTOR_SHAREPOINT("connector_sharepoint")

Optional<Boolean> deferLoading

Whether this MCP tool is deferred and discovered via tool search.

Optional<Headers> headers

Optional HTTP headers to send to the MCP server. Use for authentication or other purposes.

Optional<RequireApproval> requireApproval

Specify which of the MCP server’s tools require approval.

One of the following:

class McpToolApprovalFilter:

Specify which of the MCP server’s tools require approval. Can be always, never, or a filter object associated with tools that require approval.

Optional<Always> always

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<Never> never

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

enum McpToolApprovalSetting:

Specify a single approval policy for all tools. One of always or never. When set to always, all tools will require approval. When set to never, all tools will not require approval.

ALWAYS("always")

NEVER("never")

Optional<String> serverDescription

Optional description of the MCP server, used to provide more context.

Optional<String> serverUrl

The URL for the MCP server. One of server_url or connector_id must be provided.

CodeInterpreter

Container container

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

class CodeInterpreterToolAuto:

Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.

JsonValue; type "auto"constant"auto"constant

Always auto.

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the code interpreter container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

JsonValue; type "code_interpreter"constant"code_interpreter"constant

The type of the code interpreter tool. Always code_interpreter.

ImageGeneration

JsonValue; type "image_generation"constant"image_generation"constant

The type of the image generation tool. Always image_generation.

Optional<Action> action

Whether to generate a new image or edit an existing image. Default: auto.

One of the following:

GENERATE("generate")

EDIT("edit")

AUTO("auto")

Optional<Background> background

Background type for the generated image. One of transparent, opaque, or auto. Default: auto.

One of the following:

TRANSPARENT("transparent")

OPAQUE("opaque")

AUTO("auto")

Optional<InputFidelity> inputFidelity

Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1 and gpt-image-1.5 and later models, unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.

One of the following:

HIGH("high")

LOW("low")

Optional<InputImageMask> inputImageMask

Optional mask for inpainting. Contains image_url (string, optional) and file_id (string, optional).

Optional<String> fileId

File ID for the mask image.

Optional<String> imageUrl

Base64-encoded mask image.

Optional<Model> model

The image generation model to use. Default: gpt-image-1.

One of the following:

GPT_IMAGE_1("gpt-image-1")

GPT_IMAGE_1_MINI("gpt-image-1-mini")

GPT_IMAGE_1_5("gpt-image-1.5")

Optional<Moderation> moderation

Moderation level for the generated image. Default: auto.

One of the following:

AUTO("auto")

LOW("low")

Optional<Long> outputCompression

Compression level for the output image. Default: 100.

minimum0

maximum100

Optional<OutputFormat> outputFormat

The output format of the generated image. One of png, webp, or jpeg. Default: png.

One of the following:

PNG("png")

WEBP("webp")

JPEG("jpeg")

Optional<Long> partialImages

Number of partial images to generate in streaming mode, from 0 (default value) to 3.

minimum0

maximum3

Optional<Quality> quality

The quality of the generated image. One of low, medium, high, or auto. Default: auto.

One of the following:

LOW("low")

MEDIUM("medium")

HIGH("high")

AUTO("auto")

Optional<Size> size

The size of the generated image. One of 1024x1024, 1024x1536, 1536x1024, or auto. Default: auto.

One of the following:

_1024X1024("1024x1024")

_1024X1536("1024x1536")

_1536X1024("1536x1024")

AUTO("auto")

JsonValue;

JsonValue; type "local_shell"constant"local_shell"constant

The type of the local shell tool. Always local_shell.

class FunctionShellTool:

A tool that allows the model to execute shell commands.

JsonValue; type "shell"constant"shell"constant

The type of the shell tool. Always shell.

Optional<Environment> environment

One of the following:

class ContainerAuto:

JsonValue; type "container_auto"constant"container_auto"constant

Automatically creates a container for this request

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

Optional<List<Skill>> skills

An optional list of skills referenced by id or inline data.

One of the following:

class SkillReference:

String skillId

The ID of the referenced skill.

maxLength64

minLength1

JsonValue; type "skill_reference"constant"skill_reference"constant

References a skill created with the /v1/skills endpoint.

Optional<String> version

Optional skill version. Use a positive integer or ‘latest’. Omit for default.

class InlineSkill:

String description

The description of the skill.

String name

The name of the skill.

InlineSkillSource source

Inline skill payload

JsonValue; type "inline"constant"inline"constant

Defines an inline skill for this request.

class LocalEnvironment:

JsonValue; type "local"constant"local"constant

Use a local computer environment.

Optional<List<LocalSkill>> skills

An optional list of skills.

String description

The description of the skill.

String name

The name of the skill.

String path

The path to the directory containing the skill.

class ContainerReference:

String containerId

The ID of the referenced container.

JsonValue; type "container_reference"constant"container_reference"constant

References a container created with the /v1/containers endpoint

class CustomTool:

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

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

class NamespaceTool:

Groups function/custom tools under a shared namespace.

String description

A description of the namespace shown to the model.

minLength1

String name

The namespace name used in tool calls (for example, crm).

minLength1

List<Tool> tools

The function/custom tools available inside this namespace.

One of the following:

class Function:

String name

maxLength128

minLength1

JsonValue; type "function"constant"function"constant

Optional<Boolean> deferLoading

Whether this function should be deferred and discovered via tool search.

Optional<String> description

Optional<JsonValue> parameters

Optional<Boolean> strict

class CustomTool:

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

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

JsonValue; type "namespace"constant"namespace"constant

The type of the tool. Always namespace.

class ToolSearchTool:

Hosted or BYOT tool search configuration for deferred tools.

JsonValue; type "tool_search"constant"tool_search"constant

The type of the tool. Always tool_search.

Optional<String> description

Description shown to the model for a client-executed tool search tool.

Optional<Execution> execution

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

One of the following:

SERVER("server")

CLIENT("client")

Optional<JsonValue> parameters

Parameter schema for a client-executed tool search tool.

class WebSearchPreviewTool:

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

Type type

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")

WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")

Optional<List<SearchContentType>> searchContentTypes

One of the following:

TEXT("text")

IMAGE("image")

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The user’s location.

JsonValue; type "approximate"constant"approximate"constant

The type of location approximation. Always approximate.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

class ApplyPatchTool:

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

JsonValue; type "apply_patch"constant"apply_patch"constant

The type of the tool. Always apply_patch.

JsonValue; type "tool_search_output"constant"tool_search_output"constant

The item type. Always tool_search_output.

Optional<String> id

The unique ID of this tool search output.

Optional<String> callId

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

maxLength64

minLength1

Optional<Execution> execution

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

One of the following:

SERVER("server")

CLIENT("client")

Optional<Status> status

The status of the tool search output.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseReasoningItem:

A description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your input to the Responses API for subsequent turns of a conversation if you are manually managing context.

String id

The unique identifier of the reasoning content.

List<Summary> summary

Reasoning summary content.

String text

A summary of the reasoning output from the model so far.

JsonValue; type "summary_text"constant"summary_text"constant

The type of the object. Always summary_text.

JsonValue; type "reasoning"constant"reasoning"constant

The type of the object. Always reasoning.

Optional<List<Content>> content

Reasoning text content.

String text

The reasoning text from the model.

JsonValue; type "reasoning_text"constant"reasoning_text"constant

The type of the reasoning text. Always reasoning_text.

Optional<String> encryptedContent

The encrypted content of the reasoning item - populated when a response is generated with reasoning.encrypted_content in the include parameter.

Optional<Status> status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseCompactionItemParam:

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

String encryptedContent

The encrypted content of the compaction summary.

maxLength10485760

JsonValue; type "compaction"constant"compaction"constant

The type of the item. Always compaction.

Optional<String> id

The ID of the compaction item.

ImageGenerationCall

String id

The unique ID of the image generation call.

Optional<String> result

The generated image encoded in base64.

Status status

The status of the image generation call.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

GENERATING("generating")

FAILED("failed")

JsonValue; type "image_generation_call"constant"image_generation_call"constant

The type of the image generation call. Always image_generation_call.

class ResponseCodeInterpreterToolCall:

A tool call to run code.

String id

The unique ID of the code interpreter tool call.

Optional<String> code

The code to run, or null if not available.

String containerId

The ID of the container used to run the code.

Optional<List<Output>> outputs

The outputs generated by the code interpreter, such as logs or images. Can be null if no outputs are available.

One of the following:

class Logs:

The logs output from the code interpreter.

String logs

The logs output from the code interpreter.

JsonValue; type "logs"constant"logs"constant

The type of the output. Always logs.

class Image:

The image output from the code interpreter.

JsonValue; type "image"constant"image"constant

The type of the output. Always image.

String url

The URL of the image output from the code interpreter.

Status status

The status of the code interpreter tool call. Valid values are in_progress, completed, incomplete, interpreting, and failed.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

INTERPRETING("interpreting")

FAILED("failed")

JsonValue; type "code_interpreter_call"constant"code_interpreter_call"constant

The type of the code interpreter tool call. Always code_interpreter_call.

LocalShellCall

String id

The unique ID of the local shell call.

Action action

Execute a shell command on the server.

List<String> command

The command to run.

Env env

Environment variables to set for the command.

JsonValue; type "exec"constant"exec"constant

The type of the local shell action. Always exec.

Optional<Long> timeoutMs

Optional timeout in milliseconds for the command.

Optional<String> user

Optional user to run the command as.

Optional<String> workingDirectory

Optional working directory to run the command in.

String callId

The unique ID of the local shell tool call generated by the model.

Status status

The status of the local shell call.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "local_shell_call"constant"local_shell_call"constant

The type of the local shell call. Always local_shell_call.

LocalShellCallOutput

String id

The unique ID of the local shell tool call generated by the model.

String output

A JSON string of the output of the local shell tool call.

JsonValue; type "local_shell_call_output"constant"local_shell_call_output"constant

The type of the local shell tool call output. Always local_shell_call_output.

Optional<Status> status

The status of the item. One of in_progress, completed, or incomplete.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

ShellCall

Action action

The shell commands and limits that describe how to run the tool call.

List<String> commands

Ordered shell commands for the execution environment to run.

Optional<Long> maxOutputLength

Maximum number of UTF-8 characters to capture from combined stdout and stderr output.

Optional<Long> timeoutMs

Maximum wall-clock time in milliseconds to allow the shell commands to run.

String callId

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

maxLength64

minLength1

JsonValue; type "shell_call"constant"shell_call"constant

The type of the item. Always shell_call.

Optional<String> id

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

Optional<Environment> environment

The environment to execute the shell commands in.

One of the following:

class LocalEnvironment:

JsonValue; type "local"constant"local"constant

Use a local computer environment.

Optional<List<LocalSkill>> skills

An optional list of skills.

String description

The description of the skill.

String name

The name of the skill.

String path

The path to the directory containing the skill.

class ContainerReference:

String containerId

The ID of the referenced container.

JsonValue; type "container_reference"constant"container_reference"constant

References a container created with the /v1/containers endpoint

Optional<Status> status

The status of the shell call. One of in_progress, completed, or incomplete.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

ShellCallOutput

String callId

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

maxLength64

minLength1

List<ResponseFunctionShellCallOutputContent> output

Captured chunks of stdout and stderr output, along with their associated outcomes.

Outcome outcome

The exit or timeout outcome associated with this shell call.

One of the following:

JsonValue;

JsonValue; type "timeout"constant"timeout"constant

The outcome type. Always timeout.

class Exit:

Indicates that the shell commands finished and returned an exit code.

long exitCode

The exit code returned by the shell process.

JsonValue; type "exit"constant"exit"constant

The outcome type. Always exit.

String stderr

Captured stderr output for the shell call.

maxLength10485760

String stdout

Captured stdout output for the shell call.

maxLength10485760

JsonValue; type "shell_call_output"constant"shell_call_output"constant

The type of the item. Always shell_call_output.

Optional<String> id

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

Optional<Long> maxOutputLength

The maximum number of UTF-8 characters captured for this shell call’s combined output.

Optional<Status> status

The status of the shell call output.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

ApplyPatchCall

String callId

The unique ID of the apply patch tool call generated by the model.

maxLength64

minLength1

Operation operation

The specific create, delete, or update instruction for the apply_patch tool call.

One of the following:

class CreateFile:

Instruction for creating a new file via the apply_patch tool.

String diff

Unified diff content to apply when creating the file.

maxLength10485760

String path

Path of the file to create relative to the workspace root.

minLength1

JsonValue; type "create_file"constant"create_file"constant

The operation type. Always create_file.

class DeleteFile:

Instruction for deleting an existing file via the apply_patch tool.

String path

Path of the file to delete relative to the workspace root.

minLength1

JsonValue; type "delete_file"constant"delete_file"constant

The operation type. Always delete_file.

class UpdateFile:

Instruction for updating an existing file via the apply_patch tool.

String diff

Unified diff content to apply to the existing file.

maxLength10485760

String path

Path of the file to update relative to the workspace root.

minLength1

JsonValue; type "update_file"constant"update_file"constant

The operation type. Always update_file.

Status status

The status of the apply patch tool call. One of in_progress or completed.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

JsonValue; type "apply_patch_call"constant"apply_patch_call"constant

The type of the item. Always apply_patch_call.

Optional<String> id

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

ApplyPatchCallOutput

String callId

The unique ID of the apply patch tool call generated by the model.

maxLength64

minLength1

Status status

The status of the apply patch tool call output. One of completed or failed.

One of the following:

COMPLETED("completed")

FAILED("failed")

JsonValue; type "apply_patch_call_output"constant"apply_patch_call_output"constant

The type of the item. Always apply_patch_call_output.

Optional<String> id

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

Optional<String> output

Optional human-readable log text from the apply patch tool (e.g., patch results or errors).

maxLength10485760

McpListTools

String id

The unique ID of the list.

String serverLabel

The label of the MCP server.

List<Tool> tools

The tools available on the server.

JsonValue inputSchema

The JSON schema describing the tool’s input.

String name

The name of the tool.

Optional<JsonValue> annotations

Additional annotations about the tool.

Optional<String> description

The description of the tool.

JsonValue; type "mcp_list_tools"constant"mcp_list_tools"constant

The type of the item. Always mcp_list_tools.

Optional<String> error

Error message if the server could not list tools.

McpApprovalRequest

String id

The unique ID of the approval request.

String arguments

A JSON string of arguments for the tool.

String name

The name of the tool to run.

String serverLabel

The label of the MCP server making the request.

JsonValue; type "mcp_approval_request"constant"mcp_approval_request"constant

The type of the item. Always mcp_approval_request.

McpApprovalResponse

String approvalRequestId

The ID of the approval request being answered.

boolean approve

Whether the request was approved.

JsonValue; type "mcp_approval_response"constant"mcp_approval_response"constant

The type of the item. Always mcp_approval_response.

Optional<String> id

The unique ID of the approval response

Optional<String> reason

Optional reason for the decision.

McpCall

String id

The unique ID of the tool call.

String arguments

A JSON string of the arguments passed to the tool.

String name

The name of the tool that was run.

String serverLabel

The label of the MCP server running the tool.

JsonValue; type "mcp_call"constant"mcp_call"constant

The type of the item. Always mcp_call.

Optional<String> approvalRequestId

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.

Optional<String> error

The error from the tool call, if any.

Optional<String> output

The output from the tool call.

Optional<Status> status

The status of the tool call. One of in_progress, completed, incomplete, calling, or failed.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

CALLING("calling")

FAILED("failed")

class ResponseCustomToolCallOutput:

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

String callId

The call ID, used to map this custom tool call output to a custom tool call.

Output output

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:

String

List<FunctionAndCustomToolCallOutput>

One of the following:

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputImage:

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

Detail detail

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("low")

HIGH("high")

AUTO("auto")

ORIGINAL("original")

JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<String> fileId

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

Optional<String> imageUrl

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

class ResponseInputFile:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

Optional<Detail> detail

The detail level of the file to be sent to the model. Use low for the default rendering behavior, or high to render the file at higher quality. Defaults to low.

One of the following:

LOW("low")

HIGH("high")

Optional<String> fileData

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

Optional<String> fileId

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

Optional<String> fileUrl

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

Optional<String> filename

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

JsonValue; type "custom_tool_call_output"constant"custom_tool_call_output"constant

The type of the custom tool call output. Always custom_tool_call_output.

Optional<String> id

The unique ID of the custom tool call output in the OpenAI platform.

class ResponseCustomToolCall:

A call to a custom tool created by the model.

String callId

An identifier used to map this custom tool call to a tool call output.

String input

The input for the custom tool call generated by the model.

String name

The name of the custom tool being called.

JsonValue; type "custom_tool_call"constant"custom_tool_call"constant

The type of the custom tool call. Always custom_tool_call.

Optional<String> id

The unique ID of the custom tool call in the OpenAI platform.

Optional<String> namespace

The namespace of the custom tool being called.

ItemReference

String id

The ID of the item to reference.

Optional<Type> type

The type of item to reference. Always item_reference.

class ResponseInputMessageItem:

String id

The unique ID of the message input.

List<ResponseInputContent> content

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

Role role

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

One of the following:

USER("user")

SYSTEM("system")

DEVELOPER("developer")

JsonValue; type "message"constant"message"constant

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

Optional<Status> status

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

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputTextContent:

A text input to the model.

String text

The text input to the model.

maxLength10485760

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseItem: A class that can be one of several variants.union

Content item used to generate a response.

class ResponseInputMessageItem:

String id

The unique ID of the message input.

List<ResponseInputContent> content

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

Role role

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

One of the following:

USER("user")

SYSTEM("system")

DEVELOPER("developer")

JsonValue; type "message"constant"message"constant

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

Optional<Status> status

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

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseOutputMessage:

An output message from the model.

String id

The unique ID of the output message.

List<Content> content

The content of the output message.

One of the following:

class ResponseOutputText:

A text output from the model.

List<Annotation> annotations

The annotations of the text output.

One of the following:

class FileCitation:

A citation to a file.

String fileId

The ID of the file.

String filename

The filename of the file cited.

long index

The index of the file in the list of files.

JsonValue; type "file_citation"constant"file_citation"constant

The type of the file citation. Always file_citation.

class UrlCitation:

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

long endIndex

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

long startIndex

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

String title

The title of the web resource.

JsonValue; type "url_citation"constant"url_citation"constant

The type of the URL citation. Always url_citation.

String url

The URL of the web resource.

class ContainerFileCitation:

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

String containerId

The ID of the container file.

long endIndex

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

String fileId

The ID of the file.

String filename

The filename of the container file cited.

long startIndex

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

JsonValue; type "container_file_citation"constant"container_file_citation"constant

The type of the container file citation. Always container_file_citation.

class FilePath:

A path to a file.

String fileId

The ID of the file.

long index

The index of the file in the list of files.

JsonValue; type "file_path"constant"file_path"constant

The type of the file path. Always file_path.

String text

The text output from the model.

JsonValue; type "output_text"constant"output_text"constant

The type of the output text. Always output_text.

Optional<List<Logprob>> logprobs

String token

List<long> bytes

double logprob

List<TopLogprob> topLogprobs

String token

List<long> bytes

double logprob

class ResponseOutputRefusal:

A refusal from the model.

String refusal

The refusal explanation from the model.

JsonValue; type "refusal"constant"refusal"constant

The type of the refusal. Always refusal.

JsonValue; role "assistant"constant"assistant"constant

The role of the output message. Always assistant.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "message"constant"message"constant

The type of the output message. Always message.

Optional<Phase> phase

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("commentary")

FINAL_ANSWER("final_answer")

class ResponseFileSearchToolCall:

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

String id

The unique ID of the file search tool call.

List<String> queries

The queries used to search for files.

Status status

The status of the file search tool call. One of in_progress, searching, incomplete or failed,

One of the following:

IN_PROGRESS("in_progress")

SEARCHING("searching")

COMPLETED("completed")

INCOMPLETE("incomplete")

FAILED("failed")

JsonValue; type "file_search_call"constant"file_search_call"constant

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

Optional<List<Result>> results

The results of the file search tool call.

Optional<Attributes> attributes

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

double

boolean

Optional<String> fileId

The unique ID of the file.

Optional<String> filename

The name of the file.

Optional<Double> score

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

formatfloat

Optional<String> text

The text that was retrieved from the file.

class ResponseComputerToolCall:

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

String id

The unique ID of the computer call.

String callId

An identifier used when responding to the tool call with output.

List<PendingSafetyCheck> pendingSafetyChecks

The pending safety checks for the computer call.

String id

The ID of the pending safety check.

Optional<String> code

The type of the pending safety check.

Optional<String> message

Details about the pending safety check.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

Type type

The type of the computer call. Always computer_call.

Optional<Action> action

A click action.

One of the following:

class Click:

A click action.

Button button

Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.

One of the following:

LEFT("left")

RIGHT("right")

WHEEL("wheel")

BACK("back")

FORWARD("forward")

JsonValue; type "click"constant"click"constant

Specifies the event type. For a click action, this property is always click.

long x

The x-coordinate where the click occurred.

long y

The y-coordinate where the click occurred.

Optional<List<String>> keys

The keys being held while clicking.

class DoubleClick:

A double click action.

Optional<List<String>> keys

The keys being held while double-clicking.

JsonValue; type "double_click"constant"double_click"constant

Specifies the event type. For a double click action, this property is always set to double_click.

long x

The x-coordinate where the double click occurred.

long y

The y-coordinate where the double click occurred.

class Drag:

A drag action.

List<Path> path

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

long x

The x-coordinate.

long y

The y-coordinate.

JsonValue; type "drag"constant"drag"constant

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

Optional<List<String>> keys

The keys being held while dragging the mouse.

class Keypress:

A collection of keypresses the model would like to perform.

List<String> keys

The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key.

JsonValue; type "keypress"constant"keypress"constant

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

class Move:

A mouse move action.

JsonValue; type "move"constant"move"constant

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

long x

The x-coordinate to move to.

long y

The y-coordinate to move to.

Optional<List<String>> keys

The keys being held while moving the mouse.

JsonValue;

JsonValue; type "screenshot"constant"screenshot"constant

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

class Scroll:

A scroll action.

long scrollX

The horizontal scroll distance.

long scrollY

The vertical scroll distance.

JsonValue; type "scroll"constant"scroll"constant

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

long x

The x-coordinate where the scroll occurred.

long y

The y-coordinate where the scroll occurred.

Optional<List<String>> keys

The keys being held while scrolling.

class Type:

An action to type in text.

String text

The text to type.

JsonValue; type "type"constant"type"constant

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

JsonValue;

JsonValue; type "wait"constant"wait"constant

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

Optional<List<ComputerAction>> actions

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

class ResponseComputerToolCallOutputItem:

String id

The unique ID of the computer call tool output.

String callId

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

ResponseComputerToolCallOutputScreenshot output

A computer screenshot image used with the computer use tool.

Status status

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("completed")

INCOMPLETE("incomplete")

FAILED("failed")

IN_PROGRESS("in_progress")

JsonValue; type "computer_call_output"constant"computer_call_output"constant

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

Optional<List<AcknowledgedSafetyCheck>> acknowledgedSafetyChecks

The safety checks reported by the API that have been acknowledged by the developer.

String id

The ID of the pending safety check.

Optional<String> code

The type of the pending safety check.

Optional<String> message

Details about the pending safety check.

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseFunctionWebSearch:

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

String id

The unique ID of the web search tool call.

Action action

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:

class Search:

Action type “search” - Performs a web search query.

String query

[DEPRECATED] The search query.

JsonValue; type "search"constant"search"constant

The action type.

Optional<List<String>> queries

The search queries.

Optional<List<Source>> sources

The sources used in the search.

JsonValue; type "url"constant"url"constant

The type of source. Always url.

String url

The URL of the source.

class OpenPage:

Action type “open_page” - Opens a specific URL from search results.

JsonValue; type "open_page"constant"open_page"constant

The action type.

Optional<String> url

The URL opened by the model.

formaturi

class FindInPage:

Action type “find_in_page”: Searches for a pattern within a loaded page.

String pattern

The pattern or text to search for within the page.

JsonValue; type "find_in_page"constant"find_in_page"constant

The action type.

String url

The URL of the page searched for the pattern.

formaturi

Status status

The status of the web search tool call.

One of the following:

IN_PROGRESS("in_progress")

SEARCHING("searching")

COMPLETED("completed")

FAILED("failed")

JsonValue; type "web_search_call"constant"web_search_call"constant

The type of the web search tool call. Always web_search_call.

class ResponseFunctionToolCallItem:

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

String id

The unique ID of the function tool call.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseFunctionToolCallOutputItem:

String id

The unique ID of the function call tool output.

String callId

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

Output output

The output from the function call generated by your code. Can be a string or an list of output content.

One of the following:

String

List<FunctionAndCustomToolCallOutput>

One of the following:

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputImage:

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

Detail detail

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("low")

HIGH("high")

AUTO("auto")

ORIGINAL("original")

JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<String> fileId

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

Optional<String> imageUrl

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

class ResponseInputFile:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

Optional<Detail> detail

The detail level of the file to be sent to the model. Use low for the default rendering behavior, or high to render the file at higher quality. Defaults to low.

One of the following:

LOW("low")

HIGH("high")

Optional<String> fileData

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

Optional<String> fileId

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

Optional<String> fileUrl

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

Optional<String> filename

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

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "function_call_output"constant"function_call_output"constant

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

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseToolSearchCall:

String id

The unique ID of the tool search call item.

JsonValue arguments

Arguments used for the tool search call.

Optional<String> callId

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

Execution execution

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

One of the following:

SERVER("server")

CLIENT("client")

Status status

The status of the tool search call item that was recorded.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "tool_search_call"constant"tool_search_call"constant

The type of the item. Always tool_search_call.

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseToolSearchOutputItem:

String id

The unique ID of the tool search output item.

Optional<String> callId

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

Execution execution

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

One of the following:

SERVER("server")

CLIENT("client")

Status status

The status of the tool search output item that was recorded.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

List<Tool> tools

The loaded tool definitions returned by tool search.

One of the following:

class FunctionTool:

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

String name

The name of the function to call.

Optional<Parameters> parameters

A JSON schema object describing the parameters of the function.

Optional<Boolean> strict

Whether to enforce strict parameter validation. Default true.

JsonValue; type "function"constant"function"constant

The type of the function tool. Always function.

Optional<Boolean> deferLoading

Whether this function is deferred and loaded via tool search.

Optional<String> description

A description of the function. Used by the model to determine whether or not to call the function.

class FileSearchTool:

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

JsonValue; type "file_search"constant"file_search"constant

The type of the file search tool. Always file_search.

List<String> vectorStoreIds

The IDs of the vector stores to search.

Optional<Filters> filters

A filter to apply.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

class CompoundFilter:

Combine multiple filters using and or or.

List<Filter> filters

Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

JsonValue

Type type

Type of operation: and or or.

One of the following:

AND("and")

OR("or")

Optional<Long> maxNumResults

The maximum number of results to return. This number should be between 1 and 50 inclusive.

Optional<RankingOptions> rankingOptions

Ranking options for search.

Optional<HybridSearch> hybridSearch

Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled.

double embeddingWeight

The weight of the embedding in the reciprocal ranking fusion.

double textWeight

The weight of the text in the reciprocal ranking fusion.

Optional<Ranker> ranker

The ranker to use for the file search.

One of the following:

AUTO("auto")

DEFAULT_2024_11_15("default-2024-11-15")

Optional<Double> scoreThreshold

The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.

class ComputerTool:

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

JsonValue; type "computer"constant"computer"constant

The type of the computer tool. Always computer.

class ComputerUsePreviewTool:

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

long displayHeight

The height of the computer display.

long displayWidth

The width of the computer display.

Environment environment

The type of computer environment to control.

One of the following:

WINDOWS("windows")

MAC("mac")

LINUX("linux")

UBUNTU("ubuntu")

BROWSER("browser")

JsonValue; type "computer_use_preview"constant"computer_use_preview"constant

The type of the computer use tool. Always computer_use_preview.

class WebSearchTool:

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

Type type

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")

WEB_SEARCH_2025_08_26("web_search_2025_08_26")

Optional<Filters> filters

Filters for the search.

Optional<List<String>> allowedDomains

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

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The approximate location of the user.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

Optional<Type> type

The type of location approximation. Always approximate.

Mcp

String serverLabel

A label for this MCP server, used to identify it in tool calls.

JsonValue; type "mcp"constant"mcp"constant

The type of the MCP tool. Always mcp.

Optional<AllowedTools> allowedTools

List of allowed tool names or a filter object.

One of the following:

List<String>

class McpToolFilter:

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<String> authorization

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.

Optional<ConnectorId> connectorId

Identifier for service connectors, like those available in ChatGPT. One of server_url or connector_id must be provided. Learn more about service connectors here.

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_dropbox")

CONNECTOR_GMAIL("connector_gmail")

CONNECTOR_GOOGLECALENDAR("connector_googlecalendar")

CONNECTOR_GOOGLEDRIVE("connector_googledrive")

CONNECTOR_MICROSOFTTEAMS("connector_microsoftteams")

CONNECTOR_OUTLOOKCALENDAR("connector_outlookcalendar")

CONNECTOR_OUTLOOKEMAIL("connector_outlookemail")

CONNECTOR_SHAREPOINT("connector_sharepoint")

Optional<Boolean> deferLoading

Whether this MCP tool is deferred and discovered via tool search.

Optional<Headers> headers

Optional HTTP headers to send to the MCP server. Use for authentication or other purposes.

Optional<RequireApproval> requireApproval

Specify which of the MCP server’s tools require approval.

One of the following:

class McpToolApprovalFilter:

Specify which of the MCP server’s tools require approval. Can be always, never, or a filter object associated with tools that require approval.

Optional<Always> always

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<Never> never

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

enum McpToolApprovalSetting:

Specify a single approval policy for all tools. One of always or never. When set to always, all tools will require approval. When set to never, all tools will not require approval.

ALWAYS("always")

NEVER("never")

Optional<String> serverDescription

Optional description of the MCP server, used to provide more context.

Optional<String> serverUrl

The URL for the MCP server. One of server_url or connector_id must be provided.

CodeInterpreter

Container container

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

class CodeInterpreterToolAuto:

Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.

JsonValue; type "auto"constant"auto"constant

Always auto.

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the code interpreter container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

JsonValue; type "code_interpreter"constant"code_interpreter"constant

The type of the code interpreter tool. Always code_interpreter.

ImageGeneration

JsonValue; type "image_generation"constant"image_generation"constant

The type of the image generation tool. Always image_generation.

Optional<Action> action

Whether to generate a new image or edit an existing image. Default: auto.

One of the following:

GENERATE("generate")

EDIT("edit")

AUTO("auto")

Optional<Background> background

Background type for the generated image. One of transparent, opaque, or auto. Default: auto.

One of the following:

TRANSPARENT("transparent")

OPAQUE("opaque")

AUTO("auto")

Optional<InputFidelity> inputFidelity

Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1 and gpt-image-1.5 and later models, unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.

One of the following:

HIGH("high")

LOW("low")

Optional<InputImageMask> inputImageMask

Optional mask for inpainting. Contains image_url (string, optional) and file_id (string, optional).

Optional<String> fileId

File ID for the mask image.

Optional<String> imageUrl

Base64-encoded mask image.

Optional<Model> model

The image generation model to use. Default: gpt-image-1.

One of the following:

GPT_IMAGE_1("gpt-image-1")

GPT_IMAGE_1_MINI("gpt-image-1-mini")

GPT_IMAGE_1_5("gpt-image-1.5")

Optional<Moderation> moderation

Moderation level for the generated image. Default: auto.

One of the following:

AUTO("auto")

LOW("low")

Optional<Long> outputCompression

Compression level for the output image. Default: 100.

minimum0

maximum100

Optional<OutputFormat> outputFormat

The output format of the generated image. One of png, webp, or jpeg. Default: png.

One of the following:

PNG("png")

WEBP("webp")

JPEG("jpeg")

Optional<Long> partialImages

Number of partial images to generate in streaming mode, from 0 (default value) to 3.

minimum0

maximum3

Optional<Quality> quality

The quality of the generated image. One of low, medium, high, or auto. Default: auto.

One of the following:

LOW("low")

MEDIUM("medium")

HIGH("high")

AUTO("auto")

Optional<Size> size

The size of the generated image. One of 1024x1024, 1024x1536, 1536x1024, or auto. Default: auto.

One of the following:

_1024X1024("1024x1024")

_1024X1536("1024x1536")

_1536X1024("1536x1024")

AUTO("auto")

JsonValue;

JsonValue; type "local_shell"constant"local_shell"constant

The type of the local shell tool. Always local_shell.

class FunctionShellTool:

A tool that allows the model to execute shell commands.

JsonValue; type "shell"constant"shell"constant

The type of the shell tool. Always shell.

Optional<Environment> environment

One of the following:

class ContainerAuto:

JsonValue; type "container_auto"constant"container_auto"constant

Automatically creates a container for this request

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

Optional<List<Skill>> skills

An optional list of skills referenced by id or inline data.

One of the following:

class SkillReference:

String skillId

The ID of the referenced skill.

maxLength64

minLength1

JsonValue; type "skill_reference"constant"skill_reference"constant

References a skill created with the /v1/skills endpoint.

Optional<String> version

Optional skill version. Use a positive integer or ‘latest’. Omit for default.

class InlineSkill:

String description

The description of the skill.

String name

The name of the skill.

InlineSkillSource source

Inline skill payload

JsonValue; type "inline"constant"inline"constant

Defines an inline skill for this request.

class LocalEnvironment:

JsonValue; type "local"constant"local"constant

Use a local computer environment.

Optional<List<LocalSkill>> skills

An optional list of skills.

String description

The description of the skill.

String name

The name of the skill.

String path

The path to the directory containing the skill.

class ContainerReference:

String containerId

The ID of the referenced container.

JsonValue; type "container_reference"constant"container_reference"constant

References a container created with the /v1/containers endpoint

class CustomTool:

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

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

class NamespaceTool:

Groups function/custom tools under a shared namespace.

String description

A description of the namespace shown to the model.

minLength1

String name

The namespace name used in tool calls (for example, crm).

minLength1

List<Tool> tools

The function/custom tools available inside this namespace.

One of the following:

class Function:

String name

maxLength128

minLength1

JsonValue; type "function"constant"function"constant

Optional<Boolean> deferLoading

Whether this function should be deferred and discovered via tool search.

Optional<String> description

Optional<JsonValue> parameters

Optional<Boolean> strict

class CustomTool:

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

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

JsonValue; type "namespace"constant"namespace"constant

The type of the tool. Always namespace.

class ToolSearchTool:

Hosted or BYOT tool search configuration for deferred tools.

JsonValue; type "tool_search"constant"tool_search"constant

The type of the tool. Always tool_search.

Optional<String> description

Description shown to the model for a client-executed tool search tool.

Optional<Execution> execution

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

One of the following:

SERVER("server")

CLIENT("client")

Optional<JsonValue> parameters

Parameter schema for a client-executed tool search tool.

class WebSearchPreviewTool:

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

Type type

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")

WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")

Optional<List<SearchContentType>> searchContentTypes

One of the following:

TEXT("text")

IMAGE("image")

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The user’s location.

JsonValue; type "approximate"constant"approximate"constant

The type of location approximation. Always approximate.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

class ApplyPatchTool:

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

JsonValue; type "apply_patch"constant"apply_patch"constant

The type of the tool. Always apply_patch.

JsonValue; type "tool_search_output"constant"tool_search_output"constant

The type of the item. Always tool_search_output.

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseReasoningItem:

A description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your input to the Responses API for subsequent turns of a conversation if you are manually managing context.

String id

The unique identifier of the reasoning content.

List<Summary> summary

Reasoning summary content.

String text

A summary of the reasoning output from the model so far.

JsonValue; type "summary_text"constant"summary_text"constant

The type of the object. Always summary_text.

JsonValue; type "reasoning"constant"reasoning"constant

The type of the object. Always reasoning.

Optional<List<Content>> content

Reasoning text content.

String text

The reasoning text from the model.

JsonValue; type "reasoning_text"constant"reasoning_text"constant

The type of the reasoning text. Always reasoning_text.

Optional<String> encryptedContent

The encrypted content of the reasoning item - populated when a response is generated with reasoning.encrypted_content in the include parameter.

Optional<Status> status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseCompactionItem:

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

String id

The unique ID of the compaction item.

String encryptedContent

The encrypted content that was produced by compaction.

JsonValue; type "compaction"constant"compaction"constant

The type of the item. Always compaction.

Optional<String> createdBy

The identifier of the actor that created the item.

ImageGenerationCall

String id

The unique ID of the image generation call.

Optional<String> result

The generated image encoded in base64.

Status status

The status of the image generation call.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

GENERATING("generating")

FAILED("failed")

JsonValue; type "image_generation_call"constant"image_generation_call"constant

The type of the image generation call. Always image_generation_call.

class ResponseCodeInterpreterToolCall:

A tool call to run code.

String id

The unique ID of the code interpreter tool call.

Optional<String> code

The code to run, or null if not available.

String containerId

The ID of the container used to run the code.

Optional<List<Output>> outputs

The outputs generated by the code interpreter, such as logs or images. Can be null if no outputs are available.

One of the following:

class Logs:

The logs output from the code interpreter.

String logs

The logs output from the code interpreter.

JsonValue; type "logs"constant"logs"constant

The type of the output. Always logs.

class Image:

The image output from the code interpreter.

JsonValue; type "image"constant"image"constant

The type of the output. Always image.

String url

The URL of the image output from the code interpreter.

Status status

The status of the code interpreter tool call. Valid values are in_progress, completed, incomplete, interpreting, and failed.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

INTERPRETING("interpreting")

FAILED("failed")

JsonValue; type "code_interpreter_call"constant"code_interpreter_call"constant

The type of the code interpreter tool call. Always code_interpreter_call.

LocalShellCall

String id

The unique ID of the local shell call.

Action action

Execute a shell command on the server.

List<String> command

The command to run.

Env env

Environment variables to set for the command.

JsonValue; type "exec"constant"exec"constant

The type of the local shell action. Always exec.

Optional<Long> timeoutMs

Optional timeout in milliseconds for the command.

Optional<String> user

Optional user to run the command as.

Optional<String> workingDirectory

Optional working directory to run the command in.

String callId

The unique ID of the local shell tool call generated by the model.

Status status

The status of the local shell call.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "local_shell_call"constant"local_shell_call"constant

The type of the local shell call. Always local_shell_call.

LocalShellCallOutput

String id

The unique ID of the local shell tool call generated by the model.

String output

A JSON string of the output of the local shell tool call.

JsonValue; type "local_shell_call_output"constant"local_shell_call_output"constant

The type of the local shell tool call output. Always local_shell_call_output.

Optional<Status> status

The status of the item. One of in_progress, completed, or incomplete.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseFunctionShellToolCall:

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

String id

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

Action action

The shell commands and limits that describe how to run the tool call.

List<String> commands

Optional<Long> maxOutputLength

Optional maximum number of characters to return from each command.

Optional<Long> timeoutMs

Optional timeout in milliseconds for the commands.

String callId

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

Optional<Environment> environment

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

One of the following:

class ResponseLocalEnvironment:

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

JsonValue; type "local"constant"local"constant

The environment type. Always local.

class ResponseContainerReference:

Represents a container created with /v1/containers.

String containerId

JsonValue; type "container_reference"constant"container_reference"constant

The environment type. Always container_reference.

Status status

The status of the shell call. One of in_progress, completed, or incomplete.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "shell_call"constant"shell_call"constant

The type of the item. Always shell_call.

Optional<String> createdBy

The ID of the entity that created this tool call.

class ResponseFunctionShellToolCallOutput:

The output of a shell tool call that was emitted.

String id

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

String callId

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

Optional<Long> maxOutputLength

The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output.

List<Output> output

An array of shell call output contents

Outcome outcome

Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk.

One of the following:

JsonValue;

JsonValue; type "timeout"constant"timeout"constant

The outcome type. Always timeout.

class Exit:

Indicates that the shell commands finished and returned an exit code.

long exitCode

Exit code from the shell process.

JsonValue; type "exit"constant"exit"constant

The outcome type. Always exit.

String stderr

The standard error output that was captured.

String stdout

The standard output that was captured.

Optional<String> createdBy

The identifier of the actor that created the item.

Status status

The status of the shell call output. One of in_progress, completed, or incomplete.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "shell_call_output"constant"shell_call_output"constant

The type of the shell call output. Always shell_call_output.

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseApplyPatchToolCall:

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

String id

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

String callId

The unique ID of the apply patch tool call generated by the model.

Operation operation

One of the create_file, delete_file, or update_file operations applied via apply_patch.

One of the following:

class CreateFile:

Instruction describing how to create a file via the apply_patch tool.

String diff

Diff to apply.

String path

Path of the file to create.

JsonValue; type "create_file"constant"create_file"constant

Create a new file with the provided diff.

class DeleteFile:

Instruction describing how to delete a file via the apply_patch tool.

String path

Path of the file to delete.

JsonValue; type "delete_file"constant"delete_file"constant

Delete the specified file.

class UpdateFile:

Instruction describing how to update a file via the apply_patch tool.

String diff

Diff to apply.

String path

Path of the file to update.

JsonValue; type "update_file"constant"update_file"constant

Update an existing file with the provided diff.

Status status

The status of the apply patch tool call. One of in_progress or completed.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

JsonValue; type "apply_patch_call"constant"apply_patch_call"constant

The type of the item. Always apply_patch_call.

Optional<String> createdBy

The ID of the entity that created this tool call.

class ResponseApplyPatchToolCallOutput:

The output emitted by an apply patch tool call.

String id

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

String callId

The unique ID of the apply patch tool call generated by the model.

Status status

The status of the apply patch tool call output. One of completed or failed.

One of the following:

COMPLETED("completed")

FAILED("failed")

JsonValue; type "apply_patch_call_output"constant"apply_patch_call_output"constant

The type of the item. Always apply_patch_call_output.

Optional<String> createdBy

The ID of the entity that created this tool call output.

Optional<String> output

Optional textual output returned by the apply patch tool.

McpListTools

String id

The unique ID of the list.

String serverLabel

The label of the MCP server.

List<Tool> tools

The tools available on the server.

JsonValue inputSchema

The JSON schema describing the tool’s input.

String name

The name of the tool.

Optional<JsonValue> annotations

Additional annotations about the tool.

Optional<String> description

The description of the tool.

JsonValue; type "mcp_list_tools"constant"mcp_list_tools"constant

The type of the item. Always mcp_list_tools.

Optional<String> error

Error message if the server could not list tools.

McpApprovalRequest

String id

The unique ID of the approval request.

String arguments

A JSON string of arguments for the tool.

String name

The name of the tool to run.

String serverLabel

The label of the MCP server making the request.

JsonValue; type "mcp_approval_request"constant"mcp_approval_request"constant

The type of the item. Always mcp_approval_request.

McpApprovalResponse

String id

The unique ID of the approval response

String approvalRequestId

The ID of the approval request being answered.

boolean approve

Whether the request was approved.

JsonValue; type "mcp_approval_response"constant"mcp_approval_response"constant

The type of the item. Always mcp_approval_response.

Optional<String> reason

Optional reason for the decision.

McpCall

String id

The unique ID of the tool call.

String arguments

A JSON string of the arguments passed to the tool.

String name

The name of the tool that was run.

String serverLabel

The label of the MCP server running the tool.

JsonValue; type "mcp_call"constant"mcp_call"constant

The type of the item. Always mcp_call.

Optional<String> approvalRequestId

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.

Optional<String> error

The error from the tool call, if any.

Optional<String> output

The output from the tool call.

Optional<Status> status

The status of the tool call. One of in_progress, completed, incomplete, calling, or failed.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

CALLING("calling")

FAILED("failed")

class ResponseCustomToolCallItem:

A call to a custom tool created by the model.

String id

The unique ID of the custom tool call item.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseCustomToolCallOutputItem:

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

String id

The unique ID of the custom tool call output item.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseLocalEnvironment:

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

JsonValue; type "local"constant"local"constant

The environment type. Always local.

class ResponseMcpCallArgumentsDeltaEvent:

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

String delta

A JSON string containing the partial update to the arguments for the MCP tool call.

String itemId

The unique identifier of the MCP tool call item being processed.

long outputIndex

The index of the output item in the response’s output array.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.mcp_call_arguments.delta"constant"response.mcp_call_arguments.delta"constant

The type of the event. Always ‘response.mcp_call_arguments.delta’.

class ResponseMcpCallArgumentsDoneEvent:

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

String arguments

A JSON string containing the finalized arguments for the MCP tool call.

String itemId

The unique identifier of the MCP tool call item being processed.

long outputIndex

The index of the output item in the response’s output array.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.mcp_call_arguments.done"constant"response.mcp_call_arguments.done"constant

The type of the event. Always ‘response.mcp_call_arguments.done’.

class ResponseMcpCallCompletedEvent:

Emitted when an MCP tool call has completed successfully.

String itemId

The ID of the MCP tool call item that completed.

long outputIndex

The index of the output item that completed.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.mcp_call.completed"constant"response.mcp_call.completed"constant

The type of the event. Always ‘response.mcp_call.completed’.

class ResponseMcpCallFailedEvent:

Emitted when an MCP tool call has failed.

String itemId

The ID of the MCP tool call item that failed.

long outputIndex

The index of the output item that failed.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.mcp_call.failed"constant"response.mcp_call.failed"constant

The type of the event. Always ‘response.mcp_call.failed’.

class ResponseMcpCallInProgressEvent:

Emitted when an MCP tool call is in progress.

String itemId

The unique identifier of the MCP tool call item being processed.

long outputIndex

The index of the output item in the response’s output array.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.mcp_call.in_progress"constant"response.mcp_call.in_progress"constant

The type of the event. Always ‘response.mcp_call.in_progress’.

class ResponseMcpListToolsCompletedEvent:

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

String itemId

The ID of the MCP tool call item that produced this output.

long outputIndex

The index of the output item that was processed.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.mcp_list_tools.completed"constant"response.mcp_list_tools.completed"constant

The type of the event. Always ‘response.mcp_list_tools.completed’.

class ResponseMcpListToolsFailedEvent:

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

String itemId

The ID of the MCP tool call item that failed.

long outputIndex

The index of the output item that failed.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.mcp_list_tools.failed"constant"response.mcp_list_tools.failed"constant

The type of the event. Always ‘response.mcp_list_tools.failed’.

class ResponseMcpListToolsInProgressEvent:

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

String itemId

The ID of the MCP tool call item that is being processed.

long outputIndex

The index of the output item that is being processed.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.mcp_list_tools.in_progress"constant"response.mcp_list_tools.in_progress"constant

The type of the event. Always ‘response.mcp_list_tools.in_progress’.

class ResponseOutputAudio:

An audio output from the model.

String data

Base64-encoded audio data from the model.

String transcript

The transcript of the audio data from the model.

JsonValue; type "output_audio"constant"output_audio"constant

The type of the output audio. Always output_audio.

class ResponseOutputItem: A class that can be one of several variants.union

An output message from the model.

class ResponseOutputMessage:

An output message from the model.

String id

The unique ID of the output message.

List<Content> content

The content of the output message.

One of the following:

class ResponseOutputText:

A text output from the model.

List<Annotation> annotations

The annotations of the text output.

One of the following:

class FileCitation:

A citation to a file.

String fileId

The ID of the file.

String filename

The filename of the file cited.

long index

The index of the file in the list of files.

JsonValue; type "file_citation"constant"file_citation"constant

The type of the file citation. Always file_citation.

class UrlCitation:

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

long endIndex

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

long startIndex

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

String title

The title of the web resource.

JsonValue; type "url_citation"constant"url_citation"constant

The type of the URL citation. Always url_citation.

String url

The URL of the web resource.

class ContainerFileCitation:

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

String containerId

The ID of the container file.

long endIndex

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

String fileId

The ID of the file.

String filename

The filename of the container file cited.

long startIndex

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

JsonValue; type "container_file_citation"constant"container_file_citation"constant

The type of the container file citation. Always container_file_citation.

class FilePath:

A path to a file.

String fileId

The ID of the file.

long index

The index of the file in the list of files.

JsonValue; type "file_path"constant"file_path"constant

The type of the file path. Always file_path.

String text

The text output from the model.

JsonValue; type "output_text"constant"output_text"constant

The type of the output text. Always output_text.

Optional<List<Logprob>> logprobs

String token

List<long> bytes

double logprob

List<TopLogprob> topLogprobs

String token

List<long> bytes

double logprob

class ResponseOutputRefusal:

A refusal from the model.

String refusal

The refusal explanation from the model.

JsonValue; type "refusal"constant"refusal"constant

The type of the refusal. Always refusal.

JsonValue; role "assistant"constant"assistant"constant

The role of the output message. Always assistant.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "message"constant"message"constant

The type of the output message. Always message.

Optional<Phase> phase

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("commentary")

FINAL_ANSWER("final_answer")

class ResponseFileSearchToolCall:

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

String id

The unique ID of the file search tool call.

List<String> queries

The queries used to search for files.

Status status

The status of the file search tool call. One of in_progress, searching, incomplete or failed,

One of the following:

IN_PROGRESS("in_progress")

SEARCHING("searching")

COMPLETED("completed")

INCOMPLETE("incomplete")

FAILED("failed")

JsonValue; type "file_search_call"constant"file_search_call"constant

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

Optional<List<Result>> results

The results of the file search tool call.

Optional<Attributes> attributes

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

double

boolean

Optional<String> fileId

The unique ID of the file.

Optional<String> filename

The name of the file.

Optional<Double> score

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

formatfloat

Optional<String> text

The text that was retrieved from the file.

class ResponseFunctionToolCall:

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

String arguments

A JSON string of the arguments to pass to the function.

String callId

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

String name

The name of the function to run.

JsonValue; type "function_call"constant"function_call"constant

The type of the function tool call. Always function_call.

Optional<String> id

The unique ID of the function tool call.

Optional<String> namespace

The namespace of the function to run.

Optional<Status> status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseFunctionToolCallOutputItem:

String id

The unique ID of the function call tool output.

String callId

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

Output output

The output from the function call generated by your code. Can be a string or an list of output content.

One of the following:

String

List<FunctionAndCustomToolCallOutput>

One of the following:

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputImage:

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

Detail detail

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("low")

HIGH("high")

AUTO("auto")

ORIGINAL("original")

JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<String> fileId

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

Optional<String> imageUrl

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

class ResponseInputFile:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

Optional<Detail> detail

The detail level of the file to be sent to the model. Use low for the default rendering behavior, or high to render the file at higher quality. Defaults to low.

One of the following:

LOW("low")

HIGH("high")

Optional<String> fileData

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

Optional<String> fileId

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

Optional<String> fileUrl

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

Optional<String> filename

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

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "function_call_output"constant"function_call_output"constant

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

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseFunctionWebSearch:

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

String id

The unique ID of the web search tool call.

Action action

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:

class Search:

Action type “search” - Performs a web search query.

String query

[DEPRECATED] The search query.

JsonValue; type "search"constant"search"constant

The action type.

Optional<List<String>> queries

The search queries.

Optional<List<Source>> sources

The sources used in the search.

JsonValue; type "url"constant"url"constant

The type of source. Always url.

String url

The URL of the source.

class OpenPage:

Action type “open_page” - Opens a specific URL from search results.

JsonValue; type "open_page"constant"open_page"constant

The action type.

Optional<String> url

The URL opened by the model.

formaturi

class FindInPage:

Action type “find_in_page”: Searches for a pattern within a loaded page.

String pattern

The pattern or text to search for within the page.

JsonValue; type "find_in_page"constant"find_in_page"constant

The action type.

String url

The URL of the page searched for the pattern.

formaturi

Status status

The status of the web search tool call.

One of the following:

IN_PROGRESS("in_progress")

SEARCHING("searching")

COMPLETED("completed")

FAILED("failed")

JsonValue; type "web_search_call"constant"web_search_call"constant

The type of the web search tool call. Always web_search_call.

class ResponseComputerToolCall:

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

String id

The unique ID of the computer call.

String callId

An identifier used when responding to the tool call with output.

List<PendingSafetyCheck> pendingSafetyChecks

The pending safety checks for the computer call.

String id

The ID of the pending safety check.

Optional<String> code

The type of the pending safety check.

Optional<String> message

Details about the pending safety check.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

Type type

The type of the computer call. Always computer_call.

Optional<Action> action

A click action.

One of the following:

class Click:

A click action.

Button button

Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.

One of the following:

LEFT("left")

RIGHT("right")

WHEEL("wheel")

BACK("back")

FORWARD("forward")

JsonValue; type "click"constant"click"constant

Specifies the event type. For a click action, this property is always click.

long x

The x-coordinate where the click occurred.

long y

The y-coordinate where the click occurred.

Optional<List<String>> keys

The keys being held while clicking.

class DoubleClick:

A double click action.

Optional<List<String>> keys

The keys being held while double-clicking.

JsonValue; type "double_click"constant"double_click"constant

Specifies the event type. For a double click action, this property is always set to double_click.

long x

The x-coordinate where the double click occurred.

long y

The y-coordinate where the double click occurred.

class Drag:

A drag action.

List<Path> path

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

long x

The x-coordinate.

long y

The y-coordinate.

JsonValue; type "drag"constant"drag"constant

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

Optional<List<String>> keys

The keys being held while dragging the mouse.

class Keypress:

A collection of keypresses the model would like to perform.

List<String> keys

The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key.

JsonValue; type "keypress"constant"keypress"constant

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

class Move:

A mouse move action.

JsonValue; type "move"constant"move"constant

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

long x

The x-coordinate to move to.

long y

The y-coordinate to move to.

Optional<List<String>> keys

The keys being held while moving the mouse.

JsonValue;

JsonValue; type "screenshot"constant"screenshot"constant

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

class Scroll:

A scroll action.

long scrollX

The horizontal scroll distance.

long scrollY

The vertical scroll distance.

JsonValue; type "scroll"constant"scroll"constant

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

long x

The x-coordinate where the scroll occurred.

long y

The y-coordinate where the scroll occurred.

Optional<List<String>> keys

The keys being held while scrolling.

class Type:

An action to type in text.

String text

The text to type.

JsonValue; type "type"constant"type"constant

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

JsonValue;

JsonValue; type "wait"constant"wait"constant

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

Optional<List<ComputerAction>> actions

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

class ResponseComputerToolCallOutputItem:

String id

The unique ID of the computer call tool output.

String callId

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

ResponseComputerToolCallOutputScreenshot output

A computer screenshot image used with the computer use tool.

Status status

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("completed")

INCOMPLETE("incomplete")

FAILED("failed")

IN_PROGRESS("in_progress")

JsonValue; type "computer_call_output"constant"computer_call_output"constant

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

Optional<List<AcknowledgedSafetyCheck>> acknowledgedSafetyChecks

The safety checks reported by the API that have been acknowledged by the developer.

String id

The ID of the pending safety check.

Optional<String> code

The type of the pending safety check.

Optional<String> message

Details about the pending safety check.

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseReasoningItem:

A description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your input to the Responses API for subsequent turns of a conversation if you are manually managing context.

String id

The unique identifier of the reasoning content.

List<Summary> summary

Reasoning summary content.

String text

A summary of the reasoning output from the model so far.

JsonValue; type "summary_text"constant"summary_text"constant

The type of the object. Always summary_text.

JsonValue; type "reasoning"constant"reasoning"constant

The type of the object. Always reasoning.

Optional<List<Content>> content

Reasoning text content.

String text

The reasoning text from the model.

JsonValue; type "reasoning_text"constant"reasoning_text"constant

The type of the reasoning text. Always reasoning_text.

Optional<String> encryptedContent

The encrypted content of the reasoning item - populated when a response is generated with reasoning.encrypted_content in the include parameter.

Optional<Status> status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseToolSearchCall:

String id

The unique ID of the tool search call item.

JsonValue arguments

Arguments used for the tool search call.

Optional<String> callId

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

Execution execution

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

One of the following:

SERVER("server")

CLIENT("client")

Status status

The status of the tool search call item that was recorded.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "tool_search_call"constant"tool_search_call"constant

The type of the item. Always tool_search_call.

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseToolSearchOutputItem:

String id

The unique ID of the tool search output item.

Optional<String> callId

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

Execution execution

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

One of the following:

SERVER("server")

CLIENT("client")

Status status

The status of the tool search output item that was recorded.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

List<Tool> tools

The loaded tool definitions returned by tool search.

One of the following:

class FunctionTool:

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

String name

The name of the function to call.

Optional<Parameters> parameters

A JSON schema object describing the parameters of the function.

Optional<Boolean> strict

Whether to enforce strict parameter validation. Default true.

JsonValue; type "function"constant"function"constant

The type of the function tool. Always function.

Optional<Boolean> deferLoading

Whether this function is deferred and loaded via tool search.

Optional<String> description

A description of the function. Used by the model to determine whether or not to call the function.

class FileSearchTool:

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

JsonValue; type "file_search"constant"file_search"constant

The type of the file search tool. Always file_search.

List<String> vectorStoreIds

The IDs of the vector stores to search.

Optional<Filters> filters

A filter to apply.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

class CompoundFilter:

Combine multiple filters using and or or.

List<Filter> filters

Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

JsonValue

Type type

Type of operation: and or or.

One of the following:

AND("and")

OR("or")

Optional<Long> maxNumResults

The maximum number of results to return. This number should be between 1 and 50 inclusive.

Optional<RankingOptions> rankingOptions

Ranking options for search.

Optional<HybridSearch> hybridSearch

Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled.

double embeddingWeight

The weight of the embedding in the reciprocal ranking fusion.

double textWeight

The weight of the text in the reciprocal ranking fusion.

Optional<Ranker> ranker

The ranker to use for the file search.

One of the following:

AUTO("auto")

DEFAULT_2024_11_15("default-2024-11-15")

Optional<Double> scoreThreshold

The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.

class ComputerTool:

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

JsonValue; type "computer"constant"computer"constant

The type of the computer tool. Always computer.

class ComputerUsePreviewTool:

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

long displayHeight

The height of the computer display.

long displayWidth

The width of the computer display.

Environment environment

The type of computer environment to control.

One of the following:

WINDOWS("windows")

MAC("mac")

LINUX("linux")

UBUNTU("ubuntu")

BROWSER("browser")

JsonValue; type "computer_use_preview"constant"computer_use_preview"constant

The type of the computer use tool. Always computer_use_preview.

class WebSearchTool:

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

Type type

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")

WEB_SEARCH_2025_08_26("web_search_2025_08_26")

Optional<Filters> filters

Filters for the search.

Optional<List<String>> allowedDomains

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

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The approximate location of the user.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

Optional<Type> type

The type of location approximation. Always approximate.

Mcp

String serverLabel

A label for this MCP server, used to identify it in tool calls.

JsonValue; type "mcp"constant"mcp"constant

The type of the MCP tool. Always mcp.

Optional<AllowedTools> allowedTools

List of allowed tool names or a filter object.

One of the following:

List<String>

class McpToolFilter:

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<String> authorization

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.

Optional<ConnectorId> connectorId

Identifier for service connectors, like those available in ChatGPT. One of server_url or connector_id must be provided. Learn more about service connectors here.

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_dropbox")

CONNECTOR_GMAIL("connector_gmail")

CONNECTOR_GOOGLECALENDAR("connector_googlecalendar")

CONNECTOR_GOOGLEDRIVE("connector_googledrive")

CONNECTOR_MICROSOFTTEAMS("connector_microsoftteams")

CONNECTOR_OUTLOOKCALENDAR("connector_outlookcalendar")

CONNECTOR_OUTLOOKEMAIL("connector_outlookemail")

CONNECTOR_SHAREPOINT("connector_sharepoint")

Optional<Boolean> deferLoading

Whether this MCP tool is deferred and discovered via tool search.

Optional<Headers> headers

Optional HTTP headers to send to the MCP server. Use for authentication or other purposes.

Optional<RequireApproval> requireApproval

Specify which of the MCP server’s tools require approval.

One of the following:

class McpToolApprovalFilter:

Specify which of the MCP server’s tools require approval. Can be always, never, or a filter object associated with tools that require approval.

Optional<Always> always

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<Never> never

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

enum McpToolApprovalSetting:

Specify a single approval policy for all tools. One of always or never. When set to always, all tools will require approval. When set to never, all tools will not require approval.

ALWAYS("always")

NEVER("never")

Optional<String> serverDescription

Optional description of the MCP server, used to provide more context.

Optional<String> serverUrl

The URL for the MCP server. One of server_url or connector_id must be provided.

CodeInterpreter

Container container

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

class CodeInterpreterToolAuto:

Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.

JsonValue; type "auto"constant"auto"constant

Always auto.

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the code interpreter container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

JsonValue; type "code_interpreter"constant"code_interpreter"constant

The type of the code interpreter tool. Always code_interpreter.

ImageGeneration

JsonValue; type "image_generation"constant"image_generation"constant

The type of the image generation tool. Always image_generation.

Optional<Action> action

Whether to generate a new image or edit an existing image. Default: auto.

One of the following:

GENERATE("generate")

EDIT("edit")

AUTO("auto")

Optional<Background> background

Background type for the generated image. One of transparent, opaque, or auto. Default: auto.

One of the following:

TRANSPARENT("transparent")

OPAQUE("opaque")

AUTO("auto")

Optional<InputFidelity> inputFidelity

Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1 and gpt-image-1.5 and later models, unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.

One of the following:

HIGH("high")

LOW("low")

Optional<InputImageMask> inputImageMask

Optional mask for inpainting. Contains image_url (string, optional) and file_id (string, optional).

Optional<String> fileId

File ID for the mask image.

Optional<String> imageUrl

Base64-encoded mask image.

Optional<Model> model

The image generation model to use. Default: gpt-image-1.

One of the following:

GPT_IMAGE_1("gpt-image-1")

GPT_IMAGE_1_MINI("gpt-image-1-mini")

GPT_IMAGE_1_5("gpt-image-1.5")

Optional<Moderation> moderation

Moderation level for the generated image. Default: auto.

One of the following:

AUTO("auto")

LOW("low")

Optional<Long> outputCompression

Compression level for the output image. Default: 100.

minimum0

maximum100

Optional<OutputFormat> outputFormat

The output format of the generated image. One of png, webp, or jpeg. Default: png.

One of the following:

PNG("png")

WEBP("webp")

JPEG("jpeg")

Optional<Long> partialImages

Number of partial images to generate in streaming mode, from 0 (default value) to 3.

minimum0

maximum3

Optional<Quality> quality

The quality of the generated image. One of low, medium, high, or auto. Default: auto.

One of the following:

LOW("low")

MEDIUM("medium")

HIGH("high")

AUTO("auto")

Optional<Size> size

The size of the generated image. One of 1024x1024, 1024x1536, 1536x1024, or auto. Default: auto.

One of the following:

_1024X1024("1024x1024")

_1024X1536("1024x1536")

_1536X1024("1536x1024")

AUTO("auto")

JsonValue;

JsonValue; type "local_shell"constant"local_shell"constant

The type of the local shell tool. Always local_shell.

class FunctionShellTool:

A tool that allows the model to execute shell commands.

JsonValue; type "shell"constant"shell"constant

The type of the shell tool. Always shell.

Optional<Environment> environment

One of the following:

class ContainerAuto:

JsonValue; type "container_auto"constant"container_auto"constant

Automatically creates a container for this request

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

Optional<List<Skill>> skills

An optional list of skills referenced by id or inline data.

One of the following:

class SkillReference:

String skillId

The ID of the referenced skill.

maxLength64

minLength1

JsonValue; type "skill_reference"constant"skill_reference"constant

References a skill created with the /v1/skills endpoint.

Optional<String> version

Optional skill version. Use a positive integer or ‘latest’. Omit for default.

class InlineSkill:

String description

The description of the skill.

String name

The name of the skill.

InlineSkillSource source

Inline skill payload

JsonValue; type "inline"constant"inline"constant

Defines an inline skill for this request.

class LocalEnvironment:

JsonValue; type "local"constant"local"constant

Use a local computer environment.

Optional<List<LocalSkill>> skills

An optional list of skills.

String description

The description of the skill.

String name

The name of the skill.

String path

The path to the directory containing the skill.

class ContainerReference:

String containerId

The ID of the referenced container.

JsonValue; type "container_reference"constant"container_reference"constant

References a container created with the /v1/containers endpoint

class CustomTool:

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

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

class NamespaceTool:

Groups function/custom tools under a shared namespace.

String description

A description of the namespace shown to the model.

minLength1

String name

The namespace name used in tool calls (for example, crm).

minLength1

List<Tool> tools

The function/custom tools available inside this namespace.

One of the following:

class Function:

String name

maxLength128

minLength1

JsonValue; type "function"constant"function"constant

Optional<Boolean> deferLoading

Whether this function should be deferred and discovered via tool search.

Optional<String> description

Optional<JsonValue> parameters

Optional<Boolean> strict

class CustomTool:

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

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

JsonValue; type "namespace"constant"namespace"constant

The type of the tool. Always namespace.

class ToolSearchTool:

Hosted or BYOT tool search configuration for deferred tools.

JsonValue; type "tool_search"constant"tool_search"constant

The type of the tool. Always tool_search.

Optional<String> description

Description shown to the model for a client-executed tool search tool.

Optional<Execution> execution

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

One of the following:

SERVER("server")

CLIENT("client")

Optional<JsonValue> parameters

Parameter schema for a client-executed tool search tool.

class WebSearchPreviewTool:

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

Type type

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")

WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")

Optional<List<SearchContentType>> searchContentTypes

One of the following:

TEXT("text")

IMAGE("image")

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The user’s location.

JsonValue; type "approximate"constant"approximate"constant

The type of location approximation. Always approximate.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

class ApplyPatchTool:

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

JsonValue; type "apply_patch"constant"apply_patch"constant

The type of the tool. Always apply_patch.

JsonValue; type "tool_search_output"constant"tool_search_output"constant

The type of the item. Always tool_search_output.

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseCompactionItem:

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

String id

The unique ID of the compaction item.

String encryptedContent

The encrypted content that was produced by compaction.

JsonValue; type "compaction"constant"compaction"constant

The type of the item. Always compaction.

Optional<String> createdBy

The identifier of the actor that created the item.

ImageGenerationCall

String id

The unique ID of the image generation call.

Optional<String> result

The generated image encoded in base64.

Status status

The status of the image generation call.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

GENERATING("generating")

FAILED("failed")

JsonValue; type "image_generation_call"constant"image_generation_call"constant

The type of the image generation call. Always image_generation_call.

class ResponseCodeInterpreterToolCall:

A tool call to run code.

String id

The unique ID of the code interpreter tool call.

Optional<String> code

The code to run, or null if not available.

String containerId

The ID of the container used to run the code.

Optional<List<Output>> outputs

The outputs generated by the code interpreter, such as logs or images. Can be null if no outputs are available.

One of the following:

class Logs:

The logs output from the code interpreter.

String logs

The logs output from the code interpreter.

JsonValue; type "logs"constant"logs"constant

The type of the output. Always logs.

class Image:

The image output from the code interpreter.

JsonValue; type "image"constant"image"constant

The type of the output. Always image.

String url

The URL of the image output from the code interpreter.

Status status

The status of the code interpreter tool call. Valid values are in_progress, completed, incomplete, interpreting, and failed.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

INTERPRETING("interpreting")

FAILED("failed")

JsonValue; type "code_interpreter_call"constant"code_interpreter_call"constant

The type of the code interpreter tool call. Always code_interpreter_call.

LocalShellCall

String id

The unique ID of the local shell call.

Action action

Execute a shell command on the server.

List<String> command

The command to run.

Env env

Environment variables to set for the command.

JsonValue; type "exec"constant"exec"constant

The type of the local shell action. Always exec.

Optional<Long> timeoutMs

Optional timeout in milliseconds for the command.

Optional<String> user

Optional user to run the command as.

Optional<String> workingDirectory

Optional working directory to run the command in.

String callId

The unique ID of the local shell tool call generated by the model.

Status status

The status of the local shell call.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "local_shell_call"constant"local_shell_call"constant

The type of the local shell call. Always local_shell_call.

LocalShellCallOutput

String id

The unique ID of the local shell tool call generated by the model.

String output

A JSON string of the output of the local shell tool call.

JsonValue; type "local_shell_call_output"constant"local_shell_call_output"constant

The type of the local shell tool call output. Always local_shell_call_output.

Optional<Status> status

The status of the item. One of in_progress, completed, or incomplete.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseFunctionShellToolCall:

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

String id

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

Action action

The shell commands and limits that describe how to run the tool call.

List<String> commands

Optional<Long> maxOutputLength

Optional maximum number of characters to return from each command.

Optional<Long> timeoutMs

Optional timeout in milliseconds for the commands.

String callId

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

Optional<Environment> environment

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

One of the following:

class ResponseLocalEnvironment:

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

JsonValue; type "local"constant"local"constant

The environment type. Always local.

class ResponseContainerReference:

Represents a container created with /v1/containers.

String containerId

JsonValue; type "container_reference"constant"container_reference"constant

The environment type. Always container_reference.

Status status

The status of the shell call. One of in_progress, completed, or incomplete.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "shell_call"constant"shell_call"constant

The type of the item. Always shell_call.

Optional<String> createdBy

The ID of the entity that created this tool call.

class ResponseFunctionShellToolCallOutput:

The output of a shell tool call that was emitted.

String id

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

String callId

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

Optional<Long> maxOutputLength

The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output.

List<Output> output

An array of shell call output contents

Outcome outcome

Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk.

One of the following:

JsonValue;

JsonValue; type "timeout"constant"timeout"constant

The outcome type. Always timeout.

class Exit:

Indicates that the shell commands finished and returned an exit code.

long exitCode

Exit code from the shell process.

JsonValue; type "exit"constant"exit"constant

The outcome type. Always exit.

String stderr

The standard error output that was captured.

String stdout

The standard output that was captured.

Optional<String> createdBy

The identifier of the actor that created the item.

Status status

The status of the shell call output. One of in_progress, completed, or incomplete.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "shell_call_output"constant"shell_call_output"constant

The type of the shell call output. Always shell_call_output.

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseApplyPatchToolCall:

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

String id

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

String callId

The unique ID of the apply patch tool call generated by the model.

Operation operation

One of the create_file, delete_file, or update_file operations applied via apply_patch.

One of the following:

class CreateFile:

Instruction describing how to create a file via the apply_patch tool.

String diff

Diff to apply.

String path

Path of the file to create.

JsonValue; type "create_file"constant"create_file"constant

Create a new file with the provided diff.

class DeleteFile:

Instruction describing how to delete a file via the apply_patch tool.

String path

Path of the file to delete.

JsonValue; type "delete_file"constant"delete_file"constant

Delete the specified file.

class UpdateFile:

Instruction describing how to update a file via the apply_patch tool.

String diff

Diff to apply.

String path

Path of the file to update.

JsonValue; type "update_file"constant"update_file"constant

Update an existing file with the provided diff.

Status status

The status of the apply patch tool call. One of in_progress or completed.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

JsonValue; type "apply_patch_call"constant"apply_patch_call"constant

The type of the item. Always apply_patch_call.

Optional<String> createdBy

The ID of the entity that created this tool call.

class ResponseApplyPatchToolCallOutput:

The output emitted by an apply patch tool call.

String id

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

String callId

The unique ID of the apply patch tool call generated by the model.

Status status

The status of the apply patch tool call output. One of completed or failed.

One of the following:

COMPLETED("completed")

FAILED("failed")

JsonValue; type "apply_patch_call_output"constant"apply_patch_call_output"constant

The type of the item. Always apply_patch_call_output.

Optional<String> createdBy

The ID of the entity that created this tool call output.

Optional<String> output

Optional textual output returned by the apply patch tool.

McpCall

String id

The unique ID of the tool call.

String arguments

A JSON string of the arguments passed to the tool.

String name

The name of the tool that was run.

String serverLabel

The label of the MCP server running the tool.

JsonValue; type "mcp_call"constant"mcp_call"constant

The type of the item. Always mcp_call.

Optional<String> approvalRequestId

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.

Optional<String> error

The error from the tool call, if any.

Optional<String> output

The output from the tool call.

Optional<Status> status

The status of the tool call. One of in_progress, completed, incomplete, calling, or failed.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

CALLING("calling")

FAILED("failed")

McpListTools

String id

The unique ID of the list.

String serverLabel

The label of the MCP server.

List<Tool> tools

The tools available on the server.

JsonValue inputSchema

The JSON schema describing the tool’s input.

String name

The name of the tool.

Optional<JsonValue> annotations

Additional annotations about the tool.

Optional<String> description

The description of the tool.

JsonValue; type "mcp_list_tools"constant"mcp_list_tools"constant

The type of the item. Always mcp_list_tools.

Optional<String> error

Error message if the server could not list tools.

McpApprovalRequest

String id

The unique ID of the approval request.

String arguments

A JSON string of arguments for the tool.

String name

The name of the tool to run.

String serverLabel

The label of the MCP server making the request.

JsonValue; type "mcp_approval_request"constant"mcp_approval_request"constant

The type of the item. Always mcp_approval_request.

McpApprovalResponse

String id

The unique ID of the approval response

String approvalRequestId

The ID of the approval request being answered.

boolean approve

Whether the request was approved.

JsonValue; type "mcp_approval_response"constant"mcp_approval_response"constant

The type of the item. Always mcp_approval_response.

Optional<String> reason

Optional reason for the decision.

class ResponseCustomToolCall:

A call to a custom tool created by the model.

String callId

An identifier used to map this custom tool call to a tool call output.

String input

The input for the custom tool call generated by the model.

String name

The name of the custom tool being called.

JsonValue; type "custom_tool_call"constant"custom_tool_call"constant

The type of the custom tool call. Always custom_tool_call.

Optional<String> id

The unique ID of the custom tool call in the OpenAI platform.

Optional<String> namespace

The namespace of the custom tool being called.

class ResponseCustomToolCallOutputItem:

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

String id

The unique ID of the custom tool call output item.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseOutputItemAddedEvent:

Emitted when a new output item is added.

ResponseOutputItem item

The output item that was added.

long outputIndex

The index of the output item that was added.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.output_item.added"constant"response.output_item.added"constant

The type of the event. Always response.output_item.added.

class ResponseOutputItemDoneEvent:

Emitted when an output item is marked done.

ResponseOutputItem item

The output item that was marked done.

long outputIndex

The index of the output item that was marked done.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.output_item.done"constant"response.output_item.done"constant

The type of the event. Always response.output_item.done.

class ResponseOutputMessage:

An output message from the model.

String id

The unique ID of the output message.

List<Content> content

The content of the output message.

One of the following:

class ResponseOutputText:

A text output from the model.

List<Annotation> annotations

The annotations of the text output.

One of the following:

class FileCitation:

A citation to a file.

String fileId

The ID of the file.

String filename

The filename of the file cited.

long index

The index of the file in the list of files.

JsonValue; type "file_citation"constant"file_citation"constant

The type of the file citation. Always file_citation.

class UrlCitation:

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

long endIndex

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

long startIndex

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

String title

The title of the web resource.

JsonValue; type "url_citation"constant"url_citation"constant

The type of the URL citation. Always url_citation.

String url

The URL of the web resource.

class ContainerFileCitation:

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

String containerId

The ID of the container file.

long endIndex

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

String fileId

The ID of the file.

String filename

The filename of the container file cited.

long startIndex

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

JsonValue; type "container_file_citation"constant"container_file_citation"constant

The type of the container file citation. Always container_file_citation.

class FilePath:

A path to a file.

String fileId

The ID of the file.

long index

The index of the file in the list of files.

JsonValue; type "file_path"constant"file_path"constant

The type of the file path. Always file_path.

String text

The text output from the model.

JsonValue; type "output_text"constant"output_text"constant

The type of the output text. Always output_text.

Optional<List<Logprob>> logprobs

String token

List<long> bytes

double logprob

List<TopLogprob> topLogprobs

String token

List<long> bytes

double logprob

class ResponseOutputRefusal:

A refusal from the model.

String refusal

The refusal explanation from the model.

JsonValue; type "refusal"constant"refusal"constant

The type of the refusal. Always refusal.

JsonValue; role "assistant"constant"assistant"constant

The role of the output message. Always assistant.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "message"constant"message"constant

The type of the output message. Always message.

Optional<Phase> phase

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("commentary")

FINAL_ANSWER("final_answer")

class ResponseOutputRefusal:

A refusal from the model.

String refusal

The refusal explanation from the model.

JsonValue; type "refusal"constant"refusal"constant

The type of the refusal. Always refusal.

class ResponseOutputText:

A text output from the model.

List<Annotation> annotations

The annotations of the text output.

One of the following:

class FileCitation:

A citation to a file.

String fileId

The ID of the file.

String filename

The filename of the file cited.

long index

The index of the file in the list of files.

JsonValue; type "file_citation"constant"file_citation"constant

The type of the file citation. Always file_citation.

class UrlCitation:

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

long endIndex

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

long startIndex

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

String title

The title of the web resource.

JsonValue; type "url_citation"constant"url_citation"constant

The type of the URL citation. Always url_citation.

String url

The URL of the web resource.

class ContainerFileCitation:

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

String containerId

The ID of the container file.

long endIndex

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

String fileId

The ID of the file.

String filename

The filename of the container file cited.

long startIndex

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

JsonValue; type "container_file_citation"constant"container_file_citation"constant

The type of the container file citation. Always container_file_citation.

class FilePath:

A path to a file.

String fileId

The ID of the file.

long index

The index of the file in the list of files.

JsonValue; type "file_path"constant"file_path"constant

The type of the file path. Always file_path.

String text

The text output from the model.

JsonValue; type "output_text"constant"output_text"constant

The type of the output text. Always output_text.

Optional<List<Logprob>> logprobs

String token

List<long> bytes

double logprob

List<TopLogprob> topLogprobs

String token

List<long> bytes

double logprob

class ResponseOutputTextAnnotationAddedEvent:

Emitted when an annotation is added to output text content.

JsonValue annotation

The annotation object being added. (See annotation schema for details.)

long annotationIndex

The index of the annotation within the content part.

long contentIndex

The index of the content part within the output item.

String itemId

The unique identifier of the item to which the annotation is being added.

long outputIndex

The index of the output item in the response’s output array.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.output_text.annotation.added"constant"response.output_text.annotation.added"constant

The type of the event. Always ‘response.output_text.annotation.added’.

class ResponsePrompt:

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

String id

The unique identifier of the prompt template to use.

Optional<Variables> variables

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

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputImage:

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

Detail detail

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("low")

HIGH("high")

AUTO("auto")

ORIGINAL("original")

JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<String> fileId

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

Optional<String> imageUrl

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

class ResponseInputFile:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

Optional<Detail> detail

The detail level of the file to be sent to the model. Use low for the default rendering behavior, or high to render the file at higher quality. Defaults to low.

One of the following:

LOW("low")

HIGH("high")

Optional<String> fileData

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

Optional<String> fileId

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

Optional<String> fileUrl

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

Optional<String> filename

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

Optional<String> version

Optional version of the prompt template.

class ResponseQueuedEvent:

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

Response response

The full response object that is queued.

long sequenceNumber

The sequence number for this event.

JsonValue; type "response.queued"constant"response.queued"constant

The type of the event. Always ‘response.queued’.

class ResponseReasoningItem:

A description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your input to the Responses API for subsequent turns of a conversation if you are manually managing context.

String id

The unique identifier of the reasoning content.

List<Summary> summary

Reasoning summary content.

String text

A summary of the reasoning output from the model so far.

JsonValue; type "summary_text"constant"summary_text"constant

The type of the object. Always summary_text.

JsonValue; type "reasoning"constant"reasoning"constant

The type of the object. Always reasoning.

Optional<List<Content>> content

Reasoning text content.

String text

The reasoning text from the model.

JsonValue; type "reasoning_text"constant"reasoning_text"constant

The type of the reasoning text. Always reasoning_text.

Optional<String> encryptedContent

The encrypted content of the reasoning item - populated when a response is generated with reasoning.encrypted_content in the include parameter.

Optional<Status> status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseReasoningSummaryPartAddedEvent:

Emitted when a new reasoning summary part is added.

String itemId

The ID of the item this summary part is associated with.

long outputIndex

The index of the output item this summary part is associated with.

Part part

The summary part that was added.

String text

The text of the summary part.

JsonValue; type "summary_text"constant"summary_text"constant

The type of the summary part. Always summary_text.

long sequenceNumber

The sequence number of this event.

long summaryIndex

The index of the summary part within the reasoning summary.

JsonValue; type "response.reasoning_summary_part.added"constant"response.reasoning_summary_part.added"constant

The type of the event. Always response.reasoning_summary_part.added.

class ResponseReasoningSummaryPartDoneEvent:

Emitted when a reasoning summary part is completed.

String itemId

The ID of the item this summary part is associated with.

long outputIndex

The index of the output item this summary part is associated with.

Part part

The completed summary part.

String text

The text of the summary part.

JsonValue; type "summary_text"constant"summary_text"constant

The type of the summary part. Always summary_text.

long sequenceNumber

The sequence number of this event.

long summaryIndex

The index of the summary part within the reasoning summary.

JsonValue; type "response.reasoning_summary_part.done"constant"response.reasoning_summary_part.done"constant

The type of the event. Always response.reasoning_summary_part.done.

class ResponseReasoningSummaryTextDeltaEvent:

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

String delta

The text delta that was added to the summary.

String itemId

The ID of the item this summary text delta is associated with.

long outputIndex

The index of the output item this summary text delta is associated with.

long sequenceNumber

The sequence number of this event.

long summaryIndex

The index of the summary part within the reasoning summary.

JsonValue; type "response.reasoning_summary_text.delta"constant"response.reasoning_summary_text.delta"constant

The type of the event. Always response.reasoning_summary_text.delta.

class ResponseReasoningSummaryTextDoneEvent:

Emitted when a reasoning summary text is completed.

String itemId

The ID of the item this summary text is associated with.

long outputIndex

The index of the output item this summary text is associated with.

long sequenceNumber

The sequence number of this event.

long summaryIndex

The index of the summary part within the reasoning summary.

String text

The full text of the completed reasoning summary.

JsonValue; type "response.reasoning_summary_text.done"constant"response.reasoning_summary_text.done"constant

The type of the event. Always response.reasoning_summary_text.done.

class ResponseReasoningTextDeltaEvent:

Emitted when a delta is added to a reasoning text.

long contentIndex

The index of the reasoning content part this delta is associated with.

String delta

The text delta that was added to the reasoning content.

String itemId

The ID of the item this reasoning text delta is associated with.

long outputIndex

The index of the output item this reasoning text delta is associated with.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.reasoning_text.delta"constant"response.reasoning_text.delta"constant

The type of the event. Always response.reasoning_text.delta.

class ResponseReasoningTextDoneEvent:

Emitted when a reasoning text is completed.

long contentIndex

The index of the reasoning content part.

String itemId

The ID of the item this reasoning text is associated with.

long outputIndex

The index of the output item this reasoning text is associated with.

long sequenceNumber

The sequence number of this event.

String text

The full text of the completed reasoning content.

JsonValue; type "response.reasoning_text.done"constant"response.reasoning_text.done"constant

The type of the event. Always response.reasoning_text.done.

class ResponseRefusalDeltaEvent:

Emitted when there is a partial refusal text.

long contentIndex

The index of the content part that the refusal text is added to.

String delta

The refusal text that is added.

String itemId

The ID of the output item that the refusal text is added to.

long outputIndex

The index of the output item that the refusal text is added to.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.refusal.delta"constant"response.refusal.delta"constant

The type of the event. Always response.refusal.delta.

class ResponseRefusalDoneEvent:

Emitted when refusal text is finalized.

long contentIndex

The index of the content part that the refusal text is finalized.

String itemId

The ID of the output item that the refusal text is finalized.

long outputIndex

The index of the output item that the refusal text is finalized.

String refusal

The refusal text that is finalized.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.refusal.done"constant"response.refusal.done"constant

The type of the event. Always response.refusal.done.

enum ResponseStatus:

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

COMPLETED("completed")

FAILED("failed")

IN_PROGRESS("in_progress")

CANCELLED("cancelled")

QUEUED("queued")

INCOMPLETE("incomplete")

class ResponseStreamEvent: A class that can be one of several variants.union

Emitted when there is a partial audio response.

class ResponseAudioDeltaEvent:

Emitted when there is a partial audio response.

String delta

A chunk of Base64 encoded response audio bytes.

long sequenceNumber

A sequence number for this chunk of the stream response.

JsonValue; type "response.audio.delta"constant"response.audio.delta"constant

The type of the event. Always response.audio.delta.

class ResponseAudioDoneEvent:

Emitted when the audio response is complete.

long sequenceNumber

The sequence number of the delta.

JsonValue; type "response.audio.done"constant"response.audio.done"constant

The type of the event. Always response.audio.done.

class ResponseAudioTranscriptDeltaEvent:

Emitted when there is a partial transcript of audio.

String delta

The partial transcript of the audio response.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.audio.transcript.delta"constant"response.audio.transcript.delta"constant

The type of the event. Always response.audio.transcript.delta.

class ResponseAudioTranscriptDoneEvent:

Emitted when the full audio transcript is completed.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.audio.transcript.done"constant"response.audio.transcript.done"constant

The type of the event. Always response.audio.transcript.done.

class ResponseCodeInterpreterCallCodeDeltaEvent:

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

String delta

The partial code snippet being streamed by the code interpreter.

String itemId

The unique identifier of the code interpreter tool call item.

long outputIndex

The index of the output item in the response for which the code is being streamed.

long sequenceNumber

The sequence number of this event, used to order streaming events.

JsonValue; type "response.code_interpreter_call_code.delta"constant"response.code_interpreter_call_code.delta"constant

The type of the event. Always response.code_interpreter_call_code.delta.

class ResponseCodeInterpreterCallCodeDoneEvent:

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

String code

The final code snippet output by the code interpreter.

String itemId

The unique identifier of the code interpreter tool call item.

long outputIndex

The index of the output item in the response for which the code is finalized.

long sequenceNumber

The sequence number of this event, used to order streaming events.

JsonValue; type "response.code_interpreter_call_code.done"constant"response.code_interpreter_call_code.done"constant

The type of the event. Always response.code_interpreter_call_code.done.

class ResponseCodeInterpreterCallCompletedEvent:

Emitted when the code interpreter call is completed.

String itemId

The unique identifier of the code interpreter tool call item.

long outputIndex

The index of the output item in the response for which the code interpreter call is completed.

long sequenceNumber

The sequence number of this event, used to order streaming events.

JsonValue; type "response.code_interpreter_call.completed"constant"response.code_interpreter_call.completed"constant

The type of the event. Always response.code_interpreter_call.completed.

class ResponseCodeInterpreterCallInProgressEvent:

Emitted when a code interpreter call is in progress.

String itemId

The unique identifier of the code interpreter tool call item.

long outputIndex

The index of the output item in the response for which the code interpreter call is in progress.

long sequenceNumber

The sequence number of this event, used to order streaming events.

JsonValue; type "response.code_interpreter_call.in_progress"constant"response.code_interpreter_call.in_progress"constant

The type of the event. Always response.code_interpreter_call.in_progress.

class ResponseCodeInterpreterCallInterpretingEvent:

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

String itemId

The unique identifier of the code interpreter tool call item.

long outputIndex

The index of the output item in the response for which the code interpreter is interpreting code.

long sequenceNumber

The sequence number of this event, used to order streaming events.

JsonValue; type "response.code_interpreter_call.interpreting"constant"response.code_interpreter_call.interpreting"constant

The type of the event. Always response.code_interpreter_call.interpreting.

class ResponseCompletedEvent:

Emitted when the model response is complete.

Response response

Properties of the completed response.

long sequenceNumber

The sequence number for this event.

JsonValue; type "response.completed"constant"response.completed"constant

The type of the event. Always response.completed.

class ResponseContentPartAddedEvent:

Emitted when a new content part is added.

long contentIndex

The index of the content part that was added.

String itemId

The ID of the output item that the content part was added to.

long outputIndex

The index of the output item that the content part was added to.

Part part

The content part that was added.

One of the following:

class ResponseOutputText:

A text output from the model.

List<Annotation> annotations

The annotations of the text output.

One of the following:

class FileCitation:

A citation to a file.

String fileId

The ID of the file.

String filename

The filename of the file cited.

long index

The index of the file in the list of files.

JsonValue; type "file_citation"constant"file_citation"constant

The type of the file citation. Always file_citation.

class UrlCitation:

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

long endIndex

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

long startIndex

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

String title

The title of the web resource.

JsonValue; type "url_citation"constant"url_citation"constant

The type of the URL citation. Always url_citation.

String url

The URL of the web resource.

class ContainerFileCitation:

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

String containerId

The ID of the container file.

long endIndex

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

String fileId

The ID of the file.

String filename

The filename of the container file cited.

long startIndex

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

JsonValue; type "container_file_citation"constant"container_file_citation"constant

The type of the container file citation. Always container_file_citation.

class FilePath:

A path to a file.

String fileId

The ID of the file.

long index

The index of the file in the list of files.

JsonValue; type "file_path"constant"file_path"constant

The type of the file path. Always file_path.

String text

The text output from the model.

JsonValue; type "output_text"constant"output_text"constant

The type of the output text. Always output_text.

Optional<List<Logprob>> logprobs

String token

List<long> bytes

double logprob

List<TopLogprob> topLogprobs

String token

List<long> bytes

double logprob

class ResponseOutputRefusal:

A refusal from the model.

String refusal

The refusal explanation from the model.

JsonValue; type "refusal"constant"refusal"constant

The type of the refusal. Always refusal.

class ReasoningText:

Reasoning text from the model.

String text

The reasoning text from the model.

JsonValue; type "reasoning_text"constant"reasoning_text"constant

The type of the reasoning text. Always reasoning_text.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.content_part.added"constant"response.content_part.added"constant

The type of the event. Always response.content_part.added.

class ResponseContentPartDoneEvent:

Emitted when a content part is done.

long contentIndex

The index of the content part that is done.

String itemId

The ID of the output item that the content part was added to.

long outputIndex

The index of the output item that the content part was added to.

Part part

The content part that is done.

One of the following:

class ResponseOutputText:

A text output from the model.

List<Annotation> annotations

The annotations of the text output.

One of the following:

class FileCitation:

A citation to a file.

String fileId

The ID of the file.

String filename

The filename of the file cited.

long index

The index of the file in the list of files.

JsonValue; type "file_citation"constant"file_citation"constant

The type of the file citation. Always file_citation.

class UrlCitation:

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

long endIndex

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

long startIndex

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

String title

The title of the web resource.

JsonValue; type "url_citation"constant"url_citation"constant

The type of the URL citation. Always url_citation.

String url

The URL of the web resource.

class ContainerFileCitation:

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

String containerId

The ID of the container file.

long endIndex

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

String fileId

The ID of the file.

String filename

The filename of the container file cited.

long startIndex

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

JsonValue; type "container_file_citation"constant"container_file_citation"constant

The type of the container file citation. Always container_file_citation.

class FilePath:

A path to a file.

String fileId

The ID of the file.

long index

The index of the file in the list of files.

JsonValue; type "file_path"constant"file_path"constant

The type of the file path. Always file_path.

String text

The text output from the model.

JsonValue; type "output_text"constant"output_text"constant

The type of the output text. Always output_text.

Optional<List<Logprob>> logprobs

String token

List<long> bytes

double logprob

List<TopLogprob> topLogprobs

String token

List<long> bytes

double logprob

class ResponseOutputRefusal:

A refusal from the model.

String refusal

The refusal explanation from the model.

JsonValue; type "refusal"constant"refusal"constant

The type of the refusal. Always refusal.

class ReasoningText:

Reasoning text from the model.

String text

The reasoning text from the model.

JsonValue; type "reasoning_text"constant"reasoning_text"constant

The type of the reasoning text. Always reasoning_text.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.content_part.done"constant"response.content_part.done"constant

The type of the event. Always response.content_part.done.

class ResponseCreatedEvent:

An event that is emitted when a response is created.

Response response

The response that was created.

long sequenceNumber

The sequence number for this event.

JsonValue; type "response.created"constant"response.created"constant

The type of the event. Always response.created.

class ResponseErrorEvent:

Emitted when an error occurs.

Optional<String> code

The error code.

String message

The error message.

Optional<String> param

The error parameter.

long sequenceNumber

The sequence number of this event.

JsonValue; type "error"constant"error"constant

The type of the event. Always error.

class ResponseFileSearchCallCompletedEvent:

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

String itemId

The ID of the output item that the file search call is initiated.

long outputIndex

The index of the output item that the file search call is initiated.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.file_search_call.completed"constant"response.file_search_call.completed"constant

The type of the event. Always response.file_search_call.completed.

class ResponseFileSearchCallInProgressEvent:

Emitted when a file search call is initiated.

String itemId

The ID of the output item that the file search call is initiated.

long outputIndex

The index of the output item that the file search call is initiated.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.file_search_call.in_progress"constant"response.file_search_call.in_progress"constant

The type of the event. Always response.file_search_call.in_progress.

class ResponseFileSearchCallSearchingEvent:

Emitted when a file search is currently searching.

String itemId

The ID of the output item that the file search call is initiated.

long outputIndex

The index of the output item that the file search call is searching.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.file_search_call.searching"constant"response.file_search_call.searching"constant

The type of the event. Always response.file_search_call.searching.

class ResponseFunctionCallArgumentsDeltaEvent:

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

String delta

The function-call arguments delta that is added.

String itemId

The ID of the output item that the function-call arguments delta is added to.

long outputIndex

The index of the output item that the function-call arguments delta is added to.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.function_call_arguments.delta"constant"response.function_call_arguments.delta"constant

The type of the event. Always response.function_call_arguments.delta.

class ResponseFunctionCallArgumentsDoneEvent:

Emitted when function-call arguments are finalized.

String arguments

The function-call arguments.

String itemId

The ID of the item.

String name

The name of the function that was called.

long outputIndex

The index of the output item.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.function_call_arguments.done"constant"response.function_call_arguments.done"constant

class ResponseInProgressEvent:

Emitted when the response is in progress.

Response response

The response that is in progress.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.in_progress"constant"response.in_progress"constant

The type of the event. Always response.in_progress.

class ResponseFailedEvent:

An event that is emitted when a response fails.

Response response

The response that failed.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.failed"constant"response.failed"constant

The type of the event. Always response.failed.

class ResponseIncompleteEvent:

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

Response response

The response that was incomplete.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.incomplete"constant"response.incomplete"constant

The type of the event. Always response.incomplete.

class ResponseOutputItemAddedEvent:

Emitted when a new output item is added.

ResponseOutputItem item

The output item that was added.

long outputIndex

The index of the output item that was added.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.output_item.added"constant"response.output_item.added"constant

The type of the event. Always response.output_item.added.

class ResponseOutputItemDoneEvent:

Emitted when an output item is marked done.

ResponseOutputItem item

The output item that was marked done.

long outputIndex

The index of the output item that was marked done.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.output_item.done"constant"response.output_item.done"constant

The type of the event. Always response.output_item.done.

class ResponseReasoningSummaryPartAddedEvent:

Emitted when a new reasoning summary part is added.

String itemId

The ID of the item this summary part is associated with.

long outputIndex

The index of the output item this summary part is associated with.

Part part

The summary part that was added.

String text

The text of the summary part.

JsonValue; type "summary_text"constant"summary_text"constant

The type of the summary part. Always summary_text.

long sequenceNumber

The sequence number of this event.

long summaryIndex

The index of the summary part within the reasoning summary.

JsonValue; type "response.reasoning_summary_part.added"constant"response.reasoning_summary_part.added"constant

The type of the event. Always response.reasoning_summary_part.added.

class ResponseReasoningSummaryPartDoneEvent:

Emitted when a reasoning summary part is completed.

String itemId

The ID of the item this summary part is associated with.

long outputIndex

The index of the output item this summary part is associated with.

Part part

The completed summary part.

String text

The text of the summary part.

JsonValue; type "summary_text"constant"summary_text"constant

The type of the summary part. Always summary_text.

long sequenceNumber

The sequence number of this event.

long summaryIndex

The index of the summary part within the reasoning summary.

JsonValue; type "response.reasoning_summary_part.done"constant"response.reasoning_summary_part.done"constant

The type of the event. Always response.reasoning_summary_part.done.

class ResponseReasoningSummaryTextDeltaEvent:

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

String delta

The text delta that was added to the summary.

String itemId

The ID of the item this summary text delta is associated with.

long outputIndex

The index of the output item this summary text delta is associated with.

long sequenceNumber

The sequence number of this event.

long summaryIndex

The index of the summary part within the reasoning summary.

JsonValue; type "response.reasoning_summary_text.delta"constant"response.reasoning_summary_text.delta"constant

The type of the event. Always response.reasoning_summary_text.delta.

class ResponseReasoningSummaryTextDoneEvent:

Emitted when a reasoning summary text is completed.

String itemId

The ID of the item this summary text is associated with.

long outputIndex

The index of the output item this summary text is associated with.

long sequenceNumber

The sequence number of this event.

long summaryIndex

The index of the summary part within the reasoning summary.

String text

The full text of the completed reasoning summary.

JsonValue; type "response.reasoning_summary_text.done"constant"response.reasoning_summary_text.done"constant

The type of the event. Always response.reasoning_summary_text.done.

class ResponseReasoningTextDeltaEvent:

Emitted when a delta is added to a reasoning text.

long contentIndex

The index of the reasoning content part this delta is associated with.

String delta

The text delta that was added to the reasoning content.

String itemId

The ID of the item this reasoning text delta is associated with.

long outputIndex

The index of the output item this reasoning text delta is associated with.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.reasoning_text.delta"constant"response.reasoning_text.delta"constant

The type of the event. Always response.reasoning_text.delta.

class ResponseReasoningTextDoneEvent:

Emitted when a reasoning text is completed.

long contentIndex

The index of the reasoning content part.

String itemId

The ID of the item this reasoning text is associated with.

long outputIndex

The index of the output item this reasoning text is associated with.

long sequenceNumber

The sequence number of this event.

String text

The full text of the completed reasoning content.

JsonValue; type "response.reasoning_text.done"constant"response.reasoning_text.done"constant

The type of the event. Always response.reasoning_text.done.

class ResponseRefusalDeltaEvent:

Emitted when there is a partial refusal text.

long contentIndex

The index of the content part that the refusal text is added to.

String delta

The refusal text that is added.

String itemId

The ID of the output item that the refusal text is added to.

long outputIndex

The index of the output item that the refusal text is added to.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.refusal.delta"constant"response.refusal.delta"constant

The type of the event. Always response.refusal.delta.

class ResponseRefusalDoneEvent:

Emitted when refusal text is finalized.

long contentIndex

The index of the content part that the refusal text is finalized.

String itemId

The ID of the output item that the refusal text is finalized.

long outputIndex

The index of the output item that the refusal text is finalized.

String refusal

The refusal text that is finalized.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.refusal.done"constant"response.refusal.done"constant

The type of the event. Always response.refusal.done.

class ResponseTextDeltaEvent:

Emitted when there is an additional text delta.

long contentIndex

The index of the content part that the text delta was added to.

String delta

The text delta that was added.

String itemId

The ID of the output item that the text delta was added to.

List<Logprob> logprobs

The log probabilities of the tokens in the delta.

String token

A possible text token.

double logprob

The log probability of this token.

Optional<List<TopLogprob>> topLogprobs

The log probability of the top 20 most likely tokens.

Optional<String> token

A possible text token.

Optional<Double> logprob

The log probability of this token.

long outputIndex

The index of the output item that the text delta was added to.

long sequenceNumber

The sequence number for this event.

JsonValue; type "response.output_text.delta"constant"response.output_text.delta"constant

The type of the event. Always response.output_text.delta.

class ResponseTextDoneEvent:

Emitted when text content is finalized.

long contentIndex

The index of the content part that the text content is finalized.

String itemId

The ID of the output item that the text content is finalized.

List<Logprob> logprobs

The log probabilities of the tokens in the delta.

String token

A possible text token.

double logprob

The log probability of this token.

Optional<List<TopLogprob>> topLogprobs

The log probability of the top 20 most likely tokens.

Optional<String> token

A possible text token.

Optional<Double> logprob

The log probability of this token.

long outputIndex

The index of the output item that the text content is finalized.

long sequenceNumber

The sequence number for this event.

String text

The text content that is finalized.

JsonValue; type "response.output_text.done"constant"response.output_text.done"constant

The type of the event. Always response.output_text.done.

class ResponseWebSearchCallCompletedEvent:

Emitted when a web search call is completed.

String itemId

Unique ID for the output item associated with the web search call.

long outputIndex

The index of the output item that the web search call is associated with.

long sequenceNumber

The sequence number of the web search call being processed.

JsonValue; type "response.web_search_call.completed"constant"response.web_search_call.completed"constant

The type of the event. Always response.web_search_call.completed.

class ResponseWebSearchCallInProgressEvent:

Emitted when a web search call is initiated.

String itemId

Unique ID for the output item associated with the web search call.

long outputIndex

The index of the output item that the web search call is associated with.

long sequenceNumber

The sequence number of the web search call being processed.

JsonValue; type "response.web_search_call.in_progress"constant"response.web_search_call.in_progress"constant

The type of the event. Always response.web_search_call.in_progress.

class ResponseWebSearchCallSearchingEvent:

Emitted when a web search call is executing.

String itemId

Unique ID for the output item associated with the web search call.

long outputIndex

The index of the output item that the web search call is associated with.

long sequenceNumber

The sequence number of the web search call being processed.

JsonValue; type "response.web_search_call.searching"constant"response.web_search_call.searching"constant

The type of the event. Always response.web_search_call.searching.

class ResponseImageGenCallCompletedEvent:

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

String itemId

The unique identifier of the image generation item being processed.

long outputIndex

The index of the output item in the response’s output array.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.image_generation_call.completed"constant"response.image_generation_call.completed"constant

The type of the event. Always ‘response.image_generation_call.completed’.

class ResponseImageGenCallGeneratingEvent:

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

String itemId

The unique identifier of the image generation item being processed.

long outputIndex

The index of the output item in the response’s output array.

long sequenceNumber

The sequence number of the image generation item being processed.

JsonValue; type "response.image_generation_call.generating"constant"response.image_generation_call.generating"constant

The type of the event. Always ‘response.image_generation_call.generating’.

class ResponseImageGenCallInProgressEvent:

Emitted when an image generation tool call is in progress.

String itemId

The unique identifier of the image generation item being processed.

long outputIndex

The index of the output item in the response’s output array.

long sequenceNumber

The sequence number of the image generation item being processed.

JsonValue; type "response.image_generation_call.in_progress"constant"response.image_generation_call.in_progress"constant

The type of the event. Always ‘response.image_generation_call.in_progress’.

class ResponseImageGenCallPartialImageEvent:

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

String itemId

The unique identifier of the image generation item being processed.

long outputIndex

The index of the output item in the response’s output array.

String partialImageB64

Base64-encoded partial image data, suitable for rendering as an image.

long partialImageIndex

0-based index for the partial image (backend is 1-based, but this is 0-based for the user).

long sequenceNumber

The sequence number of the image generation item being processed.

JsonValue; type "response.image_generation_call.partial_image"constant"response.image_generation_call.partial_image"constant

The type of the event. Always ‘response.image_generation_call.partial_image’.

class ResponseMcpCallArgumentsDeltaEvent:

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

String delta

A JSON string containing the partial update to the arguments for the MCP tool call.

String itemId

The unique identifier of the MCP tool call item being processed.

long outputIndex

The index of the output item in the response’s output array.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.mcp_call_arguments.delta"constant"response.mcp_call_arguments.delta"constant

The type of the event. Always ‘response.mcp_call_arguments.delta’.

class ResponseMcpCallArgumentsDoneEvent:

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

String arguments

A JSON string containing the finalized arguments for the MCP tool call.

String itemId

The unique identifier of the MCP tool call item being processed.

long outputIndex

The index of the output item in the response’s output array.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.mcp_call_arguments.done"constant"response.mcp_call_arguments.done"constant

The type of the event. Always ‘response.mcp_call_arguments.done’.

class ResponseMcpCallCompletedEvent:

Emitted when an MCP tool call has completed successfully.

String itemId

The ID of the MCP tool call item that completed.

long outputIndex

The index of the output item that completed.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.mcp_call.completed"constant"response.mcp_call.completed"constant

The type of the event. Always ‘response.mcp_call.completed’.

class ResponseMcpCallFailedEvent:

Emitted when an MCP tool call has failed.

String itemId

The ID of the MCP tool call item that failed.

long outputIndex

The index of the output item that failed.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.mcp_call.failed"constant"response.mcp_call.failed"constant

The type of the event. Always ‘response.mcp_call.failed’.

class ResponseMcpCallInProgressEvent:

Emitted when an MCP tool call is in progress.

String itemId

The unique identifier of the MCP tool call item being processed.

long outputIndex

The index of the output item in the response’s output array.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.mcp_call.in_progress"constant"response.mcp_call.in_progress"constant

The type of the event. Always ‘response.mcp_call.in_progress’.

class ResponseMcpListToolsCompletedEvent:

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

String itemId

The ID of the MCP tool call item that produced this output.

long outputIndex

The index of the output item that was processed.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.mcp_list_tools.completed"constant"response.mcp_list_tools.completed"constant

The type of the event. Always ‘response.mcp_list_tools.completed’.

class ResponseMcpListToolsFailedEvent:

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

String itemId

The ID of the MCP tool call item that failed.

long outputIndex

The index of the output item that failed.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.mcp_list_tools.failed"constant"response.mcp_list_tools.failed"constant

The type of the event. Always ‘response.mcp_list_tools.failed’.

class ResponseMcpListToolsInProgressEvent:

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

String itemId

The ID of the MCP tool call item that is being processed.

long outputIndex

The index of the output item that is being processed.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.mcp_list_tools.in_progress"constant"response.mcp_list_tools.in_progress"constant

The type of the event. Always ‘response.mcp_list_tools.in_progress’.

class ResponseOutputTextAnnotationAddedEvent:

Emitted when an annotation is added to output text content.

JsonValue annotation

The annotation object being added. (See annotation schema for details.)

long annotationIndex

The index of the annotation within the content part.

long contentIndex

The index of the content part within the output item.

String itemId

The unique identifier of the item to which the annotation is being added.

long outputIndex

The index of the output item in the response’s output array.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.output_text.annotation.added"constant"response.output_text.annotation.added"constant

The type of the event. Always ‘response.output_text.annotation.added’.

class ResponseQueuedEvent:

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

Response response

The full response object that is queued.

long sequenceNumber

The sequence number for this event.

JsonValue; type "response.queued"constant"response.queued"constant

The type of the event. Always ‘response.queued’.

class ResponseCustomToolCallInputDeltaEvent:

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

String delta

The incremental input data (delta) for the custom tool call.

String itemId

Unique identifier for the API item associated with this event.

long outputIndex

The index of the output this delta applies to.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.custom_tool_call_input.delta"constant"response.custom_tool_call_input.delta"constant

The event type identifier.

class ResponseCustomToolCallInputDoneEvent:

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

String input

The complete input data for the custom tool call.

String itemId

Unique identifier for the API item associated with this event.

long outputIndex

The index of the output this event applies to.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.custom_tool_call_input.done"constant"response.custom_tool_call_input.done"constant

The event type identifier.

class ResponseTextConfig:

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

• Text inputs and outputs
• Structured Outputs

Optional<ResponseFormatTextConfig> format

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.

Optional<Verbosity> verbosity

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.

One of the following:

LOW("low")

MEDIUM("medium")

HIGH("high")

class ResponseTextDeltaEvent:

Emitted when there is an additional text delta.

long contentIndex

The index of the content part that the text delta was added to.

String delta

The text delta that was added.

String itemId

The ID of the output item that the text delta was added to.

List<Logprob> logprobs

The log probabilities of the tokens in the delta.

String token

A possible text token.

double logprob

The log probability of this token.

Optional<List<TopLogprob>> topLogprobs

The log probability of the top 20 most likely tokens.

Optional<String> token

A possible text token.

Optional<Double> logprob

The log probability of this token.

long outputIndex

The index of the output item that the text delta was added to.

long sequenceNumber

The sequence number for this event.

JsonValue; type "response.output_text.delta"constant"response.output_text.delta"constant

The type of the event. Always response.output_text.delta.

class ResponseTextDoneEvent:

Emitted when text content is finalized.

long contentIndex

The index of the content part that the text content is finalized.

String itemId

The ID of the output item that the text content is finalized.

List<Logprob> logprobs

The log probabilities of the tokens in the delta.

String token

A possible text token.

double logprob

The log probability of this token.

Optional<List<TopLogprob>> topLogprobs

The log probability of the top 20 most likely tokens.

Optional<String> token

A possible text token.

Optional<Double> logprob

The log probability of this token.

long outputIndex

The index of the output item that the text content is finalized.

long sequenceNumber

The sequence number for this event.

String text

The text content that is finalized.

JsonValue; type "response.output_text.done"constant"response.output_text.done"constant

The type of the event. Always response.output_text.done.

class ResponseToolSearchCall:

String id

The unique ID of the tool search call item.

JsonValue arguments

Arguments used for the tool search call.

Optional<String> callId

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

Execution execution

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

One of the following:

SERVER("server")

CLIENT("client")

Status status

The status of the tool search call item that was recorded.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "tool_search_call"constant"tool_search_call"constant

The type of the item. Always tool_search_call.

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseToolSearchOutputItem:

String id

The unique ID of the tool search output item.

Optional<String> callId

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

Execution execution

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

One of the following:

SERVER("server")

CLIENT("client")

Status status

The status of the tool search output item that was recorded.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

List<Tool> tools

The loaded tool definitions returned by tool search.

One of the following:

class FunctionTool:

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

String name

The name of the function to call.

Optional<Parameters> parameters

A JSON schema object describing the parameters of the function.

Optional<Boolean> strict

Whether to enforce strict parameter validation. Default true.

JsonValue; type "function"constant"function"constant

The type of the function tool. Always function.

Optional<Boolean> deferLoading

Whether this function is deferred and loaded via tool search.

Optional<String> description

A description of the function. Used by the model to determine whether or not to call the function.

class FileSearchTool:

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

JsonValue; type "file_search"constant"file_search"constant

The type of the file search tool. Always file_search.

List<String> vectorStoreIds

The IDs of the vector stores to search.

Optional<Filters> filters

A filter to apply.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

class CompoundFilter:

Combine multiple filters using and or or.

List<Filter> filters

Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

JsonValue

Type type

Type of operation: and or or.

One of the following:

AND("and")

OR("or")

Optional<Long> maxNumResults

The maximum number of results to return. This number should be between 1 and 50 inclusive.

Optional<RankingOptions> rankingOptions

Ranking options for search.

Optional<HybridSearch> hybridSearch

Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled.

double embeddingWeight

The weight of the embedding in the reciprocal ranking fusion.

double textWeight

The weight of the text in the reciprocal ranking fusion.

Optional<Ranker> ranker

The ranker to use for the file search.

One of the following:

AUTO("auto")

DEFAULT_2024_11_15("default-2024-11-15")

Optional<Double> scoreThreshold

The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.

class ComputerTool:

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

JsonValue; type "computer"constant"computer"constant

The type of the computer tool. Always computer.

class ComputerUsePreviewTool:

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

long displayHeight

The height of the computer display.

long displayWidth

The width of the computer display.

Environment environment

The type of computer environment to control.

One of the following:

WINDOWS("windows")

MAC("mac")

LINUX("linux")

UBUNTU("ubuntu")

BROWSER("browser")

JsonValue; type "computer_use_preview"constant"computer_use_preview"constant

The type of the computer use tool. Always computer_use_preview.

class WebSearchTool:

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

Type type

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")

WEB_SEARCH_2025_08_26("web_search_2025_08_26")

Optional<Filters> filters

Filters for the search.

Optional<List<String>> allowedDomains

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

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The approximate location of the user.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

Optional<Type> type

The type of location approximation. Always approximate.

Mcp

String serverLabel

A label for this MCP server, used to identify it in tool calls.

JsonValue; type "mcp"constant"mcp"constant

The type of the MCP tool. Always mcp.

Optional<AllowedTools> allowedTools

List of allowed tool names or a filter object.

One of the following:

List<String>

class McpToolFilter:

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<String> authorization

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.

Optional<ConnectorId> connectorId

Identifier for service connectors, like those available in ChatGPT. One of server_url or connector_id must be provided. Learn more about service connectors here.

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_dropbox")

CONNECTOR_GMAIL("connector_gmail")

CONNECTOR_GOOGLECALENDAR("connector_googlecalendar")

CONNECTOR_GOOGLEDRIVE("connector_googledrive")

CONNECTOR_MICROSOFTTEAMS("connector_microsoftteams")

CONNECTOR_OUTLOOKCALENDAR("connector_outlookcalendar")

CONNECTOR_OUTLOOKEMAIL("connector_outlookemail")

CONNECTOR_SHAREPOINT("connector_sharepoint")

Optional<Boolean> deferLoading

Whether this MCP tool is deferred and discovered via tool search.

Optional<Headers> headers

Optional HTTP headers to send to the MCP server. Use for authentication or other purposes.

Optional<RequireApproval> requireApproval

Specify which of the MCP server’s tools require approval.

One of the following:

class McpToolApprovalFilter:

Specify which of the MCP server’s tools require approval. Can be always, never, or a filter object associated with tools that require approval.

Optional<Always> always

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<Never> never

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

enum McpToolApprovalSetting:

Specify a single approval policy for all tools. One of always or never. When set to always, all tools will require approval. When set to never, all tools will not require approval.

ALWAYS("always")

NEVER("never")

Optional<String> serverDescription

Optional description of the MCP server, used to provide more context.

Optional<String> serverUrl

The URL for the MCP server. One of server_url or connector_id must be provided.

CodeInterpreter

Container container

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

class CodeInterpreterToolAuto:

Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.

JsonValue; type "auto"constant"auto"constant

Always auto.

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the code interpreter container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

JsonValue; type "code_interpreter"constant"code_interpreter"constant

The type of the code interpreter tool. Always code_interpreter.

ImageGeneration

JsonValue; type "image_generation"constant"image_generation"constant

The type of the image generation tool. Always image_generation.

Optional<Action> action

Whether to generate a new image or edit an existing image. Default: auto.

One of the following:

GENERATE("generate")

EDIT("edit")

AUTO("auto")

Optional<Background> background

Background type for the generated image. One of transparent, opaque, or auto. Default: auto.

One of the following:

TRANSPARENT("transparent")

OPAQUE("opaque")

AUTO("auto")

Optional<InputFidelity> inputFidelity

Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1 and gpt-image-1.5 and later models, unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.

One of the following:

HIGH("high")

LOW("low")

Optional<InputImageMask> inputImageMask

Optional mask for inpainting. Contains image_url (string, optional) and file_id (string, optional).

Optional<String> fileId

File ID for the mask image.

Optional<String> imageUrl

Base64-encoded mask image.

Optional<Model> model

The image generation model to use. Default: gpt-image-1.

One of the following:

GPT_IMAGE_1("gpt-image-1")

GPT_IMAGE_1_MINI("gpt-image-1-mini")

GPT_IMAGE_1_5("gpt-image-1.5")

Optional<Moderation> moderation

Moderation level for the generated image. Default: auto.

One of the following:

AUTO("auto")

LOW("low")

Optional<Long> outputCompression

Compression level for the output image. Default: 100.

minimum0

maximum100

Optional<OutputFormat> outputFormat

The output format of the generated image. One of png, webp, or jpeg. Default: png.

One of the following:

PNG("png")

WEBP("webp")

JPEG("jpeg")

Optional<Long> partialImages

Number of partial images to generate in streaming mode, from 0 (default value) to 3.

minimum0

maximum3

Optional<Quality> quality

The quality of the generated image. One of low, medium, high, or auto. Default: auto.

One of the following:

LOW("low")

MEDIUM("medium")

HIGH("high")

AUTO("auto")

Optional<Size> size

The size of the generated image. One of 1024x1024, 1024x1536, 1536x1024, or auto. Default: auto.

One of the following:

_1024X1024("1024x1024")

_1024X1536("1024x1536")

_1536X1024("1536x1024")

AUTO("auto")

JsonValue;

JsonValue; type "local_shell"constant"local_shell"constant

The type of the local shell tool. Always local_shell.

class FunctionShellTool:

A tool that allows the model to execute shell commands.

JsonValue; type "shell"constant"shell"constant

The type of the shell tool. Always shell.

Optional<Environment> environment

One of the following:

class ContainerAuto:

JsonValue; type "container_auto"constant"container_auto"constant

Automatically creates a container for this request

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

Optional<List<Skill>> skills

An optional list of skills referenced by id or inline data.

One of the following:

class SkillReference:

String skillId

The ID of the referenced skill.

maxLength64

minLength1

JsonValue; type "skill_reference"constant"skill_reference"constant

References a skill created with the /v1/skills endpoint.

Optional<String> version

Optional skill version. Use a positive integer or ‘latest’. Omit for default.

class InlineSkill:

String description

The description of the skill.

String name

The name of the skill.

InlineSkillSource source

Inline skill payload

JsonValue; type "inline"constant"inline"constant

Defines an inline skill for this request.

class LocalEnvironment:

JsonValue; type "local"constant"local"constant

Use a local computer environment.

Optional<List<LocalSkill>> skills

An optional list of skills.

String description

The description of the skill.

String name

The name of the skill.

String path

The path to the directory containing the skill.

class ContainerReference:

String containerId

The ID of the referenced container.

JsonValue; type "container_reference"constant"container_reference"constant

References a container created with the /v1/containers endpoint

class CustomTool:

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

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

class NamespaceTool:

Groups function/custom tools under a shared namespace.

String description

A description of the namespace shown to the model.

minLength1

String name

The namespace name used in tool calls (for example, crm).

minLength1

List<Tool> tools

The function/custom tools available inside this namespace.

One of the following:

class Function:

String name

maxLength128

minLength1

JsonValue; type "function"constant"function"constant

Optional<Boolean> deferLoading

Whether this function should be deferred and discovered via tool search.

Optional<String> description

Optional<JsonValue> parameters

Optional<Boolean> strict

class CustomTool:

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

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

JsonValue; type "namespace"constant"namespace"constant

The type of the tool. Always namespace.

class ToolSearchTool:

Hosted or BYOT tool search configuration for deferred tools.

JsonValue; type "tool_search"constant"tool_search"constant

The type of the tool. Always tool_search.

Optional<String> description

Description shown to the model for a client-executed tool search tool.

Optional<Execution> execution

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

One of the following:

SERVER("server")

CLIENT("client")

Optional<JsonValue> parameters

Parameter schema for a client-executed tool search tool.

class WebSearchPreviewTool:

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

Type type

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")

WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")

Optional<List<SearchContentType>> searchContentTypes

One of the following:

TEXT("text")

IMAGE("image")

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The user’s location.

JsonValue; type "approximate"constant"approximate"constant

The type of location approximation. Always approximate.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

class ApplyPatchTool:

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

JsonValue; type "apply_patch"constant"apply_patch"constant

The type of the tool. Always apply_patch.

JsonValue; type "tool_search_output"constant"tool_search_output"constant

The type of the item. Always tool_search_output.

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseToolSearchOutputItemParam:

List<Tool> tools

The loaded tool definitions returned by the tool search output.

One of the following:

class FunctionTool:

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

String name

The name of the function to call.

Optional<Parameters> parameters

A JSON schema object describing the parameters of the function.

Optional<Boolean> strict

Whether to enforce strict parameter validation. Default true.

JsonValue; type "function"constant"function"constant

The type of the function tool. Always function.

Optional<Boolean> deferLoading

Whether this function is deferred and loaded via tool search.

Optional<String> description

A description of the function. Used by the model to determine whether or not to call the function.

class FileSearchTool:

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

JsonValue; type "file_search"constant"file_search"constant

The type of the file search tool. Always file_search.

List<String> vectorStoreIds

The IDs of the vector stores to search.

Optional<Filters> filters

A filter to apply.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

class CompoundFilter:

Combine multiple filters using and or or.

List<Filter> filters

Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

JsonValue

Type type

Type of operation: and or or.

One of the following:

AND("and")

OR("or")

Optional<Long> maxNumResults

The maximum number of results to return. This number should be between 1 and 50 inclusive.

Optional<RankingOptions> rankingOptions

Ranking options for search.

Optional<HybridSearch> hybridSearch

Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled.

double embeddingWeight

The weight of the embedding in the reciprocal ranking fusion.

double textWeight

The weight of the text in the reciprocal ranking fusion.

Optional<Ranker> ranker

The ranker to use for the file search.

One of the following:

AUTO("auto")

DEFAULT_2024_11_15("default-2024-11-15")

Optional<Double> scoreThreshold

The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.

class ComputerTool:

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

JsonValue; type "computer"constant"computer"constant

The type of the computer tool. Always computer.

class ComputerUsePreviewTool:

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

long displayHeight

The height of the computer display.

long displayWidth

The width of the computer display.

Environment environment

The type of computer environment to control.

One of the following:

WINDOWS("windows")

MAC("mac")

LINUX("linux")

UBUNTU("ubuntu")

BROWSER("browser")

JsonValue; type "computer_use_preview"constant"computer_use_preview"constant

The type of the computer use tool. Always computer_use_preview.

class WebSearchTool:

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

Type type

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")

WEB_SEARCH_2025_08_26("web_search_2025_08_26")

Optional<Filters> filters

Filters for the search.

Optional<List<String>> allowedDomains

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

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The approximate location of the user.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

Optional<Type> type

The type of location approximation. Always approximate.

Mcp

String serverLabel

A label for this MCP server, used to identify it in tool calls.

JsonValue; type "mcp"constant"mcp"constant

The type of the MCP tool. Always mcp.

Optional<AllowedTools> allowedTools

List of allowed tool names or a filter object.

One of the following:

List<String>

class McpToolFilter:

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<String> authorization

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.

Optional<ConnectorId> connectorId

Identifier for service connectors, like those available in ChatGPT. One of server_url or connector_id must be provided. Learn more about service connectors here.

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_dropbox")

CONNECTOR_GMAIL("connector_gmail")

CONNECTOR_GOOGLECALENDAR("connector_googlecalendar")

CONNECTOR_GOOGLEDRIVE("connector_googledrive")

CONNECTOR_MICROSOFTTEAMS("connector_microsoftteams")

CONNECTOR_OUTLOOKCALENDAR("connector_outlookcalendar")

CONNECTOR_OUTLOOKEMAIL("connector_outlookemail")

CONNECTOR_SHAREPOINT("connector_sharepoint")

Optional<Boolean> deferLoading

Whether this MCP tool is deferred and discovered via tool search.

Optional<Headers> headers

Optional HTTP headers to send to the MCP server. Use for authentication or other purposes.

Optional<RequireApproval> requireApproval

Specify which of the MCP server’s tools require approval.

One of the following:

class McpToolApprovalFilter:

Specify which of the MCP server’s tools require approval. Can be always, never, or a filter object associated with tools that require approval.

Optional<Always> always

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<Never> never

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

enum McpToolApprovalSetting:

Specify a single approval policy for all tools. One of always or never. When set to always, all tools will require approval. When set to never, all tools will not require approval.

ALWAYS("always")

NEVER("never")

Optional<String> serverDescription

Optional description of the MCP server, used to provide more context.

Optional<String> serverUrl

The URL for the MCP server. One of server_url or connector_id must be provided.

CodeInterpreter

Container container

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

class CodeInterpreterToolAuto:

Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.

JsonValue; type "auto"constant"auto"constant

Always auto.

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the code interpreter container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

JsonValue; type "code_interpreter"constant"code_interpreter"constant

The type of the code interpreter tool. Always code_interpreter.

ImageGeneration

JsonValue; type "image_generation"constant"image_generation"constant

The type of the image generation tool. Always image_generation.

Optional<Action> action

Whether to generate a new image or edit an existing image. Default: auto.

One of the following:

GENERATE("generate")

EDIT("edit")

AUTO("auto")

Optional<Background> background

Background type for the generated image. One of transparent, opaque, or auto. Default: auto.

One of the following:

TRANSPARENT("transparent")

OPAQUE("opaque")

AUTO("auto")

Optional<InputFidelity> inputFidelity

Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1 and gpt-image-1.5 and later models, unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.

One of the following:

HIGH("high")

LOW("low")

Optional<InputImageMask> inputImageMask

Optional mask for inpainting. Contains image_url (string, optional) and file_id (string, optional).

Optional<String> fileId

File ID for the mask image.

Optional<String> imageUrl

Base64-encoded mask image.

Optional<Model> model

The image generation model to use. Default: gpt-image-1.

One of the following:

GPT_IMAGE_1("gpt-image-1")

GPT_IMAGE_1_MINI("gpt-image-1-mini")

GPT_IMAGE_1_5("gpt-image-1.5")

Optional<Moderation> moderation

Moderation level for the generated image. Default: auto.

One of the following:

AUTO("auto")

LOW("low")

Optional<Long> outputCompression

Compression level for the output image. Default: 100.

minimum0

maximum100

Optional<OutputFormat> outputFormat

The output format of the generated image. One of png, webp, or jpeg. Default: png.

One of the following:

PNG("png")

WEBP("webp")

JPEG("jpeg")

Optional<Long> partialImages

Number of partial images to generate in streaming mode, from 0 (default value) to 3.

minimum0

maximum3

Optional<Quality> quality

The quality of the generated image. One of low, medium, high, or auto. Default: auto.

One of the following:

LOW("low")

MEDIUM("medium")

HIGH("high")

AUTO("auto")

Optional<Size> size

The size of the generated image. One of 1024x1024, 1024x1536, 1536x1024, or auto. Default: auto.

One of the following:

_1024X1024("1024x1024")

_1024X1536("1024x1536")

_1536X1024("1536x1024")

AUTO("auto")

JsonValue;

JsonValue; type "local_shell"constant"local_shell"constant

The type of the local shell tool. Always local_shell.

class FunctionShellTool:

A tool that allows the model to execute shell commands.

JsonValue; type "shell"constant"shell"constant

The type of the shell tool. Always shell.

Optional<Environment> environment

One of the following:

class ContainerAuto:

JsonValue; type "container_auto"constant"container_auto"constant

Automatically creates a container for this request

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

Optional<List<Skill>> skills

An optional list of skills referenced by id or inline data.

One of the following:

class SkillReference:

String skillId

The ID of the referenced skill.

maxLength64

minLength1

JsonValue; type "skill_reference"constant"skill_reference"constant

References a skill created with the /v1/skills endpoint.

Optional<String> version

Optional skill version. Use a positive integer or ‘latest’. Omit for default.

class InlineSkill:

String description

The description of the skill.

String name

The name of the skill.

InlineSkillSource source

Inline skill payload

JsonValue; type "inline"constant"inline"constant

Defines an inline skill for this request.

class LocalEnvironment:

JsonValue; type "local"constant"local"constant

Use a local computer environment.

Optional<List<LocalSkill>> skills

An optional list of skills.

String description

The description of the skill.

String name

The name of the skill.

String path

The path to the directory containing the skill.

class ContainerReference:

String containerId

The ID of the referenced container.

JsonValue; type "container_reference"constant"container_reference"constant

References a container created with the /v1/containers endpoint

class CustomTool:

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

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

class NamespaceTool:

Groups function/custom tools under a shared namespace.

String description

A description of the namespace shown to the model.

minLength1

String name

The namespace name used in tool calls (for example, crm).

minLength1

List<Tool> tools

The function/custom tools available inside this namespace.

One of the following:

class Function:

String name

maxLength128

minLength1

JsonValue; type "function"constant"function"constant

Optional<Boolean> deferLoading

Whether this function should be deferred and discovered via tool search.

Optional<String> description

Optional<JsonValue> parameters

Optional<Boolean> strict

class CustomTool:

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

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

JsonValue; type "namespace"constant"namespace"constant

The type of the tool. Always namespace.

class ToolSearchTool:

Hosted or BYOT tool search configuration for deferred tools.

JsonValue; type "tool_search"constant"tool_search"constant

The type of the tool. Always tool_search.

Optional<String> description

Description shown to the model for a client-executed tool search tool.

Optional<Execution> execution

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

One of the following:

SERVER("server")

CLIENT("client")

Optional<JsonValue> parameters

Parameter schema for a client-executed tool search tool.

class WebSearchPreviewTool:

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

Type type

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")

WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")

Optional<List<SearchContentType>> searchContentTypes

One of the following:

TEXT("text")

IMAGE("image")

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The user’s location.

JsonValue; type "approximate"constant"approximate"constant

The type of location approximation. Always approximate.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

class ApplyPatchTool:

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

JsonValue; type "apply_patch"constant"apply_patch"constant

The type of the tool. Always apply_patch.

JsonValue; type "tool_search_output"constant"tool_search_output"constant

The item type. Always tool_search_output.

Optional<String> id

The unique ID of this tool search output.

Optional<String> callId

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

maxLength64

minLength1

Optional<Execution> execution

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

One of the following:

SERVER("server")

CLIENT("client")

Optional<Status> status

The status of the tool search output.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseUsage:

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

long inputTokens

The number of input tokens.

InputTokensDetails inputTokensDetails

A detailed breakdown of the input tokens.

long cachedTokens

The number of tokens that were retrieved from the cache. More on prompt caching.

long outputTokens

The number of output tokens.

OutputTokensDetails outputTokensDetails

A detailed breakdown of the output tokens.

long reasoningTokens

The number of reasoning tokens.

long totalTokens

The total number of tokens used.

class ResponseWebSearchCallCompletedEvent:

Emitted when a web search call is completed.

String itemId

Unique ID for the output item associated with the web search call.

long outputIndex

The index of the output item that the web search call is associated with.

long sequenceNumber

The sequence number of the web search call being processed.

JsonValue; type "response.web_search_call.completed"constant"response.web_search_call.completed"constant

The type of the event. Always response.web_search_call.completed.

class ResponseWebSearchCallInProgressEvent:

Emitted when a web search call is initiated.

String itemId

Unique ID for the output item associated with the web search call.

long outputIndex

The index of the output item that the web search call is associated with.

long sequenceNumber

The sequence number of the web search call being processed.

JsonValue; type "response.web_search_call.in_progress"constant"response.web_search_call.in_progress"constant

The type of the event. Always response.web_search_call.in_progress.

class ResponseWebSearchCallSearchingEvent:

Emitted when a web search call is executing.

String itemId

Unique ID for the output item associated with the web search call.

long outputIndex

The index of the output item that the web search call is associated with.

long sequenceNumber

The sequence number of the web search call being processed.

JsonValue; type "response.web_search_call.searching"constant"response.web_search_call.searching"constant

The type of the event. Always response.web_search_call.searching.

class ResponsesClientEvent:

JsonValue; type "response.create"constant"response.create"constant

The type of the client event. Always response.create.

Optional<Boolean> background

Whether to run the model response in the background. Learn more.

Optional<List<ContextManagement>> contextManagement

Context management configuration for this request.

String type

The context management entry type. Currently only ‘compaction’ is supported.

Optional<Long> compactThreshold

Token threshold at which compaction should be triggered for this entry.

minimum1000

Optional<Conversation> conversation

The conversation that this response belongs to. Items from this conversation are prepended to input_items for this response request. Input items and output items from this response are automatically added to this conversation after this response completes.

One of the following:

String

class ResponseConversationParam:

The conversation that this response belongs to.

String id

The unique ID of the conversation.

Optional<List<ResponseIncludable>> include

Specify additional output data to include in the model response. Currently supported values are:

• web_search_call.action.sources: Include the sources of the web search tool call.
• code_interpreter_call.outputs: Includes the outputs of python code execution in code interpreter tool call items.
• computer_call_output.output.image_url: Include image urls from the computer call output.
• file_search_call.results: Include the search results of the file search tool call.
• message.input_image.image_url: Include image urls from the input message.
• message.output_text.logprobs: Include logprobs with assistant messages.
• reasoning.encrypted_content: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the store parameter is set to false, or when an organization is enrolled in the zero data retention program).

One of the following:

FILE_SEARCH_CALL_RESULTS("file_search_call.results")

WEB_SEARCH_CALL_RESULTS("web_search_call.results")

WEB_SEARCH_CALL_ACTION_SOURCES("web_search_call.action.sources")

MESSAGE_INPUT_IMAGE_IMAGE_URL("message.input_image.image_url")

COMPUTER_CALL_OUTPUT_OUTPUT_IMAGE_URL("computer_call_output.output.image_url")

CODE_INTERPRETER_CALL_OUTPUTS("code_interpreter_call.outputs")

REASONING_ENCRYPTED_CONTENT("reasoning.encrypted_content")

MESSAGE_OUTPUT_TEXT_LOGPROBS("message.output_text.logprobs")

Optional<Input> input

Text, image, or file inputs to the model, used to generate a response.

Learn more:

• Text inputs and outputs
• Image inputs
• File inputs
• Conversation state
• Function calling

One of the following:

String

List<ResponseInputItem>

One of the following:

class EasyInputMessage:

A message input to the model with a role indicating instruction following hierarchy. Instructions given with the developer or system role take precedence over instructions given with the user role. Messages with the assistant role are presumed to have been generated by the model in previous interactions.

Content content

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

One of the following:

String

List<ResponseInputContent>

One of the following:

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputImage:

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

Detail detail

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("low")

HIGH("high")

AUTO("auto")

ORIGINAL("original")

JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<String> fileId

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

Optional<String> imageUrl

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

class ResponseInputFile:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

Optional<Detail> detail

The detail level of the file to be sent to the model. Use low for the default rendering behavior, or high to render the file at higher quality. Defaults to low.

One of the following:

LOW("low")

HIGH("high")

Optional<String> fileData

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

Optional<String> fileId

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

Optional<String> fileUrl

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

Optional<String> filename

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

Role role

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

One of the following:

USER("user")

ASSISTANT("assistant")

SYSTEM("system")

DEVELOPER("developer")

Optional<Phase> phase

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("commentary")

FINAL_ANSWER("final_answer")

Optional<Type> type

The type of the message input. Always message.

Message

List<ResponseInputContent> content

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

Role role

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

One of the following:

USER("user")

SYSTEM("system")

DEVELOPER("developer")

Optional<Status> status

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

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

Optional<Type> type

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

class ResponseOutputMessage:

An output message from the model.

String id

The unique ID of the output message.

List<Content> content

The content of the output message.

One of the following:

class ResponseOutputText:

A text output from the model.

List<Annotation> annotations

The annotations of the text output.

One of the following:

class FileCitation:

A citation to a file.

String fileId

The ID of the file.

String filename

The filename of the file cited.

long index

The index of the file in the list of files.

JsonValue; type "file_citation"constant"file_citation"constant

The type of the file citation. Always file_citation.

class UrlCitation:

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

long endIndex

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

long startIndex

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

String title

The title of the web resource.

JsonValue; type "url_citation"constant"url_citation"constant

The type of the URL citation. Always url_citation.

String url

The URL of the web resource.

class ContainerFileCitation:

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

String containerId

The ID of the container file.

long endIndex

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

String fileId

The ID of the file.

String filename

The filename of the container file cited.

long startIndex

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

JsonValue; type "container_file_citation"constant"container_file_citation"constant

The type of the container file citation. Always container_file_citation.

class FilePath:

A path to a file.

String fileId

The ID of the file.

long index

The index of the file in the list of files.

JsonValue; type "file_path"constant"file_path"constant

The type of the file path. Always file_path.

String text

The text output from the model.

JsonValue; type "output_text"constant"output_text"constant

The type of the output text. Always output_text.

Optional<List<Logprob>> logprobs

String token

List<long> bytes

double logprob

List<TopLogprob> topLogprobs

String token

List<long> bytes

double logprob

class ResponseOutputRefusal:

A refusal from the model.

String refusal

The refusal explanation from the model.

JsonValue; type "refusal"constant"refusal"constant

The type of the refusal. Always refusal.

JsonValue; role "assistant"constant"assistant"constant

The role of the output message. Always assistant.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "message"constant"message"constant

The type of the output message. Always message.

Optional<Phase> phase

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("commentary")

FINAL_ANSWER("final_answer")

class ResponseFileSearchToolCall:

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

String id

The unique ID of the file search tool call.

List<String> queries

The queries used to search for files.

Status status

The status of the file search tool call. One of in_progress, searching, incomplete or failed,

One of the following:

IN_PROGRESS("in_progress")

SEARCHING("searching")

COMPLETED("completed")

INCOMPLETE("incomplete")

FAILED("failed")

JsonValue; type "file_search_call"constant"file_search_call"constant

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

Optional<List<Result>> results

The results of the file search tool call.

Optional<Attributes> attributes

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

double

boolean

Optional<String> fileId

The unique ID of the file.

Optional<String> filename

The name of the file.

Optional<Double> score

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

formatfloat

Optional<String> text

The text that was retrieved from the file.

class ResponseComputerToolCall:

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

String id

The unique ID of the computer call.

String callId

An identifier used when responding to the tool call with output.

List<PendingSafetyCheck> pendingSafetyChecks

The pending safety checks for the computer call.

String id

The ID of the pending safety check.

Optional<String> code

The type of the pending safety check.

Optional<String> message

Details about the pending safety check.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

Type type

The type of the computer call. Always computer_call.

Optional<Action> action

A click action.

One of the following:

class Click:

A click action.

Button button

Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.

One of the following:

LEFT("left")

RIGHT("right")

WHEEL("wheel")

BACK("back")

FORWARD("forward")

JsonValue; type "click"constant"click"constant

Specifies the event type. For a click action, this property is always click.

long x

The x-coordinate where the click occurred.

long y

The y-coordinate where the click occurred.

Optional<List<String>> keys

The keys being held while clicking.

class DoubleClick:

A double click action.

Optional<List<String>> keys

The keys being held while double-clicking.

JsonValue; type "double_click"constant"double_click"constant

Specifies the event type. For a double click action, this property is always set to double_click.

long x

The x-coordinate where the double click occurred.

long y

The y-coordinate where the double click occurred.

class Drag:

A drag action.

List<Path> path

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

long x

The x-coordinate.

long y

The y-coordinate.

JsonValue; type "drag"constant"drag"constant

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

Optional<List<String>> keys

The keys being held while dragging the mouse.

class Keypress:

A collection of keypresses the model would like to perform.

List<String> keys

The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key.

JsonValue; type "keypress"constant"keypress"constant

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

class Move:

A mouse move action.

JsonValue; type "move"constant"move"constant

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

long x

The x-coordinate to move to.

long y

The y-coordinate to move to.

Optional<List<String>> keys

The keys being held while moving the mouse.

JsonValue;

JsonValue; type "screenshot"constant"screenshot"constant

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

class Scroll:

A scroll action.

long scrollX

The horizontal scroll distance.

long scrollY

The vertical scroll distance.

JsonValue; type "scroll"constant"scroll"constant

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

long x

The x-coordinate where the scroll occurred.

long y

The y-coordinate where the scroll occurred.

Optional<List<String>> keys

The keys being held while scrolling.

class Type:

An action to type in text.

String text

The text to type.

JsonValue; type "type"constant"type"constant

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

JsonValue;

JsonValue; type "wait"constant"wait"constant

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

Optional<List<ComputerAction>> actions

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

ComputerCallOutput

String callId

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

maxLength64

minLength1

ResponseComputerToolCallOutputScreenshot output

A computer screenshot image used with the computer use tool.

JsonValue; type "computer_call_output"constant"computer_call_output"constant

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

Optional<String> id

The ID of the computer tool call output.

Optional<List<AcknowledgedSafetyCheck>> acknowledgedSafetyChecks

The safety checks reported by the API that have been acknowledged by the developer.

String id

The ID of the pending safety check.

Optional<String> code

The type of the pending safety check.

Optional<String> message

Details about the pending safety check.

Optional<Status> status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseFunctionWebSearch:

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

String id

The unique ID of the web search tool call.

Action action

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:

class Search:

Action type “search” - Performs a web search query.

String query

[DEPRECATED] The search query.

JsonValue; type "search"constant"search"constant

The action type.

Optional<List<String>> queries

The search queries.

Optional<List<Source>> sources

The sources used in the search.

JsonValue; type "url"constant"url"constant

The type of source. Always url.

String url

The URL of the source.

class OpenPage:

Action type “open_page” - Opens a specific URL from search results.

JsonValue; type "open_page"constant"open_page"constant

The action type.

Optional<String> url

The URL opened by the model.

formaturi

class FindInPage:

Action type “find_in_page”: Searches for a pattern within a loaded page.

String pattern

The pattern or text to search for within the page.

JsonValue; type "find_in_page"constant"find_in_page"constant

The action type.

String url

The URL of the page searched for the pattern.

formaturi

Status status

The status of the web search tool call.

One of the following:

IN_PROGRESS("in_progress")

SEARCHING("searching")

COMPLETED("completed")

FAILED("failed")

JsonValue; type "web_search_call"constant"web_search_call"constant

The type of the web search tool call. Always web_search_call.

class ResponseFunctionToolCall:

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

String arguments

A JSON string of the arguments to pass to the function.

String callId

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

String name

The name of the function to run.

JsonValue; type "function_call"constant"function_call"constant

The type of the function tool call. Always function_call.

Optional<String> id

The unique ID of the function tool call.

Optional<String> namespace

The namespace of the function to run.

Optional<Status> status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

FunctionCallOutput

String callId

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

maxLength64

minLength1

Output output

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

One of the following:

String

List<ResponseFunctionCallOutputItem>

One of the following:

class ResponseInputTextContent:

A text input to the model.

String text

The text input to the model.

maxLength10485760

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputImageContent:

An image input to the model. Learn about image inputs

JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<Detail> detail

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("low")

HIGH("high")

AUTO("auto")

ORIGINAL("original")

Optional<String> fileId

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

Optional<String> imageUrl

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

maxLength20971520

class ResponseInputFileContent:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

Optional<Detail> detail

The detail level of the file to be sent to the model. Use low for the default rendering behavior, or high to render the file at higher quality. Defaults to low.

One of the following:

LOW("low")

HIGH("high")

Optional<String> fileData

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

maxLength73400320

Optional<String> fileId

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

Optional<String> fileUrl

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

Optional<String> filename

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

JsonValue; type "function_call_output"constant"function_call_output"constant

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

Optional<String> id

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

Optional<Status> status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

ToolSearchCall

JsonValue arguments

The arguments supplied to the tool search call.

JsonValue; type "tool_search_call"constant"tool_search_call"constant

The item type. Always tool_search_call.

Optional<String> id

The unique ID of this tool search call.

Optional<String> callId

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

maxLength64

minLength1

Optional<Execution> execution

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

One of the following:

SERVER("server")

CLIENT("client")

Optional<Status> status

The status of the tool search call.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseToolSearchOutputItemParam:

List<Tool> tools

The loaded tool definitions returned by the tool search output.

One of the following:

class FunctionTool:

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

String name

The name of the function to call.

Optional<Parameters> parameters

A JSON schema object describing the parameters of the function.

Optional<Boolean> strict

Whether to enforce strict parameter validation. Default true.

JsonValue; type "function"constant"function"constant

The type of the function tool. Always function.

Optional<Boolean> deferLoading

Whether this function is deferred and loaded via tool search.

Optional<String> description

A description of the function. Used by the model to determine whether or not to call the function.

class FileSearchTool:

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

JsonValue; type "file_search"constant"file_search"constant

The type of the file search tool. Always file_search.

List<String> vectorStoreIds

The IDs of the vector stores to search.

Optional<Filters> filters

A filter to apply.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

class CompoundFilter:

Combine multiple filters using and or or.

List<Filter> filters

Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

JsonValue

Type type

Type of operation: and or or.

One of the following:

AND("and")

OR("or")

Optional<Long> maxNumResults

The maximum number of results to return. This number should be between 1 and 50 inclusive.

Optional<RankingOptions> rankingOptions

Ranking options for search.

Optional<HybridSearch> hybridSearch

Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled.

double embeddingWeight

The weight of the embedding in the reciprocal ranking fusion.

double textWeight

The weight of the text in the reciprocal ranking fusion.

Optional<Ranker> ranker

The ranker to use for the file search.

One of the following:

AUTO("auto")

DEFAULT_2024_11_15("default-2024-11-15")

Optional<Double> scoreThreshold

The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.

class ComputerTool:

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

JsonValue; type "computer"constant"computer"constant

The type of the computer tool. Always computer.

class ComputerUsePreviewTool:

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

long displayHeight

The height of the computer display.

long displayWidth

The width of the computer display.

Environment environment

The type of computer environment to control.

One of the following:

WINDOWS("windows")

MAC("mac")

LINUX("linux")

UBUNTU("ubuntu")

BROWSER("browser")

JsonValue; type "computer_use_preview"constant"computer_use_preview"constant

The type of the computer use tool. Always computer_use_preview.

class WebSearchTool:

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

Type type

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")

WEB_SEARCH_2025_08_26("web_search_2025_08_26")

Optional<Filters> filters

Filters for the search.

Optional<List<String>> allowedDomains

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

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The approximate location of the user.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

Optional<Type> type

The type of location approximation. Always approximate.

Mcp

String serverLabel

A label for this MCP server, used to identify it in tool calls.

JsonValue; type "mcp"constant"mcp"constant

The type of the MCP tool. Always mcp.

Optional<AllowedTools> allowedTools

List of allowed tool names or a filter object.

One of the following:

List<String>

class McpToolFilter:

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<String> authorization

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.

Optional<ConnectorId> connectorId

Identifier for service connectors, like those available in ChatGPT. One of server_url or connector_id must be provided. Learn more about service connectors here.

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_dropbox")

CONNECTOR_GMAIL("connector_gmail")

CONNECTOR_GOOGLECALENDAR("connector_googlecalendar")

CONNECTOR_GOOGLEDRIVE("connector_googledrive")

CONNECTOR_MICROSOFTTEAMS("connector_microsoftteams")

CONNECTOR_OUTLOOKCALENDAR("connector_outlookcalendar")

CONNECTOR_OUTLOOKEMAIL("connector_outlookemail")

CONNECTOR_SHAREPOINT("connector_sharepoint")

Optional<Boolean> deferLoading

Whether this MCP tool is deferred and discovered via tool search.

Optional<Headers> headers

Optional HTTP headers to send to the MCP server. Use for authentication or other purposes.

Optional<RequireApproval> requireApproval

Specify which of the MCP server’s tools require approval.

One of the following:

class McpToolApprovalFilter:

Specify which of the MCP server’s tools require approval. Can be always, never, or a filter object associated with tools that require approval.

Optional<Always> always

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<Never> never

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

enum McpToolApprovalSetting:

Specify a single approval policy for all tools. One of always or never. When set to always, all tools will require approval. When set to never, all tools will not require approval.

ALWAYS("always")

NEVER("never")

Optional<String> serverDescription

Optional description of the MCP server, used to provide more context.

Optional<String> serverUrl

The URL for the MCP server. One of server_url or connector_id must be provided.

CodeInterpreter

Container container

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

class CodeInterpreterToolAuto:

Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.

JsonValue; type "auto"constant"auto"constant

Always auto.

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the code interpreter container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

JsonValue; type "code_interpreter"constant"code_interpreter"constant

The type of the code interpreter tool. Always code_interpreter.

ImageGeneration

JsonValue; type "image_generation"constant"image_generation"constant

The type of the image generation tool. Always image_generation.

Optional<Action> action

Whether to generate a new image or edit an existing image. Default: auto.

One of the following:

GENERATE("generate")

EDIT("edit")

AUTO("auto")

Optional<Background> background

Background type for the generated image. One of transparent, opaque, or auto. Default: auto.

One of the following:

TRANSPARENT("transparent")

OPAQUE("opaque")

AUTO("auto")

Optional<InputFidelity> inputFidelity

Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1 and gpt-image-1.5 and later models, unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.

One of the following:

HIGH("high")

LOW("low")

Optional<InputImageMask> inputImageMask

Optional mask for inpainting. Contains image_url (string, optional) and file_id (string, optional).

Optional<String> fileId

File ID for the mask image.

Optional<String> imageUrl

Base64-encoded mask image.

Optional<Model> model

The image generation model to use. Default: gpt-image-1.

One of the following:

GPT_IMAGE_1("gpt-image-1")

GPT_IMAGE_1_MINI("gpt-image-1-mini")

GPT_IMAGE_1_5("gpt-image-1.5")

Optional<Moderation> moderation

Moderation level for the generated image. Default: auto.

One of the following:

AUTO("auto")

LOW("low")

Optional<Long> outputCompression

Compression level for the output image. Default: 100.

minimum0

maximum100

Optional<OutputFormat> outputFormat

The output format of the generated image. One of png, webp, or jpeg. Default: png.

One of the following:

PNG("png")

WEBP("webp")

JPEG("jpeg")

Optional<Long> partialImages

Number of partial images to generate in streaming mode, from 0 (default value) to 3.

minimum0

maximum3

Optional<Quality> quality

The quality of the generated image. One of low, medium, high, or auto. Default: auto.

One of the following:

LOW("low")

MEDIUM("medium")

HIGH("high")

AUTO("auto")

Optional<Size> size

The size of the generated image. One of 1024x1024, 1024x1536, 1536x1024, or auto. Default: auto.

One of the following:

_1024X1024("1024x1024")

_1024X1536("1024x1536")

_1536X1024("1536x1024")

AUTO("auto")

JsonValue;

JsonValue; type "local_shell"constant"local_shell"constant

The type of the local shell tool. Always local_shell.

class FunctionShellTool:

A tool that allows the model to execute shell commands.

JsonValue; type "shell"constant"shell"constant

The type of the shell tool. Always shell.

Optional<Environment> environment

One of the following:

class ContainerAuto:

JsonValue; type "container_auto"constant"container_auto"constant

Automatically creates a container for this request

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

Optional<List<Skill>> skills

An optional list of skills referenced by id or inline data.

One of the following:

class SkillReference:

String skillId

The ID of the referenced skill.

maxLength64

minLength1

JsonValue; type "skill_reference"constant"skill_reference"constant

References a skill created with the /v1/skills endpoint.

Optional<String> version

Optional skill version. Use a positive integer or ‘latest’. Omit for default.

class InlineSkill:

String description

The description of the skill.

String name

The name of the skill.

InlineSkillSource source

Inline skill payload

JsonValue; type "inline"constant"inline"constant

Defines an inline skill for this request.

class LocalEnvironment:

JsonValue; type "local"constant"local"constant

Use a local computer environment.

Optional<List<LocalSkill>> skills

An optional list of skills.

String description

The description of the skill.

String name

The name of the skill.

String path

The path to the directory containing the skill.

class ContainerReference:

String containerId

The ID of the referenced container.

JsonValue; type "container_reference"constant"container_reference"constant

References a container created with the /v1/containers endpoint

class CustomTool:

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

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

class NamespaceTool:

Groups function/custom tools under a shared namespace.

String description

A description of the namespace shown to the model.

minLength1

String name

The namespace name used in tool calls (for example, crm).

minLength1

List<Tool> tools

The function/custom tools available inside this namespace.

One of the following:

class Function:

String name

maxLength128

minLength1

JsonValue; type "function"constant"function"constant

Optional<Boolean> deferLoading

Whether this function should be deferred and discovered via tool search.

Optional<String> description

Optional<JsonValue> parameters

Optional<Boolean> strict

class CustomTool:

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

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

JsonValue; type "namespace"constant"namespace"constant

The type of the tool. Always namespace.

class ToolSearchTool:

Hosted or BYOT tool search configuration for deferred tools.

JsonValue; type "tool_search"constant"tool_search"constant

The type of the tool. Always tool_search.

Optional<String> description

Description shown to the model for a client-executed tool search tool.

Optional<Execution> execution

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

One of the following:

SERVER("server")

CLIENT("client")

Optional<JsonValue> parameters

Parameter schema for a client-executed tool search tool.

class WebSearchPreviewTool:

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

Type type

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")

WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")

Optional<List<SearchContentType>> searchContentTypes

One of the following:

TEXT("text")

IMAGE("image")

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The user’s location.

JsonValue; type "approximate"constant"approximate"constant

The type of location approximation. Always approximate.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

class ApplyPatchTool:

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

JsonValue; type "apply_patch"constant"apply_patch"constant

The type of the tool. Always apply_patch.

JsonValue; type "tool_search_output"constant"tool_search_output"constant

The item type. Always tool_search_output.

Optional<String> id

The unique ID of this tool search output.

Optional<String> callId

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

maxLength64

minLength1

Optional<Execution> execution

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

One of the following:

SERVER("server")

CLIENT("client")

Optional<Status> status

The status of the tool search output.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseReasoningItem:

A description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your input to the Responses API for subsequent turns of a conversation if you are manually managing context.

String id

The unique identifier of the reasoning content.

List<Summary> summary

Reasoning summary content.

String text

A summary of the reasoning output from the model so far.

JsonValue; type "summary_text"constant"summary_text"constant

The type of the object. Always summary_text.

JsonValue; type "reasoning"constant"reasoning"constant

The type of the object. Always reasoning.

Optional<List<Content>> content

Reasoning text content.

String text

The reasoning text from the model.

JsonValue; type "reasoning_text"constant"reasoning_text"constant

The type of the reasoning text. Always reasoning_text.

Optional<String> encryptedContent

The encrypted content of the reasoning item - populated when a response is generated with reasoning.encrypted_content in the include parameter.

Optional<Status> status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseCompactionItemParam:

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

String encryptedContent

The encrypted content of the compaction summary.

maxLength10485760

JsonValue; type "compaction"constant"compaction"constant

The type of the item. Always compaction.

Optional<String> id

The ID of the compaction item.

ImageGenerationCall

String id

The unique ID of the image generation call.

Optional<String> result

The generated image encoded in base64.

Status status

The status of the image generation call.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

GENERATING("generating")

FAILED("failed")

JsonValue; type "image_generation_call"constant"image_generation_call"constant

The type of the image generation call. Always image_generation_call.

class ResponseCodeInterpreterToolCall:

A tool call to run code.

String id

The unique ID of the code interpreter tool call.

Optional<String> code

The code to run, or null if not available.

String containerId

The ID of the container used to run the code.

Optional<List<Output>> outputs

The outputs generated by the code interpreter, such as logs or images. Can be null if no outputs are available.

One of the following:

class Logs:

The logs output from the code interpreter.

String logs

The logs output from the code interpreter.

JsonValue; type "logs"constant"logs"constant

The type of the output. Always logs.

class Image:

The image output from the code interpreter.

JsonValue; type "image"constant"image"constant

The type of the output. Always image.

String url

The URL of the image output from the code interpreter.

Status status

The status of the code interpreter tool call. Valid values are in_progress, completed, incomplete, interpreting, and failed.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

INTERPRETING("interpreting")

FAILED("failed")

JsonValue; type "code_interpreter_call"constant"code_interpreter_call"constant

The type of the code interpreter tool call. Always code_interpreter_call.

LocalShellCall

String id

The unique ID of the local shell call.

Action action

Execute a shell command on the server.

List<String> command

The command to run.

Env env

Environment variables to set for the command.

JsonValue; type "exec"constant"exec"constant

The type of the local shell action. Always exec.

Optional<Long> timeoutMs

Optional timeout in milliseconds for the command.

Optional<String> user

Optional user to run the command as.

Optional<String> workingDirectory

Optional working directory to run the command in.

String callId

The unique ID of the local shell tool call generated by the model.

Status status

The status of the local shell call.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "local_shell_call"constant"local_shell_call"constant

The type of the local shell call. Always local_shell_call.

LocalShellCallOutput

String id

The unique ID of the local shell tool call generated by the model.

String output

A JSON string of the output of the local shell tool call.

JsonValue; type "local_shell_call_output"constant"local_shell_call_output"constant

The type of the local shell tool call output. Always local_shell_call_output.

Optional<Status> status

The status of the item. One of in_progress, completed, or incomplete.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

ShellCall

Action action

The shell commands and limits that describe how to run the tool call.

List<String> commands

Ordered shell commands for the execution environment to run.

Optional<Long> maxOutputLength

Maximum number of UTF-8 characters to capture from combined stdout and stderr output.

Optional<Long> timeoutMs

Maximum wall-clock time in milliseconds to allow the shell commands to run.

String callId

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

maxLength64

minLength1

JsonValue; type "shell_call"constant"shell_call"constant

The type of the item. Always shell_call.

Optional<String> id

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

Optional<Environment> environment

The environment to execute the shell commands in.

One of the following:

class LocalEnvironment:

JsonValue; type "local"constant"local"constant

Use a local computer environment.

Optional<List<LocalSkill>> skills

An optional list of skills.

String description

The description of the skill.

String name

The name of the skill.

String path

The path to the directory containing the skill.

class ContainerReference:

String containerId

The ID of the referenced container.

JsonValue; type "container_reference"constant"container_reference"constant

References a container created with the /v1/containers endpoint

Optional<Status> status

The status of the shell call. One of in_progress, completed, or incomplete.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

ShellCallOutput

String callId

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

maxLength64

minLength1

List<ResponseFunctionShellCallOutputContent> output

Captured chunks of stdout and stderr output, along with their associated outcomes.

Outcome outcome

The exit or timeout outcome associated with this shell call.

One of the following:

JsonValue;

JsonValue; type "timeout"constant"timeout"constant

The outcome type. Always timeout.

class Exit:

Indicates that the shell commands finished and returned an exit code.

long exitCode

The exit code returned by the shell process.

JsonValue; type "exit"constant"exit"constant

The outcome type. Always exit.

String stderr

Captured stderr output for the shell call.

maxLength10485760

String stdout

Captured stdout output for the shell call.

maxLength10485760

JsonValue; type "shell_call_output"constant"shell_call_output"constant

The type of the item. Always shell_call_output.

Optional<String> id

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

Optional<Long> maxOutputLength

The maximum number of UTF-8 characters captured for this shell call’s combined output.

Optional<Status> status

The status of the shell call output.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

ApplyPatchCall

String callId

The unique ID of the apply patch tool call generated by the model.

maxLength64

minLength1

Operation operation

The specific create, delete, or update instruction for the apply_patch tool call.

One of the following:

class CreateFile:

Instruction for creating a new file via the apply_patch tool.

String diff

Unified diff content to apply when creating the file.

maxLength10485760

String path

Path of the file to create relative to the workspace root.

minLength1

JsonValue; type "create_file"constant"create_file"constant

The operation type. Always create_file.

class DeleteFile:

Instruction for deleting an existing file via the apply_patch tool.

String path

Path of the file to delete relative to the workspace root.

minLength1

JsonValue; type "delete_file"constant"delete_file"constant

The operation type. Always delete_file.

class UpdateFile:

Instruction for updating an existing file via the apply_patch tool.

String diff

Unified diff content to apply to the existing file.

maxLength10485760

String path

Path of the file to update relative to the workspace root.

minLength1

JsonValue; type "update_file"constant"update_file"constant

The operation type. Always update_file.

Status status

The status of the apply patch tool call. One of in_progress or completed.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

JsonValue; type "apply_patch_call"constant"apply_patch_call"constant

The type of the item. Always apply_patch_call.

Optional<String> id

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

ApplyPatchCallOutput

String callId

The unique ID of the apply patch tool call generated by the model.

maxLength64

minLength1

Status status

The status of the apply patch tool call output. One of completed or failed.

One of the following:

COMPLETED("completed")

FAILED("failed")

JsonValue; type "apply_patch_call_output"constant"apply_patch_call_output"constant

The type of the item. Always apply_patch_call_output.

Optional<String> id

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

Optional<String> output

Optional human-readable log text from the apply patch tool (e.g., patch results or errors).

maxLength10485760

McpListTools

String id

The unique ID of the list.

String serverLabel

The label of the MCP server.

List<Tool> tools

The tools available on the server.

JsonValue inputSchema

The JSON schema describing the tool’s input.

String name

The name of the tool.

Optional<JsonValue> annotations

Additional annotations about the tool.

Optional<String> description

The description of the tool.

JsonValue; type "mcp_list_tools"constant"mcp_list_tools"constant

The type of the item. Always mcp_list_tools.

Optional<String> error

Error message if the server could not list tools.

McpApprovalRequest

String id

The unique ID of the approval request.

String arguments

A JSON string of arguments for the tool.

String name

The name of the tool to run.

String serverLabel

The label of the MCP server making the request.

JsonValue; type "mcp_approval_request"constant"mcp_approval_request"constant

The type of the item. Always mcp_approval_request.

McpApprovalResponse

String approvalRequestId

The ID of the approval request being answered.

boolean approve

Whether the request was approved.

JsonValue; type "mcp_approval_response"constant"mcp_approval_response"constant

The type of the item. Always mcp_approval_response.

Optional<String> id

The unique ID of the approval response

Optional<String> reason

Optional reason for the decision.

McpCall

String id

The unique ID of the tool call.

String arguments

A JSON string of the arguments passed to the tool.

String name

The name of the tool that was run.

String serverLabel

The label of the MCP server running the tool.

JsonValue; type "mcp_call"constant"mcp_call"constant

The type of the item. Always mcp_call.

Optional<String> approvalRequestId

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.

Optional<String> error

The error from the tool call, if any.

Optional<String> output

The output from the tool call.

Optional<Status> status

The status of the tool call. One of in_progress, completed, incomplete, calling, or failed.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

CALLING("calling")

FAILED("failed")

class ResponseCustomToolCallOutput:

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

String callId

The call ID, used to map this custom tool call output to a custom tool call.

Output output

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:

String

List<FunctionAndCustomToolCallOutput>

One of the following:

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputImage:

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

Detail detail

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("low")

HIGH("high")

AUTO("auto")

ORIGINAL("original")

JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<String> fileId

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

Optional<String> imageUrl

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

class ResponseInputFile:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

Optional<Detail> detail

The detail level of the file to be sent to the model. Use low for the default rendering behavior, or high to render the file at higher quality. Defaults to low.

One of the following:

LOW("low")

HIGH("high")

Optional<String> fileData

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

Optional<String> fileId

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

Optional<String> fileUrl

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

Optional<String> filename

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

JsonValue; type "custom_tool_call_output"constant"custom_tool_call_output"constant

The type of the custom tool call output. Always custom_tool_call_output.

Optional<String> id

The unique ID of the custom tool call output in the OpenAI platform.

class ResponseCustomToolCall:

A call to a custom tool created by the model.

String callId

An identifier used to map this custom tool call to a tool call output.

String input

The input for the custom tool call generated by the model.

String name

The name of the custom tool being called.

JsonValue; type "custom_tool_call"constant"custom_tool_call"constant

The type of the custom tool call. Always custom_tool_call.

Optional<String> id

The unique ID of the custom tool call in the OpenAI platform.

Optional<String> namespace

The namespace of the custom tool being called.

ItemReference

String id

The ID of the item to reference.

Optional<Type> type

The type of item to reference. Always item_reference.

Optional<String> instructions

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.

Optional<Long> maxOutputTokens

An upper bound for the number of tokens that can be generated for a response, including visible output tokens and reasoning tokens.

minimum16

Optional<Long> maxToolCalls

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.

Optional<Metadata> metadata

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

Optional<ResponsesModel> model

Model ID used to generate the response, like gpt-4o or o3. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.

Optional<Boolean> parallelToolCalls

Whether to allow the model to run tool calls in parallel.

Optional<String> previousResponseId

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.

Optional<ResponsePrompt> prompt

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

Optional<String> promptCacheKey

Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more.

Optional<PromptCacheRetention> promptCacheRetention

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.

One of the following:

IN_MEMORY("in_memory")

_24H("24h")

Optional<Reasoning> reasoning

gpt-5 and o-series models only

Configuration options for reasoning models.

Optional<String> safetyIdentifier

A stable identifier used to help detect users of your application that may be violating OpenAI’s usage policies. The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. Learn more.

maxLength64

Optional<ServiceTier> serviceTier

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’ or ‘priority’, then the request will be processed with the corresponding service tier.
• When not set, the default behavior is ‘auto’.

When the service_tier parameter is set, the response body will include the service_tier value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.

One of the following:

AUTO("auto")

DEFAULT("default")

FLEX("flex")

SCALE("scale")

PRIORITY("priority")

Optional<Boolean> store

Whether to store the generated model response for later retrieval via API.

Optional<Boolean> stream

If set to true, the model response data will be streamed to the client as it is generated using server-sent events. See the Streaming section below for more information.

Optional<StreamOptions> streamOptions

Options for streaming responses. Only set this when you set stream: true.

Optional<Boolean> includeObfuscation

When true, stream obfuscation will be enabled. Stream obfuscation adds random characters to an obfuscation field on streaming delta events to normalize payload sizes as a mitigation to certain side-channel attacks. These obfuscation fields are included by default, but add a small amount of overhead to the data stream. You can set include_obfuscation to false to optimize for bandwidth if you trust the network links between your application and the OpenAI API.

Optional<Double> temperature

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

Optional<ResponseTextConfig> text

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

Optional<ToolChoice> toolChoice

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:

enum ToolChoiceOptions:

Controls which (if any) tool is called by the model.

none means the model will not call any tool and instead generates a message.

auto means the model can pick between generating a message or calling one or more tools.

required means the model must call one or more tools.

NONE("none")

AUTO("auto")

REQUIRED("required")

class ToolChoiceAllowed:

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

Mode mode

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("auto")

REQUIRED("required")

List<Tool> tools

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

JsonValue; type "allowed_tools"constant"allowed_tools"constant

Allowed tool configuration type. Always allowed_tools.

class ToolChoiceTypes:

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

Type type

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("file_search")

WEB_SEARCH_PREVIEW("web_search_preview")

COMPUTER("computer")

COMPUTER_USE_PREVIEW("computer_use_preview")

COMPUTER_USE("computer_use")

WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")

IMAGE_GENERATION("image_generation")

CODE_INTERPRETER("code_interpreter")

class ToolChoiceFunction:

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

String name

The name of the function to call.

JsonValue; type "function"constant"function"constant

For function calling, the type is always function.

class ToolChoiceMcp:

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

String serverLabel

The label of the MCP server to use.

JsonValue; type "mcp"constant"mcp"constant

For MCP tools, the type is always mcp.

Optional<String> name

The name of the tool to call on the server.

class ToolChoiceCustom:

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

String name

The name of the custom tool to call.

JsonValue; type "custom"constant"custom"constant

For custom tool calling, the type is always custom.

class ToolChoiceApplyPatch:

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

JsonValue; type "apply_patch"constant"apply_patch"constant

The tool to call. Always apply_patch.

class ToolChoiceShell:

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

JsonValue; type "shell"constant"shell"constant

The tool to call. Always shell.

Optional<List<Tool>> tools

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:

class FunctionTool:

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

String name

The name of the function to call.

Optional<Parameters> parameters

A JSON schema object describing the parameters of the function.

Optional<Boolean> strict

Whether to enforce strict parameter validation. Default true.

JsonValue; type "function"constant"function"constant

The type of the function tool. Always function.

Optional<Boolean> deferLoading

Whether this function is deferred and loaded via tool search.

Optional<String> description

A description of the function. Used by the model to determine whether or not to call the function.

class FileSearchTool:

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

JsonValue; type "file_search"constant"file_search"constant

The type of the file search tool. Always file_search.

List<String> vectorStoreIds

The IDs of the vector stores to search.

Optional<Filters> filters

A filter to apply.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

class CompoundFilter:

Combine multiple filters using and or or.

List<Filter> filters

Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

JsonValue

Type type

Type of operation: and or or.

One of the following:

AND("and")

OR("or")

Optional<Long> maxNumResults

The maximum number of results to return. This number should be between 1 and 50 inclusive.

Optional<RankingOptions> rankingOptions

Ranking options for search.

Optional<HybridSearch> hybridSearch

Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled.

double embeddingWeight

The weight of the embedding in the reciprocal ranking fusion.

double textWeight

The weight of the text in the reciprocal ranking fusion.

Optional<Ranker> ranker

The ranker to use for the file search.

One of the following:

AUTO("auto")

DEFAULT_2024_11_15("default-2024-11-15")

Optional<Double> scoreThreshold

The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.

class ComputerTool:

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

JsonValue; type "computer"constant"computer"constant

The type of the computer tool. Always computer.

class ComputerUsePreviewTool:

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

long displayHeight

The height of the computer display.

long displayWidth

The width of the computer display.

Environment environment

The type of computer environment to control.

One of the following:

WINDOWS("windows")

MAC("mac")

LINUX("linux")

UBUNTU("ubuntu")

BROWSER("browser")

JsonValue; type "computer_use_preview"constant"computer_use_preview"constant

The type of the computer use tool. Always computer_use_preview.

class WebSearchTool:

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

Type type

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")

WEB_SEARCH_2025_08_26("web_search_2025_08_26")

Optional<Filters> filters

Filters for the search.

Optional<List<String>> allowedDomains

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

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The approximate location of the user.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

Optional<Type> type

The type of location approximation. Always approximate.

Mcp

String serverLabel

A label for this MCP server, used to identify it in tool calls.

JsonValue; type "mcp"constant"mcp"constant

The type of the MCP tool. Always mcp.

Optional<AllowedTools> allowedTools

List of allowed tool names or a filter object.

One of the following:

List<String>

class McpToolFilter:

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<String> authorization

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.

Optional<ConnectorId> connectorId

Identifier for service connectors, like those available in ChatGPT. One of server_url or connector_id must be provided. Learn more about service connectors here.

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_dropbox")

CONNECTOR_GMAIL("connector_gmail")

CONNECTOR_GOOGLECALENDAR("connector_googlecalendar")

CONNECTOR_GOOGLEDRIVE("connector_googledrive")

CONNECTOR_MICROSOFTTEAMS("connector_microsoftteams")

CONNECTOR_OUTLOOKCALENDAR("connector_outlookcalendar")

CONNECTOR_OUTLOOKEMAIL("connector_outlookemail")

CONNECTOR_SHAREPOINT("connector_sharepoint")

Optional<Boolean> deferLoading

Whether this MCP tool is deferred and discovered via tool search.

Optional<Headers> headers

Optional HTTP headers to send to the MCP server. Use for authentication or other purposes.

Optional<RequireApproval> requireApproval

Specify which of the MCP server’s tools require approval.

One of the following:

class McpToolApprovalFilter:

Specify which of the MCP server’s tools require approval. Can be always, never, or a filter object associated with tools that require approval.

Optional<Always> always

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<Never> never

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

enum McpToolApprovalSetting:

Specify a single approval policy for all tools. One of always or never. When set to always, all tools will require approval. When set to never, all tools will not require approval.

ALWAYS("always")

NEVER("never")

Optional<String> serverDescription

Optional description of the MCP server, used to provide more context.

Optional<String> serverUrl

The URL for the MCP server. One of server_url or connector_id must be provided.

CodeInterpreter

Container container

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

class CodeInterpreterToolAuto:

Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.

JsonValue; type "auto"constant"auto"constant

Always auto.

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the code interpreter container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

JsonValue; type "code_interpreter"constant"code_interpreter"constant

The type of the code interpreter tool. Always code_interpreter.

ImageGeneration

JsonValue; type "image_generation"constant"image_generation"constant

The type of the image generation tool. Always image_generation.

Optional<Action> action

Whether to generate a new image or edit an existing image. Default: auto.

One of the following:

GENERATE("generate")

EDIT("edit")

AUTO("auto")

Optional<Background> background

Background type for the generated image. One of transparent, opaque, or auto. Default: auto.

One of the following:

TRANSPARENT("transparent")

OPAQUE("opaque")

AUTO("auto")

Optional<InputFidelity> inputFidelity

Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1 and gpt-image-1.5 and later models, unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.

One of the following:

HIGH("high")

LOW("low")

Optional<InputImageMask> inputImageMask

Optional mask for inpainting. Contains image_url (string, optional) and file_id (string, optional).

Optional<String> fileId

File ID for the mask image.

Optional<String> imageUrl

Base64-encoded mask image.

Optional<Model> model

The image generation model to use. Default: gpt-image-1.

One of the following:

GPT_IMAGE_1("gpt-image-1")

GPT_IMAGE_1_MINI("gpt-image-1-mini")

GPT_IMAGE_1_5("gpt-image-1.5")

Optional<Moderation> moderation

Moderation level for the generated image. Default: auto.

One of the following:

AUTO("auto")

LOW("low")

Optional<Long> outputCompression

Compression level for the output image. Default: 100.

minimum0

maximum100

Optional<OutputFormat> outputFormat

The output format of the generated image. One of png, webp, or jpeg. Default: png.

One of the following:

PNG("png")

WEBP("webp")

JPEG("jpeg")

Optional<Long> partialImages

Number of partial images to generate in streaming mode, from 0 (default value) to 3.

minimum0

maximum3

Optional<Quality> quality

The quality of the generated image. One of low, medium, high, or auto. Default: auto.

One of the following:

LOW("low")

MEDIUM("medium")

HIGH("high")

AUTO("auto")

Optional<Size> size

The size of the generated image. One of 1024x1024, 1024x1536, 1536x1024, or auto. Default: auto.

One of the following:

_1024X1024("1024x1024")

_1024X1536("1024x1536")

_1536X1024("1536x1024")

AUTO("auto")

JsonValue;

JsonValue; type "local_shell"constant"local_shell"constant

The type of the local shell tool. Always local_shell.

class FunctionShellTool:

A tool that allows the model to execute shell commands.

JsonValue; type "shell"constant"shell"constant

The type of the shell tool. Always shell.

Optional<Environment> environment

One of the following:

class ContainerAuto:

JsonValue; type "container_auto"constant"container_auto"constant

Automatically creates a container for this request

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

Optional<List<Skill>> skills

An optional list of skills referenced by id or inline data.

One of the following:

class SkillReference:

String skillId

The ID of the referenced skill.

maxLength64

minLength1

JsonValue; type "skill_reference"constant"skill_reference"constant

References a skill created with the /v1/skills endpoint.

Optional<String> version

Optional skill version. Use a positive integer or ‘latest’. Omit for default.

class InlineSkill:

String description

The description of the skill.

String name

The name of the skill.

InlineSkillSource source

Inline skill payload

JsonValue; type "inline"constant"inline"constant

Defines an inline skill for this request.

class LocalEnvironment:

JsonValue; type "local"constant"local"constant

Use a local computer environment.

Optional<List<LocalSkill>> skills

An optional list of skills.

String description

The description of the skill.

String name

The name of the skill.

String path

The path to the directory containing the skill.

class ContainerReference:

String containerId

The ID of the referenced container.

JsonValue; type "container_reference"constant"container_reference"constant

References a container created with the /v1/containers endpoint

class CustomTool:

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

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

class NamespaceTool:

Groups function/custom tools under a shared namespace.

String description

A description of the namespace shown to the model.

minLength1

String name

The namespace name used in tool calls (for example, crm).

minLength1

List<Tool> tools

The function/custom tools available inside this namespace.

One of the following:

class Function:

String name

maxLength128

minLength1

JsonValue; type "function"constant"function"constant

Optional<Boolean> deferLoading

Whether this function should be deferred and discovered via tool search.

Optional<String> description

Optional<JsonValue> parameters

Optional<Boolean> strict

class CustomTool:

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

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

JsonValue; type "namespace"constant"namespace"constant

The type of the tool. Always namespace.

class ToolSearchTool:

Hosted or BYOT tool search configuration for deferred tools.

JsonValue; type "tool_search"constant"tool_search"constant

The type of the tool. Always tool_search.

Optional<String> description

Description shown to the model for a client-executed tool search tool.

Optional<Execution> execution

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

One of the following:

SERVER("server")

CLIENT("client")

Optional<JsonValue> parameters

Parameter schema for a client-executed tool search tool.

class WebSearchPreviewTool:

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

Type type

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")

WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")

Optional<List<SearchContentType>> searchContentTypes

One of the following:

TEXT("text")

IMAGE("image")

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The user’s location.

JsonValue; type "approximate"constant"approximate"constant

The type of location approximation. Always approximate.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

class ApplyPatchTool:

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

JsonValue; type "apply_patch"constant"apply_patch"constant

The type of the tool. Always apply_patch.

Optional<Long> topLogprobs

An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability.

minimum0

maximum20

Optional<Double> topP

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

Optional<Truncation> truncation

The truncation strategy to use for the model response.

• auto: If the input to this Response exceeds the model’s context window size, the model will truncate the response to fit the context window by dropping items from the beginning of the conversation.
• disabled (default): If the input size will exceed the context window size for a model, the request will fail with a 400 error.

One of the following:

AUTO("auto")

DISABLED("disabled")

DeprecatedOptional<String> user

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.

class ResponsesServerEvent: A class that can be one of several variants.union

Server events emitted by the Responses WebSocket server.

class ResponseAudioDeltaEvent:

Emitted when there is a partial audio response.

String delta

A chunk of Base64 encoded response audio bytes.

long sequenceNumber

A sequence number for this chunk of the stream response.

JsonValue; type "response.audio.delta"constant"response.audio.delta"constant

The type of the event. Always response.audio.delta.

class ResponseAudioDoneEvent:

Emitted when the audio response is complete.

long sequenceNumber

The sequence number of the delta.

JsonValue; type "response.audio.done"constant"response.audio.done"constant

The type of the event. Always response.audio.done.

class ResponseAudioTranscriptDeltaEvent:

Emitted when there is a partial transcript of audio.

String delta

The partial transcript of the audio response.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.audio.transcript.delta"constant"response.audio.transcript.delta"constant

The type of the event. Always response.audio.transcript.delta.

class ResponseAudioTranscriptDoneEvent:

Emitted when the full audio transcript is completed.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.audio.transcript.done"constant"response.audio.transcript.done"constant

The type of the event. Always response.audio.transcript.done.

class ResponseCodeInterpreterCallCodeDeltaEvent:

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

String delta

The partial code snippet being streamed by the code interpreter.

String itemId

The unique identifier of the code interpreter tool call item.

long outputIndex

The index of the output item in the response for which the code is being streamed.

long sequenceNumber

The sequence number of this event, used to order streaming events.

JsonValue; type "response.code_interpreter_call_code.delta"constant"response.code_interpreter_call_code.delta"constant

The type of the event. Always response.code_interpreter_call_code.delta.

class ResponseCodeInterpreterCallCodeDoneEvent:

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

String code

The final code snippet output by the code interpreter.

String itemId

The unique identifier of the code interpreter tool call item.

long outputIndex

The index of the output item in the response for which the code is finalized.

long sequenceNumber

The sequence number of this event, used to order streaming events.

JsonValue; type "response.code_interpreter_call_code.done"constant"response.code_interpreter_call_code.done"constant

The type of the event. Always response.code_interpreter_call_code.done.

class ResponseCodeInterpreterCallCompletedEvent:

Emitted when the code interpreter call is completed.

String itemId

The unique identifier of the code interpreter tool call item.

long outputIndex

The index of the output item in the response for which the code interpreter call is completed.

long sequenceNumber

The sequence number of this event, used to order streaming events.

JsonValue; type "response.code_interpreter_call.completed"constant"response.code_interpreter_call.completed"constant

The type of the event. Always response.code_interpreter_call.completed.

class ResponseCodeInterpreterCallInProgressEvent:

Emitted when a code interpreter call is in progress.

String itemId

The unique identifier of the code interpreter tool call item.

long outputIndex

The index of the output item in the response for which the code interpreter call is in progress.

long sequenceNumber

The sequence number of this event, used to order streaming events.

JsonValue; type "response.code_interpreter_call.in_progress"constant"response.code_interpreter_call.in_progress"constant

The type of the event. Always response.code_interpreter_call.in_progress.

class ResponseCodeInterpreterCallInterpretingEvent:

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

String itemId

The unique identifier of the code interpreter tool call item.

long outputIndex

The index of the output item in the response for which the code interpreter is interpreting code.

long sequenceNumber

The sequence number of this event, used to order streaming events.

JsonValue; type "response.code_interpreter_call.interpreting"constant"response.code_interpreter_call.interpreting"constant

The type of the event. Always response.code_interpreter_call.interpreting.

class ResponseCompletedEvent:

Emitted when the model response is complete.

Response response

Properties of the completed response.

long sequenceNumber

The sequence number for this event.

JsonValue; type "response.completed"constant"response.completed"constant

The type of the event. Always response.completed.

class ResponseContentPartAddedEvent:

Emitted when a new content part is added.

long contentIndex

The index of the content part that was added.

String itemId

The ID of the output item that the content part was added to.

long outputIndex

The index of the output item that the content part was added to.

Part part

The content part that was added.

One of the following:

class ResponseOutputText:

A text output from the model.

List<Annotation> annotations

The annotations of the text output.

One of the following:

class FileCitation:

A citation to a file.

String fileId

The ID of the file.

String filename

The filename of the file cited.

long index

The index of the file in the list of files.

JsonValue; type "file_citation"constant"file_citation"constant

The type of the file citation. Always file_citation.

class UrlCitation:

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

long endIndex

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

long startIndex

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

String title

The title of the web resource.

JsonValue; type "url_citation"constant"url_citation"constant

The type of the URL citation. Always url_citation.

String url

The URL of the web resource.

class ContainerFileCitation:

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

String containerId

The ID of the container file.

long endIndex

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

String fileId

The ID of the file.

String filename

The filename of the container file cited.

long startIndex

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

JsonValue; type "container_file_citation"constant"container_file_citation"constant

The type of the container file citation. Always container_file_citation.

class FilePath:

A path to a file.

String fileId

The ID of the file.

long index

The index of the file in the list of files.

JsonValue; type "file_path"constant"file_path"constant

The type of the file path. Always file_path.

String text

The text output from the model.

JsonValue; type "output_text"constant"output_text"constant

The type of the output text. Always output_text.

Optional<List<Logprob>> logprobs

String token

List<long> bytes

double logprob

List<TopLogprob> topLogprobs

String token

List<long> bytes

double logprob

class ResponseOutputRefusal:

A refusal from the model.

String refusal

The refusal explanation from the model.

JsonValue; type "refusal"constant"refusal"constant

The type of the refusal. Always refusal.

class ReasoningText:

Reasoning text from the model.

String text

The reasoning text from the model.

JsonValue; type "reasoning_text"constant"reasoning_text"constant

The type of the reasoning text. Always reasoning_text.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.content_part.added"constant"response.content_part.added"constant

The type of the event. Always response.content_part.added.

class ResponseContentPartDoneEvent:

Emitted when a content part is done.

long contentIndex

The index of the content part that is done.

String itemId

The ID of the output item that the content part was added to.

long outputIndex

The index of the output item that the content part was added to.

Part part

The content part that is done.

One of the following:

class ResponseOutputText:

A text output from the model.

List<Annotation> annotations

The annotations of the text output.

One of the following:

class FileCitation:

A citation to a file.

String fileId

The ID of the file.

String filename

The filename of the file cited.

long index

The index of the file in the list of files.

JsonValue; type "file_citation"constant"file_citation"constant

The type of the file citation. Always file_citation.

class UrlCitation:

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

long endIndex

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

long startIndex

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

String title

The title of the web resource.

JsonValue; type "url_citation"constant"url_citation"constant

The type of the URL citation. Always url_citation.

String url

The URL of the web resource.

class ContainerFileCitation:

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

String containerId

The ID of the container file.

long endIndex

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

String fileId

The ID of the file.

String filename

The filename of the container file cited.

long startIndex

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

JsonValue; type "container_file_citation"constant"container_file_citation"constant

The type of the container file citation. Always container_file_citation.

class FilePath:

A path to a file.

String fileId

The ID of the file.

long index

The index of the file in the list of files.

JsonValue; type "file_path"constant"file_path"constant

The type of the file path. Always file_path.

String text

The text output from the model.

JsonValue; type "output_text"constant"output_text"constant

The type of the output text. Always output_text.

Optional<List<Logprob>> logprobs

String token

List<long> bytes

double logprob

List<TopLogprob> topLogprobs

String token

List<long> bytes

double logprob

class ResponseOutputRefusal:

A refusal from the model.

String refusal

The refusal explanation from the model.

JsonValue; type "refusal"constant"refusal"constant

The type of the refusal. Always refusal.

class ReasoningText:

Reasoning text from the model.

String text

The reasoning text from the model.

JsonValue; type "reasoning_text"constant"reasoning_text"constant

The type of the reasoning text. Always reasoning_text.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.content_part.done"constant"response.content_part.done"constant

The type of the event. Always response.content_part.done.

class ResponseCreatedEvent:

An event that is emitted when a response is created.

Response response

The response that was created.

long sequenceNumber

The sequence number for this event.

JsonValue; type "response.created"constant"response.created"constant

The type of the event. Always response.created.

class ResponseErrorEvent:

Emitted when an error occurs.

Optional<String> code

The error code.

String message

The error message.

Optional<String> param

The error parameter.

long sequenceNumber

The sequence number of this event.

JsonValue; type "error"constant"error"constant

The type of the event. Always error.

class ResponseFileSearchCallCompletedEvent:

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

String itemId

The ID of the output item that the file search call is initiated.

long outputIndex

The index of the output item that the file search call is initiated.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.file_search_call.completed"constant"response.file_search_call.completed"constant

The type of the event. Always response.file_search_call.completed.

class ResponseFileSearchCallInProgressEvent:

Emitted when a file search call is initiated.

String itemId

The ID of the output item that the file search call is initiated.

long outputIndex

The index of the output item that the file search call is initiated.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.file_search_call.in_progress"constant"response.file_search_call.in_progress"constant

The type of the event. Always response.file_search_call.in_progress.

class ResponseFileSearchCallSearchingEvent:

Emitted when a file search is currently searching.

String itemId

The ID of the output item that the file search call is initiated.

long outputIndex

The index of the output item that the file search call is searching.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.file_search_call.searching"constant"response.file_search_call.searching"constant

The type of the event. Always response.file_search_call.searching.

class ResponseFunctionCallArgumentsDeltaEvent:

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

String delta

The function-call arguments delta that is added.

String itemId

The ID of the output item that the function-call arguments delta is added to.

long outputIndex

The index of the output item that the function-call arguments delta is added to.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.function_call_arguments.delta"constant"response.function_call_arguments.delta"constant

The type of the event. Always response.function_call_arguments.delta.

class ResponseFunctionCallArgumentsDoneEvent:

Emitted when function-call arguments are finalized.

String arguments

The function-call arguments.

String itemId

The ID of the item.

String name

The name of the function that was called.

long outputIndex

The index of the output item.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.function_call_arguments.done"constant"response.function_call_arguments.done"constant

class ResponseInProgressEvent:

Emitted when the response is in progress.

Response response

The response that is in progress.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.in_progress"constant"response.in_progress"constant

The type of the event. Always response.in_progress.

class ResponseFailedEvent:

An event that is emitted when a response fails.

Response response

The response that failed.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.failed"constant"response.failed"constant

The type of the event. Always response.failed.

class ResponseIncompleteEvent:

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

Response response

The response that was incomplete.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.incomplete"constant"response.incomplete"constant

The type of the event. Always response.incomplete.

class ResponseOutputItemAddedEvent:

Emitted when a new output item is added.

ResponseOutputItem item

The output item that was added.

long outputIndex

The index of the output item that was added.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.output_item.added"constant"response.output_item.added"constant

The type of the event. Always response.output_item.added.

class ResponseOutputItemDoneEvent:

Emitted when an output item is marked done.

ResponseOutputItem item

The output item that was marked done.

long outputIndex

The index of the output item that was marked done.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.output_item.done"constant"response.output_item.done"constant

The type of the event. Always response.output_item.done.

class ResponseReasoningSummaryPartAddedEvent:

Emitted when a new reasoning summary part is added.

String itemId

The ID of the item this summary part is associated with.

long outputIndex

The index of the output item this summary part is associated with.

Part part

The summary part that was added.

String text

The text of the summary part.

JsonValue; type "summary_text"constant"summary_text"constant

The type of the summary part. Always summary_text.

long sequenceNumber

The sequence number of this event.

long summaryIndex

The index of the summary part within the reasoning summary.

JsonValue; type "response.reasoning_summary_part.added"constant"response.reasoning_summary_part.added"constant

The type of the event. Always response.reasoning_summary_part.added.

class ResponseReasoningSummaryPartDoneEvent:

Emitted when a reasoning summary part is completed.

String itemId

The ID of the item this summary part is associated with.

long outputIndex

The index of the output item this summary part is associated with.

Part part

The completed summary part.

String text

The text of the summary part.

JsonValue; type "summary_text"constant"summary_text"constant

The type of the summary part. Always summary_text.

long sequenceNumber

The sequence number of this event.

long summaryIndex

The index of the summary part within the reasoning summary.

JsonValue; type "response.reasoning_summary_part.done"constant"response.reasoning_summary_part.done"constant

The type of the event. Always response.reasoning_summary_part.done.

class ResponseReasoningSummaryTextDeltaEvent:

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

String delta

The text delta that was added to the summary.

String itemId

The ID of the item this summary text delta is associated with.

long outputIndex

The index of the output item this summary text delta is associated with.

long sequenceNumber

The sequence number of this event.

long summaryIndex

The index of the summary part within the reasoning summary.

JsonValue; type "response.reasoning_summary_text.delta"constant"response.reasoning_summary_text.delta"constant

The type of the event. Always response.reasoning_summary_text.delta.

class ResponseReasoningSummaryTextDoneEvent:

Emitted when a reasoning summary text is completed.

String itemId

The ID of the item this summary text is associated with.

long outputIndex

The index of the output item this summary text is associated with.

long sequenceNumber

The sequence number of this event.

long summaryIndex

The index of the summary part within the reasoning summary.

String text

The full text of the completed reasoning summary.

JsonValue; type "response.reasoning_summary_text.done"constant"response.reasoning_summary_text.done"constant

The type of the event. Always response.reasoning_summary_text.done.

class ResponseReasoningTextDeltaEvent:

Emitted when a delta is added to a reasoning text.

long contentIndex

The index of the reasoning content part this delta is associated with.

String delta

The text delta that was added to the reasoning content.

String itemId

The ID of the item this reasoning text delta is associated with.

long outputIndex

The index of the output item this reasoning text delta is associated with.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.reasoning_text.delta"constant"response.reasoning_text.delta"constant

The type of the event. Always response.reasoning_text.delta.

class ResponseReasoningTextDoneEvent:

Emitted when a reasoning text is completed.

long contentIndex

The index of the reasoning content part.

String itemId

The ID of the item this reasoning text is associated with.

long outputIndex

The index of the output item this reasoning text is associated with.

long sequenceNumber

The sequence number of this event.

String text

The full text of the completed reasoning content.

JsonValue; type "response.reasoning_text.done"constant"response.reasoning_text.done"constant

The type of the event. Always response.reasoning_text.done.

class ResponseRefusalDeltaEvent:

Emitted when there is a partial refusal text.

long contentIndex

The index of the content part that the refusal text is added to.

String delta

The refusal text that is added.

String itemId

The ID of the output item that the refusal text is added to.

long outputIndex

The index of the output item that the refusal text is added to.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.refusal.delta"constant"response.refusal.delta"constant

The type of the event. Always response.refusal.delta.

class ResponseRefusalDoneEvent:

Emitted when refusal text is finalized.

long contentIndex

The index of the content part that the refusal text is finalized.

String itemId

The ID of the output item that the refusal text is finalized.

long outputIndex

The index of the output item that the refusal text is finalized.

String refusal

The refusal text that is finalized.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.refusal.done"constant"response.refusal.done"constant

The type of the event. Always response.refusal.done.

class ResponseTextDeltaEvent:

Emitted when there is an additional text delta.

long contentIndex

The index of the content part that the text delta was added to.

String delta

The text delta that was added.

String itemId

The ID of the output item that the text delta was added to.

List<Logprob> logprobs

The log probabilities of the tokens in the delta.

String token

A possible text token.

double logprob

The log probability of this token.

Optional<List<TopLogprob>> topLogprobs

The log probability of the top 20 most likely tokens.

Optional<String> token

A possible text token.

Optional<Double> logprob

The log probability of this token.

long outputIndex

The index of the output item that the text delta was added to.

long sequenceNumber

The sequence number for this event.

JsonValue; type "response.output_text.delta"constant"response.output_text.delta"constant

The type of the event. Always response.output_text.delta.

class ResponseTextDoneEvent:

Emitted when text content is finalized.

long contentIndex

The index of the content part that the text content is finalized.

String itemId

The ID of the output item that the text content is finalized.

List<Logprob> logprobs

The log probabilities of the tokens in the delta.

String token

A possible text token.

double logprob

The log probability of this token.

Optional<List<TopLogprob>> topLogprobs

The log probability of the top 20 most likely tokens.

Optional<String> token

A possible text token.

Optional<Double> logprob

The log probability of this token.

long outputIndex

The index of the output item that the text content is finalized.

long sequenceNumber

The sequence number for this event.

String text

The text content that is finalized.

JsonValue; type "response.output_text.done"constant"response.output_text.done"constant

The type of the event. Always response.output_text.done.

class ResponseWebSearchCallCompletedEvent:

Emitted when a web search call is completed.

String itemId

Unique ID for the output item associated with the web search call.

long outputIndex

The index of the output item that the web search call is associated with.

long sequenceNumber

The sequence number of the web search call being processed.

JsonValue; type "response.web_search_call.completed"constant"response.web_search_call.completed"constant

The type of the event. Always response.web_search_call.completed.

class ResponseWebSearchCallInProgressEvent:

Emitted when a web search call is initiated.

String itemId

Unique ID for the output item associated with the web search call.

long outputIndex

The index of the output item that the web search call is associated with.

long sequenceNumber

The sequence number of the web search call being processed.

JsonValue; type "response.web_search_call.in_progress"constant"response.web_search_call.in_progress"constant

The type of the event. Always response.web_search_call.in_progress.

class ResponseWebSearchCallSearchingEvent:

Emitted when a web search call is executing.

String itemId

Unique ID for the output item associated with the web search call.

long outputIndex

The index of the output item that the web search call is associated with.

long sequenceNumber

The sequence number of the web search call being processed.

JsonValue; type "response.web_search_call.searching"constant"response.web_search_call.searching"constant

The type of the event. Always response.web_search_call.searching.

class ResponseImageGenCallCompletedEvent:

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

String itemId

The unique identifier of the image generation item being processed.

long outputIndex

The index of the output item in the response’s output array.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.image_generation_call.completed"constant"response.image_generation_call.completed"constant

The type of the event. Always ‘response.image_generation_call.completed’.

class ResponseImageGenCallGeneratingEvent:

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

String itemId

The unique identifier of the image generation item being processed.

long outputIndex

The index of the output item in the response’s output array.

long sequenceNumber

The sequence number of the image generation item being processed.

JsonValue; type "response.image_generation_call.generating"constant"response.image_generation_call.generating"constant

The type of the event. Always ‘response.image_generation_call.generating’.

class ResponseImageGenCallInProgressEvent:

Emitted when an image generation tool call is in progress.

String itemId

The unique identifier of the image generation item being processed.

long outputIndex

The index of the output item in the response’s output array.

long sequenceNumber

The sequence number of the image generation item being processed.

JsonValue; type "response.image_generation_call.in_progress"constant"response.image_generation_call.in_progress"constant

The type of the event. Always ‘response.image_generation_call.in_progress’.

class ResponseImageGenCallPartialImageEvent:

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

String itemId

The unique identifier of the image generation item being processed.

long outputIndex

The index of the output item in the response’s output array.

String partialImageB64

Base64-encoded partial image data, suitable for rendering as an image.

long partialImageIndex

0-based index for the partial image (backend is 1-based, but this is 0-based for the user).

long sequenceNumber

The sequence number of the image generation item being processed.

JsonValue; type "response.image_generation_call.partial_image"constant"response.image_generation_call.partial_image"constant

The type of the event. Always ‘response.image_generation_call.partial_image’.

class ResponseMcpCallArgumentsDeltaEvent:

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

String delta

A JSON string containing the partial update to the arguments for the MCP tool call.

String itemId

The unique identifier of the MCP tool call item being processed.

long outputIndex

The index of the output item in the response’s output array.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.mcp_call_arguments.delta"constant"response.mcp_call_arguments.delta"constant

The type of the event. Always ‘response.mcp_call_arguments.delta’.

class ResponseMcpCallArgumentsDoneEvent:

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

String arguments

A JSON string containing the finalized arguments for the MCP tool call.

String itemId

The unique identifier of the MCP tool call item being processed.

long outputIndex

The index of the output item in the response’s output array.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.mcp_call_arguments.done"constant"response.mcp_call_arguments.done"constant

The type of the event. Always ‘response.mcp_call_arguments.done’.

class ResponseMcpCallCompletedEvent:

Emitted when an MCP tool call has completed successfully.

String itemId

The ID of the MCP tool call item that completed.

long outputIndex

The index of the output item that completed.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.mcp_call.completed"constant"response.mcp_call.completed"constant

The type of the event. Always ‘response.mcp_call.completed’.

class ResponseMcpCallFailedEvent:

Emitted when an MCP tool call has failed.

String itemId

The ID of the MCP tool call item that failed.

long outputIndex

The index of the output item that failed.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.mcp_call.failed"constant"response.mcp_call.failed"constant

The type of the event. Always ‘response.mcp_call.failed’.

class ResponseMcpCallInProgressEvent:

Emitted when an MCP tool call is in progress.

String itemId

The unique identifier of the MCP tool call item being processed.

long outputIndex

The index of the output item in the response’s output array.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.mcp_call.in_progress"constant"response.mcp_call.in_progress"constant

The type of the event. Always ‘response.mcp_call.in_progress’.

class ResponseMcpListToolsCompletedEvent:

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

String itemId

The ID of the MCP tool call item that produced this output.

long outputIndex

The index of the output item that was processed.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.mcp_list_tools.completed"constant"response.mcp_list_tools.completed"constant

The type of the event. Always ‘response.mcp_list_tools.completed’.

class ResponseMcpListToolsFailedEvent:

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

String itemId

The ID of the MCP tool call item that failed.

long outputIndex

The index of the output item that failed.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.mcp_list_tools.failed"constant"response.mcp_list_tools.failed"constant

The type of the event. Always ‘response.mcp_list_tools.failed’.

class ResponseMcpListToolsInProgressEvent:

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

String itemId

The ID of the MCP tool call item that is being processed.

long outputIndex

The index of the output item that is being processed.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.mcp_list_tools.in_progress"constant"response.mcp_list_tools.in_progress"constant

The type of the event. Always ‘response.mcp_list_tools.in_progress’.

class ResponseOutputTextAnnotationAddedEvent:

Emitted when an annotation is added to output text content.

JsonValue annotation

The annotation object being added. (See annotation schema for details.)

long annotationIndex

The index of the annotation within the content part.

long contentIndex

The index of the content part within the output item.

String itemId

The unique identifier of the item to which the annotation is being added.

long outputIndex

The index of the output item in the response’s output array.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.output_text.annotation.added"constant"response.output_text.annotation.added"constant

The type of the event. Always ‘response.output_text.annotation.added’.

class ResponseQueuedEvent:

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

Response response

The full response object that is queued.

long sequenceNumber

The sequence number for this event.

JsonValue; type "response.queued"constant"response.queued"constant

The type of the event. Always ‘response.queued’.

class ResponseCustomToolCallInputDeltaEvent:

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

String delta

The incremental input data (delta) for the custom tool call.

String itemId

Unique identifier for the API item associated with this event.

long outputIndex

The index of the output this delta applies to.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.custom_tool_call_input.delta"constant"response.custom_tool_call_input.delta"constant

The event type identifier.

class ResponseCustomToolCallInputDoneEvent:

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

String input

The complete input data for the custom tool call.

String itemId

Unique identifier for the API item associated with this event.

long outputIndex

The index of the output this event applies to.

long sequenceNumber

The sequence number of this event.

JsonValue; type "response.custom_tool_call_input.done"constant"response.custom_tool_call_input.done"constant

The event type identifier.

class SkillReference:

String skillId

The ID of the referenced skill.

maxLength64

minLength1

JsonValue; type "skill_reference"constant"skill_reference"constant

References a skill created with the /v1/skills endpoint.

Optional<String> version

Optional skill version. Use a positive integer or ‘latest’. Omit for default.

class Tool: A class that can be one of several variants.union

A tool that can be used to generate a response.

class FunctionTool:

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

String name

The name of the function to call.

Optional<Parameters> parameters

A JSON schema object describing the parameters of the function.

Optional<Boolean> strict

Whether to enforce strict parameter validation. Default true.

JsonValue; type "function"constant"function"constant

The type of the function tool. Always function.

Optional<Boolean> deferLoading

Whether this function is deferred and loaded via tool search.

Optional<String> description

A description of the function. Used by the model to determine whether or not to call the function.

class FileSearchTool:

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

JsonValue; type "file_search"constant"file_search"constant

The type of the file search tool. Always file_search.

List<String> vectorStoreIds

The IDs of the vector stores to search.

Optional<Filters> filters

A filter to apply.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

class CompoundFilter:

Combine multiple filters using and or or.

List<Filter> filters

Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

JsonValue

Type type

Type of operation: and or or.

One of the following:

AND("and")

OR("or")

Optional<Long> maxNumResults

The maximum number of results to return. This number should be between 1 and 50 inclusive.

Optional<RankingOptions> rankingOptions

Ranking options for search.

Optional<HybridSearch> hybridSearch

Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled.

double embeddingWeight

The weight of the embedding in the reciprocal ranking fusion.

double textWeight

The weight of the text in the reciprocal ranking fusion.

Optional<Ranker> ranker

The ranker to use for the file search.

One of the following:

AUTO("auto")

DEFAULT_2024_11_15("default-2024-11-15")

Optional<Double> scoreThreshold

The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.

class ComputerTool:

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

JsonValue; type "computer"constant"computer"constant

The type of the computer tool. Always computer.

class ComputerUsePreviewTool:

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

long displayHeight

The height of the computer display.

long displayWidth

The width of the computer display.

Environment environment

The type of computer environment to control.

One of the following:

WINDOWS("windows")

MAC("mac")

LINUX("linux")

UBUNTU("ubuntu")

BROWSER("browser")

JsonValue; type "computer_use_preview"constant"computer_use_preview"constant

The type of the computer use tool. Always computer_use_preview.

class WebSearchTool:

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

Type type

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")

WEB_SEARCH_2025_08_26("web_search_2025_08_26")

Optional<Filters> filters

Filters for the search.

Optional<List<String>> allowedDomains

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

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The approximate location of the user.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

Optional<Type> type

The type of location approximation. Always approximate.

Mcp

String serverLabel

A label for this MCP server, used to identify it in tool calls.

JsonValue; type "mcp"constant"mcp"constant

The type of the MCP tool. Always mcp.

Optional<AllowedTools> allowedTools

List of allowed tool names or a filter object.

One of the following:

List<String>

class McpToolFilter:

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<String> authorization

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.

Optional<ConnectorId> connectorId

Identifier for service connectors, like those available in ChatGPT. One of server_url or connector_id must be provided. Learn more about service connectors here.

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_dropbox")

CONNECTOR_GMAIL("connector_gmail")

CONNECTOR_GOOGLECALENDAR("connector_googlecalendar")

CONNECTOR_GOOGLEDRIVE("connector_googledrive")

CONNECTOR_MICROSOFTTEAMS("connector_microsoftteams")

CONNECTOR_OUTLOOKCALENDAR("connector_outlookcalendar")

CONNECTOR_OUTLOOKEMAIL("connector_outlookemail")

CONNECTOR_SHAREPOINT("connector_sharepoint")

Optional<Boolean> deferLoading

Whether this MCP tool is deferred and discovered via tool search.

Optional<Headers> headers

Optional HTTP headers to send to the MCP server. Use for authentication or other purposes.

Optional<RequireApproval> requireApproval

Specify which of the MCP server’s tools require approval.

One of the following:

class McpToolApprovalFilter:

Specify which of the MCP server’s tools require approval. Can be always, never, or a filter object associated with tools that require approval.

Optional<Always> always

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<Never> never

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

enum McpToolApprovalSetting:

Specify a single approval policy for all tools. One of always or never. When set to always, all tools will require approval. When set to never, all tools will not require approval.

ALWAYS("always")

NEVER("never")

Optional<String> serverDescription

Optional description of the MCP server, used to provide more context.

Optional<String> serverUrl

The URL for the MCP server. One of server_url or connector_id must be provided.

CodeInterpreter

Container container

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

class CodeInterpreterToolAuto:

Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.

JsonValue; type "auto"constant"auto"constant

Always auto.

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the code interpreter container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

JsonValue; type "code_interpreter"constant"code_interpreter"constant

The type of the code interpreter tool. Always code_interpreter.

ImageGeneration

JsonValue; type "image_generation"constant"image_generation"constant

The type of the image generation tool. Always image_generation.

Optional<Action> action

Whether to generate a new image or edit an existing image. Default: auto.

One of the following:

GENERATE("generate")

EDIT("edit")

AUTO("auto")

Optional<Background> background

Background type for the generated image. One of transparent, opaque, or auto. Default: auto.

One of the following:

TRANSPARENT("transparent")

OPAQUE("opaque")

AUTO("auto")

Optional<InputFidelity> inputFidelity

Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1 and gpt-image-1.5 and later models, unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.

One of the following:

HIGH("high")

LOW("low")

Optional<InputImageMask> inputImageMask

Optional mask for inpainting. Contains image_url (string, optional) and file_id (string, optional).

Optional<String> fileId

File ID for the mask image.

Optional<String> imageUrl

Base64-encoded mask image.

Optional<Model> model

The image generation model to use. Default: gpt-image-1.

One of the following:

GPT_IMAGE_1("gpt-image-1")

GPT_IMAGE_1_MINI("gpt-image-1-mini")

GPT_IMAGE_1_5("gpt-image-1.5")

Optional<Moderation> moderation

Moderation level for the generated image. Default: auto.

One of the following:

AUTO("auto")

LOW("low")

Optional<Long> outputCompression

Compression level for the output image. Default: 100.

minimum0

maximum100

Optional<OutputFormat> outputFormat

The output format of the generated image. One of png, webp, or jpeg. Default: png.

One of the following:

PNG("png")

WEBP("webp")

JPEG("jpeg")

Optional<Long> partialImages

Number of partial images to generate in streaming mode, from 0 (default value) to 3.

minimum0

maximum3

Optional<Quality> quality

The quality of the generated image. One of low, medium, high, or auto. Default: auto.

One of the following:

LOW("low")

MEDIUM("medium")

HIGH("high")

AUTO("auto")

Optional<Size> size

The size of the generated image. One of 1024x1024, 1024x1536, 1536x1024, or auto. Default: auto.

One of the following:

_1024X1024("1024x1024")

_1024X1536("1024x1536")

_1536X1024("1536x1024")

AUTO("auto")

JsonValue;

JsonValue; type "local_shell"constant"local_shell"constant

The type of the local shell tool. Always local_shell.

class FunctionShellTool:

A tool that allows the model to execute shell commands.

JsonValue; type "shell"constant"shell"constant

The type of the shell tool. Always shell.

Optional<Environment> environment

One of the following:

class ContainerAuto:

JsonValue; type "container_auto"constant"container_auto"constant

Automatically creates a container for this request

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

Optional<List<Skill>> skills

An optional list of skills referenced by id or inline data.

One of the following:

class SkillReference:

String skillId

The ID of the referenced skill.

maxLength64

minLength1

JsonValue; type "skill_reference"constant"skill_reference"constant

References a skill created with the /v1/skills endpoint.

Optional<String> version

Optional skill version. Use a positive integer or ‘latest’. Omit for default.

class InlineSkill:

String description

The description of the skill.

String name

The name of the skill.

InlineSkillSource source

Inline skill payload

JsonValue; type "inline"constant"inline"constant

Defines an inline skill for this request.

class LocalEnvironment:

JsonValue; type "local"constant"local"constant

Use a local computer environment.

Optional<List<LocalSkill>> skills

An optional list of skills.

String description

The description of the skill.

String name

The name of the skill.

String path

The path to the directory containing the skill.

class ContainerReference:

String containerId

The ID of the referenced container.

JsonValue; type "container_reference"constant"container_reference"constant

References a container created with the /v1/containers endpoint

class CustomTool:

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

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

class NamespaceTool:

Groups function/custom tools under a shared namespace.

String description

A description of the namespace shown to the model.

minLength1

String name

The namespace name used in tool calls (for example, crm).

minLength1

List<Tool> tools

The function/custom tools available inside this namespace.

One of the following:

class Function:

String name

maxLength128

minLength1

JsonValue; type "function"constant"function"constant

Optional<Boolean> deferLoading

Whether this function should be deferred and discovered via tool search.

Optional<String> description

Optional<JsonValue> parameters

Optional<Boolean> strict

class CustomTool:

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

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

JsonValue; type "namespace"constant"namespace"constant

The type of the tool. Always namespace.

class ToolSearchTool:

Hosted or BYOT tool search configuration for deferred tools.

JsonValue; type "tool_search"constant"tool_search"constant

The type of the tool. Always tool_search.

Optional<String> description

Description shown to the model for a client-executed tool search tool.

Optional<Execution> execution

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

One of the following:

SERVER("server")

CLIENT("client")

Optional<JsonValue> parameters

Parameter schema for a client-executed tool search tool.

class WebSearchPreviewTool:

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

Type type

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")

WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")

Optional<List<SearchContentType>> searchContentTypes

One of the following:

TEXT("text")

IMAGE("image")

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The user’s location.

JsonValue; type "approximate"constant"approximate"constant

The type of location approximation. Always approximate.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

class ApplyPatchTool:

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

JsonValue; type "apply_patch"constant"apply_patch"constant

The type of the tool. Always apply_patch.

class ToolChoiceAllowed:

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

Mode mode

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("auto")

REQUIRED("required")

List<Tool> tools

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

JsonValue; type "allowed_tools"constant"allowed_tools"constant

Allowed tool configuration type. Always allowed_tools.

class ToolChoiceApplyPatch:

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

JsonValue; type "apply_patch"constant"apply_patch"constant

The tool to call. Always apply_patch.

class ToolChoiceCustom:

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

String name

The name of the custom tool to call.

JsonValue; type "custom"constant"custom"constant

For custom tool calling, the type is always custom.

class ToolChoiceFunction:

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

String name

The name of the function to call.

JsonValue; type "function"constant"function"constant

For function calling, the type is always function.

class ToolChoiceMcp:

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

String serverLabel

The label of the MCP server to use.

JsonValue; type "mcp"constant"mcp"constant

For MCP tools, the type is always mcp.

Optional<String> name

The name of the tool to call on the server.

enum ToolChoiceOptions:

Controls which (if any) tool is called by the model.

none means the model will not call any tool and instead generates a message.

auto means the model can pick between generating a message or calling one or more tools.

required means the model must call one or more tools.

NONE("none")

AUTO("auto")

REQUIRED("required")

class ToolChoiceShell:

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

JsonValue; type "shell"constant"shell"constant

The tool to call. Always shell.

class ToolChoiceTypes:

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

Type type

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("file_search")

WEB_SEARCH_PREVIEW("web_search_preview")

COMPUTER("computer")

COMPUTER_USE_PREVIEW("computer_use_preview")

COMPUTER_USE("computer_use")

WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")

IMAGE_GENERATION("image_generation")

CODE_INTERPRETER("code_interpreter")

class ToolSearchTool:

Hosted or BYOT tool search configuration for deferred tools.

JsonValue; type "tool_search"constant"tool_search"constant

The type of the tool. Always tool_search.

Optional<String> description

Description shown to the model for a client-executed tool search tool.

Optional<Execution> execution

Whether tool search is executed by the server or by the client.

One of the following:

SERVER("server")

CLIENT("client")

Optional<JsonValue> parameters

Parameter schema for a client-executed tool search tool.

class WebSearchPreviewTool:

This tool searches the web for relevant results to use in a response. Learn more about the web search tool.

Type type

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")

WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")

Optional<List<SearchContentType>> searchContentTypes

One of the following:

TEXT("text")

IMAGE("image")

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The user’s location.

JsonValue; type "approximate"constant"approximate"constant

The type of location approximation. Always approximate.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

class WebSearchTool:

Search the Internet for sources related to the prompt. Learn more about the web search tool.

Type type

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")

WEB_SEARCH_2025_08_26("web_search_2025_08_26")

Optional<Filters> filters

Filters for the search.

Optional<List<String>> allowedDomains

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"]

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The approximate location of the user.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

Optional<Type> type

The type of location approximation. Always approximate.

ResponsesInput Items

List input items

InputItemListPage responses().inputItems().list(InputItemListParamsparams = InputItemListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/responses/{response_id}/input_items

ModelsExpand Collapse

class ResponseItemList:

A list of Response items.

List<ResponseItem> data

A list of items used to generate this response.

One of the following:

class ResponseInputMessageItem:

String id

The unique ID of the message input.

List<ResponseInputContent> content

A list of one or many input items to the model, containing different content types.

Role role

The role of the message input. One of user, system, or developer.

One of the following:

USER("user")

SYSTEM("system")

DEVELOPER("developer")

JsonValue; type "message"constant"message"constant

The type of the message input. Always set to message.

Optional<Status> status

The status of item. One of in_progress, completed, or incomplete. Populated when items are returned via API.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseOutputMessage:

An output message from the model.

String id

The unique ID of the output message.

List<Content> content

The content of the output message.

One of the following:

class ResponseOutputText:

A text output from the model.

List<Annotation> annotations

The annotations of the text output.

One of the following:

class FileCitation:

A citation to a file.

String fileId

The ID of the file.

String filename

The filename of the file cited.

long index

The index of the file in the list of files.

JsonValue; type "file_citation"constant"file_citation"constant

The type of the file citation. Always file_citation.

class UrlCitation:

A citation for a web resource used to generate a model response.

long endIndex

The index of the last character of the URL citation in the message.

long startIndex

The index of the first character of the URL citation in the message.

String title

The title of the web resource.

JsonValue; type "url_citation"constant"url_citation"constant

The type of the URL citation. Always url_citation.

String url

The URL of the web resource.

class ContainerFileCitation:

A citation for a container file used to generate a model response.

String containerId

The ID of the container file.

long endIndex

The index of the last character of the container file citation in the message.

String fileId

The ID of the file.

String filename

The filename of the container file cited.

long startIndex

The index of the first character of the container file citation in the message.

JsonValue; type "container_file_citation"constant"container_file_citation"constant

The type of the container file citation. Always container_file_citation.

class FilePath:

A path to a file.

String fileId

The ID of the file.

long index

The index of the file in the list of files.

JsonValue; type "file_path"constant"file_path"constant

The type of the file path. Always file_path.

String text

The text output from the model.

JsonValue; type "output_text"constant"output_text"constant

The type of the output text. Always output_text.

Optional<List<Logprob>> logprobs

String token

List<long> bytes

double logprob

List<TopLogprob> topLogprobs

String token

List<long> bytes

double logprob

class ResponseOutputRefusal:

A refusal from the model.

String refusal

The refusal explanation from the model.

JsonValue; type "refusal"constant"refusal"constant

The type of the refusal. Always refusal.

JsonValue; role "assistant"constant"assistant"constant

The role of the output message. Always assistant.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "message"constant"message"constant

The type of the output message. Always message.

Optional<Phase> phase

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("commentary")

FINAL_ANSWER("final_answer")

class ResponseFileSearchToolCall:

The results of a file search tool call. See the file search guide for more information.

String id

The unique ID of the file search tool call.

List<String> queries

The queries used to search for files.

Status status

The status of the file search tool call. One of in_progress, searching, incomplete or failed,

One of the following:

IN_PROGRESS("in_progress")

SEARCHING("searching")

COMPLETED("completed")

INCOMPLETE("incomplete")

FAILED("failed")

JsonValue; type "file_search_call"constant"file_search_call"constant

The type of the file search tool call. Always file_search_call.

Optional<List<Result>> results

The results of the file search tool call.

Optional<Attributes> attributes

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

double

boolean

Optional<String> fileId

The unique ID of the file.

Optional<String> filename

The name of the file.

Optional<Double> score

The relevance score of the file - a value between 0 and 1.

formatfloat

Optional<String> text

The text that was retrieved from the file.

class ResponseComputerToolCall:

A tool call to a computer use tool. See the computer use guide for more information.

String id

The unique ID of the computer call.

String callId

An identifier used when responding to the tool call with output.

List<PendingSafetyCheck> pendingSafetyChecks

The pending safety checks for the computer call.

String id

The ID of the pending safety check.

Optional<String> code

The type of the pending safety check.

Optional<String> message

Details about the pending safety check.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

Type type

The type of the computer call. Always computer_call.

Optional<Action> action

A click action.

One of the following:

class Click:

A click action.

Button button

Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.

One of the following:

LEFT("left")

RIGHT("right")

WHEEL("wheel")

BACK("back")

FORWARD("forward")

JsonValue; type "click"constant"click"constant

Specifies the event type. For a click action, this property is always click.

long x

The x-coordinate where the click occurred.

long y

The y-coordinate where the click occurred.

Optional<List<String>> keys

The keys being held while clicking.

class DoubleClick:

A double click action.

Optional<List<String>> keys

The keys being held while double-clicking.

JsonValue; type "double_click"constant"double_click"constant

Specifies the event type. For a double click action, this property is always set to double_click.

long x

The x-coordinate where the double click occurred.

long y

The y-coordinate where the double click occurred.

class Drag:

A drag action.

List<Path> path

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 }
]

long x

The x-coordinate.

long y

The y-coordinate.

JsonValue; type "drag"constant"drag"constant

Specifies the event type. For a drag action, this property is always set to drag.

Optional<List<String>> keys

The keys being held while dragging the mouse.

class Keypress:

A collection of keypresses the model would like to perform.

List<String> keys

The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key.

JsonValue; type "keypress"constant"keypress"constant

Specifies the event type. For a keypress action, this property is always set to keypress.

class Move:

A mouse move action.

JsonValue; type "move"constant"move"constant

Specifies the event type. For a move action, this property is always set to move.

long x

The x-coordinate to move to.

long y

The y-coordinate to move to.

Optional<List<String>> keys

The keys being held while moving the mouse.

JsonValue;

JsonValue; type "screenshot"constant"screenshot"constant

Specifies the event type. For a screenshot action, this property is always set to screenshot.

class Scroll:

A scroll action.

long scrollX

The horizontal scroll distance.

long scrollY

The vertical scroll distance.

JsonValue; type "scroll"constant"scroll"constant

Specifies the event type. For a scroll action, this property is always set to scroll.

long x

The x-coordinate where the scroll occurred.

long y

The y-coordinate where the scroll occurred.

Optional<List<String>> keys

The keys being held while scrolling.

class Type:

An action to type in text.

String text

The text to type.

JsonValue; type "type"constant"type"constant

Specifies the event type. For a type action, this property is always set to type.

JsonValue;

JsonValue; type "wait"constant"wait"constant

Specifies the event type. For a wait action, this property is always set to wait.

Optional<List<ComputerAction>> actions

Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.

class ResponseComputerToolCallOutputItem:

String id

The unique ID of the computer call tool output.

String callId

The ID of the computer tool call that produced the output.

ResponseComputerToolCallOutputScreenshot output

A computer screenshot image used with the computer use tool.

Status status

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("completed")

INCOMPLETE("incomplete")

FAILED("failed")

IN_PROGRESS("in_progress")

JsonValue; type "computer_call_output"constant"computer_call_output"constant

The type of the computer tool call output. Always computer_call_output.

Optional<List<AcknowledgedSafetyCheck>> acknowledgedSafetyChecks

The safety checks reported by the API that have been acknowledged by the developer.

String id

The ID of the pending safety check.

Optional<String> code

The type of the pending safety check.

Optional<String> message

Details about the pending safety check.

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseFunctionWebSearch:

The results of a web search tool call. See the web search guide for more information.

String id

The unique ID of the web search tool call.

Action action

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:

class Search:

Action type “search” - Performs a web search query.

String query

[DEPRECATED] The search query.

JsonValue; type "search"constant"search"constant

The action type.

Optional<List<String>> queries

The search queries.

Optional<List<Source>> sources

The sources used in the search.

JsonValue; type "url"constant"url"constant

The type of source. Always url.

String url

The URL of the source.

class OpenPage:

Action type “open_page” - Opens a specific URL from search results.

JsonValue; type "open_page"constant"open_page"constant

The action type.

Optional<String> url

The URL opened by the model.

formaturi

class FindInPage:

Action type “find_in_page”: Searches for a pattern within a loaded page.

String pattern

The pattern or text to search for within the page.

JsonValue; type "find_in_page"constant"find_in_page"constant

The action type.

String url

The URL of the page searched for the pattern.

formaturi

Status status

The status of the web search tool call.

One of the following:

IN_PROGRESS("in_progress")

SEARCHING("searching")

COMPLETED("completed")

FAILED("failed")

JsonValue; type "web_search_call"constant"web_search_call"constant

The type of the web search tool call. Always web_search_call.

class ResponseFunctionToolCallItem:

A tool call to run a function. See the function calling guide for more information.

String id

The unique ID of the function tool call.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseFunctionToolCallOutputItem:

String id

The unique ID of the function call tool output.

String callId

The unique ID of the function tool call generated by the model.

Output output

The output from the function call generated by your code. Can be a string or an list of output content.

One of the following:

String

List<FunctionAndCustomToolCallOutput>

One of the following:

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputImage:

An image input to the model. Learn about image inputs.

Detail detail

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("low")

HIGH("high")

AUTO("auto")

ORIGINAL("original")

JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<String> fileId

The ID of the file to be sent to the model.

Optional<String> imageUrl

The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.

class ResponseInputFile:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

Optional<Detail> detail

The detail level of the file to be sent to the model. Use low for the default rendering behavior, or high to render the file at higher quality. Defaults to low.

One of the following:

LOW("low")

HIGH("high")

Optional<String> fileData

The content of the file to be sent to the model.

Optional<String> fileId

The ID of the file to be sent to the model.

Optional<String> fileUrl

The URL of the file to be sent to the model.

Optional<String> filename

The name of the file to be sent to the model.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "function_call_output"constant"function_call_output"constant

The type of the function tool call output. Always function_call_output.

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseToolSearchCall:

String id

The unique ID of the tool search call item.

JsonValue arguments

Arguments used for the tool search call.

Optional<String> callId

The unique ID of the tool search call generated by the model.

Execution execution

Whether tool search was executed by the server or by the client.

One of the following:

SERVER("server")

CLIENT("client")

Status status

The status of the tool search call item that was recorded.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "tool_search_call"constant"tool_search_call"constant

The type of the item. Always tool_search_call.

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseToolSearchOutputItem:

String id

The unique ID of the tool search output item.

Optional<String> callId

The unique ID of the tool search call generated by the model.

Execution execution

Whether tool search was executed by the server or by the client.

One of the following:

SERVER("server")

CLIENT("client")

Status status

The status of the tool search output item that was recorded.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

List<Tool> tools

The loaded tool definitions returned by tool search.

One of the following:

class FunctionTool:

Defines a function in your own code the model can choose to call. Learn more about function calling.

String name

The name of the function to call.

Optional<Parameters> parameters

A JSON schema object describing the parameters of the function.

Optional<Boolean> strict

Whether to enforce strict parameter validation. Default true.

JsonValue; type "function"constant"function"constant

The type of the function tool. Always function.

Optional<Boolean> deferLoading

Whether this function is deferred and loaded via tool search.

Optional<String> description

A description of the function. Used by the model to determine whether or not to call the function.

class FileSearchTool:

A tool that searches for relevant content from uploaded files. Learn more about the file search tool.

JsonValue; type "file_search"constant"file_search"constant

The type of the file search tool. Always file_search.

List<String> vectorStoreIds

The IDs of the vector stores to search.

Optional<Filters> filters

A filter to apply.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

class CompoundFilter:

Combine multiple filters using and or or.

List<Filter> filters

Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.

One of the following:

class ComparisonFilter:

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

String key

The key to compare against the value.

Type type

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("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

IN("in")

NIN("nin")

Value value

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:

String

double

boolean

List<ComparisonFilterValueItem>

One of the following:

String

double

JsonValue

Type type

Type of operation: and or or.

One of the following:

AND("and")

OR("or")

Optional<Long> maxNumResults

The maximum number of results to return. This number should be between 1 and 50 inclusive.

Optional<RankingOptions> rankingOptions

Ranking options for search.

Optional<HybridSearch> hybridSearch

Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled.

double embeddingWeight

The weight of the embedding in the reciprocal ranking fusion.

double textWeight

The weight of the text in the reciprocal ranking fusion.

Optional<Ranker> ranker

The ranker to use for the file search.

One of the following:

AUTO("auto")

DEFAULT_2024_11_15("default-2024-11-15")

Optional<Double> scoreThreshold

The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.

class ComputerTool:

A tool that controls a virtual computer. Learn more about the computer tool.

JsonValue; type "computer"constant"computer"constant

The type of the computer tool. Always computer.

class ComputerUsePreviewTool:

A tool that controls a virtual computer. Learn more about the computer tool.

long displayHeight

The height of the computer display.

long displayWidth

The width of the computer display.

Environment environment

The type of computer environment to control.

One of the following:

WINDOWS("windows")

MAC("mac")

LINUX("linux")

UBUNTU("ubuntu")

BROWSER("browser")

JsonValue; type "computer_use_preview"constant"computer_use_preview"constant

The type of the computer use tool. Always computer_use_preview.

class WebSearchTool:

Search the Internet for sources related to the prompt. Learn more about the web search tool.

Type type

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")

WEB_SEARCH_2025_08_26("web_search_2025_08_26")

Optional<Filters> filters

Filters for the search.

Optional<List<String>> allowedDomains

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"]

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The approximate location of the user.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

Optional<Type> type

The type of location approximation. Always approximate.

Mcp

String serverLabel

A label for this MCP server, used to identify it in tool calls.

JsonValue; type "mcp"constant"mcp"constant

The type of the MCP tool. Always mcp.

Optional<AllowedTools> allowedTools

List of allowed tool names or a filter object.

One of the following:

List<String>

class McpToolFilter:

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<String> authorization

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.

Optional<ConnectorId> connectorId

Identifier for service connectors, like those available in ChatGPT. One of server_url or connector_id must be provided. Learn more about service connectors here.

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_dropbox")

CONNECTOR_GMAIL("connector_gmail")

CONNECTOR_GOOGLECALENDAR("connector_googlecalendar")

CONNECTOR_GOOGLEDRIVE("connector_googledrive")

CONNECTOR_MICROSOFTTEAMS("connector_microsoftteams")

CONNECTOR_OUTLOOKCALENDAR("connector_outlookcalendar")

CONNECTOR_OUTLOOKEMAIL("connector_outlookemail")

CONNECTOR_SHAREPOINT("connector_sharepoint")

Optional<Boolean> deferLoading

Whether this MCP tool is deferred and discovered via tool search.

Optional<Headers> headers

Optional HTTP headers to send to the MCP server. Use for authentication or other purposes.

Optional<RequireApproval> requireApproval

Specify which of the MCP server’s tools require approval.

One of the following:

class McpToolApprovalFilter:

Specify which of the MCP server’s tools require approval. Can be always, never, or a filter object associated with tools that require approval.

Optional<Always> always

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<Never> never

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

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.

Optional<List<String>> toolNames

List of allowed tool names.

enum McpToolApprovalSetting:

Specify a single approval policy for all tools. One of always or never. When set to always, all tools will require approval. When set to never, all tools will not require approval.

ALWAYS("always")

NEVER("never")

Optional<String> serverDescription

Optional description of the MCP server, used to provide more context.

Optional<String> serverUrl

The URL for the MCP server. One of server_url or connector_id must be provided.

CodeInterpreter

Container container

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

class CodeInterpreterToolAuto:

Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.

JsonValue; type "auto"constant"auto"constant

Always auto.

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the code interpreter container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

JsonValue; type "code_interpreter"constant"code_interpreter"constant

The type of the code interpreter tool. Always code_interpreter.

ImageGeneration

JsonValue; type "image_generation"constant"image_generation"constant

The type of the image generation tool. Always image_generation.

Optional<Action> action

Whether to generate a new image or edit an existing image. Default: auto.

One of the following:

GENERATE("generate")

EDIT("edit")

AUTO("auto")

Optional<Background> background

Background type for the generated image. One of transparent, opaque, or auto. Default: auto.

One of the following:

TRANSPARENT("transparent")

OPAQUE("opaque")

AUTO("auto")

Optional<InputFidelity> inputFidelity

Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1 and gpt-image-1.5 and later models, unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.

One of the following:

HIGH("high")

LOW("low")

Optional<InputImageMask> inputImageMask

Optional mask for inpainting. Contains image_url (string, optional) and file_id (string, optional).

Optional<String> fileId

File ID for the mask image.

Optional<String> imageUrl

Base64-encoded mask image.

Optional<Model> model

The image generation model to use. Default: gpt-image-1.

One of the following:

GPT_IMAGE_1("gpt-image-1")

GPT_IMAGE_1_MINI("gpt-image-1-mini")

GPT_IMAGE_1_5("gpt-image-1.5")

Optional<Moderation> moderation

Moderation level for the generated image. Default: auto.

One of the following:

AUTO("auto")

LOW("low")

Optional<Long> outputCompression

Compression level for the output image. Default: 100.

minimum0

maximum100

Optional<OutputFormat> outputFormat

The output format of the generated image. One of png, webp, or jpeg. Default: png.

One of the following:

PNG("png")

WEBP("webp")

JPEG("jpeg")

Optional<Long> partialImages

Number of partial images to generate in streaming mode, from 0 (default value) to 3.

minimum0

maximum3

Optional<Quality> quality

The quality of the generated image. One of low, medium, high, or auto. Default: auto.

One of the following:

LOW("low")

MEDIUM("medium")

HIGH("high")

AUTO("auto")

Optional<Size> size

The size of the generated image. One of 1024x1024, 1024x1536, 1536x1024, or auto. Default: auto.

One of the following:

_1024X1024("1024x1024")

_1024X1536("1024x1536")

_1536X1024("1536x1024")

AUTO("auto")

JsonValue;

JsonValue; type "local_shell"constant"local_shell"constant

The type of the local shell tool. Always local_shell.

class FunctionShellTool:

A tool that allows the model to execute shell commands.

JsonValue; type "shell"constant"shell"constant

The type of the shell tool. Always shell.

Optional<Environment> environment

One of the following:

class ContainerAuto:

JsonValue; type "container_auto"constant"container_auto"constant

Automatically creates a container for this request

Optional<List<String>> fileIds

An optional list of uploaded files to make available to your code.

Optional<MemoryLimit> memoryLimit

The memory limit for the container.

One of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

Optional<NetworkPolicy> networkPolicy

Network access policy for the container.

One of the following:

class ContainerNetworkPolicyDisabled:

JsonValue; type "disabled"constant"disabled"constant

Disable outbound network access. Always disabled.

class ContainerNetworkPolicyAllowlist:

List<String> allowedDomains

A list of allowed domains when type is allowlist.

JsonValue; type "allowlist"constant"allowlist"constant

Allow outbound network access only to specified domains. Always allowlist.

Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets

Optional domain-scoped secrets for allowlisted domains.

String domain

The domain associated with the secret.

minLength1

String name

The name of the secret to inject for the domain.

minLength1

String value

The secret value to inject for the domain.

maxLength10485760

minLength1

Optional<List<Skill>> skills

An optional list of skills referenced by id or inline data.

One of the following:

class SkillReference:

String skillId

The ID of the referenced skill.

maxLength64

minLength1

JsonValue; type "skill_reference"constant"skill_reference"constant

References a skill created with the /v1/skills endpoint.

Optional<String> version

Optional skill version. Use a positive integer or ‘latest’. Omit for default.

class InlineSkill:

String description

The description of the skill.

String name

The name of the skill.

InlineSkillSource source

Inline skill payload

JsonValue; type "inline"constant"inline"constant

Defines an inline skill for this request.

class LocalEnvironment:

JsonValue; type "local"constant"local"constant

Use a local computer environment.

Optional<List<LocalSkill>> skills

An optional list of skills.

String description

The description of the skill.

String name

The name of the skill.

String path

The path to the directory containing the skill.

class ContainerReference:

String containerId

The ID of the referenced container.

JsonValue; type "container_reference"constant"container_reference"constant

References a container created with the /v1/containers endpoint

class CustomTool:

A custom tool that processes input using a specified format. Learn more about custom tools

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

class NamespaceTool:

Groups function/custom tools under a shared namespace.

String description

A description of the namespace shown to the model.

minLength1

String name

The namespace name used in tool calls (for example, crm).

minLength1

List<Tool> tools

The function/custom tools available inside this namespace.

One of the following:

class Function:

String name

maxLength128

minLength1

JsonValue; type "function"constant"function"constant

Optional<Boolean> deferLoading

Whether this function should be deferred and discovered via tool search.

Optional<String> description

Optional<JsonValue> parameters

Optional<Boolean> strict

class CustomTool:

A custom tool that processes input using a specified format. Learn more about custom tools

String name

The name of the custom tool, used to identify it in tool calls.

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

Optional<Boolean> deferLoading

Whether this tool should be deferred and discovered via tool search.

Optional<String> description

Optional description of the custom tool, used to provide more context.

Optional<CustomToolInputFormat> format

The input format for the custom tool. Default is unconstrained text.

JsonValue; type "namespace"constant"namespace"constant

The type of the tool. Always namespace.

class ToolSearchTool:

Hosted or BYOT tool search configuration for deferred tools.

JsonValue; type "tool_search"constant"tool_search"constant

The type of the tool. Always tool_search.

Optional<String> description

Description shown to the model for a client-executed tool search tool.

Optional<Execution> execution

Whether tool search is executed by the server or by the client.

One of the following:

SERVER("server")

CLIENT("client")

Optional<JsonValue> parameters

Parameter schema for a client-executed tool search tool.

class WebSearchPreviewTool:

This tool searches the web for relevant results to use in a response. Learn more about the web search tool.

Type type

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")

WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")

Optional<List<SearchContentType>> searchContentTypes

One of the following:

TEXT("text")

IMAGE("image")

Optional<SearchContextSize> searchContextSize

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("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The user’s location.

JsonValue; type "approximate"constant"approximate"constant

The type of location approximation. Always approximate.

Optional<String> city

Free text input for the city of the user, e.g. San Francisco.

Optional<String> country

The two-letter ISO country code of the user, e.g. US.

Optional<String> region

Free text input for the region of the user, e.g. California.

Optional<String> timezone

The IANA timezone of the user, e.g. America/Los_Angeles.

class ApplyPatchTool:

Allows the assistant to create, delete, or update files using unified diffs.

JsonValue; type "apply_patch"constant"apply_patch"constant

The type of the tool. Always apply_patch.

JsonValue; type "tool_search_output"constant"tool_search_output"constant

The type of the item. Always tool_search_output.

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseReasoningItem:

A description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your input to the Responses API for subsequent turns of a conversation if you are manually managing context.

String id

The unique identifier of the reasoning content.

List<Summary> summary

Reasoning summary content.

String text

A summary of the reasoning output from the model so far.

JsonValue; type "summary_text"constant"summary_text"constant

The type of the object. Always summary_text.

JsonValue; type "reasoning"constant"reasoning"constant

The type of the object. Always reasoning.

Optional<List<Content>> content

Reasoning text content.

String text

The reasoning text from the model.

JsonValue; type "reasoning_text"constant"reasoning_text"constant

The type of the reasoning text. Always reasoning_text.

Optional<String> encryptedContent

The encrypted content of the reasoning item - populated when a response is generated with reasoning.encrypted_content in the include parameter.

Optional<Status> status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseCompactionItem:

A compaction item generated by the v1/responses/compact API.

String id

The unique ID of the compaction item.

String encryptedContent

The encrypted content that was produced by compaction.

JsonValue; type "compaction"constant"compaction"constant

The type of the item. Always compaction.

Optional<String> createdBy

The identifier of the actor that created the item.

ImageGenerationCall

String id

The unique ID of the image generation call.

Optional<String> result

The generated image encoded in base64.

Status status

The status of the image generation call.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

GENERATING("generating")

FAILED("failed")

JsonValue; type "image_generation_call"constant"image_generation_call"constant

The type of the image generation call. Always image_generation_call.

class ResponseCodeInterpreterToolCall:

A tool call to run code.

String id

The unique ID of the code interpreter tool call.

Optional<String> code

The code to run, or null if not available.

String containerId

The ID of the container used to run the code.

Optional<List<Output>> outputs

The outputs generated by the code interpreter, such as logs or images. Can be null if no outputs are available.

One of the following:

class Logs:

The logs output from the code interpreter.

String logs

The logs output from the code interpreter.

JsonValue; type "logs"constant"logs"constant

The type of the output. Always logs.

class Image:

The image output from the code interpreter.

JsonValue; type "image"constant"image"constant

The type of the output. Always image.

String url

The URL of the image output from the code interpreter.

Status status

The status of the code interpreter tool call. Valid values are in_progress, completed, incomplete, interpreting, and failed.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

INTERPRETING("interpreting")

FAILED("failed")

JsonValue; type "code_interpreter_call"constant"code_interpreter_call"constant

The type of the code interpreter tool call. Always code_interpreter_call.

LocalShellCall

String id

The unique ID of the local shell call.

Action action

Execute a shell command on the server.

List<String> command

The command to run.

Env env

Environment variables to set for the command.

JsonValue; type "exec"constant"exec"constant

The type of the local shell action. Always exec.

Optional<Long> timeoutMs

Optional timeout in milliseconds for the command.

Optional<String> user

Optional user to run the command as.

Optional<String> workingDirectory

Optional working directory to run the command in.

String callId

The unique ID of the local shell tool call generated by the model.

Status status

The status of the local shell call.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "local_shell_call"constant"local_shell_call"constant

The type of the local shell call. Always local_shell_call.

LocalShellCallOutput

String id

The unique ID of the local shell tool call generated by the model.

String output

A JSON string of the output of the local shell tool call.

JsonValue; type "local_shell_call_output"constant"local_shell_call_output"constant

The type of the local shell tool call output. Always local_shell_call_output.

Optional<Status> status

The status of the item. One of in_progress, completed, or incomplete.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseFunctionShellToolCall:

A tool call that executes one or more shell commands in a managed environment.

String id

The unique ID of the shell tool call. Populated when this item is returned via API.

Action action

The shell commands and limits that describe how to run the tool call.

List<String> commands

Optional<Long> maxOutputLength

Optional maximum number of characters to return from each command.

Optional<Long> timeoutMs

Optional timeout in milliseconds for the commands.

String callId

The unique ID of the shell tool call generated by the model.

Optional<Environment> environment

Represents the use of a local environment to perform shell actions.

One of the following:

class ResponseLocalEnvironment:

Represents the use of a local environment to perform shell actions.

JsonValue; type "local"constant"local"constant

The environment type. Always local.

class ResponseContainerReference:

Represents a container created with /v1/containers.

String containerId

JsonValue; type "container_reference"constant"container_reference"constant

The environment type. Always container_reference.

Status status

The status of the shell call. One of in_progress, completed, or incomplete.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "shell_call"constant"shell_call"constant

The type of the item. Always shell_call.

Optional<String> createdBy

The ID of the entity that created this tool call.

class ResponseFunctionShellToolCallOutput:

The output of a shell tool call that was emitted.

String id

The unique ID of the shell call output. Populated when this item is returned via API.

String callId

The unique ID of the shell tool call generated by the model.

Optional<Long> maxOutputLength

The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output.

List<Output> output

An array of shell call output contents

Outcome outcome

Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk.

One of the following:

JsonValue;

JsonValue; type "timeout"constant"timeout"constant

The outcome type. Always timeout.

class Exit:

Indicates that the shell commands finished and returned an exit code.

long exitCode

Exit code from the shell process.

JsonValue; type "exit"constant"exit"constant

The outcome type. Always exit.

String stderr

The standard error output that was captured.

String stdout

The standard output that was captured.

Optional<String> createdBy

The identifier of the actor that created the item.

Status status

The status of the shell call output. One of in_progress, completed, or incomplete.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "shell_call_output"constant"shell_call_output"constant

The type of the shell call output. Always shell_call_output.

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseApplyPatchToolCall:

A tool call that applies file diffs by creating, deleting, or updating files.

String id

The unique ID of the apply patch tool call. Populated when this item is returned via API.

String callId

The unique ID of the apply patch tool call generated by the model.

Operation operation

One of the create_file, delete_file, or update_file operations applied via apply_patch.

One of the following:

class CreateFile:

Instruction describing how to create a file via the apply_patch tool.

String diff

Diff to apply.

String path

Path of the file to create.

JsonValue; type "create_file"constant"create_file"constant

Create a new file with the provided diff.

class DeleteFile:

Instruction describing how to delete a file via the apply_patch tool.

String path

Path of the file to delete.

JsonValue; type "delete_file"constant"delete_file"constant

Delete the specified file.

class UpdateFile:

Instruction describing how to update a file via the apply_patch tool.

String diff

Diff to apply.

String path

Path of the file to update.

JsonValue; type "update_file"constant"update_file"constant

Update an existing file with the provided diff.

Status status

The status of the apply patch tool call. One of in_progress or completed.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

JsonValue; type "apply_patch_call"constant"apply_patch_call"constant

The type of the item. Always apply_patch_call.

Optional<String> createdBy

The ID of the entity that created this tool call.

class ResponseApplyPatchToolCallOutput:

The output emitted by an apply patch tool call.

String id

The unique ID of the apply patch tool call output. Populated when this item is returned via API.

String callId

The unique ID of the apply patch tool call generated by the model.

Status status

The status of the apply patch tool call output. One of completed or failed.

One of the following:

COMPLETED("completed")

FAILED("failed")

JsonValue; type "apply_patch_call_output"constant"apply_patch_call_output"constant

The type of the item. Always apply_patch_call_output.

Optional<String> createdBy

The ID of the entity that created this tool call output.

Optional<String> output

Optional textual output returned by the apply patch tool.

McpListTools

String id

The unique ID of the list.

String serverLabel

The label of the MCP server.

List<Tool> tools

The tools available on the server.

JsonValue inputSchema

The JSON schema describing the tool’s input.

String name

The name of the tool.

Optional<JsonValue> annotations

Additional annotations about the tool.

Optional<String> description

The description of the tool.

JsonValue; type "mcp_list_tools"constant"mcp_list_tools"constant

The type of the item. Always mcp_list_tools.

Optional<String> error

Error message if the server could not list tools.

McpApprovalRequest

String id

The unique ID of the approval request.

String arguments

A JSON string of arguments for the tool.

String name

The name of the tool to run.

String serverLabel

The label of the MCP server making the request.

JsonValue; type "mcp_approval_request"constant"mcp_approval_request"constant

The type of the item. Always mcp_approval_request.

McpApprovalResponse

String id

The unique ID of the approval response

String approvalRequestId

The ID of the approval request being answered.

boolean approve

Whether the request was approved.

JsonValue; type "mcp_approval_response"constant"mcp_approval_response"constant

The type of the item. Always mcp_approval_response.

Optional<String> reason

Optional reason for the decision.

McpCall

String id

The unique ID of the tool call.

String arguments

A JSON string of the arguments passed to the tool.

String name

The name of the tool that was run.

String serverLabel

The label of the MCP server running the tool.

JsonValue; type "mcp_call"constant"mcp_call"constant

The type of the item. Always mcp_call.

Optional<String> approvalRequestId

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.

Optional<String> error

The error from the tool call, if any.

Optional<String> output

The output from the tool call.

Optional<Status> status

The status of the tool call. One of in_progress, completed, incomplete, calling, or failed.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

CALLING("calling")

FAILED("failed")

class ResponseCustomToolCallItem:

A call to a custom tool created by the model.

String id

The unique ID of the custom tool call item.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

Optional<String> createdBy

The identifier of the actor that created the item.

class ResponseCustomToolCallOutputItem:

The output of a custom tool call from your code, being sent back to the model.

String id

The unique ID of the custom tool call output item.

Status status

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("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

Optional<String> createdBy

The identifier of the actor that created the item.

String firstId

The ID of the first item in the list.

boolean hasMore

Whether there are more items available.

String lastId

The ID of the last item in the list.

JsonValue; object_ "list"constant"list"constant

The type of object returned, must be list.

ResponsesInput Tokens

Get input token counts

InputTokenCountResponse responses().inputTokens().count(InputTokenCountParamsparams = InputTokenCountParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

POST/responses/input_tokens