Compact a response
Compact a conversation. Returns a compacted response object.
Learn when and how to compact long-running conversations in the conversation state guide. For ZDR-compatible compaction details, see Compaction (advanced).
ParametersExpand Collapse
ResponseCompactParams params
Optional<Model> modelModel ID used to generate the response, like gpt-5 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.
Model ID used to generate the response, like gpt-5 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<Input> inputText, image, or file inputs to the model, used to generate a response
Text, image, or file inputs to the model, used to generate a response
List<BetaResponseInputItem>
class BetaEasyInputMessage: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.
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 contentText, image, or audio input to the model, used to generate a response.
Can also contain previous assistant responses.
Text, image, or audio input to the model, used to generate a response. Can also contain previous assistant responses.
List<BetaResponseInputContent>
class BetaResponseInputText:A text input to the model.
A text input to the model.
The type of the input item. Always input_text.
class BetaResponseInputImage:An image input to the model. Learn about image inputs.
An image input to the model. Learn about image inputs.
Detail detailThe detail level of the image to be sent to the model. One of high, low, auto, or original. Defaults to auto.
The detail level of the image to be sent to the model. One of high, low, auto, or original. Defaults to auto.
The type of the input item. Always input_image.
The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.
class BetaResponseInputFile:A file input to the model.
A file input to the model.
The type of the input item. Always input_file.
Optional<Detail> detailThe detail level of the file to be sent to the model. Use auto to let the system select the detail level; for GPT-5.6 and later models, auto uses high-quality rendering, which may increase input token usage. Use low for lower-cost rendering, or high to render the file at higher quality. Defaults to auto.
The detail level of the file to be sent to the model. Use auto to let the system select the detail level; for GPT-5.6 and later models, auto uses high-quality rendering, which may increase input token usage. Use low for lower-cost rendering, or high to render the file at higher quality. Defaults to auto.
Optional<Phase> phaseLabels 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.
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.
Message
List<BetaResponseInputContent> contentA list of one or many input items to the model, containing different content
types.
A list of one or many input items to the model, containing different content types.
class BetaResponseInputText:A text input to the model.
A text input to the model.
The type of the input item. Always input_text.
class BetaResponseInputImage:An image input to the model. Learn about image inputs.
An image input to the model. Learn about image inputs.
Detail detailThe detail level of the image to be sent to the model. One of high, low, auto, or original. Defaults to auto.
The detail level of the image to be sent to the model. One of high, low, auto, or original. Defaults to auto.
The type of the input item. Always input_image.
The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.
class BetaResponseInputFile:A file input to the model.
A file input to the model.
The type of the input item. Always input_file.
Optional<Detail> detailThe detail level of the file to be sent to the model. Use auto to let the system select the detail level; for GPT-5.6 and later models, auto uses high-quality rendering, which may increase input token usage. Use low for lower-cost rendering, or high to render the file at higher quality. Defaults to auto.
The detail level of the file to be sent to the model. Use auto to let the system select the detail level; for GPT-5.6 and later models, auto uses high-quality rendering, which may increase input token usage. Use low for lower-cost rendering, or high to render the file at higher quality. Defaults to auto.
class BetaResponseOutputMessage:An output message from the model.
An output message from the model.
List<Content> contentThe content of the output message.
The content of the output message.
class BetaResponseOutputText:A text output from the model.
A text output from the model.
List<Annotation> annotationsThe annotations of the text output.
The annotations of the text output.
class UrlCitation:A citation for a web resource used to generate a model response.
A citation for a web resource used to generate a model response.
The role of the output message. Always assistant.
Status statusThe status of the message input. One of in_progress, completed, or
incomplete. Populated when input items are returned via API.
The status of the message input. One of in_progress, completed, or
incomplete. Populated when input items are returned via API.
Optional<Phase> phaseLabels 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.
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.
class BetaResponseFileSearchToolCall:The results of a file search tool call. See the
file search guide for more information.
The results of a file search tool call. See the file search guide for more information.
Status statusThe status of the file search tool call. One of in_progress,
searching, incomplete or failed,
The status of the file search tool call. One of in_progress,
searching, incomplete or failed,
The type of the file search tool call. Always file_search_call.
Optional<List<Result>> resultsThe results of the file search tool call.
The results of the file search tool call.
Optional<Attributes> attributesSet 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.
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.
class BetaResponseComputerToolCall:A tool call to a computer use tool. See the
computer use guide for more information.
A tool call to a computer use tool. See the computer use guide for more information.
Status statusThe status of the item. One of in_progress, completed, or
incomplete. Populated when items are returned via API.
The status of the item. One of in_progress, completed, or
incomplete. Populated when items are returned via API.
A click action.
A click action.
Click
DoubleClick
Drag
Scroll
Flattened batched actions for computer_use. Each action includes an
type discriminator and action-specific fields.
Flattened batched actions for computer_use. Each action includes an
type discriminator and action-specific fields.
Click
DoubleClick
Drag
Scroll
ComputerCallOutput
A computer screenshot image used with the computer use tool.
A computer screenshot image used with the computer use tool.
The type of the computer tool call output. Always computer_call_output.
Optional<List<AcknowledgedSafetyCheck>> acknowledgedSafetyChecksThe safety checks reported by the API that have been acknowledged by the developer.
The safety checks reported by the API that have been acknowledged by the developer.
class BetaResponseFunctionWebSearch:The results of a web search tool call. See the
web search guide for more information.
The results of a web search tool call. See the web search guide for more information.
Action actionAn 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).
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).
class BetaResponseFunctionToolCall:A tool call to run a function. See the
function calling guide for more information.
A tool call to run a function. See the function calling guide for more information.
FunctionCallOutput
Output outputText, image, or file output of the function tool call.
Text, image, or file output of the function tool call.
class BetaResponseInputTextContent:A text input to the model.
A text input to the model.
The type of the input item. Always input_text.
class BetaResponseInputImageContent:An image input to the model. Learn about image inputs
An image input to the model. Learn about image inputs
The type of the input item. Always input_image.
Optional<Detail> detailThe detail level of the image to be sent to the model. One of high, low, auto, or original. Defaults to auto.
The detail level of the image to be sent to the model. One of high, low, auto, or original. Defaults to auto.
The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.
class BetaResponseInputFileContent:A file input to the model.
A file input to the model.
The type of the input item. Always input_file.
Optional<Detail> detailThe detail level of the file to be sent to the model. Use auto to let the system select the detail level; for GPT-5.6 and later models, auto uses high-quality rendering, which may increase input token usage. Use low for lower-cost rendering, or high to render the file at higher quality. Defaults to auto.
The detail level of the file to be sent to the model. Use auto to let the system select the detail level; for GPT-5.6 and later models, auto uses high-quality rendering, which may increase input token usage. Use low for lower-cost rendering, or high to render the file at higher quality. Defaults to auto.
The base64-encoded data of the file to be sent to the model.
The type of the function tool call output. Always function_call_output.
The unique ID of the function tool call output. Populated when this item is returned via API.
AgentMessage
List<Content> contentPlaintext, image, or encrypted content sent between agents.
Plaintext, image, or encrypted content sent between agents.
class BetaResponseInputTextContent:A text input to the model.
A text input to the model.
The type of the input item. Always input_text.
class BetaResponseInputImageContent:An image input to the model. Learn about image inputs
An image input to the model. Learn about image inputs
The type of the input item. Always input_image.
Optional<Detail> detailThe detail level of the image to be sent to the model. One of high, low, auto, or original. Defaults to auto.
The detail level of the image to be sent to the model. One of high, low, auto, or original. Defaults to auto.
The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.
MultiAgentCall
MultiAgentCallOutput
List<Output> outputText output returned by the multi-agent action.
Text output returned by the multi-agent action.
ToolSearchCall
The item type. Always tool_search_call.
The unique ID of the tool search call generated by the model.
class BetaResponseToolSearchOutputItemParam:
List<BetaTool> toolsThe loaded tool definitions returned by the tool search output.
The loaded tool definitions returned by the tool search output.
class BetaFunctionTool:Defines a function in your own code the model can choose to call. Learn more about function calling.
Defines a function in your own code the model can choose to call. Learn more about function calling.
class BetaFileSearchTool:A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
The type of the file search tool. Always file_search.
Optional<Filters> filtersA filter to apply.
A filter to apply.
class ComparisonFilter:A filter used to compare a specified attribute key to a given value using a defined comparison operation.
A filter used to compare a specified attribute key to a given value using a defined comparison operation.
class CompoundFilter:Combine multiple filters using and or or.
Combine multiple filters using and or or.
List<Filter> filtersArray of filters to combine. Items can be ComparisonFilter or CompoundFilter.
Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.
class ComparisonFilter:A filter used to compare a specified attribute key to a given value using a defined comparison operation.
A filter used to compare a specified attribute key to a given value using a defined comparison operation.
The maximum number of results to return. This number should be between 1 and 50 inclusive.
Optional<RankingOptions> rankingOptionsRanking options for search.
Ranking options for search.
class BetaComputerTool:A tool that controls a virtual computer. Learn more about the computer tool.
A tool that controls a virtual computer. Learn more about the computer tool.
class BetaComputerUsePreviewTool:A tool that controls a virtual computer. Learn more about the computer tool.
A tool that controls a virtual computer. Learn more about the computer tool.
class BetaWebSearchTool:Search the Internet for sources related to the prompt. Learn more about the
web search tool.
Search the Internet for sources related to the prompt. Learn more about the web search tool.
Optional<SearchContextSize> searchContextSizeHigh level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.
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.
Optional<UserLocation> userLocationThe approximate location of the user.
The approximate location of the user.
The two-letter ISO country code of the user, e.g. US.
The IANA timezone of the user, e.g. America/Los_Angeles.
Mcp
Optional<AllowedTools> allowedToolsList of allowed tool names or a filter object.
List of allowed tool names or a filter object.
class McpToolFilter:A filter object to specify which tools are allowed.
A filter object to specify which tools are allowed.
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.
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> connectorIdIdentifier for service connectors, like those available in ChatGPT. One of
server_url, connector_id, or tunnel_id must be provided. Learn more
about service connectors here.
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
Identifier for service connectors, like those available in ChatGPT. One of
server_url, connector_id, or tunnel_id must be provided. Learn more
about service connectors here.
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
Optional HTTP headers to send to the MCP server. Use for authentication or other purposes.
Optional<RequireApproval> requireApprovalSpecify which of the MCP server’s tools require approval.
Specify which of the MCP server’s tools require approval.
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.
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> alwaysA filter object to specify which tools are allowed.
A filter object to specify which tools are allowed.
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<Never> neverA filter object to specify which tools are allowed.
A filter object to specify which tools are allowed.
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 description of the MCP server, used to provide more context.
CodeInterpreter
Container containerThe 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.
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.
class CodeInterpreterToolAuto:Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.
Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.
Optional<NetworkPolicy> networkPolicyNetwork access policy for the container.
Network access policy for the container.
ImageGeneration
The type of the image generation tool. Always image_generation.
Optional<Background> backgroundAllows to set transparency for the background of the generated image(s).
This parameter is only supported for GPT image models that support
transparent backgrounds. Must be one of transparent, opaque, or
auto (default value). When auto is used, the model will
automatically determine the best background for the image.
gpt-image-2 and gpt-image-2-2026-04-21 do not support
transparent backgrounds. Requests with background set to
transparent will return an error for these models; use opaque or
auto instead.
If transparent, the output format needs to support transparency,
so it should be set to either png (default value) or webp.
Allows to set transparency for the background of the generated image(s).
This parameter is only supported for GPT image models that support
transparent backgrounds. Must be one of transparent, opaque, or
auto (default value). When auto is used, the model will
automatically determine the best background for the image.
gpt-image-2 and gpt-image-2-2026-04-21 do not support
transparent backgrounds. Requests with background set to
transparent will return an error for these models; use opaque or
auto instead.
If transparent, the output format needs to support transparency,
so it should be set to either png (default value) or webp.
Optional<InputFidelity> inputFidelityControl 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.
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.
Optional<InputImageMask> inputImageMaskOptional mask for inpainting. Contains image_url
(string, optional) and file_id (string, optional).
Optional mask for inpainting. Contains image_url
(string, optional) and file_id (string, optional).
Compression level for the output image. Default: 100.
Optional<OutputFormat> outputFormatThe output format of the generated image. One of png, webp, or
jpeg. Default: png.
The output format of the generated image. One of png, webp, or
jpeg. Default: png.
Number of partial images to generate in streaming mode, from 0 (default value) to 3.
Optional<Quality> qualityThe quality of the generated image. One of low, medium, high,
or auto. Default: auto.
The quality of the generated image. One of low, medium, high,
or auto. Default: auto.
Optional<Size> sizeThe size of the generated images. For gpt-image-2 and gpt-image-2-2026-04-21, arbitrary resolutions are supported as WIDTHxHEIGHT strings, for example 1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above 2560x1440 are experimental, and the maximum supported resolution is 3840x2160. The requested size must also satisfy the model’s current pixel and edge limits. The standard sizes 1024x1024, 1536x1024, and 1024x1536 are supported by the GPT image models; auto is supported for models that allow automatic sizing. For dall-e-2, use one of 256x256, 512x512, or 1024x1024. For dall-e-3, use one of 1024x1024, 1792x1024, or 1024x1792.
The size of the generated images. For gpt-image-2 and gpt-image-2-2026-04-21, arbitrary resolutions are supported as WIDTHxHEIGHT strings, for example 1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above 2560x1440 are experimental, and the maximum supported resolution is 3840x2160. The requested size must also satisfy the model’s current pixel and edge limits. The standard sizes 1024x1024, 1536x1024, and 1024x1536 are supported by the GPT image models; auto is supported for models that allow automatic sizing. For dall-e-2, use one of 256x256, 512x512, or 1024x1024. For dall-e-3, use one of 1024x1024, 1792x1024, or 1024x1792.
class BetaFunctionShellTool:A tool that allows the model to execute shell commands.
A tool that allows the model to execute shell commands.
Optional<Environment> environment
class BetaContainerAuto:
Automatically creates a container for this request
Optional<NetworkPolicy> networkPolicyNetwork access policy for the container.
Network access policy for the container.
Optional<List<Skill>> skillsAn optional list of skills referenced by id or inline data.
An optional list of skills referenced by id or inline data.
class BetaInlineSkill:
BetaInlineSkillSource sourceInline skill payload
Inline skill payload
class BetaCustomTool:A custom tool that processes input using a specified format. Learn more about custom tools
A custom tool that processes input using a specified format. Learn more about custom tools
class BetaNamespaceTool:Groups function/custom tools under a shared namespace.
Groups function/custom tools under a shared namespace.
List<Tool> toolsThe function/custom tools available inside this namespace.
The function/custom tools available inside this namespace.
class Function:
Whether this function should be deferred and discovered via tool search.
class BetaCustomTool:A custom tool that processes input using a specified format. Learn more about custom tools
A custom tool that processes input using a specified format. Learn more about custom tools
class BetaToolSearchTool:Hosted or BYOT tool search configuration for deferred tools.
Hosted or BYOT tool search configuration for deferred tools.
class BetaWebSearchPreviewTool:This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
Type typeThe type of the web search tool. One of web_search_preview or web_search_preview_2025_03_11.
The type of the web search tool. One of web_search_preview or web_search_preview_2025_03_11.
Optional<SearchContextSize> searchContextSizeHigh level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.
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.
Optional<UserLocation> userLocationThe user’s location.
The user’s location.
The type of location approximation. Always approximate.
The two-letter ISO country code of the user, e.g. US.
The IANA timezone of the user, e.g. America/Los_Angeles.
The item type. Always tool_search_output.
The unique ID of the tool search call generated by the model.
AdditionalTools
The role that provided the additional tools. Only developer is supported.
List<BetaTool> toolsA list of additional tools made available at this item.
A list of additional tools made available at this item.
class BetaFunctionTool:Defines a function in your own code the model can choose to call. Learn more about function calling.
Defines a function in your own code the model can choose to call. Learn more about function calling.
class BetaFileSearchTool:A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
The type of the file search tool. Always file_search.
Optional<Filters> filtersA filter to apply.
A filter to apply.
class ComparisonFilter:A filter used to compare a specified attribute key to a given value using a defined comparison operation.
A filter used to compare a specified attribute key to a given value using a defined comparison operation.
class CompoundFilter:Combine multiple filters using and or or.
Combine multiple filters using and or or.
List<Filter> filtersArray of filters to combine. Items can be ComparisonFilter or CompoundFilter.
Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.
class ComparisonFilter:A filter used to compare a specified attribute key to a given value using a defined comparison operation.
A filter used to compare a specified attribute key to a given value using a defined comparison operation.
The maximum number of results to return. This number should be between 1 and 50 inclusive.
Optional<RankingOptions> rankingOptionsRanking options for search.
Ranking options for search.
class BetaComputerTool:A tool that controls a virtual computer. Learn more about the computer tool.
A tool that controls a virtual computer. Learn more about the computer tool.
class BetaComputerUsePreviewTool:A tool that controls a virtual computer. Learn more about the computer tool.
A tool that controls a virtual computer. Learn more about the computer tool.
class BetaWebSearchTool:Search the Internet for sources related to the prompt. Learn more about the
web search tool.
Search the Internet for sources related to the prompt. Learn more about the web search tool.
Optional<SearchContextSize> searchContextSizeHigh level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.
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.
Optional<UserLocation> userLocationThe approximate location of the user.
The approximate location of the user.
The two-letter ISO country code of the user, e.g. US.
The IANA timezone of the user, e.g. America/Los_Angeles.
Mcp
Optional<AllowedTools> allowedToolsList of allowed tool names or a filter object.
List of allowed tool names or a filter object.
class McpToolFilter:A filter object to specify which tools are allowed.
A filter object to specify which tools are allowed.
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.
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> connectorIdIdentifier for service connectors, like those available in ChatGPT. One of
server_url, connector_id, or tunnel_id must be provided. Learn more
about service connectors here.
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
Identifier for service connectors, like those available in ChatGPT. One of
server_url, connector_id, or tunnel_id must be provided. Learn more
about service connectors here.
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
Optional HTTP headers to send to the MCP server. Use for authentication or other purposes.
Optional<RequireApproval> requireApprovalSpecify which of the MCP server’s tools require approval.
Specify which of the MCP server’s tools require approval.
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.
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> alwaysA filter object to specify which tools are allowed.
A filter object to specify which tools are allowed.
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<Never> neverA filter object to specify which tools are allowed.
A filter object to specify which tools are allowed.
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 description of the MCP server, used to provide more context.
CodeInterpreter
Container containerThe 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.
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.
class CodeInterpreterToolAuto:Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.
Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.
Optional<NetworkPolicy> networkPolicyNetwork access policy for the container.
Network access policy for the container.
ImageGeneration
The type of the image generation tool. Always image_generation.
Optional<Background> backgroundAllows to set transparency for the background of the generated image(s).
This parameter is only supported for GPT image models that support
transparent backgrounds. Must be one of transparent, opaque, or
auto (default value). When auto is used, the model will
automatically determine the best background for the image.
gpt-image-2 and gpt-image-2-2026-04-21 do not support
transparent backgrounds. Requests with background set to
transparent will return an error for these models; use opaque or
auto instead.
If transparent, the output format needs to support transparency,
so it should be set to either png (default value) or webp.
Allows to set transparency for the background of the generated image(s).
This parameter is only supported for GPT image models that support
transparent backgrounds. Must be one of transparent, opaque, or
auto (default value). When auto is used, the model will
automatically determine the best background for the image.
gpt-image-2 and gpt-image-2-2026-04-21 do not support
transparent backgrounds. Requests with background set to
transparent will return an error for these models; use opaque or
auto instead.
If transparent, the output format needs to support transparency,
so it should be set to either png (default value) or webp.
Optional<InputFidelity> inputFidelityControl 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.
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.
Optional<InputImageMask> inputImageMaskOptional mask for inpainting. Contains image_url
(string, optional) and file_id (string, optional).
Optional mask for inpainting. Contains image_url
(string, optional) and file_id (string, optional).
Compression level for the output image. Default: 100.
Optional<OutputFormat> outputFormatThe output format of the generated image. One of png, webp, or
jpeg. Default: png.
The output format of the generated image. One of png, webp, or
jpeg. Default: png.
Number of partial images to generate in streaming mode, from 0 (default value) to 3.
Optional<Quality> qualityThe quality of the generated image. One of low, medium, high,
or auto. Default: auto.
The quality of the generated image. One of low, medium, high,
or auto. Default: auto.
Optional<Size> sizeThe size of the generated images. For gpt-image-2 and gpt-image-2-2026-04-21, arbitrary resolutions are supported as WIDTHxHEIGHT strings, for example 1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above 2560x1440 are experimental, and the maximum supported resolution is 3840x2160. The requested size must also satisfy the model’s current pixel and edge limits. The standard sizes 1024x1024, 1536x1024, and 1024x1536 are supported by the GPT image models; auto is supported for models that allow automatic sizing. For dall-e-2, use one of 256x256, 512x512, or 1024x1024. For dall-e-3, use one of 1024x1024, 1792x1024, or 1024x1792.
The size of the generated images. For gpt-image-2 and gpt-image-2-2026-04-21, arbitrary resolutions are supported as WIDTHxHEIGHT strings, for example 1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above 2560x1440 are experimental, and the maximum supported resolution is 3840x2160. The requested size must also satisfy the model’s current pixel and edge limits. The standard sizes 1024x1024, 1536x1024, and 1024x1536 are supported by the GPT image models; auto is supported for models that allow automatic sizing. For dall-e-2, use one of 256x256, 512x512, or 1024x1024. For dall-e-3, use one of 1024x1024, 1792x1024, or 1024x1792.
class BetaFunctionShellTool:A tool that allows the model to execute shell commands.
A tool that allows the model to execute shell commands.
Optional<Environment> environment
class BetaContainerAuto:
Automatically creates a container for this request
Optional<NetworkPolicy> networkPolicyNetwork access policy for the container.
Network access policy for the container.
Optional<List<Skill>> skillsAn optional list of skills referenced by id or inline data.
An optional list of skills referenced by id or inline data.
class BetaInlineSkill:
BetaInlineSkillSource sourceInline skill payload
Inline skill payload
class BetaCustomTool:A custom tool that processes input using a specified format. Learn more about custom tools
A custom tool that processes input using a specified format. Learn more about custom tools
class BetaNamespaceTool:Groups function/custom tools under a shared namespace.
Groups function/custom tools under a shared namespace.
List<Tool> toolsThe function/custom tools available inside this namespace.
The function/custom tools available inside this namespace.
class Function:
Whether this function should be deferred and discovered via tool search.
class BetaCustomTool:A custom tool that processes input using a specified format. Learn more about custom tools
A custom tool that processes input using a specified format. Learn more about custom tools
class BetaToolSearchTool:Hosted or BYOT tool search configuration for deferred tools.
Hosted or BYOT tool search configuration for deferred tools.
class BetaWebSearchPreviewTool:This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
Type typeThe type of the web search tool. One of web_search_preview or web_search_preview_2025_03_11.
The type of the web search tool. One of web_search_preview or web_search_preview_2025_03_11.
Optional<SearchContextSize> searchContextSizeHigh level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.
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.
Optional<UserLocation> userLocationThe user’s location.
The user’s location.
The type of location approximation. Always approximate.
The two-letter ISO country code of the user, e.g. US.
The IANA timezone of the user, e.g. America/Los_Angeles.
class BetaResponseReasoningItem: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.
A description of the chain of thought used by a reasoning model while generating
a response. Be sure to include these items in your input to the Responses API
for subsequent turns of a conversation if you are manually
managing context.
class BetaResponseCompactionItemParam:A compaction item generated by the v1/responses/compact API.
A compaction item generated by the v1/responses/compact API.
ImageGenerationCall
class BetaResponseCodeInterpreterToolCall:A tool call to run code.
A tool call to run code.
Optional<List<Output>> outputsThe outputs generated by the code interpreter, such as logs or images.
Can be null if no outputs are available.
The outputs generated by the code interpreter, such as logs or images. Can be null if no outputs are available.
Status statusThe status of the code interpreter tool call. Valid values are in_progress, completed, incomplete, interpreting, and failed.
The status of the code interpreter tool call. Valid values are in_progress, completed, incomplete, interpreting, and failed.
LocalShellCall
LocalShellCallOutput
ShellCall
The unique ID of the shell tool call. Populated when this item is returned via API.
ShellCallOutput
List<BetaResponseFunctionShellCallOutputContent> outputCaptured chunks of stdout and stderr output, along with their associated outcomes.
Captured chunks of stdout and stderr output, along with their associated outcomes.
The type of the item. Always shell_call_output.
The unique ID of the shell tool call output. Populated when this item is returned via API.
ApplyPatchCall
The unique ID of the apply patch tool call generated by the model.
Operation operationThe specific create, delete, or update instruction for the apply_patch tool call.
The specific create, delete, or update instruction for the apply_patch tool call.
The type of the item. Always apply_patch_call.
The unique ID of the apply patch tool call. Populated when this item is returned via API.
ApplyPatchCallOutput
The unique ID of the apply patch tool call generated by the model.
The type of the item. Always apply_patch_call_output.
The unique ID of the apply patch tool call output. Populated when this item is returned via API.
McpListTools
McpApprovalRequest
McpApprovalResponse
McpCall
class BetaResponseCustomToolCallOutput:The output of a custom tool call from your code, being sent back to the model.
The output of a custom tool call from your code, being sent back to the model.
Output outputThe output from the custom tool call generated by your code.
Can be a string or an list of output content.
The output from the custom tool call generated by your code. Can be a string or an list of output content.
List<BetaFunctionAndCustomToolCallOutput>
class BetaResponseInputText:A text input to the model.
A text input to the model.
The type of the input item. Always input_text.
class BetaResponseInputImage:An image input to the model. Learn about image inputs.
An image input to the model. Learn about image inputs.
Detail detailThe detail level of the image to be sent to the model. One of high, low, auto, or original. Defaults to auto.
The detail level of the image to be sent to the model. One of high, low, auto, or original. Defaults to auto.
The type of the input item. Always input_image.
The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.
class BetaResponseInputFile:A file input to the model.
A file input to the model.
The type of the input item. Always input_file.
Optional<Detail> detailThe detail level of the file to be sent to the model. Use auto to let the system select the detail level; for GPT-5.6 and later models, auto uses high-quality rendering, which may increase input token usage. Use low for lower-cost rendering, or high to render the file at higher quality. Defaults to auto.
The detail level of the file to be sent to the model. Use auto to let the system select the detail level; for GPT-5.6 and later models, auto uses high-quality rendering, which may increase input token usage. Use low for lower-cost rendering, or high to render the file at higher quality. Defaults to auto.
The type of the custom tool call output. Always custom_tool_call_output.
class BetaResponseCustomToolCall:A call to a custom tool created by the model.
A call to a custom tool created by the model.
A system (or developer) message inserted into the model’s context.
When used 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.
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.
A key to use when reading from or writing to the prompt cache.
Optional<PromptCacheOptions> promptCacheOptionsOptions for prompt caching. Supported for gpt-5.6 and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with prompt_cache_breakpoint. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set mode to explicit to disable the implicit breakpoint. The ttl defaults to 30m, which is currently the only supported value. See the prompt caching guide for current details.
Options for prompt caching. Supported for gpt-5.6 and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with prompt_cache_breakpoint. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set mode to explicit to disable the implicit breakpoint. The ttl defaults to 30m, which is currently the only supported value. See the prompt caching guide for current details.
Optional<Mode> modeControls whether OpenAI automatically creates an implicit cache breakpoint. Defaults to implicit. With implicit, OpenAI creates one implicit breakpoint and writes up to the latest three explicit breakpoints in the request. With explicit, OpenAI does not create an implicit breakpoint and writes up to the latest four explicit breakpoints. If there are no explicit breakpoints, the request does not use prompt caching.
Controls whether OpenAI automatically creates an implicit cache breakpoint. Defaults to implicit. With implicit, OpenAI creates one implicit breakpoint and writes up to the latest three explicit breakpoints in the request. With explicit, OpenAI does not create an implicit breakpoint and writes up to the latest four explicit breakpoints. If there are no explicit breakpoints, the request does not use prompt caching.
ReturnsExpand Collapse
class BetaCompactedResponse:
Unix timestamp (in seconds) when the compacted conversation was created.
The object type. Always response.compaction.
List<BetaResponseOutputItem> outputThe compacted list of output items. This is a list of all user messages, followed by a single compaction item.
The compacted list of output items. This is a list of all user messages, followed by a single compaction item.
class BetaResponseOutputMessage:An output message from the model.
An output message from the model.
List<Content> contentThe content of the output message.
The content of the output message.
class BetaResponseOutputText:A text output from the model.
A text output from the model.
List<Annotation> annotationsThe annotations of the text output.
The annotations of the text output.
class UrlCitation:A citation for a web resource used to generate a model response.
A citation for a web resource used to generate a model response.
The role of the output message. Always assistant.
Status statusThe status of the message input. One of in_progress, completed, or
incomplete. Populated when input items are returned via API.
The status of the message input. One of in_progress, completed, or
incomplete. Populated when input items are returned via API.
Optional<Phase> phaseLabels 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.
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.
class BetaResponseFileSearchToolCall:The results of a file search tool call. See the
file search guide for more information.
The results of a file search tool call. See the file search guide for more information.
Status statusThe status of the file search tool call. One of in_progress,
searching, incomplete or failed,
The status of the file search tool call. One of in_progress,
searching, incomplete or failed,
The type of the file search tool call. Always file_search_call.
Optional<List<Result>> resultsThe results of the file search tool call.
The results of the file search tool call.
Optional<Attributes> attributesSet 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.
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.
class BetaResponseFunctionToolCall:A tool call to run a function. See the
function calling guide for more information.
A tool call to run a function. See the function calling guide for more information.
class BetaResponseFunctionToolCallOutputItem:
Output outputThe output from the function call generated by your code.
Can be a string or an list of output content.
The output from the function call generated by your code. Can be a string or an list of output content.
List<BetaFunctionAndCustomToolCallOutput>
class BetaResponseInputText:A text input to the model.
A text input to the model.
The type of the input item. Always input_text.
class BetaResponseInputImage:An image input to the model. Learn about image inputs.
An image input to the model. Learn about image inputs.
Detail detailThe detail level of the image to be sent to the model. One of high, low, auto, or original. Defaults to auto.
The detail level of the image to be sent to the model. One of high, low, auto, or original. Defaults to auto.
The type of the input item. Always input_image.
The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.
class BetaResponseInputFile:A file input to the model.
A file input to the model.
The type of the input item. Always input_file.
Optional<Detail> detailThe detail level of the file to be sent to the model. Use auto to let the system select the detail level; for GPT-5.6 and later models, auto uses high-quality rendering, which may increase input token usage. Use low for lower-cost rendering, or high to render the file at higher quality. Defaults to auto.
The detail level of the file to be sent to the model. Use auto to let the system select the detail level; for GPT-5.6 and later models, auto uses high-quality rendering, which may increase input token usage. Use low for lower-cost rendering, or high to render the file at higher quality. Defaults to auto.
Status statusThe status of the item. One of in_progress, completed, or
incomplete. Populated when items are returned via API.
The status of the item. One of in_progress, completed, or
incomplete. Populated when items are returned via API.
The type of the function tool call output. Always function_call_output.
AgentMessage
List<Content> contentEncrypted content sent between agents.
Encrypted content sent between agents.
class BetaResponseInputText:A text input to the model.
A text input to the model.
The type of the input item. Always input_text.
class BetaResponseOutputText:A text output from the model.
A text output from the model.
List<Annotation> annotationsThe annotations of the text output.
The annotations of the text output.
class UrlCitation:A citation for a web resource used to generate a model response.
A citation for a web resource used to generate a model response.
class BetaResponseInputImage:An image input to the model. Learn about image inputs.
An image input to the model. Learn about image inputs.
Detail detailThe detail level of the image to be sent to the model. One of high, low, auto, or original. Defaults to auto.
The detail level of the image to be sent to the model. One of high, low, auto, or original. Defaults to auto.
The type of the input item. Always input_image.
The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.
class ComputerScreenshot:A screenshot of a computer.
A screenshot of a computer.
Detail detailThe detail level of the screenshot image to be sent to the model. One of high, low, auto, or original. Defaults to auto.
The detail level of the screenshot image to be sent to the model. One of high, low, auto, or original. Defaults to auto.
Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
class BetaResponseInputFile:A file input to the model.
A file input to the model.
The type of the input item. Always input_file.
Optional<Detail> detailThe detail level of the file to be sent to the model. Use auto to let the system select the detail level; for GPT-5.6 and later models, auto uses high-quality rendering, which may increase input token usage. Use low for lower-cost rendering, or high to render the file at higher quality. Defaults to auto.
The detail level of the file to be sent to the model. Use auto to let the system select the detail level; for GPT-5.6 and later models, auto uses high-quality rendering, which may increase input token usage. Use low for lower-cost rendering, or high to render the file at higher quality. Defaults to auto.
MultiAgentCall
MultiAgentCallOutput
List<BetaResponseOutputText> outputText output returned by the multi-agent action.
Text output returned by the multi-agent action.
List<Annotation> annotationsThe annotations of the text output.
The annotations of the text output.
class UrlCitation:A citation for a web resource used to generate a model response.
A citation for a web resource used to generate a model response.
class BetaResponseFunctionWebSearch:The results of a web search tool call. See the
web search guide for more information.
The results of a web search tool call. See the web search guide for more information.
Action actionAn 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).
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).
class BetaResponseComputerToolCall:A tool call to a computer use tool. See the
computer use guide for more information.
A tool call to a computer use tool. See the computer use guide for more information.
Status statusThe status of the item. One of in_progress, completed, or
incomplete. Populated when items are returned via API.
The status of the item. One of in_progress, completed, or
incomplete. Populated when items are returned via API.
A click action.
A click action.
Click
DoubleClick
Drag
Scroll
Flattened batched actions for computer_use. Each action includes an
type discriminator and action-specific fields.
Flattened batched actions for computer_use. Each action includes an
type discriminator and action-specific fields.
Click
DoubleClick
Drag
Scroll
class BetaResponseComputerToolCallOutputItem:
A computer screenshot image used with the computer use tool.
A computer screenshot image used with the computer use tool.
Status statusThe status of the message input. One of in_progress, completed, or
incomplete. Populated when input items are returned via API.
The status of the message input. One of in_progress, completed, or
incomplete. Populated when input items are returned via API.
The type of the computer tool call output. Always computer_call_output.
Optional<List<AcknowledgedSafetyCheck>> acknowledgedSafetyChecksThe safety checks reported by the API that have been acknowledged by the
developer.
The safety checks reported by the API that have been acknowledged by the developer.
class BetaResponseReasoningItem: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.
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.
ProgramOutput
class BetaResponseToolSearchCall:
The type of the item. Always tool_search_call.
class BetaResponseToolSearchOutputItem:
List<BetaTool> toolsThe loaded tool definitions returned by tool search.
The loaded tool definitions returned by tool search.
class BetaFunctionTool:Defines a function in your own code the model can choose to call. Learn more about function calling.
Defines a function in your own code the model can choose to call. Learn more about function calling.
class BetaFileSearchTool:A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
The type of the file search tool. Always file_search.
Optional<Filters> filtersA filter to apply.
A filter to apply.
class ComparisonFilter:A filter used to compare a specified attribute key to a given value using a defined comparison operation.
A filter used to compare a specified attribute key to a given value using a defined comparison operation.
class CompoundFilter:Combine multiple filters using and or or.
Combine multiple filters using and or or.
List<Filter> filtersArray of filters to combine. Items can be ComparisonFilter or CompoundFilter.
Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.
class ComparisonFilter:A filter used to compare a specified attribute key to a given value using a defined comparison operation.
A filter used to compare a specified attribute key to a given value using a defined comparison operation.
The maximum number of results to return. This number should be between 1 and 50 inclusive.
Optional<RankingOptions> rankingOptionsRanking options for search.
Ranking options for search.
class BetaComputerTool:A tool that controls a virtual computer. Learn more about the computer tool.
A tool that controls a virtual computer. Learn more about the computer tool.
class BetaComputerUsePreviewTool:A tool that controls a virtual computer. Learn more about the computer tool.
A tool that controls a virtual computer. Learn more about the computer tool.
class BetaWebSearchTool:Search the Internet for sources related to the prompt. Learn more about the
web search tool.
Search the Internet for sources related to the prompt. Learn more about the web search tool.
Optional<SearchContextSize> searchContextSizeHigh level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.
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.
Optional<UserLocation> userLocationThe approximate location of the user.
The approximate location of the user.
The two-letter ISO country code of the user, e.g. US.
The IANA timezone of the user, e.g. America/Los_Angeles.
Mcp
Optional<AllowedTools> allowedToolsList of allowed tool names or a filter object.
List of allowed tool names or a filter object.
class McpToolFilter:A filter object to specify which tools are allowed.
A filter object to specify which tools are allowed.
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.
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> connectorIdIdentifier for service connectors, like those available in ChatGPT. One of
server_url, connector_id, or tunnel_id must be provided. Learn more
about service connectors here.
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
Identifier for service connectors, like those available in ChatGPT. One of
server_url, connector_id, or tunnel_id must be provided. Learn more
about service connectors here.
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
Optional HTTP headers to send to the MCP server. Use for authentication or other purposes.
Optional<RequireApproval> requireApprovalSpecify which of the MCP server’s tools require approval.
Specify which of the MCP server’s tools require approval.
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.
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> alwaysA filter object to specify which tools are allowed.
A filter object to specify which tools are allowed.
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<Never> neverA filter object to specify which tools are allowed.
A filter object to specify which tools are allowed.
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 description of the MCP server, used to provide more context.
CodeInterpreter
Container containerThe 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.
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.
class CodeInterpreterToolAuto:Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.
Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.
Optional<NetworkPolicy> networkPolicyNetwork access policy for the container.
Network access policy for the container.
ImageGeneration
The type of the image generation tool. Always image_generation.
Optional<Background> backgroundAllows to set transparency for the background of the generated image(s).
This parameter is only supported for GPT image models that support
transparent backgrounds. Must be one of transparent, opaque, or
auto (default value). When auto is used, the model will
automatically determine the best background for the image.
gpt-image-2 and gpt-image-2-2026-04-21 do not support
transparent backgrounds. Requests with background set to
transparent will return an error for these models; use opaque or
auto instead.
If transparent, the output format needs to support transparency,
so it should be set to either png (default value) or webp.
Allows to set transparency for the background of the generated image(s).
This parameter is only supported for GPT image models that support
transparent backgrounds. Must be one of transparent, opaque, or
auto (default value). When auto is used, the model will
automatically determine the best background for the image.
gpt-image-2 and gpt-image-2-2026-04-21 do not support
transparent backgrounds. Requests with background set to
transparent will return an error for these models; use opaque or
auto instead.
If transparent, the output format needs to support transparency,
so it should be set to either png (default value) or webp.
Optional<InputFidelity> inputFidelityControl 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.
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.
Optional<InputImageMask> inputImageMaskOptional mask for inpainting. Contains image_url
(string, optional) and file_id (string, optional).
Optional mask for inpainting. Contains image_url
(string, optional) and file_id (string, optional).
Compression level for the output image. Default: 100.
Optional<OutputFormat> outputFormatThe output format of the generated image. One of png, webp, or
jpeg. Default: png.
The output format of the generated image. One of png, webp, or
jpeg. Default: png.
Number of partial images to generate in streaming mode, from 0 (default value) to 3.
Optional<Quality> qualityThe quality of the generated image. One of low, medium, high,
or auto. Default: auto.
The quality of the generated image. One of low, medium, high,
or auto. Default: auto.
Optional<Size> sizeThe size of the generated images. For gpt-image-2 and gpt-image-2-2026-04-21, arbitrary resolutions are supported as WIDTHxHEIGHT strings, for example 1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above 2560x1440 are experimental, and the maximum supported resolution is 3840x2160. The requested size must also satisfy the model’s current pixel and edge limits. The standard sizes 1024x1024, 1536x1024, and 1024x1536 are supported by the GPT image models; auto is supported for models that allow automatic sizing. For dall-e-2, use one of 256x256, 512x512, or 1024x1024. For dall-e-3, use one of 1024x1024, 1792x1024, or 1024x1792.
The size of the generated images. For gpt-image-2 and gpt-image-2-2026-04-21, arbitrary resolutions are supported as WIDTHxHEIGHT strings, for example 1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above 2560x1440 are experimental, and the maximum supported resolution is 3840x2160. The requested size must also satisfy the model’s current pixel and edge limits. The standard sizes 1024x1024, 1536x1024, and 1024x1536 are supported by the GPT image models; auto is supported for models that allow automatic sizing. For dall-e-2, use one of 256x256, 512x512, or 1024x1024. For dall-e-3, use one of 1024x1024, 1792x1024, or 1024x1792.
class BetaFunctionShellTool:A tool that allows the model to execute shell commands.
A tool that allows the model to execute shell commands.
Optional<Environment> environment
class BetaContainerAuto:
Automatically creates a container for this request
Optional<NetworkPolicy> networkPolicyNetwork access policy for the container.
Network access policy for the container.
Optional<List<Skill>> skillsAn optional list of skills referenced by id or inline data.
An optional list of skills referenced by id or inline data.
class BetaInlineSkill:
BetaInlineSkillSource sourceInline skill payload
Inline skill payload
class BetaCustomTool:A custom tool that processes input using a specified format. Learn more about custom tools
A custom tool that processes input using a specified format. Learn more about custom tools
class BetaNamespaceTool:Groups function/custom tools under a shared namespace.
Groups function/custom tools under a shared namespace.
List<Tool> toolsThe function/custom tools available inside this namespace.
The function/custom tools available inside this namespace.
class Function:
Whether this function should be deferred and discovered via tool search.
class BetaCustomTool:A custom tool that processes input using a specified format. Learn more about custom tools
A custom tool that processes input using a specified format. Learn more about custom tools
class BetaToolSearchTool:Hosted or BYOT tool search configuration for deferred tools.
Hosted or BYOT tool search configuration for deferred tools.
class BetaWebSearchPreviewTool:This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
Type typeThe type of the web search tool. One of web_search_preview or web_search_preview_2025_03_11.
The type of the web search tool. One of web_search_preview or web_search_preview_2025_03_11.
Optional<SearchContextSize> searchContextSizeHigh level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.
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.
Optional<UserLocation> userLocationThe user’s location.
The user’s location.
The type of location approximation. Always approximate.
The two-letter ISO country code of the user, e.g. US.
The IANA timezone of the user, e.g. America/Los_Angeles.
The type of the item. Always tool_search_output.
AdditionalTools
List<BetaTool> toolsThe additional tool definitions made available at this item.
The additional tool definitions made available at this item.
class BetaFunctionTool:Defines a function in your own code the model can choose to call. Learn more about function calling.
Defines a function in your own code the model can choose to call. Learn more about function calling.
class BetaFileSearchTool:A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
The type of the file search tool. Always file_search.
Optional<Filters> filtersA filter to apply.
A filter to apply.
class ComparisonFilter:A filter used to compare a specified attribute key to a given value using a defined comparison operation.
A filter used to compare a specified attribute key to a given value using a defined comparison operation.
class CompoundFilter:Combine multiple filters using and or or.
Combine multiple filters using and or or.
List<Filter> filtersArray of filters to combine. Items can be ComparisonFilter or CompoundFilter.
Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.
class ComparisonFilter:A filter used to compare a specified attribute key to a given value using a defined comparison operation.
A filter used to compare a specified attribute key to a given value using a defined comparison operation.
The maximum number of results to return. This number should be between 1 and 50 inclusive.
Optional<RankingOptions> rankingOptionsRanking options for search.
Ranking options for search.
class BetaComputerTool:A tool that controls a virtual computer. Learn more about the computer tool.
A tool that controls a virtual computer. Learn more about the computer tool.
class BetaComputerUsePreviewTool:A tool that controls a virtual computer. Learn more about the computer tool.
A tool that controls a virtual computer. Learn more about the computer tool.
class BetaWebSearchTool:Search the Internet for sources related to the prompt. Learn more about the
web search tool.
Search the Internet for sources related to the prompt. Learn more about the web search tool.
Optional<SearchContextSize> searchContextSizeHigh level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.
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.
Optional<UserLocation> userLocationThe approximate location of the user.
The approximate location of the user.
The two-letter ISO country code of the user, e.g. US.
The IANA timezone of the user, e.g. America/Los_Angeles.
Mcp
Optional<AllowedTools> allowedToolsList of allowed tool names or a filter object.
List of allowed tool names or a filter object.
class McpToolFilter:A filter object to specify which tools are allowed.
A filter object to specify which tools are allowed.
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.
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> connectorIdIdentifier for service connectors, like those available in ChatGPT. One of
server_url, connector_id, or tunnel_id must be provided. Learn more
about service connectors here.
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
Identifier for service connectors, like those available in ChatGPT. One of
server_url, connector_id, or tunnel_id must be provided. Learn more
about service connectors here.
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
Optional HTTP headers to send to the MCP server. Use for authentication or other purposes.
Optional<RequireApproval> requireApprovalSpecify which of the MCP server’s tools require approval.
Specify which of the MCP server’s tools require approval.
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.
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> alwaysA filter object to specify which tools are allowed.
A filter object to specify which tools are allowed.
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<Never> neverA filter object to specify which tools are allowed.
A filter object to specify which tools are allowed.
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 description of the MCP server, used to provide more context.
CodeInterpreter
Container containerThe 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.
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.
class CodeInterpreterToolAuto:Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.
Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.
Optional<NetworkPolicy> networkPolicyNetwork access policy for the container.
Network access policy for the container.
ImageGeneration
The type of the image generation tool. Always image_generation.
Optional<Background> backgroundAllows to set transparency for the background of the generated image(s).
This parameter is only supported for GPT image models that support
transparent backgrounds. Must be one of transparent, opaque, or
auto (default value). When auto is used, the model will
automatically determine the best background for the image.
gpt-image-2 and gpt-image-2-2026-04-21 do not support
transparent backgrounds. Requests with background set to
transparent will return an error for these models; use opaque or
auto instead.
If transparent, the output format needs to support transparency,
so it should be set to either png (default value) or webp.
Allows to set transparency for the background of the generated image(s).
This parameter is only supported for GPT image models that support
transparent backgrounds. Must be one of transparent, opaque, or
auto (default value). When auto is used, the model will
automatically determine the best background for the image.
gpt-image-2 and gpt-image-2-2026-04-21 do not support
transparent backgrounds. Requests with background set to
transparent will return an error for these models; use opaque or
auto instead.
If transparent, the output format needs to support transparency,
so it should be set to either png (default value) or webp.
Optional<InputFidelity> inputFidelityControl 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.
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.
Optional<InputImageMask> inputImageMaskOptional mask for inpainting. Contains image_url
(string, optional) and file_id (string, optional).
Optional mask for inpainting. Contains image_url
(string, optional) and file_id (string, optional).
Compression level for the output image. Default: 100.
Optional<OutputFormat> outputFormatThe output format of the generated image. One of png, webp, or
jpeg. Default: png.
The output format of the generated image. One of png, webp, or
jpeg. Default: png.
Number of partial images to generate in streaming mode, from 0 (default value) to 3.
Optional<Quality> qualityThe quality of the generated image. One of low, medium, high,
or auto. Default: auto.
The quality of the generated image. One of low, medium, high,
or auto. Default: auto.
Optional<Size> sizeThe size of the generated images. For gpt-image-2 and gpt-image-2-2026-04-21, arbitrary resolutions are supported as WIDTHxHEIGHT strings, for example 1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above 2560x1440 are experimental, and the maximum supported resolution is 3840x2160. The requested size must also satisfy the model’s current pixel and edge limits. The standard sizes 1024x1024, 1536x1024, and 1024x1536 are supported by the GPT image models; auto is supported for models that allow automatic sizing. For dall-e-2, use one of 256x256, 512x512, or 1024x1024. For dall-e-3, use one of 1024x1024, 1792x1024, or 1024x1792.
The size of the generated images. For gpt-image-2 and gpt-image-2-2026-04-21, arbitrary resolutions are supported as WIDTHxHEIGHT strings, for example 1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above 2560x1440 are experimental, and the maximum supported resolution is 3840x2160. The requested size must also satisfy the model’s current pixel and edge limits. The standard sizes 1024x1024, 1536x1024, and 1024x1536 are supported by the GPT image models; auto is supported for models that allow automatic sizing. For dall-e-2, use one of 256x256, 512x512, or 1024x1024. For dall-e-3, use one of 1024x1024, 1792x1024, or 1024x1792.
class BetaFunctionShellTool:A tool that allows the model to execute shell commands.
A tool that allows the model to execute shell commands.
Optional<Environment> environment
class BetaContainerAuto:
Automatically creates a container for this request
Optional<NetworkPolicy> networkPolicyNetwork access policy for the container.
Network access policy for the container.
Optional<List<Skill>> skillsAn optional list of skills referenced by id or inline data.
An optional list of skills referenced by id or inline data.
class BetaInlineSkill:
BetaInlineSkillSource sourceInline skill payload
Inline skill payload
class BetaCustomTool:A custom tool that processes input using a specified format. Learn more about custom tools
A custom tool that processes input using a specified format. Learn more about custom tools
class BetaNamespaceTool:Groups function/custom tools under a shared namespace.
Groups function/custom tools under a shared namespace.
List<Tool> toolsThe function/custom tools available inside this namespace.
The function/custom tools available inside this namespace.
class Function:
Whether this function should be deferred and discovered via tool search.
class BetaCustomTool:A custom tool that processes input using a specified format. Learn more about custom tools
A custom tool that processes input using a specified format. Learn more about custom tools
class BetaToolSearchTool:Hosted or BYOT tool search configuration for deferred tools.
Hosted or BYOT tool search configuration for deferred tools.
class BetaWebSearchPreviewTool:This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
Type typeThe type of the web search tool. One of web_search_preview or web_search_preview_2025_03_11.
The type of the web search tool. One of web_search_preview or web_search_preview_2025_03_11.
Optional<SearchContextSize> searchContextSizeHigh level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.
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.
Optional<UserLocation> userLocationThe user’s location.
The user’s location.
The type of location approximation. Always approximate.
The two-letter ISO country code of the user, e.g. US.
The IANA timezone of the user, e.g. America/Los_Angeles.
class BetaResponseCompactionItem:A compaction item generated by the v1/responses/compact API.
A compaction item generated by the v1/responses/compact API.
ImageGenerationCall
class BetaResponseCodeInterpreterToolCall:A tool call to run code.
A tool call to run code.
Optional<List<Output>> outputsThe outputs generated by the code interpreter, such as logs or images.
Can be null if no outputs are available.
The outputs generated by the code interpreter, such as logs or images. Can be null if no outputs are available.
Status statusThe status of the code interpreter tool call. Valid values are in_progress, completed, incomplete, interpreting, and failed.
The status of the code interpreter tool call. Valid values are in_progress, completed, incomplete, interpreting, and failed.
LocalShellCall
LocalShellCallOutput
class BetaResponseFunctionShellToolCall:A tool call that executes one or more shell commands in a managed environment.
A tool call that executes one or more shell commands in a managed environment.
Optional<Environment> environmentRepresents the use of a local environment to perform shell actions.
Represents the use of a local environment to perform shell actions.
class BetaResponseFunctionShellToolCallOutput:The output of a shell tool call that was emitted.
The output of a shell tool call that was emitted.
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> outputAn array of shell call output contents
An array of shell call output contents
The type of the shell call output. Always shell_call_output.
class BetaResponseApplyPatchToolCall:A tool call that applies file diffs by creating, deleting, or updating files.
A tool call that applies file diffs by creating, deleting, or updating files.
Operation operationOne of the create_file, delete_file, or update_file operations applied via apply_patch.
One of the create_file, delete_file, or update_file operations applied via apply_patch.
The type of the item. Always apply_patch_call.
class BetaResponseApplyPatchToolCallOutput:The output emitted by an apply patch tool call.
The output emitted by an apply patch tool call.
The unique ID of the apply patch tool call output. Populated when this item is returned via API.
The type of the item. Always apply_patch_call_output.
McpCall
McpListTools
McpApprovalRequest
McpApprovalResponse
class BetaResponseCustomToolCall:A call to a custom tool created by the model.
A call to a custom tool created by the model.
BetaResponseUsage usageToken accounting for the compaction pass, including cached, reasoning, and total tokens.
Token accounting for the compaction pass, including cached, reasoning, and total tokens.
InputTokensDetails inputTokensDetailsA detailed breakdown of the input tokens.
A detailed breakdown of the input tokens.
The number of tokens that were retrieved from the cache. More on prompt caching.
Compact a response
package com.openai.example;
import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.beta.responses.BetaCompactedResponse;
import com.openai.models.beta.responses.ResponseCompactParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
OpenAIClient client = OpenAIOkHttpClient.fromEnv();
ResponseCompactParams params = ResponseCompactParams.builder()
.model(ResponseCompactParams.Model.GPT_5_6_SOL)
.build();
BetaCompactedResponse betaCompactedResponse = client.beta().responses().compact(params);
}
}{
"id": "resp_001",
"object": "response.compaction",
"created_at": 1764967971,
"output": [
{
"id": "msg_000",
"type": "message",
"status": "completed",
"content": [
{
"type": "input_text",
"text": "Create a simple landing page for a dog petting cafe."
}
],
"role": "user"
},
{
"id": "cmp_001",
"type": "compaction",
"encrypted_content": "gAAAAABpM0Yj-...="
}
],
"usage": {
"input_tokens": 139,
"input_tokens_details": {
"cached_tokens": 0,
"cache_write_tokens": 0
},
"output_tokens": 438,
"output_tokens_details": {
"reasoning_tokens": 64
},
"total_tokens": 577
}
}
Returns Examples
{
"id": "resp_001",
"object": "response.compaction",
"created_at": 1764967971,
"output": [
{
"id": "msg_000",
"type": "message",
"status": "completed",
"content": [
{
"type": "input_text",
"text": "Create a simple landing page for a dog petting cafe."
}
],
"role": "user"
},
{
"id": "cmp_001",
"type": "compaction",
"encrypted_content": "gAAAAABpM0Yj-...="
}
],
"usage": {
"input_tokens": 139,
"input_tokens_details": {
"cached_tokens": 0,
"cache_write_tokens": 0
},
"output_tokens": 438,
"output_tokens_details": {
"reasoning_tokens": 64
},
"total_tokens": 577
}
}