Responses

Create a model response

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

post /responses

Creates a model response. Provide text or image inputs to generate text or JSON outputs. Have the model call your own custom code or use built-in tools like web search or file search to use your own data as input for the model's response.

Parameters

ResponseCreateParams params
- 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.
- 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.
  - 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).
  - 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
  - String
  - List<ResponseInputItem>
    - 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.
        
        String
        
        List<ResponseInputContent>
        
        class ResponseInputText:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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.
        
        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.
        
        COMMENTARY("commentary")
        
        FINAL_ANSWER("final_answer")
      - Optional<Type> type
        
        The type of the message input. Always message.
        
        MESSAGE("message")
    - Message
      - List<ResponseInputContent> content
        
        A list of one or many input items to the model, containing different content types.
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
      - Role role
        
        The role of the message input. One of user, system, or developer.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - Optional<Type> type
        
        The type of the message input. Always set to message.
        
        MESSAGE("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.
        
        class ResponseOutputText:
        
        A text output from the model.
        
        List<Annotation> annotations
        
        The annotations of the text output.
        
        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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
        
        String text
        
        The text output from the model.
        
        JsonValue; type "output_text"constant
        
        The type of the output text. Always output_text.
        
        OUTPUT_TEXT("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
        
        The type of the refusal. Always refusal.
        
        REFUSAL("refusal")
      - JsonValue; role "assistant"constant
        
        The role of the output message. Always assistant.
        
        ASSISTANT("assistant")
      - Status status
        
        The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "message"constant
        
        The type of the output message. Always message.
        
        MESSAGE("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.
        
        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,
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        FAILED("failed")
      - JsonValue; type "file_search_call"constant
        
        The type of the file search tool call. Always file_search_call.
        
        FILE_SEARCH_CALL("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.
        
        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.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - Type type
        
        The type of the computer call. Always computer_call.
        
        COMPUTER_CALL("computer_call")
      - Optional<Action> action
        
        A click action.
        
        class Click:
        
        A click action.
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        class Move:
        
        A mouse move action.
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        class Scroll:
        
        A scroll action.
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
      - Optional<List<ComputerAction>> actions
        
        Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.
        
        Click
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        Move
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        Scroll
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
    - ComputerCallOutput
      - 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.
        
        JsonValue; type "computer_screenshot"constant
        
        Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
        
        COMPUTER_SCREENSHOT("computer_screenshot")
        
        Optional<String> fileId
        
        The identifier of an uploaded file that contains the screenshot.
        
        Optional<String> imageUrl
        
        The URL of the screenshot image.
      - JsonValue; type "computer_call_output"constant
        
        The type of the computer tool call output. Always computer_call_output.
        
        COMPUTER_CALL_OUTPUT("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.
        
        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).
        
        class Search:
        
        Action type "search" - Performs a web search query.
        
        String query
        
        [DEPRECATED] The search query.
        
        JsonValue; type "search"constant
        
        The action type.
        
        SEARCH("search")
        
        Optional<List<String>> queries
        
        The search queries.
        
        Optional<List<Source>> sources
        
        The sources used in the search.
        
        JsonValue; type "url"constant
        
        The type of source. Always url.
        
        URL("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
        
        The action type.
        
        OPEN_PAGE("open_page")
        
        Optional<String> url
        
        The URL opened by the model.
        
        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
        
        The action type.
        
        FIND_IN_PAGE("find_in_page")
        
        String url
        
        The URL of the page searched for the pattern.
      - Status status
        
        The status of the web search tool call.
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        FAILED("failed")
      - JsonValue; type "web_search_call"constant
        
        The type of the web search tool call. Always web_search_call.
        
        WEB_SEARCH_CALL("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
        
        The type of the function tool call. Always function_call.
        
        FUNCTION_CALL("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - FunctionCallOutput
      - String callId
        
        The unique ID of the function tool call generated by the model.
      - Output output
        
        Text, image, or file output of the function tool call.
        
        String
        
        List<ResponseFunctionCallOutputItem>
        
        class ResponseInputTextContent:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("input_text")
        
        class ResponseInputImageContent:
        
        An image input to the model. Learn about image inputs
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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.
        
        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.
        
        class ResponseInputFileContent:
        
        A file input to the model.
        
        JsonValue; type "input_file"constant
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        LOW("low")
        
        HIGH("high")
        
        Optional<String> fileData
        
        The base64-encoded data 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 "function_call_output"constant
        
        The type of the function tool call output. Always function_call_output.
        
        FUNCTION_CALL_OUTPUT("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.
        
        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
        
        The item type. Always tool_search_call.
        
        TOOL_SEARCH_CALL("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.
      - Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
      - Optional<Status> status
        
        The status of the tool search call.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - class ResponseToolSearchOutputItemParam:
      - List<Tool> tools
        
        The loaded tool definitions returned by the tool search output.
        
        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
        
        The type of the function tool. Always function.
        
        FUNCTION("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
        
        The type of the file search tool. Always file_search.
        
        FILE_SEARCH("file_search")
        
        List<String> vectorStoreIds
        
        The IDs of the vector stores to search.
        
        Optional<Filters> filters
        
        A filter to apply.
        
        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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
        
        Type type
        
        Type of operation: and or or.
        
        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.
        
        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
        
        The type of the computer tool. Always computer.
        
        COMPUTER("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.
        
        WINDOWS("windows")
        
        MAC("mac")
        
        LINUX("linux")
        
        UBUNTU("ubuntu")
        
        BROWSER("browser")
        
        JsonValue; type "computer_use_preview"constant
        
        The type of the computer use tool. Always computer_use_preview.
        
        COMPUTER_USE_PREVIEW("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.
        
        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.
        
        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.
        
        APPROXIMATE("approximate")
        
        Mcp
        
        String serverLabel
        
        A label for this MCP server, used to identify it in tool calls.
        
        JsonValue; type "mcp"constant
        
        The type of the MCP tool. Always mcp.
        
        MCP("mcp")
        
        Optional<AllowedTools> allowedTools
        
        List of allowed tool names or a filter object.
        
        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
        
        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.
        
        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.
        
        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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
        
        JsonValue; type "code_interpreter"constant
        
        The type of the code interpreter tool. Always code_interpreter.
        
        CODE_INTERPRETER("code_interpreter")
        
        ImageGeneration
        
        JsonValue; type "image_generation"constant
        
        The type of the image generation tool. Always image_generation.
        
        IMAGE_GENERATION("image_generation")
        
        Optional<Action> action
        
        Whether to generate a new image or edit an existing image. Default: auto.
        
        GENERATE("generate")
        
        EDIT("edit")
        
        AUTO("auto")
        
        Optional<Background> background
        
        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.
        
        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.
        
        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.
        
        GPT_IMAGE_1("gpt-image-1")
        
        GPT_IMAGE_1_MINI("gpt-image-1-mini")
        
        GPT_IMAGE_2("gpt-image-2")
        
        GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
        
        GPT_IMAGE_1_5("gpt-image-1.5")
        
        CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
        
        Optional<Moderation> moderation
        
        Moderation level for the generated image. Default: auto.
        
        AUTO("auto")
        
        LOW("low")
        
        Optional<Long> outputCompression
        
        Compression level for the output image. Default: 100.
        
        Optional<OutputFormat> outputFormat
        
        The output format of the generated image. One of png, webp, or jpeg. Default: png.
        
        PNG("png")
        
        WEBP("webp")
        
        JPEG("jpeg")
        
        Optional<Long> partialImages
        
        Number of partial images to generate in streaming mode, from 0 (default value) to 3.
        
        Optional<Quality> quality
        
        The quality of the generated image. One of low, medium, high, or auto. Default: auto.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        AUTO("auto")
        
        Optional<Size> size
        
        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.
        
        _1024X1024("1024x1024")
        
        _1024X1536("1024x1536")
        
        _1536X1024("1536x1024")
        
        AUTO("auto")
        
        JsonValue;
        
        JsonValue; type "local_shell"constant
        
        The type of the local shell tool. Always local_shell.
        
        LOCAL_SHELL("local_shell")
        
        class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        JsonValue; type "shell"constant
        
        The type of the shell tool. Always shell.
        
        SHELL("shell")
        
        Optional<Environment> environment
        
        class ContainerAuto:
        
        JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
        
        Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
        
        class LocalEnvironment:
        
        JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
        
        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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
        
        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
        
        The type of the custom tool. Always custom.
        
        CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
        
        Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
        
        class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        String description
        
        A description of the namespace shown to the model.
        
        String name
        
        The namespace name used in tool calls (for example, crm).
        
        List<Tool> tools
        
        The function/custom tools available inside this namespace.
        
        class Function:
        
        String name
        
        JsonValue; type "function"constant
        
        FUNCTION("function")
        
        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
        
        JsonValue; type "namespace"constant
        
        The type of the tool. Always namespace.
        
        NAMESPACE("namespace")
        
        class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        JsonValue; type "tool_search"constant
        
        The type of the tool. Always tool_search.
        
        TOOL_SEARCH("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.
        
        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.
        
        WEB_SEARCH_PREVIEW("web_search_preview")
        
        WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
        
        Optional<List<SearchContentType>> searchContentTypes
        
        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.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        Optional<UserLocation> userLocation
        
        The user's location.
        
        JsonValue; type "approximate"constant
        
        The type of location approximation. Always approximate.
        
        APPROXIMATE("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
        
        The type of the tool. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
      - JsonValue; type "tool_search_output"constant
        
        The item type. Always tool_search_output.
        
        TOOL_SEARCH_OUTPUT("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.
      - Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
      - Optional<Status> status
        
        The status of the tool search output.
        
        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
        
        The type of the object. Always summary_text.
        
        SUMMARY_TEXT("summary_text")
      - JsonValue; type "reasoning"constant
        
        The type of the object. Always reasoning.
        
        REASONING("reasoning")
      - Optional<List<Content>> content
        
        Reasoning text content.
        
        String text
        
        The reasoning text from the model.
        
        JsonValue; type "reasoning_text"constant
        
        The type of the reasoning text. Always reasoning_text.
        
        REASONING_TEXT("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.
        
        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.
      - JsonValue; type "compaction"constant
        
        The type of the item. Always compaction.
        
        COMPACTION("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        GENERATING("generating")
        
        FAILED("failed")
      - JsonValue; type "image_generation_call"constant
        
        The type of the image generation call. Always image_generation_call.
        
        IMAGE_GENERATION_CALL("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.
        
        class Logs:
        
        The logs output from the code interpreter.
        
        String logs
        
        The logs output from the code interpreter.
        
        JsonValue; type "logs"constant
        
        The type of the output. Always logs.
        
        LOGS("logs")
        
        class Image:
        
        The image output from the code interpreter.
        
        JsonValue; type "image"constant
        
        The type of the output. Always image.
        
        IMAGE("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        INTERPRETING("interpreting")
        
        FAILED("failed")
      - JsonValue; type "code_interpreter_call"constant
        
        The type of the code interpreter tool call. Always code_interpreter_call.
        
        CODE_INTERPRETER_CALL("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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "local_shell_call"constant
        
        The type of the local shell call. Always local_shell_call.
        
        LOCAL_SHELL_CALL("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
        
        The type of the local shell tool call output. Always local_shell_call_output.
        
        LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
      - Optional<Status> status
        
        The status of the item. One of in_progress, completed, or incomplete.
        
        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.
      - JsonValue; type "shell_call"constant
        
        The type of the item. Always shell_call.
        
        SHELL_CALL("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.
        
        class LocalEnvironment:
        
        class ContainerReference:
      - Optional<Status> status
        
        The status of the shell call. One of in_progress, completed, or incomplete.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - ShellCallOutput
      - String callId
        
        The unique ID of the shell tool call generated by the model.
      - 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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("exit")
        
        String stderr
        
        Captured stderr output for the shell call.
        
        String stdout
        
        Captured stdout output for the shell call.
      - JsonValue; type "shell_call_output"constant
        
        The type of the item. Always shell_call_output.
        
        SHELL_CALL_OUTPUT("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - ApplyPatchCall
      - String callId
        
        The unique ID of the apply patch tool call generated by the model.
      - Operation operation
        
        The specific create, delete, or update instruction for the apply_patch tool call.
        
        class CreateFile:
        
        Instruction for creating a new file via the apply_patch tool.
        
        String diff
        
        Unified diff content to apply when creating the file.
        
        String path
        
        Path of the file to create relative to the workspace root.
        
        JsonValue; type "create_file"constant
        
        The operation type. Always create_file.
        
        CREATE_FILE("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.
        
        JsonValue; type "delete_file"constant
        
        The operation type. Always delete_file.
        
        DELETE_FILE("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.
        
        String path
        
        Path of the file to update relative to the workspace root.
        
        JsonValue; type "update_file"constant
        
        The operation type. Always update_file.
        
        UPDATE_FILE("update_file")
      - Status status
        
        The status of the apply patch tool call. One of in_progress or completed.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
      - JsonValue; type "apply_patch_call"constant
        
        The type of the item. Always apply_patch_call.
        
        APPLY_PATCH_CALL("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.
      - Status status
        
        The status of the apply patch tool call output. One of completed or failed.
        
        COMPLETED("completed")
        
        FAILED("failed")
      - JsonValue; type "apply_patch_call_output"constant
        
        The type of the item. Always apply_patch_call_output.
        
        APPLY_PATCH_CALL_OUTPUT("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).
    - 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
        
        The type of the item. Always mcp_list_tools.
        
        MCP_LIST_TOOLS("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
        
        The type of the item. Always mcp_approval_request.
        
        MCP_APPROVAL_REQUEST("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
        
        The type of the item. Always mcp_approval_response.
        
        MCP_APPROVAL_RESPONSE("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
        
        The type of the item. Always mcp_call.
        
        MCP_CALL("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.
        
        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.
        
        String
        
        List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
      - JsonValue; type "custom_tool_call_output"constant
        
        The type of the custom tool call output. Always custom_tool_call_output.
        
        CUSTOM_TOOL_CALL_OUTPUT("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
        
        The type of the custom tool call. Always custom_tool_call.
        
        CUSTOM_TOOL_CALL("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.
    - JsonValue;
      - JsonValue; type "compaction_trigger"constant
        
        The type of the item. Always compaction_trigger.
        
        COMPACTION_TRIGGER("compaction_trigger")
    - ItemReference
      - String id
        
        The ID of the item to reference.
      - Optional<Type> type
        
        The type of item to reference. Always item_reference.
        
        ITEM_REFERENCE("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.
- 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.
  - 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.
- 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.
  - 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<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.
- 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.
  - 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.
      - 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 tool configuration type. Always allowed_tools.
      - ALLOWED_TOOLS("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
      - 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
      
      For function calling, the type is always function.
      - FUNCTION("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
      
      For MCP tools, the type is always mcp.
      - MCP("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
      
      For custom tool calling, the type is always custom.
      - CUSTOM("custom")
  - class ToolChoiceApplyPatch:
    
    Forces the model to call the apply_patch tool when executing a tool call.
    - JsonValue; type "apply_patch"constant
      
      The tool to call. Always apply_patch.
      - APPLY_PATCH("apply_patch")
  - class ToolChoiceShell:
    
    Forces the model to call the shell tool when a tool call is required.
    - JsonValue; type "shell"constant
      
      The tool to call. Always shell.
      - SHELL("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.
  - class FunctionTool:
    
    Defines a function in your own code the model can choose to call. Learn more about function calling.
  - class FileSearchTool:
    
    A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
  - class ComputerTool:
    
    A tool that controls a virtual computer. Learn more about the computer tool.
  - class ComputerUsePreviewTool:
    
    A tool that controls a virtual computer. Learn more about the computer tool.
  - class WebSearchTool:
    
    Search the Internet for sources related to the prompt. Learn more about the web search tool.
  - Mcp
  - CodeInterpreter
  - ImageGeneration
  - JsonValue;
  - class FunctionShellTool:
    
    A tool that allows the model to execute shell commands.
  - class CustomTool:
    
    A custom tool that processes input using a specified format. Learn more about custom tools
  - class NamespaceTool:
    
    Groups function/custom tools under a shared namespace.
  - class ToolSearchTool:
    
    Hosted or BYOT tool search configuration for deferred tools.
  - class WebSearchPreviewTool:
    
    This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
  - class ApplyPatchTool:
    
    Allows the assistant to create, delete, or update files using unified diffs.
- Optional<Long> topLogprobs
  
  An integer between 0 and 20 specifying the maximum number of most likely tokens to return at each token position, each with an associated log probability. In some cases, the number of returned tokens may be fewer than requested.
- 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.
- 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.
  - AUTO("auto")
  - DISABLED("disabled")
- Optional<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.

Returns

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.
  - Code code
    
    The error code for the response.
    - 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.
- Optional<IncompleteDetails> incompleteDetails
  
  Details about why the response is incomplete.
  - Optional<Reason> reason
    
    The reason why the response is incomplete.
    - 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.
  - String
  - List<ResponseInputItem>
    - 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.
        
        String
        
        List<ResponseInputContent>
        
        class ResponseInputText:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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.
        
        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.
        
        COMMENTARY("commentary")
        
        FINAL_ANSWER("final_answer")
      - Optional<Type> type
        
        The type of the message input. Always message.
        
        MESSAGE("message")
    - Message
      - List<ResponseInputContent> content
        
        A list of one or many input items to the model, containing different content types.
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
      - Role role
        
        The role of the message input. One of user, system, or developer.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - Optional<Type> type
        
        The type of the message input. Always set to message.
        
        MESSAGE("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.
        
        class ResponseOutputText:
        
        A text output from the model.
        
        List<Annotation> annotations
        
        The annotations of the text output.
        
        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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
        
        String text
        
        The text output from the model.
        
        JsonValue; type "output_text"constant
        
        The type of the output text. Always output_text.
        
        OUTPUT_TEXT("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
        
        The type of the refusal. Always refusal.
        
        REFUSAL("refusal")
      - JsonValue; role "assistant"constant
        
        The role of the output message. Always assistant.
        
        ASSISTANT("assistant")
      - Status status
        
        The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "message"constant
        
        The type of the output message. Always message.
        
        MESSAGE("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.
        
        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,
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        FAILED("failed")
      - JsonValue; type "file_search_call"constant
        
        The type of the file search tool call. Always file_search_call.
        
        FILE_SEARCH_CALL("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.
        
        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.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - Type type
        
        The type of the computer call. Always computer_call.
        
        COMPUTER_CALL("computer_call")
      - Optional<Action> action
        
        A click action.
        
        class Click:
        
        A click action.
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        class Move:
        
        A mouse move action.
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        class Scroll:
        
        A scroll action.
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
      - Optional<List<ComputerAction>> actions
        
        Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.
        
        Click
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        Move
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        Scroll
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
    - ComputerCallOutput
      - 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.
        
        JsonValue; type "computer_screenshot"constant
        
        Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
        
        COMPUTER_SCREENSHOT("computer_screenshot")
        
        Optional<String> fileId
        
        The identifier of an uploaded file that contains the screenshot.
        
        Optional<String> imageUrl
        
        The URL of the screenshot image.
      - JsonValue; type "computer_call_output"constant
        
        The type of the computer tool call output. Always computer_call_output.
        
        COMPUTER_CALL_OUTPUT("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.
        
        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).
        
        class Search:
        
        Action type "search" - Performs a web search query.
        
        String query
        
        [DEPRECATED] The search query.
        
        JsonValue; type "search"constant
        
        The action type.
        
        SEARCH("search")
        
        Optional<List<String>> queries
        
        The search queries.
        
        Optional<List<Source>> sources
        
        The sources used in the search.
        
        JsonValue; type "url"constant
        
        The type of source. Always url.
        
        URL("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
        
        The action type.
        
        OPEN_PAGE("open_page")
        
        Optional<String> url
        
        The URL opened by the model.
        
        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
        
        The action type.
        
        FIND_IN_PAGE("find_in_page")
        
        String url
        
        The URL of the page searched for the pattern.
      - Status status
        
        The status of the web search tool call.
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        FAILED("failed")
      - JsonValue; type "web_search_call"constant
        
        The type of the web search tool call. Always web_search_call.
        
        WEB_SEARCH_CALL("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
        
        The type of the function tool call. Always function_call.
        
        FUNCTION_CALL("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - FunctionCallOutput
      - String callId
        
        The unique ID of the function tool call generated by the model.
      - Output output
        
        Text, image, or file output of the function tool call.
        
        String
        
        List<ResponseFunctionCallOutputItem>
        
        class ResponseInputTextContent:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("input_text")
        
        class ResponseInputImageContent:
        
        An image input to the model. Learn about image inputs
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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.
        
        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.
        
        class ResponseInputFileContent:
        
        A file input to the model.
        
        JsonValue; type "input_file"constant
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        LOW("low")
        
        HIGH("high")
        
        Optional<String> fileData
        
        The base64-encoded data 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 "function_call_output"constant
        
        The type of the function tool call output. Always function_call_output.
        
        FUNCTION_CALL_OUTPUT("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.
        
        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
        
        The item type. Always tool_search_call.
        
        TOOL_SEARCH_CALL("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.
      - Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
      - Optional<Status> status
        
        The status of the tool search call.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - class ResponseToolSearchOutputItemParam:
      - List<Tool> tools
        
        The loaded tool definitions returned by the tool search output.
        
        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
        
        The type of the function tool. Always function.
        
        FUNCTION("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
        
        The type of the file search tool. Always file_search.
        
        FILE_SEARCH("file_search")
        
        List<String> vectorStoreIds
        
        The IDs of the vector stores to search.
        
        Optional<Filters> filters
        
        A filter to apply.
        
        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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
        
        Type type
        
        Type of operation: and or or.
        
        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.
        
        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
        
        The type of the computer tool. Always computer.
        
        COMPUTER("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.
        
        WINDOWS("windows")
        
        MAC("mac")
        
        LINUX("linux")
        
        UBUNTU("ubuntu")
        
        BROWSER("browser")
        
        JsonValue; type "computer_use_preview"constant
        
        The type of the computer use tool. Always computer_use_preview.
        
        COMPUTER_USE_PREVIEW("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.
        
        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.
        
        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.
        
        APPROXIMATE("approximate")
        
        Mcp
        
        String serverLabel
        
        A label for this MCP server, used to identify it in tool calls.
        
        JsonValue; type "mcp"constant
        
        The type of the MCP tool. Always mcp.
        
        MCP("mcp")
        
        Optional<AllowedTools> allowedTools
        
        List of allowed tool names or a filter object.
        
        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
        
        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.
        
        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.
        
        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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
        
        JsonValue; type "code_interpreter"constant
        
        The type of the code interpreter tool. Always code_interpreter.
        
        CODE_INTERPRETER("code_interpreter")
        
        ImageGeneration
        
        JsonValue; type "image_generation"constant
        
        The type of the image generation tool. Always image_generation.
        
        IMAGE_GENERATION("image_generation")
        
        Optional<Action> action
        
        Whether to generate a new image or edit an existing image. Default: auto.
        
        GENERATE("generate")
        
        EDIT("edit")
        
        AUTO("auto")
        
        Optional<Background> background
        
        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.
        
        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.
        
        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.
        
        GPT_IMAGE_1("gpt-image-1")
        
        GPT_IMAGE_1_MINI("gpt-image-1-mini")
        
        GPT_IMAGE_2("gpt-image-2")
        
        GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
        
        GPT_IMAGE_1_5("gpt-image-1.5")
        
        CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
        
        Optional<Moderation> moderation
        
        Moderation level for the generated image. Default: auto.
        
        AUTO("auto")
        
        LOW("low")
        
        Optional<Long> outputCompression
        
        Compression level for the output image. Default: 100.
        
        Optional<OutputFormat> outputFormat
        
        The output format of the generated image. One of png, webp, or jpeg. Default: png.
        
        PNG("png")
        
        WEBP("webp")
        
        JPEG("jpeg")
        
        Optional<Long> partialImages
        
        Number of partial images to generate in streaming mode, from 0 (default value) to 3.
        
        Optional<Quality> quality
        
        The quality of the generated image. One of low, medium, high, or auto. Default: auto.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        AUTO("auto")
        
        Optional<Size> size
        
        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.
        
        _1024X1024("1024x1024")
        
        _1024X1536("1024x1536")
        
        _1536X1024("1536x1024")
        
        AUTO("auto")
        
        JsonValue;
        
        JsonValue; type "local_shell"constant
        
        The type of the local shell tool. Always local_shell.
        
        LOCAL_SHELL("local_shell")
        
        class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        JsonValue; type "shell"constant
        
        The type of the shell tool. Always shell.
        
        SHELL("shell")
        
        Optional<Environment> environment
        
        class ContainerAuto:
        
        JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
        
        Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
        
        class LocalEnvironment:
        
        JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
        
        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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
        
        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
        
        The type of the custom tool. Always custom.
        
        CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
        
        Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
        
        class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        String description
        
        A description of the namespace shown to the model.
        
        String name
        
        The namespace name used in tool calls (for example, crm).
        
        List<Tool> tools
        
        The function/custom tools available inside this namespace.
        
        class Function:
        
        String name
        
        JsonValue; type "function"constant
        
        FUNCTION("function")
        
        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
        
        JsonValue; type "namespace"constant
        
        The type of the tool. Always namespace.
        
        NAMESPACE("namespace")
        
        class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        JsonValue; type "tool_search"constant
        
        The type of the tool. Always tool_search.
        
        TOOL_SEARCH("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.
        
        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.
        
        WEB_SEARCH_PREVIEW("web_search_preview")
        
        WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
        
        Optional<List<SearchContentType>> searchContentTypes
        
        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.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        Optional<UserLocation> userLocation
        
        The user's location.
        
        JsonValue; type "approximate"constant
        
        The type of location approximation. Always approximate.
        
        APPROXIMATE("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
        
        The type of the tool. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
      - JsonValue; type "tool_search_output"constant
        
        The item type. Always tool_search_output.
        
        TOOL_SEARCH_OUTPUT("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.
      - Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
      - Optional<Status> status
        
        The status of the tool search output.
        
        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
        
        The type of the object. Always summary_text.
        
        SUMMARY_TEXT("summary_text")
      - JsonValue; type "reasoning"constant
        
        The type of the object. Always reasoning.
        
        REASONING("reasoning")
      - Optional<List<Content>> content
        
        Reasoning text content.
        
        String text
        
        The reasoning text from the model.
        
        JsonValue; type "reasoning_text"constant
        
        The type of the reasoning text. Always reasoning_text.
        
        REASONING_TEXT("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.
        
        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.
      - JsonValue; type "compaction"constant
        
        The type of the item. Always compaction.
        
        COMPACTION("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        GENERATING("generating")
        
        FAILED("failed")
      - JsonValue; type "image_generation_call"constant
        
        The type of the image generation call. Always image_generation_call.
        
        IMAGE_GENERATION_CALL("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.
        
        class Logs:
        
        The logs output from the code interpreter.
        
        String logs
        
        The logs output from the code interpreter.
        
        JsonValue; type "logs"constant
        
        The type of the output. Always logs.
        
        LOGS("logs")
        
        class Image:
        
        The image output from the code interpreter.
        
        JsonValue; type "image"constant
        
        The type of the output. Always image.
        
        IMAGE("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        INTERPRETING("interpreting")
        
        FAILED("failed")
      - JsonValue; type "code_interpreter_call"constant
        
        The type of the code interpreter tool call. Always code_interpreter_call.
        
        CODE_INTERPRETER_CALL("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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "local_shell_call"constant
        
        The type of the local shell call. Always local_shell_call.
        
        LOCAL_SHELL_CALL("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
        
        The type of the local shell tool call output. Always local_shell_call_output.
        
        LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
      - Optional<Status> status
        
        The status of the item. One of in_progress, completed, or incomplete.
        
        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.
      - JsonValue; type "shell_call"constant
        
        The type of the item. Always shell_call.
        
        SHELL_CALL("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.
        
        class LocalEnvironment:
        
        class ContainerReference:
      - Optional<Status> status
        
        The status of the shell call. One of in_progress, completed, or incomplete.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - ShellCallOutput
      - String callId
        
        The unique ID of the shell tool call generated by the model.
      - 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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("exit")
        
        String stderr
        
        Captured stderr output for the shell call.
        
        String stdout
        
        Captured stdout output for the shell call.
      - JsonValue; type "shell_call_output"constant
        
        The type of the item. Always shell_call_output.
        
        SHELL_CALL_OUTPUT("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - ApplyPatchCall
      - String callId
        
        The unique ID of the apply patch tool call generated by the model.
      - Operation operation
        
        The specific create, delete, or update instruction for the apply_patch tool call.
        
        class CreateFile:
        
        Instruction for creating a new file via the apply_patch tool.
        
        String diff
        
        Unified diff content to apply when creating the file.
        
        String path
        
        Path of the file to create relative to the workspace root.
        
        JsonValue; type "create_file"constant
        
        The operation type. Always create_file.
        
        CREATE_FILE("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.
        
        JsonValue; type "delete_file"constant
        
        The operation type. Always delete_file.
        
        DELETE_FILE("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.
        
        String path
        
        Path of the file to update relative to the workspace root.
        
        JsonValue; type "update_file"constant
        
        The operation type. Always update_file.
        
        UPDATE_FILE("update_file")
      - Status status
        
        The status of the apply patch tool call. One of in_progress or completed.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
      - JsonValue; type "apply_patch_call"constant
        
        The type of the item. Always apply_patch_call.
        
        APPLY_PATCH_CALL("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.
      - Status status
        
        The status of the apply patch tool call output. One of completed or failed.
        
        COMPLETED("completed")
        
        FAILED("failed")
      - JsonValue; type "apply_patch_call_output"constant
        
        The type of the item. Always apply_patch_call_output.
        
        APPLY_PATCH_CALL_OUTPUT("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).
    - 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
        
        The type of the item. Always mcp_list_tools.
        
        MCP_LIST_TOOLS("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
        
        The type of the item. Always mcp_approval_request.
        
        MCP_APPROVAL_REQUEST("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
        
        The type of the item. Always mcp_approval_response.
        
        MCP_APPROVAL_RESPONSE("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
        
        The type of the item. Always mcp_call.
        
        MCP_CALL("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.
        
        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.
        
        String
        
        List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
      - JsonValue; type "custom_tool_call_output"constant
        
        The type of the custom tool call output. Always custom_tool_call_output.
        
        CUSTOM_TOOL_CALL_OUTPUT("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
        
        The type of the custom tool call. Always custom_tool_call.
        
        CUSTOM_TOOL_CALL("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.
    - JsonValue;
      - JsonValue; type "compaction_trigger"constant
        
        The type of the item. Always compaction_trigger.
        
        COMPACTION_TRIGGER("compaction_trigger")
    - ItemReference
      - String id
        
        The ID of the item to reference.
      - Optional<Type> type
        
        The type of item to reference. Always item_reference.
        
        ITEM_REFERENCE("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.
  - String
  - enum ChatModel:
    - GPT_5_4("gpt-5.4")
    - GPT_5_4_MINI("gpt-5.4-mini")
    - GPT_5_4_NANO("gpt-5.4-nano")
    - GPT_5_4_MINI_2026_03_17("gpt-5.4-mini-2026-03-17")
    - GPT_5_4_NANO_2026_03_17("gpt-5.4-nano-2026-03-17")
    - GPT_5_3_CHAT_LATEST("gpt-5.3-chat-latest")
    - GPT_5_2("gpt-5.2")
    - GPT_5_2_2025_12_11("gpt-5.2-2025-12-11")
    - GPT_5_2_CHAT_LATEST("gpt-5.2-chat-latest")
    - GPT_5_2_PRO("gpt-5.2-pro")
    - GPT_5_2_PRO_2025_12_11("gpt-5.2-pro-2025-12-11")
    - GPT_5_1("gpt-5.1")
    - GPT_5_1_2025_11_13("gpt-5.1-2025-11-13")
    - GPT_5_1_CODEX("gpt-5.1-codex")
    - GPT_5_1_MINI("gpt-5.1-mini")
    - GPT_5_1_CHAT_LATEST("gpt-5.1-chat-latest")
    - GPT_5("gpt-5")
    - GPT_5_MINI("gpt-5-mini")
    - GPT_5_NANO("gpt-5-nano")
    - GPT_5_2025_08_07("gpt-5-2025-08-07")
    - GPT_5_MINI_2025_08_07("gpt-5-mini-2025-08-07")
    - GPT_5_NANO_2025_08_07("gpt-5-nano-2025-08-07")
    - GPT_5_CHAT_LATEST("gpt-5-chat-latest")
    - GPT_4_1("gpt-4.1")
    - GPT_4_1_MINI("gpt-4.1-mini")
    - GPT_4_1_NANO("gpt-4.1-nano")
    - GPT_4_1_2025_04_14("gpt-4.1-2025-04-14")
    - GPT_4_1_MINI_2025_04_14("gpt-4.1-mini-2025-04-14")
    - GPT_4_1_NANO_2025_04_14("gpt-4.1-nano-2025-04-14")
    - O4_MINI("o4-mini")
    - O4_MINI_2025_04_16("o4-mini-2025-04-16")
    - O3("o3")
    - O3_2025_04_16("o3-2025-04-16")
    - O3_MINI("o3-mini")
    - O3_MINI_2025_01_31("o3-mini-2025-01-31")
    - O1("o1")
    - O1_2024_12_17("o1-2024-12-17")
    - O1_PREVIEW("o1-preview")
    - O1_PREVIEW_2024_09_12("o1-preview-2024-09-12")
    - O1_MINI("o1-mini")
    - O1_MINI_2024_09_12("o1-mini-2024-09-12")
    - GPT_4O("gpt-4o")
    - GPT_4O_2024_11_20("gpt-4o-2024-11-20")
    - GPT_4O_2024_08_06("gpt-4o-2024-08-06")
    - GPT_4O_2024_05_13("gpt-4o-2024-05-13")
    - GPT_4O_AUDIO_PREVIEW("gpt-4o-audio-preview")
    - GPT_4O_AUDIO_PREVIEW_2024_10_01("gpt-4o-audio-preview-2024-10-01")
    - GPT_4O_AUDIO_PREVIEW_2024_12_17("gpt-4o-audio-preview-2024-12-17")
    - GPT_4O_AUDIO_PREVIEW_2025_06_03("gpt-4o-audio-preview-2025-06-03")
    - GPT_4O_MINI_AUDIO_PREVIEW("gpt-4o-mini-audio-preview")
    - GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17("gpt-4o-mini-audio-preview-2024-12-17")
    - GPT_4O_SEARCH_PREVIEW("gpt-4o-search-preview")
    - GPT_4O_MINI_SEARCH_PREVIEW("gpt-4o-mini-search-preview")
    - GPT_4O_SEARCH_PREVIEW_2025_03_11("gpt-4o-search-preview-2025-03-11")
    - GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11("gpt-4o-mini-search-preview-2025-03-11")
    - CHATGPT_4O_LATEST("chatgpt-4o-latest")
    - CODEX_MINI_LATEST("codex-mini-latest")
    - GPT_4O_MINI("gpt-4o-mini")
    - GPT_4O_MINI_2024_07_18("gpt-4o-mini-2024-07-18")
    - GPT_4_TURBO("gpt-4-turbo")
    - GPT_4_TURBO_2024_04_09("gpt-4-turbo-2024-04-09")
    - GPT_4_0125_PREVIEW("gpt-4-0125-preview")
    - GPT_4_TURBO_PREVIEW("gpt-4-turbo-preview")
    - GPT_4_1106_PREVIEW("gpt-4-1106-preview")
    - GPT_4_VISION_PREVIEW("gpt-4-vision-preview")
    - GPT_4("gpt-4")
    - GPT_4_0314("gpt-4-0314")
    - GPT_4_0613("gpt-4-0613")
    - GPT_4_32K("gpt-4-32k")
    - GPT_4_32K_0314("gpt-4-32k-0314")
    - GPT_4_32K_0613("gpt-4-32k-0613")
    - GPT_3_5_TURBO("gpt-3.5-turbo")
    - GPT_3_5_TURBO_16K("gpt-3.5-turbo-16k")
    - GPT_3_5_TURBO_0301("gpt-3.5-turbo-0301")
    - GPT_3_5_TURBO_0613("gpt-3.5-turbo-0613")
    - GPT_3_5_TURBO_1106("gpt-3.5-turbo-1106")
    - GPT_3_5_TURBO_0125("gpt-3.5-turbo-0125")
    - GPT_3_5_TURBO_16K_0613("gpt-3.5-turbo-16k-0613")
  - ResponsesOnlyModel
    - O1_PRO("o1-pro")
    - O1_PRO_2025_03_19("o1-pro-2025-03-19")
    - O3_PRO("o3-pro")
    - O3_PRO_2025_06_10("o3-pro-2025-06-10")
    - O3_DEEP_RESEARCH("o3-deep-research")
    - O3_DEEP_RESEARCH_2025_06_26("o3-deep-research-2025-06-26")
    - O4_MINI_DEEP_RESEARCH("o4-mini-deep-research")
    - O4_MINI_DEEP_RESEARCH_2025_06_26("o4-mini-deep-research-2025-06-26")
    - COMPUTER_USE_PREVIEW("computer-use-preview")
    - COMPUTER_USE_PREVIEW_2025_03_11("computer-use-preview-2025-03-11")
    - GPT_5_CODEX("gpt-5-codex")
    - GPT_5_PRO("gpt-5-pro")
    - GPT_5_PRO_2025_10_06("gpt-5-pro-2025-10-06")
    - GPT_5_1_CODEX_MAX("gpt-5.1-codex-max")
- JsonValue; object_ "response"constant
  
  The object type of this resource - always set to response.
  - RESPONSE("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.
  - class ResponseOutputMessage:
    
    An output message from the model.
  - class ResponseFileSearchToolCall:
    
    The results of a file search tool call. See the file search guide for more information.
  - class ResponseFunctionToolCall:
    
    A tool call to run a function. See the function calling guide for more information.
  - 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.
      - String
      - List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
    - Status status
      
      The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "function_call_output"constant
      
      The type of the function tool call output. Always function_call_output.
      - FUNCTION_CALL_OUTPUT("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.
  - class ResponseComputerToolCall:
    
    A tool call to a computer use tool. See the computer use guide for more information.
  - 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.
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
      - FAILED("failed")
      - IN_PROGRESS("in_progress")
    - JsonValue; type "computer_call_output"constant
      
      The type of the computer tool call output. Always computer_call_output.
      - COMPUTER_CALL_OUTPUT("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.
  - 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.
      - SERVER("server")
      - CLIENT("client")
    - Status status
      
      The status of the tool search call item that was recorded.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "tool_search_call"constant
      
      The type of the item. Always tool_search_call.
      - TOOL_SEARCH_CALL("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.
      - SERVER("server")
      - CLIENT("client")
    - Status status
      
      The status of the tool search output item that was recorded.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - List<Tool> tools
      
      The loaded tool definitions returned by tool search.
      - class FunctionTool:
        
        Defines a function in your own code the model can choose to call. Learn more about function calling.
      - class FileSearchTool:
        
        A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
      - class ComputerTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
      - class ComputerUsePreviewTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
      - class WebSearchTool:
        
        Search the Internet for sources related to the prompt. Learn more about the web search tool.
      - Mcp
      - CodeInterpreter
      - ImageGeneration
      - JsonValue;
      - class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
      - class CustomTool:
        
        A custom tool that processes input using a specified format. Learn more about custom tools
      - class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
      - class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
      - class WebSearchPreviewTool:
        
        This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
      - class ApplyPatchTool:
        
        Allows the assistant to create, delete, or update files using unified diffs.
    - JsonValue; type "tool_search_output"constant
      
      The type of the item. Always tool_search_output.
      - TOOL_SEARCH_OUTPUT("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
      
      The type of the item. Always compaction.
      - COMPACTION("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - GENERATING("generating")
      - FAILED("failed")
    - JsonValue; type "image_generation_call"constant
      
      The type of the image generation call. Always image_generation_call.
      - IMAGE_GENERATION_CALL("image_generation_call")
  - class ResponseCodeInterpreterToolCall:
    
    A tool call to run code.
  - 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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "local_shell_call"constant
      
      The type of the local shell call. Always local_shell_call.
      - LOCAL_SHELL_CALL("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
      
      The type of the local shell tool call output. Always local_shell_call_output.
      - LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
    - Optional<Status> status
      
      The status of the item. One of in_progress, completed, or incomplete.
      - 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.
      - class ResponseLocalEnvironment:
        
        Represents the use of a local environment to perform shell actions.
        
        JsonValue; type "local"constant
        
        The environment type. Always local.
        
        LOCAL("local")
      - class ResponseContainerReference:
        
        Represents a container created with /v1/containers.
        
        String containerId
        
        JsonValue; type "container_reference"constant
        
        The environment type. Always container_reference.
        
        CONTAINER_REFERENCE("container_reference")
    - Status status
      
      The status of the shell call. One of in_progress, completed, or incomplete.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "shell_call"constant
      
      The type of the item. Always shell_call.
      - SHELL_CALL("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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "shell_call_output"constant
      
      The type of the shell call output. Always shell_call_output.
      - SHELL_CALL_OUTPUT("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.
      - 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 a new file with the provided diff.
        
        CREATE_FILE("create_file")
      - 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 the specified file.
        
        DELETE_FILE("delete_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 an existing file with the provided diff.
        
        UPDATE_FILE("update_file")
    - Status status
      
      The status of the apply patch tool call. One of in_progress or completed.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
    - JsonValue; type "apply_patch_call"constant
      
      The type of the item. Always apply_patch_call.
      - APPLY_PATCH_CALL("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.
      - COMPLETED("completed")
      - FAILED("failed")
    - JsonValue; type "apply_patch_call_output"constant
      
      The type of the item. Always apply_patch_call_output.
      - APPLY_PATCH_CALL_OUTPUT("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
      
      The type of the item. Always mcp_call.
      - MCP_CALL("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.
      - 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
      
      The type of the item. Always mcp_list_tools.
      - MCP_LIST_TOOLS("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
      
      The type of the item. Always mcp_approval_request.
      - MCP_APPROVAL_REQUEST("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
      
      The type of the item. Always mcp_approval_response.
      - MCP_APPROVAL_RESPONSE("mcp_approval_response")
    - Optional<String> reason
      
      Optional reason for the decision.
  - class ResponseCustomToolCall:
    
    A call to a custom tool created by the model.
  - 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.
      - 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.
- 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.
  - 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.
      - 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 tool configuration type. Always allowed_tools.
      - ALLOWED_TOOLS("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
      - 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
      
      For function calling, the type is always function.
      - FUNCTION("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
      
      For MCP tools, the type is always mcp.
      - MCP("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
      
      For custom tool calling, the type is always custom.
      - CUSTOM("custom")
  - class ToolChoiceApplyPatch:
    
    Forces the model to call the apply_patch tool when executing a tool call.
    - JsonValue; type "apply_patch"constant
      
      The tool to call. Always apply_patch.
      - APPLY_PATCH("apply_patch")
  - class ToolChoiceShell:
    
    Forces the model to call the shell tool when a tool call is required.
    - JsonValue; type "shell"constant
      
      The tool to call. Always shell.
      - SHELL("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.
  - class FunctionTool:
    
    Defines a function in your own code the model can choose to call. Learn more about function calling.
  - class FileSearchTool:
    
    A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
  - class ComputerTool:
    
    A tool that controls a virtual computer. Learn more about the computer tool.
  - class ComputerUsePreviewTool:
    
    A tool that controls a virtual computer. Learn more about the computer tool.
  - class WebSearchTool:
    
    Search the Internet for sources related to the prompt. Learn more about the web search tool.
  - Mcp
  - CodeInterpreter
  - ImageGeneration
  - JsonValue;
  - class FunctionShellTool:
    
    A tool that allows the model to execute shell commands.
  - class CustomTool:
    
    A custom tool that processes input using a specified format. Learn more about custom tools
  - class NamespaceTool:
    
    Groups function/custom tools under a shared namespace.
  - class ToolSearchTool:
    
    Hosted or BYOT tool search configuration for deferred tools.
  - class WebSearchPreviewTool:
    
    This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
  - class ApplyPatchTool:
    
    Allows the assistant to create, delete, or update files using unified diffs.
- 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.
- 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.
  - 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.
    - String
    - class ResponseInputText:
      
      A text input to the model.
    - class ResponseInputImage:
      
      An image input to the model. Learn about image inputs.
    - class ResponseInputFile:
      
      A file input to the model.
  - Optional<String> version
    
    Optional version of the prompt template.
- 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.
  - IN_MEMORY("in_memory")
  - _24H("24h")
- Optional<Reasoning> reasoning
  
  gpt-5 and o-series models only
  
  Configuration options for reasoning models.
  - Optional<ReasoningEffort> effort
    
    Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
    - gpt-5.1 defaults to none, which does not perform reasoning. The supported reasoning values for gpt-5.1 are none, low, medium, and high. Tool calls are supported for all reasoning values in gpt-5.1.
    - All models before gpt-5.1 default to medium reasoning effort, and do not support none.
    - The gpt-5-pro model defaults to (and only supports) high reasoning effort.
    - xhigh is supported for all models after gpt-5.1-codex-max.
    - NONE("none")
    - MINIMAL("minimal")
    - LOW("low")
    - MEDIUM("medium")
    - HIGH("high")
    - XHIGH("xhigh")
  - Optional<GenerateSummary> generateSummary
    
    Deprecated: use summary instead.
    
    A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
    - AUTO("auto")
    - CONCISE("concise")
    - DETAILED("detailed")
  - Optional<Summary> summary
    
    A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
    
    concise is supported for computer-use-preview models and all reasoning models after gpt-5.
    - AUTO("auto")
    - CONCISE("concise")
    - DETAILED("detailed")
- 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.
- 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.
  - 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.
  - COMPLETED("completed")
  - FAILED("failed")
  - IN_PROGRESS("in_progress")
  - CANCELLED("cancelled")
  - QUEUED("queued")
  - INCOMPLETE("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<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.
    - class ResponseFormatText:
      
      Default response format. Used to generate text responses.
      - JsonValue; type "text"constant
        
        The type of response format being defined. Always text.
        
        TEXT("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
        
        The type of response format being defined. Always json_schema.
        
        JSON_SCHEMA("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
        
        The type of response format being defined. Always json_object.
        
        JSON_OBJECT("json_object")
  - 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.
    - LOW("low")
    - MEDIUM("medium")
    - HIGH("high")
- Optional<Long> topLogprobs
  
  An integer between 0 and 20 specifying the maximum number of most likely tokens to return at each token position, each with an associated log probability. In some cases, the number of returned tokens may be fewer than requested.
- 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.
  - 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.
  - 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.
- Optional<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.

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.responses.Response;
import com.openai.models.responses.ResponseCreateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        Response response = client.responses().create();
    }
}

Response

{
  "id": "id",
  "created_at": 0,
  "error": {
    "code": "server_error",
    "message": "message"
  },
  "incomplete_details": {
    "reason": "max_output_tokens"
  },
  "instructions": "string",
  "metadata": {
    "foo": "string"
  },
  "model": "gpt-5.1",
  "object": "response",
  "output": [
    {
      "id": "id",
      "content": [
        {
          "annotations": [
            {
              "file_id": "file_id",
              "filename": "filename",
              "index": 0,
              "type": "file_citation"
            }
          ],
          "text": "text",
          "type": "output_text",
          "logprobs": [
            {
              "token": "token",
              "bytes": [
                0
              ],
              "logprob": 0,
              "top_logprobs": [
                {
                  "token": "token",
                  "bytes": [
                    0
                  ],
                  "logprob": 0
                }
              ]
            }
          ]
        }
      ],
      "role": "assistant",
      "status": "in_progress",
      "type": "message",
      "phase": "commentary"
    }
  ],
  "parallel_tool_calls": true,
  "temperature": 1,
  "tool_choice": "none",
  "tools": [
    {
      "name": "name",
      "parameters": {
        "foo": "bar"
      },
      "strict": true,
      "type": "function",
      "defer_loading": true,
      "description": "description"
    }
  ],
  "top_p": 1,
  "background": true,
  "completed_at": 0,
  "conversation": {
    "id": "id"
  },
  "max_output_tokens": 0,
  "max_tool_calls": 0,
  "output_text": "output_text",
  "previous_response_id": "previous_response_id",
  "prompt": {
    "id": "id",
    "variables": {
      "foo": "string"
    },
    "version": "version"
  },
  "prompt_cache_key": "prompt-cache-key-1234",
  "prompt_cache_retention": "in_memory",
  "reasoning": {
    "effort": "none",
    "generate_summary": "auto",
    "summary": "auto"
  },
  "safety_identifier": "safety-identifier-1234",
  "service_tier": "auto",
  "status": "completed",
  "text": {
    "format": {
      "type": "text"
    },
    "verbosity": "low"
  },
  "top_logprobs": 0,
  "truncation": "auto",
  "usage": {
    "input_tokens": 0,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 0,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 0
  },
  "user": "user-1234"
}

Get a model response

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

get /responses/{response_id}

Retrieves a model response with the given ID.

Parameters

ResponseRetrieveParams params
- Optional<String> responseId
- Optional<List<ResponseIncludable>> include
  
  Additional fields to include in the response. See the include parameter for Response creation above for more information.
  - 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<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<Long> startingAfter
  
  The sequence number of the event after which to start streaming.

Returns

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.
  - Code code
    
    The error code for the response.
    - 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.
- Optional<IncompleteDetails> incompleteDetails
  
  Details about why the response is incomplete.
  - Optional<Reason> reason
    
    The reason why the response is incomplete.
    - 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.
  - String
  - List<ResponseInputItem>
    - 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.
        
        String
        
        List<ResponseInputContent>
        
        class ResponseInputText:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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.
        
        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.
        
        COMMENTARY("commentary")
        
        FINAL_ANSWER("final_answer")
      - Optional<Type> type
        
        The type of the message input. Always message.
        
        MESSAGE("message")
    - Message
      - List<ResponseInputContent> content
        
        A list of one or many input items to the model, containing different content types.
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
      - Role role
        
        The role of the message input. One of user, system, or developer.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - Optional<Type> type
        
        The type of the message input. Always set to message.
        
        MESSAGE("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.
        
        class ResponseOutputText:
        
        A text output from the model.
        
        List<Annotation> annotations
        
        The annotations of the text output.
        
        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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
        
        String text
        
        The text output from the model.
        
        JsonValue; type "output_text"constant
        
        The type of the output text. Always output_text.
        
        OUTPUT_TEXT("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
        
        The type of the refusal. Always refusal.
        
        REFUSAL("refusal")
      - JsonValue; role "assistant"constant
        
        The role of the output message. Always assistant.
        
        ASSISTANT("assistant")
      - Status status
        
        The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "message"constant
        
        The type of the output message. Always message.
        
        MESSAGE("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.
        
        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,
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        FAILED("failed")
      - JsonValue; type "file_search_call"constant
        
        The type of the file search tool call. Always file_search_call.
        
        FILE_SEARCH_CALL("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.
        
        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.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - Type type
        
        The type of the computer call. Always computer_call.
        
        COMPUTER_CALL("computer_call")
      - Optional<Action> action
        
        A click action.
        
        class Click:
        
        A click action.
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        class Move:
        
        A mouse move action.
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        class Scroll:
        
        A scroll action.
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
      - Optional<List<ComputerAction>> actions
        
        Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.
        
        Click
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        Move
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        Scroll
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
    - ComputerCallOutput
      - 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.
        
        JsonValue; type "computer_screenshot"constant
        
        Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
        
        COMPUTER_SCREENSHOT("computer_screenshot")
        
        Optional<String> fileId
        
        The identifier of an uploaded file that contains the screenshot.
        
        Optional<String> imageUrl
        
        The URL of the screenshot image.
      - JsonValue; type "computer_call_output"constant
        
        The type of the computer tool call output. Always computer_call_output.
        
        COMPUTER_CALL_OUTPUT("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.
        
        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).
        
        class Search:
        
        Action type "search" - Performs a web search query.
        
        String query
        
        [DEPRECATED] The search query.
        
        JsonValue; type "search"constant
        
        The action type.
        
        SEARCH("search")
        
        Optional<List<String>> queries
        
        The search queries.
        
        Optional<List<Source>> sources
        
        The sources used in the search.
        
        JsonValue; type "url"constant
        
        The type of source. Always url.
        
        URL("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
        
        The action type.
        
        OPEN_PAGE("open_page")
        
        Optional<String> url
        
        The URL opened by the model.
        
        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
        
        The action type.
        
        FIND_IN_PAGE("find_in_page")
        
        String url
        
        The URL of the page searched for the pattern.
      - Status status
        
        The status of the web search tool call.
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        FAILED("failed")
      - JsonValue; type "web_search_call"constant
        
        The type of the web search tool call. Always web_search_call.
        
        WEB_SEARCH_CALL("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
        
        The type of the function tool call. Always function_call.
        
        FUNCTION_CALL("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - FunctionCallOutput
      - String callId
        
        The unique ID of the function tool call generated by the model.
      - Output output
        
        Text, image, or file output of the function tool call.
        
        String
        
        List<ResponseFunctionCallOutputItem>
        
        class ResponseInputTextContent:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("input_text")
        
        class ResponseInputImageContent:
        
        An image input to the model. Learn about image inputs
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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.
        
        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.
        
        class ResponseInputFileContent:
        
        A file input to the model.
        
        JsonValue; type "input_file"constant
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        LOW("low")
        
        HIGH("high")
        
        Optional<String> fileData
        
        The base64-encoded data 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 "function_call_output"constant
        
        The type of the function tool call output. Always function_call_output.
        
        FUNCTION_CALL_OUTPUT("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.
        
        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
        
        The item type. Always tool_search_call.
        
        TOOL_SEARCH_CALL("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.
      - Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
      - Optional<Status> status
        
        The status of the tool search call.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - class ResponseToolSearchOutputItemParam:
      - List<Tool> tools
        
        The loaded tool definitions returned by the tool search output.
        
        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
        
        The type of the function tool. Always function.
        
        FUNCTION("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
        
        The type of the file search tool. Always file_search.
        
        FILE_SEARCH("file_search")
        
        List<String> vectorStoreIds
        
        The IDs of the vector stores to search.
        
        Optional<Filters> filters
        
        A filter to apply.
        
        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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
        
        Type type
        
        Type of operation: and or or.
        
        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.
        
        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
        
        The type of the computer tool. Always computer.
        
        COMPUTER("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.
        
        WINDOWS("windows")
        
        MAC("mac")
        
        LINUX("linux")
        
        UBUNTU("ubuntu")
        
        BROWSER("browser")
        
        JsonValue; type "computer_use_preview"constant
        
        The type of the computer use tool. Always computer_use_preview.
        
        COMPUTER_USE_PREVIEW("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.
        
        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.
        
        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.
        
        APPROXIMATE("approximate")
        
        Mcp
        
        String serverLabel
        
        A label for this MCP server, used to identify it in tool calls.
        
        JsonValue; type "mcp"constant
        
        The type of the MCP tool. Always mcp.
        
        MCP("mcp")
        
        Optional<AllowedTools> allowedTools
        
        List of allowed tool names or a filter object.
        
        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
        
        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.
        
        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.
        
        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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
        
        JsonValue; type "code_interpreter"constant
        
        The type of the code interpreter tool. Always code_interpreter.
        
        CODE_INTERPRETER("code_interpreter")
        
        ImageGeneration
        
        JsonValue; type "image_generation"constant
        
        The type of the image generation tool. Always image_generation.
        
        IMAGE_GENERATION("image_generation")
        
        Optional<Action> action
        
        Whether to generate a new image or edit an existing image. Default: auto.
        
        GENERATE("generate")
        
        EDIT("edit")
        
        AUTO("auto")
        
        Optional<Background> background
        
        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.
        
        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.
        
        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.
        
        GPT_IMAGE_1("gpt-image-1")
        
        GPT_IMAGE_1_MINI("gpt-image-1-mini")
        
        GPT_IMAGE_2("gpt-image-2")
        
        GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
        
        GPT_IMAGE_1_5("gpt-image-1.5")
        
        CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
        
        Optional<Moderation> moderation
        
        Moderation level for the generated image. Default: auto.
        
        AUTO("auto")
        
        LOW("low")
        
        Optional<Long> outputCompression
        
        Compression level for the output image. Default: 100.
        
        Optional<OutputFormat> outputFormat
        
        The output format of the generated image. One of png, webp, or jpeg. Default: png.
        
        PNG("png")
        
        WEBP("webp")
        
        JPEG("jpeg")
        
        Optional<Long> partialImages
        
        Number of partial images to generate in streaming mode, from 0 (default value) to 3.
        
        Optional<Quality> quality
        
        The quality of the generated image. One of low, medium, high, or auto. Default: auto.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        AUTO("auto")
        
        Optional<Size> size
        
        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.
        
        _1024X1024("1024x1024")
        
        _1024X1536("1024x1536")
        
        _1536X1024("1536x1024")
        
        AUTO("auto")
        
        JsonValue;
        
        JsonValue; type "local_shell"constant
        
        The type of the local shell tool. Always local_shell.
        
        LOCAL_SHELL("local_shell")
        
        class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        JsonValue; type "shell"constant
        
        The type of the shell tool. Always shell.
        
        SHELL("shell")
        
        Optional<Environment> environment
        
        class ContainerAuto:
        
        JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
        
        Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
        
        class LocalEnvironment:
        
        JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
        
        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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
        
        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
        
        The type of the custom tool. Always custom.
        
        CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
        
        Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
        
        class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        String description
        
        A description of the namespace shown to the model.
        
        String name
        
        The namespace name used in tool calls (for example, crm).
        
        List<Tool> tools
        
        The function/custom tools available inside this namespace.
        
        class Function:
        
        String name
        
        JsonValue; type "function"constant
        
        FUNCTION("function")
        
        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
        
        JsonValue; type "namespace"constant
        
        The type of the tool. Always namespace.
        
        NAMESPACE("namespace")
        
        class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        JsonValue; type "tool_search"constant
        
        The type of the tool. Always tool_search.
        
        TOOL_SEARCH("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.
        
        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.
        
        WEB_SEARCH_PREVIEW("web_search_preview")
        
        WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
        
        Optional<List<SearchContentType>> searchContentTypes
        
        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.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        Optional<UserLocation> userLocation
        
        The user's location.
        
        JsonValue; type "approximate"constant
        
        The type of location approximation. Always approximate.
        
        APPROXIMATE("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
        
        The type of the tool. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
      - JsonValue; type "tool_search_output"constant
        
        The item type. Always tool_search_output.
        
        TOOL_SEARCH_OUTPUT("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.
      - Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
      - Optional<Status> status
        
        The status of the tool search output.
        
        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
        
        The type of the object. Always summary_text.
        
        SUMMARY_TEXT("summary_text")
      - JsonValue; type "reasoning"constant
        
        The type of the object. Always reasoning.
        
        REASONING("reasoning")
      - Optional<List<Content>> content
        
        Reasoning text content.
        
        String text
        
        The reasoning text from the model.
        
        JsonValue; type "reasoning_text"constant
        
        The type of the reasoning text. Always reasoning_text.
        
        REASONING_TEXT("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.
        
        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.
      - JsonValue; type "compaction"constant
        
        The type of the item. Always compaction.
        
        COMPACTION("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        GENERATING("generating")
        
        FAILED("failed")
      - JsonValue; type "image_generation_call"constant
        
        The type of the image generation call. Always image_generation_call.
        
        IMAGE_GENERATION_CALL("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.
        
        class Logs:
        
        The logs output from the code interpreter.
        
        String logs
        
        The logs output from the code interpreter.
        
        JsonValue; type "logs"constant
        
        The type of the output. Always logs.
        
        LOGS("logs")
        
        class Image:
        
        The image output from the code interpreter.
        
        JsonValue; type "image"constant
        
        The type of the output. Always image.
        
        IMAGE("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        INTERPRETING("interpreting")
        
        FAILED("failed")
      - JsonValue; type "code_interpreter_call"constant
        
        The type of the code interpreter tool call. Always code_interpreter_call.
        
        CODE_INTERPRETER_CALL("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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "local_shell_call"constant
        
        The type of the local shell call. Always local_shell_call.
        
        LOCAL_SHELL_CALL("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
        
        The type of the local shell tool call output. Always local_shell_call_output.
        
        LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
      - Optional<Status> status
        
        The status of the item. One of in_progress, completed, or incomplete.
        
        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.
      - JsonValue; type "shell_call"constant
        
        The type of the item. Always shell_call.
        
        SHELL_CALL("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.
        
        class LocalEnvironment:
        
        class ContainerReference:
      - Optional<Status> status
        
        The status of the shell call. One of in_progress, completed, or incomplete.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - ShellCallOutput
      - String callId
        
        The unique ID of the shell tool call generated by the model.
      - 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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("exit")
        
        String stderr
        
        Captured stderr output for the shell call.
        
        String stdout
        
        Captured stdout output for the shell call.
      - JsonValue; type "shell_call_output"constant
        
        The type of the item. Always shell_call_output.
        
        SHELL_CALL_OUTPUT("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - ApplyPatchCall
      - String callId
        
        The unique ID of the apply patch tool call generated by the model.
      - Operation operation
        
        The specific create, delete, or update instruction for the apply_patch tool call.
        
        class CreateFile:
        
        Instruction for creating a new file via the apply_patch tool.
        
        String diff
        
        Unified diff content to apply when creating the file.
        
        String path
        
        Path of the file to create relative to the workspace root.
        
        JsonValue; type "create_file"constant
        
        The operation type. Always create_file.
        
        CREATE_FILE("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.
        
        JsonValue; type "delete_file"constant
        
        The operation type. Always delete_file.
        
        DELETE_FILE("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.
        
        String path
        
        Path of the file to update relative to the workspace root.
        
        JsonValue; type "update_file"constant
        
        The operation type. Always update_file.
        
        UPDATE_FILE("update_file")
      - Status status
        
        The status of the apply patch tool call. One of in_progress or completed.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
      - JsonValue; type "apply_patch_call"constant
        
        The type of the item. Always apply_patch_call.
        
        APPLY_PATCH_CALL("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.
      - Status status
        
        The status of the apply patch tool call output. One of completed or failed.
        
        COMPLETED("completed")
        
        FAILED("failed")
      - JsonValue; type "apply_patch_call_output"constant
        
        The type of the item. Always apply_patch_call_output.
        
        APPLY_PATCH_CALL_OUTPUT("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).
    - 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
        
        The type of the item. Always mcp_list_tools.
        
        MCP_LIST_TOOLS("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
        
        The type of the item. Always mcp_approval_request.
        
        MCP_APPROVAL_REQUEST("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
        
        The type of the item. Always mcp_approval_response.
        
        MCP_APPROVAL_RESPONSE("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
        
        The type of the item. Always mcp_call.
        
        MCP_CALL("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.
        
        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.
        
        String
        
        List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
      - JsonValue; type "custom_tool_call_output"constant
        
        The type of the custom tool call output. Always custom_tool_call_output.
        
        CUSTOM_TOOL_CALL_OUTPUT("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
        
        The type of the custom tool call. Always custom_tool_call.
        
        CUSTOM_TOOL_CALL("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.
    - JsonValue;
      - JsonValue; type "compaction_trigger"constant
        
        The type of the item. Always compaction_trigger.
        
        COMPACTION_TRIGGER("compaction_trigger")
    - ItemReference
      - String id
        
        The ID of the item to reference.
      - Optional<Type> type
        
        The type of item to reference. Always item_reference.
        
        ITEM_REFERENCE("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.
  - String
  - enum ChatModel:
    - GPT_5_4("gpt-5.4")
    - GPT_5_4_MINI("gpt-5.4-mini")
    - GPT_5_4_NANO("gpt-5.4-nano")
    - GPT_5_4_MINI_2026_03_17("gpt-5.4-mini-2026-03-17")
    - GPT_5_4_NANO_2026_03_17("gpt-5.4-nano-2026-03-17")
    - GPT_5_3_CHAT_LATEST("gpt-5.3-chat-latest")
    - GPT_5_2("gpt-5.2")
    - GPT_5_2_2025_12_11("gpt-5.2-2025-12-11")
    - GPT_5_2_CHAT_LATEST("gpt-5.2-chat-latest")
    - GPT_5_2_PRO("gpt-5.2-pro")
    - GPT_5_2_PRO_2025_12_11("gpt-5.2-pro-2025-12-11")
    - GPT_5_1("gpt-5.1")
    - GPT_5_1_2025_11_13("gpt-5.1-2025-11-13")
    - GPT_5_1_CODEX("gpt-5.1-codex")
    - GPT_5_1_MINI("gpt-5.1-mini")
    - GPT_5_1_CHAT_LATEST("gpt-5.1-chat-latest")
    - GPT_5("gpt-5")
    - GPT_5_MINI("gpt-5-mini")
    - GPT_5_NANO("gpt-5-nano")
    - GPT_5_2025_08_07("gpt-5-2025-08-07")
    - GPT_5_MINI_2025_08_07("gpt-5-mini-2025-08-07")
    - GPT_5_NANO_2025_08_07("gpt-5-nano-2025-08-07")
    - GPT_5_CHAT_LATEST("gpt-5-chat-latest")
    - GPT_4_1("gpt-4.1")
    - GPT_4_1_MINI("gpt-4.1-mini")
    - GPT_4_1_NANO("gpt-4.1-nano")
    - GPT_4_1_2025_04_14("gpt-4.1-2025-04-14")
    - GPT_4_1_MINI_2025_04_14("gpt-4.1-mini-2025-04-14")
    - GPT_4_1_NANO_2025_04_14("gpt-4.1-nano-2025-04-14")
    - O4_MINI("o4-mini")
    - O4_MINI_2025_04_16("o4-mini-2025-04-16")
    - O3("o3")
    - O3_2025_04_16("o3-2025-04-16")
    - O3_MINI("o3-mini")
    - O3_MINI_2025_01_31("o3-mini-2025-01-31")
    - O1("o1")
    - O1_2024_12_17("o1-2024-12-17")
    - O1_PREVIEW("o1-preview")
    - O1_PREVIEW_2024_09_12("o1-preview-2024-09-12")
    - O1_MINI("o1-mini")
    - O1_MINI_2024_09_12("o1-mini-2024-09-12")
    - GPT_4O("gpt-4o")
    - GPT_4O_2024_11_20("gpt-4o-2024-11-20")
    - GPT_4O_2024_08_06("gpt-4o-2024-08-06")
    - GPT_4O_2024_05_13("gpt-4o-2024-05-13")
    - GPT_4O_AUDIO_PREVIEW("gpt-4o-audio-preview")
    - GPT_4O_AUDIO_PREVIEW_2024_10_01("gpt-4o-audio-preview-2024-10-01")
    - GPT_4O_AUDIO_PREVIEW_2024_12_17("gpt-4o-audio-preview-2024-12-17")
    - GPT_4O_AUDIO_PREVIEW_2025_06_03("gpt-4o-audio-preview-2025-06-03")
    - GPT_4O_MINI_AUDIO_PREVIEW("gpt-4o-mini-audio-preview")
    - GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17("gpt-4o-mini-audio-preview-2024-12-17")
    - GPT_4O_SEARCH_PREVIEW("gpt-4o-search-preview")
    - GPT_4O_MINI_SEARCH_PREVIEW("gpt-4o-mini-search-preview")
    - GPT_4O_SEARCH_PREVIEW_2025_03_11("gpt-4o-search-preview-2025-03-11")
    - GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11("gpt-4o-mini-search-preview-2025-03-11")
    - CHATGPT_4O_LATEST("chatgpt-4o-latest")
    - CODEX_MINI_LATEST("codex-mini-latest")
    - GPT_4O_MINI("gpt-4o-mini")
    - GPT_4O_MINI_2024_07_18("gpt-4o-mini-2024-07-18")
    - GPT_4_TURBO("gpt-4-turbo")
    - GPT_4_TURBO_2024_04_09("gpt-4-turbo-2024-04-09")
    - GPT_4_0125_PREVIEW("gpt-4-0125-preview")
    - GPT_4_TURBO_PREVIEW("gpt-4-turbo-preview")
    - GPT_4_1106_PREVIEW("gpt-4-1106-preview")
    - GPT_4_VISION_PREVIEW("gpt-4-vision-preview")
    - GPT_4("gpt-4")
    - GPT_4_0314("gpt-4-0314")
    - GPT_4_0613("gpt-4-0613")
    - GPT_4_32K("gpt-4-32k")
    - GPT_4_32K_0314("gpt-4-32k-0314")
    - GPT_4_32K_0613("gpt-4-32k-0613")
    - GPT_3_5_TURBO("gpt-3.5-turbo")
    - GPT_3_5_TURBO_16K("gpt-3.5-turbo-16k")
    - GPT_3_5_TURBO_0301("gpt-3.5-turbo-0301")
    - GPT_3_5_TURBO_0613("gpt-3.5-turbo-0613")
    - GPT_3_5_TURBO_1106("gpt-3.5-turbo-1106")
    - GPT_3_5_TURBO_0125("gpt-3.5-turbo-0125")
    - GPT_3_5_TURBO_16K_0613("gpt-3.5-turbo-16k-0613")
  - ResponsesOnlyModel
    - O1_PRO("o1-pro")
    - O1_PRO_2025_03_19("o1-pro-2025-03-19")
    - O3_PRO("o3-pro")
    - O3_PRO_2025_06_10("o3-pro-2025-06-10")
    - O3_DEEP_RESEARCH("o3-deep-research")
    - O3_DEEP_RESEARCH_2025_06_26("o3-deep-research-2025-06-26")
    - O4_MINI_DEEP_RESEARCH("o4-mini-deep-research")
    - O4_MINI_DEEP_RESEARCH_2025_06_26("o4-mini-deep-research-2025-06-26")
    - COMPUTER_USE_PREVIEW("computer-use-preview")
    - COMPUTER_USE_PREVIEW_2025_03_11("computer-use-preview-2025-03-11")
    - GPT_5_CODEX("gpt-5-codex")
    - GPT_5_PRO("gpt-5-pro")
    - GPT_5_PRO_2025_10_06("gpt-5-pro-2025-10-06")
    - GPT_5_1_CODEX_MAX("gpt-5.1-codex-max")
- JsonValue; object_ "response"constant
  
  The object type of this resource - always set to response.
  - RESPONSE("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.
  - class ResponseOutputMessage:
    
    An output message from the model.
  - class ResponseFileSearchToolCall:
    
    The results of a file search tool call. See the file search guide for more information.
  - class ResponseFunctionToolCall:
    
    A tool call to run a function. See the function calling guide for more information.
  - 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.
      - String
      - List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
    - Status status
      
      The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "function_call_output"constant
      
      The type of the function tool call output. Always function_call_output.
      - FUNCTION_CALL_OUTPUT("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.
  - class ResponseComputerToolCall:
    
    A tool call to a computer use tool. See the computer use guide for more information.
  - 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.
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
      - FAILED("failed")
      - IN_PROGRESS("in_progress")
    - JsonValue; type "computer_call_output"constant
      
      The type of the computer tool call output. Always computer_call_output.
      - COMPUTER_CALL_OUTPUT("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.
  - 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.
      - SERVER("server")
      - CLIENT("client")
    - Status status
      
      The status of the tool search call item that was recorded.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "tool_search_call"constant
      
      The type of the item. Always tool_search_call.
      - TOOL_SEARCH_CALL("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.
      - SERVER("server")
      - CLIENT("client")
    - Status status
      
      The status of the tool search output item that was recorded.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - List<Tool> tools
      
      The loaded tool definitions returned by tool search.
      - class FunctionTool:
        
        Defines a function in your own code the model can choose to call. Learn more about function calling.
      - class FileSearchTool:
        
        A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
      - class ComputerTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
      - class ComputerUsePreviewTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
      - class WebSearchTool:
        
        Search the Internet for sources related to the prompt. Learn more about the web search tool.
      - Mcp
      - CodeInterpreter
      - ImageGeneration
      - JsonValue;
      - class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
      - class CustomTool:
        
        A custom tool that processes input using a specified format. Learn more about custom tools
      - class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
      - class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
      - class WebSearchPreviewTool:
        
        This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
      - class ApplyPatchTool:
        
        Allows the assistant to create, delete, or update files using unified diffs.
    - JsonValue; type "tool_search_output"constant
      
      The type of the item. Always tool_search_output.
      - TOOL_SEARCH_OUTPUT("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
      
      The type of the item. Always compaction.
      - COMPACTION("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - GENERATING("generating")
      - FAILED("failed")
    - JsonValue; type "image_generation_call"constant
      
      The type of the image generation call. Always image_generation_call.
      - IMAGE_GENERATION_CALL("image_generation_call")
  - class ResponseCodeInterpreterToolCall:
    
    A tool call to run code.
  - 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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "local_shell_call"constant
      
      The type of the local shell call. Always local_shell_call.
      - LOCAL_SHELL_CALL("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
      
      The type of the local shell tool call output. Always local_shell_call_output.
      - LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
    - Optional<Status> status
      
      The status of the item. One of in_progress, completed, or incomplete.
      - 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.
      - class ResponseLocalEnvironment:
        
        Represents the use of a local environment to perform shell actions.
        
        JsonValue; type "local"constant
        
        The environment type. Always local.
        
        LOCAL("local")
      - class ResponseContainerReference:
        
        Represents a container created with /v1/containers.
        
        String containerId
        
        JsonValue; type "container_reference"constant
        
        The environment type. Always container_reference.
        
        CONTAINER_REFERENCE("container_reference")
    - Status status
      
      The status of the shell call. One of in_progress, completed, or incomplete.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "shell_call"constant
      
      The type of the item. Always shell_call.
      - SHELL_CALL("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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "shell_call_output"constant
      
      The type of the shell call output. Always shell_call_output.
      - SHELL_CALL_OUTPUT("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.
      - 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 a new file with the provided diff.
        
        CREATE_FILE("create_file")
      - 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 the specified file.
        
        DELETE_FILE("delete_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 an existing file with the provided diff.
        
        UPDATE_FILE("update_file")
    - Status status
      
      The status of the apply patch tool call. One of in_progress or completed.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
    - JsonValue; type "apply_patch_call"constant
      
      The type of the item. Always apply_patch_call.
      - APPLY_PATCH_CALL("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.
      - COMPLETED("completed")
      - FAILED("failed")
    - JsonValue; type "apply_patch_call_output"constant
      
      The type of the item. Always apply_patch_call_output.
      - APPLY_PATCH_CALL_OUTPUT("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
      
      The type of the item. Always mcp_call.
      - MCP_CALL("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.
      - 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
      
      The type of the item. Always mcp_list_tools.
      - MCP_LIST_TOOLS("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
      
      The type of the item. Always mcp_approval_request.
      - MCP_APPROVAL_REQUEST("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
      
      The type of the item. Always mcp_approval_response.
      - MCP_APPROVAL_RESPONSE("mcp_approval_response")
    - Optional<String> reason
      
      Optional reason for the decision.
  - class ResponseCustomToolCall:
    
    A call to a custom tool created by the model.
  - 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.
      - 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.
- 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.
  - 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.
      - 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 tool configuration type. Always allowed_tools.
      - ALLOWED_TOOLS("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
      - 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
      
      For function calling, the type is always function.
      - FUNCTION("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
      
      For MCP tools, the type is always mcp.
      - MCP("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
      
      For custom tool calling, the type is always custom.
      - CUSTOM("custom")
  - class ToolChoiceApplyPatch:
    
    Forces the model to call the apply_patch tool when executing a tool call.
    - JsonValue; type "apply_patch"constant
      
      The tool to call. Always apply_patch.
      - APPLY_PATCH("apply_patch")
  - class ToolChoiceShell:
    
    Forces the model to call the shell tool when a tool call is required.
    - JsonValue; type "shell"constant
      
      The tool to call. Always shell.
      - SHELL("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.
  - class FunctionTool:
    
    Defines a function in your own code the model can choose to call. Learn more about function calling.
  - class FileSearchTool:
    
    A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
  - class ComputerTool:
    
    A tool that controls a virtual computer. Learn more about the computer tool.
  - class ComputerUsePreviewTool:
    
    A tool that controls a virtual computer. Learn more about the computer tool.
  - class WebSearchTool:
    
    Search the Internet for sources related to the prompt. Learn more about the web search tool.
  - Mcp
  - CodeInterpreter
  - ImageGeneration
  - JsonValue;
  - class FunctionShellTool:
    
    A tool that allows the model to execute shell commands.
  - class CustomTool:
    
    A custom tool that processes input using a specified format. Learn more about custom tools
  - class NamespaceTool:
    
    Groups function/custom tools under a shared namespace.
  - class ToolSearchTool:
    
    Hosted or BYOT tool search configuration for deferred tools.
  - class WebSearchPreviewTool:
    
    This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
  - class ApplyPatchTool:
    
    Allows the assistant to create, delete, or update files using unified diffs.
- 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.
- 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.
  - 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.
    - String
    - class ResponseInputText:
      
      A text input to the model.
    - class ResponseInputImage:
      
      An image input to the model. Learn about image inputs.
    - class ResponseInputFile:
      
      A file input to the model.
  - Optional<String> version
    
    Optional version of the prompt template.
- 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.
  - IN_MEMORY("in_memory")
  - _24H("24h")
- Optional<Reasoning> reasoning
  
  gpt-5 and o-series models only
  
  Configuration options for reasoning models.
  - Optional<ReasoningEffort> effort
    
    Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
    - gpt-5.1 defaults to none, which does not perform reasoning. The supported reasoning values for gpt-5.1 are none, low, medium, and high. Tool calls are supported for all reasoning values in gpt-5.1.
    - All models before gpt-5.1 default to medium reasoning effort, and do not support none.
    - The gpt-5-pro model defaults to (and only supports) high reasoning effort.
    - xhigh is supported for all models after gpt-5.1-codex-max.
    - NONE("none")
    - MINIMAL("minimal")
    - LOW("low")
    - MEDIUM("medium")
    - HIGH("high")
    - XHIGH("xhigh")
  - Optional<GenerateSummary> generateSummary
    
    Deprecated: use summary instead.
    
    A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
    - AUTO("auto")
    - CONCISE("concise")
    - DETAILED("detailed")
  - Optional<Summary> summary
    
    A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
    
    concise is supported for computer-use-preview models and all reasoning models after gpt-5.
    - AUTO("auto")
    - CONCISE("concise")
    - DETAILED("detailed")
- 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.
- 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.
  - 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.
  - COMPLETED("completed")
  - FAILED("failed")
  - IN_PROGRESS("in_progress")
  - CANCELLED("cancelled")
  - QUEUED("queued")
  - INCOMPLETE("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<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.
    - class ResponseFormatText:
      
      Default response format. Used to generate text responses.
      - JsonValue; type "text"constant
        
        The type of response format being defined. Always text.
        
        TEXT("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
        
        The type of response format being defined. Always json_schema.
        
        JSON_SCHEMA("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
        
        The type of response format being defined. Always json_object.
        
        JSON_OBJECT("json_object")
  - 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.
    - LOW("low")
    - MEDIUM("medium")
    - HIGH("high")
- Optional<Long> topLogprobs
  
  An integer between 0 and 20 specifying the maximum number of most likely tokens to return at each token position, each with an associated log probability. In some cases, the number of returned tokens may be fewer than requested.
- 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.
  - 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.
  - 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.
- Optional<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.

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.responses.Response;
import com.openai.models.responses.ResponseRetrieveParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        Response response = client.responses().retrieve("resp_677efb5139a88190b512bc3fef8e535d");
    }
}

Response

{
  "id": "id",
  "created_at": 0,
  "error": {
    "code": "server_error",
    "message": "message"
  },
  "incomplete_details": {
    "reason": "max_output_tokens"
  },
  "instructions": "string",
  "metadata": {
    "foo": "string"
  },
  "model": "gpt-5.1",
  "object": "response",
  "output": [
    {
      "id": "id",
      "content": [
        {
          "annotations": [
            {
              "file_id": "file_id",
              "filename": "filename",
              "index": 0,
              "type": "file_citation"
            }
          ],
          "text": "text",
          "type": "output_text",
          "logprobs": [
            {
              "token": "token",
              "bytes": [
                0
              ],
              "logprob": 0,
              "top_logprobs": [
                {
                  "token": "token",
                  "bytes": [
                    0
                  ],
                  "logprob": 0
                }
              ]
            }
          ]
        }
      ],
      "role": "assistant",
      "status": "in_progress",
      "type": "message",
      "phase": "commentary"
    }
  ],
  "parallel_tool_calls": true,
  "temperature": 1,
  "tool_choice": "none",
  "tools": [
    {
      "name": "name",
      "parameters": {
        "foo": "bar"
      },
      "strict": true,
      "type": "function",
      "defer_loading": true,
      "description": "description"
    }
  ],
  "top_p": 1,
  "background": true,
  "completed_at": 0,
  "conversation": {
    "id": "id"
  },
  "max_output_tokens": 0,
  "max_tool_calls": 0,
  "output_text": "output_text",
  "previous_response_id": "previous_response_id",
  "prompt": {
    "id": "id",
    "variables": {
      "foo": "string"
    },
    "version": "version"
  },
  "prompt_cache_key": "prompt-cache-key-1234",
  "prompt_cache_retention": "in_memory",
  "reasoning": {
    "effort": "none",
    "generate_summary": "auto",
    "summary": "auto"
  },
  "safety_identifier": "safety-identifier-1234",
  "service_tier": "auto",
  "status": "completed",
  "text": {
    "format": {
      "type": "text"
    },
    "verbosity": "low"
  },
  "top_logprobs": 0,
  "truncation": "auto",
  "usage": {
    "input_tokens": 0,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 0,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 0
  },
  "user": "user-1234"
}

Delete a model response

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

delete /responses/{response_id}

Deletes a model response with the given ID.

Parameters

ResponseDeleteParams params
- Optional<String> responseId

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.responses.ResponseDeleteParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        client.responses().delete("resp_677efb5139a88190b512bc3fef8e535d");
    }
}

Cancel a response

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

post /responses/{response_id}/cancel

Cancels a model response with the given ID. Only responses created with the background parameter set to true can be cancelled. Learn more.

Parameters

ResponseCancelParams params
- Optional<String> responseId

Returns

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.
  - Code code
    
    The error code for the response.
    - 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.
- Optional<IncompleteDetails> incompleteDetails
  
  Details about why the response is incomplete.
  - Optional<Reason> reason
    
    The reason why the response is incomplete.
    - 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.
  - String
  - List<ResponseInputItem>
    - 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.
        
        String
        
        List<ResponseInputContent>
        
        class ResponseInputText:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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.
        
        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.
        
        COMMENTARY("commentary")
        
        FINAL_ANSWER("final_answer")
      - Optional<Type> type
        
        The type of the message input. Always message.
        
        MESSAGE("message")
    - Message
      - List<ResponseInputContent> content
        
        A list of one or many input items to the model, containing different content types.
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
      - Role role
        
        The role of the message input. One of user, system, or developer.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - Optional<Type> type
        
        The type of the message input. Always set to message.
        
        MESSAGE("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.
        
        class ResponseOutputText:
        
        A text output from the model.
        
        List<Annotation> annotations
        
        The annotations of the text output.
        
        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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
        
        String text
        
        The text output from the model.
        
        JsonValue; type "output_text"constant
        
        The type of the output text. Always output_text.
        
        OUTPUT_TEXT("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
        
        The type of the refusal. Always refusal.
        
        REFUSAL("refusal")
      - JsonValue; role "assistant"constant
        
        The role of the output message. Always assistant.
        
        ASSISTANT("assistant")
      - Status status
        
        The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "message"constant
        
        The type of the output message. Always message.
        
        MESSAGE("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.
        
        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,
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        FAILED("failed")
      - JsonValue; type "file_search_call"constant
        
        The type of the file search tool call. Always file_search_call.
        
        FILE_SEARCH_CALL("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.
        
        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.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - Type type
        
        The type of the computer call. Always computer_call.
        
        COMPUTER_CALL("computer_call")
      - Optional<Action> action
        
        A click action.
        
        class Click:
        
        A click action.
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        class Move:
        
        A mouse move action.
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        class Scroll:
        
        A scroll action.
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
      - Optional<List<ComputerAction>> actions
        
        Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.
        
        Click
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        Move
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        Scroll
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
    - ComputerCallOutput
      - 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.
        
        JsonValue; type "computer_screenshot"constant
        
        Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
        
        COMPUTER_SCREENSHOT("computer_screenshot")
        
        Optional<String> fileId
        
        The identifier of an uploaded file that contains the screenshot.
        
        Optional<String> imageUrl
        
        The URL of the screenshot image.
      - JsonValue; type "computer_call_output"constant
        
        The type of the computer tool call output. Always computer_call_output.
        
        COMPUTER_CALL_OUTPUT("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.
        
        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).
        
        class Search:
        
        Action type "search" - Performs a web search query.
        
        String query
        
        [DEPRECATED] The search query.
        
        JsonValue; type "search"constant
        
        The action type.
        
        SEARCH("search")
        
        Optional<List<String>> queries
        
        The search queries.
        
        Optional<List<Source>> sources
        
        The sources used in the search.
        
        JsonValue; type "url"constant
        
        The type of source. Always url.
        
        URL("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
        
        The action type.
        
        OPEN_PAGE("open_page")
        
        Optional<String> url
        
        The URL opened by the model.
        
        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
        
        The action type.
        
        FIND_IN_PAGE("find_in_page")
        
        String url
        
        The URL of the page searched for the pattern.
      - Status status
        
        The status of the web search tool call.
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        FAILED("failed")
      - JsonValue; type "web_search_call"constant
        
        The type of the web search tool call. Always web_search_call.
        
        WEB_SEARCH_CALL("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
        
        The type of the function tool call. Always function_call.
        
        FUNCTION_CALL("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - FunctionCallOutput
      - String callId
        
        The unique ID of the function tool call generated by the model.
      - Output output
        
        Text, image, or file output of the function tool call.
        
        String
        
        List<ResponseFunctionCallOutputItem>
        
        class ResponseInputTextContent:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("input_text")
        
        class ResponseInputImageContent:
        
        An image input to the model. Learn about image inputs
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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.
        
        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.
        
        class ResponseInputFileContent:
        
        A file input to the model.
        
        JsonValue; type "input_file"constant
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        LOW("low")
        
        HIGH("high")
        
        Optional<String> fileData
        
        The base64-encoded data 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 "function_call_output"constant
        
        The type of the function tool call output. Always function_call_output.
        
        FUNCTION_CALL_OUTPUT("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.
        
        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
        
        The item type. Always tool_search_call.
        
        TOOL_SEARCH_CALL("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.
      - Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
      - Optional<Status> status
        
        The status of the tool search call.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - class ResponseToolSearchOutputItemParam:
      - List<Tool> tools
        
        The loaded tool definitions returned by the tool search output.
        
        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
        
        The type of the function tool. Always function.
        
        FUNCTION("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
        
        The type of the file search tool. Always file_search.
        
        FILE_SEARCH("file_search")
        
        List<String> vectorStoreIds
        
        The IDs of the vector stores to search.
        
        Optional<Filters> filters
        
        A filter to apply.
        
        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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
        
        Type type
        
        Type of operation: and or or.
        
        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.
        
        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
        
        The type of the computer tool. Always computer.
        
        COMPUTER("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.
        
        WINDOWS("windows")
        
        MAC("mac")
        
        LINUX("linux")
        
        UBUNTU("ubuntu")
        
        BROWSER("browser")
        
        JsonValue; type "computer_use_preview"constant
        
        The type of the computer use tool. Always computer_use_preview.
        
        COMPUTER_USE_PREVIEW("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.
        
        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.
        
        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.
        
        APPROXIMATE("approximate")
        
        Mcp
        
        String serverLabel
        
        A label for this MCP server, used to identify it in tool calls.
        
        JsonValue; type "mcp"constant
        
        The type of the MCP tool. Always mcp.
        
        MCP("mcp")
        
        Optional<AllowedTools> allowedTools
        
        List of allowed tool names or a filter object.
        
        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
        
        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.
        
        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.
        
        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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
        
        JsonValue; type "code_interpreter"constant
        
        The type of the code interpreter tool. Always code_interpreter.
        
        CODE_INTERPRETER("code_interpreter")
        
        ImageGeneration
        
        JsonValue; type "image_generation"constant
        
        The type of the image generation tool. Always image_generation.
        
        IMAGE_GENERATION("image_generation")
        
        Optional<Action> action
        
        Whether to generate a new image or edit an existing image. Default: auto.
        
        GENERATE("generate")
        
        EDIT("edit")
        
        AUTO("auto")
        
        Optional<Background> background
        
        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.
        
        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.
        
        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.
        
        GPT_IMAGE_1("gpt-image-1")
        
        GPT_IMAGE_1_MINI("gpt-image-1-mini")
        
        GPT_IMAGE_2("gpt-image-2")
        
        GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
        
        GPT_IMAGE_1_5("gpt-image-1.5")
        
        CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
        
        Optional<Moderation> moderation
        
        Moderation level for the generated image. Default: auto.
        
        AUTO("auto")
        
        LOW("low")
        
        Optional<Long> outputCompression
        
        Compression level for the output image. Default: 100.
        
        Optional<OutputFormat> outputFormat
        
        The output format of the generated image. One of png, webp, or jpeg. Default: png.
        
        PNG("png")
        
        WEBP("webp")
        
        JPEG("jpeg")
        
        Optional<Long> partialImages
        
        Number of partial images to generate in streaming mode, from 0 (default value) to 3.
        
        Optional<Quality> quality
        
        The quality of the generated image. One of low, medium, high, or auto. Default: auto.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        AUTO("auto")
        
        Optional<Size> size
        
        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.
        
        _1024X1024("1024x1024")
        
        _1024X1536("1024x1536")
        
        _1536X1024("1536x1024")
        
        AUTO("auto")
        
        JsonValue;
        
        JsonValue; type "local_shell"constant
        
        The type of the local shell tool. Always local_shell.
        
        LOCAL_SHELL("local_shell")
        
        class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        JsonValue; type "shell"constant
        
        The type of the shell tool. Always shell.
        
        SHELL("shell")
        
        Optional<Environment> environment
        
        class ContainerAuto:
        
        JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
        
        Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
        
        class LocalEnvironment:
        
        JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
        
        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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
        
        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
        
        The type of the custom tool. Always custom.
        
        CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
        
        Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
        
        class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        String description
        
        A description of the namespace shown to the model.
        
        String name
        
        The namespace name used in tool calls (for example, crm).
        
        List<Tool> tools
        
        The function/custom tools available inside this namespace.
        
        class Function:
        
        String name
        
        JsonValue; type "function"constant
        
        FUNCTION("function")
        
        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
        
        JsonValue; type "namespace"constant
        
        The type of the tool. Always namespace.
        
        NAMESPACE("namespace")
        
        class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        JsonValue; type "tool_search"constant
        
        The type of the tool. Always tool_search.
        
        TOOL_SEARCH("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.
        
        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.
        
        WEB_SEARCH_PREVIEW("web_search_preview")
        
        WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
        
        Optional<List<SearchContentType>> searchContentTypes
        
        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.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        Optional<UserLocation> userLocation
        
        The user's location.
        
        JsonValue; type "approximate"constant
        
        The type of location approximation. Always approximate.
        
        APPROXIMATE("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
        
        The type of the tool. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
      - JsonValue; type "tool_search_output"constant
        
        The item type. Always tool_search_output.
        
        TOOL_SEARCH_OUTPUT("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.
      - Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
      - Optional<Status> status
        
        The status of the tool search output.
        
        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
        
        The type of the object. Always summary_text.
        
        SUMMARY_TEXT("summary_text")
      - JsonValue; type "reasoning"constant
        
        The type of the object. Always reasoning.
        
        REASONING("reasoning")
      - Optional<List<Content>> content
        
        Reasoning text content.
        
        String text
        
        The reasoning text from the model.
        
        JsonValue; type "reasoning_text"constant
        
        The type of the reasoning text. Always reasoning_text.
        
        REASONING_TEXT("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.
        
        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.
      - JsonValue; type "compaction"constant
        
        The type of the item. Always compaction.
        
        COMPACTION("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        GENERATING("generating")
        
        FAILED("failed")
      - JsonValue; type "image_generation_call"constant
        
        The type of the image generation call. Always image_generation_call.
        
        IMAGE_GENERATION_CALL("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.
        
        class Logs:
        
        The logs output from the code interpreter.
        
        String logs
        
        The logs output from the code interpreter.
        
        JsonValue; type "logs"constant
        
        The type of the output. Always logs.
        
        LOGS("logs")
        
        class Image:
        
        The image output from the code interpreter.
        
        JsonValue; type "image"constant
        
        The type of the output. Always image.
        
        IMAGE("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        INTERPRETING("interpreting")
        
        FAILED("failed")
      - JsonValue; type "code_interpreter_call"constant
        
        The type of the code interpreter tool call. Always code_interpreter_call.
        
        CODE_INTERPRETER_CALL("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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "local_shell_call"constant
        
        The type of the local shell call. Always local_shell_call.
        
        LOCAL_SHELL_CALL("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
        
        The type of the local shell tool call output. Always local_shell_call_output.
        
        LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
      - Optional<Status> status
        
        The status of the item. One of in_progress, completed, or incomplete.
        
        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.
      - JsonValue; type "shell_call"constant
        
        The type of the item. Always shell_call.
        
        SHELL_CALL("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.
        
        class LocalEnvironment:
        
        class ContainerReference:
      - Optional<Status> status
        
        The status of the shell call. One of in_progress, completed, or incomplete.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - ShellCallOutput
      - String callId
        
        The unique ID of the shell tool call generated by the model.
      - 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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("exit")
        
        String stderr
        
        Captured stderr output for the shell call.
        
        String stdout
        
        Captured stdout output for the shell call.
      - JsonValue; type "shell_call_output"constant
        
        The type of the item. Always shell_call_output.
        
        SHELL_CALL_OUTPUT("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - ApplyPatchCall
      - String callId
        
        The unique ID of the apply patch tool call generated by the model.
      - Operation operation
        
        The specific create, delete, or update instruction for the apply_patch tool call.
        
        class CreateFile:
        
        Instruction for creating a new file via the apply_patch tool.
        
        String diff
        
        Unified diff content to apply when creating the file.
        
        String path
        
        Path of the file to create relative to the workspace root.
        
        JsonValue; type "create_file"constant
        
        The operation type. Always create_file.
        
        CREATE_FILE("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.
        
        JsonValue; type "delete_file"constant
        
        The operation type. Always delete_file.
        
        DELETE_FILE("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.
        
        String path
        
        Path of the file to update relative to the workspace root.
        
        JsonValue; type "update_file"constant
        
        The operation type. Always update_file.
        
        UPDATE_FILE("update_file")
      - Status status
        
        The status of the apply patch tool call. One of in_progress or completed.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
      - JsonValue; type "apply_patch_call"constant
        
        The type of the item. Always apply_patch_call.
        
        APPLY_PATCH_CALL("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.
      - Status status
        
        The status of the apply patch tool call output. One of completed or failed.
        
        COMPLETED("completed")
        
        FAILED("failed")
      - JsonValue; type "apply_patch_call_output"constant
        
        The type of the item. Always apply_patch_call_output.
        
        APPLY_PATCH_CALL_OUTPUT("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).
    - 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
        
        The type of the item. Always mcp_list_tools.
        
        MCP_LIST_TOOLS("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
        
        The type of the item. Always mcp_approval_request.
        
        MCP_APPROVAL_REQUEST("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
        
        The type of the item. Always mcp_approval_response.
        
        MCP_APPROVAL_RESPONSE("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
        
        The type of the item. Always mcp_call.
        
        MCP_CALL("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.
        
        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.
        
        String
        
        List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
      - JsonValue; type "custom_tool_call_output"constant
        
        The type of the custom tool call output. Always custom_tool_call_output.
        
        CUSTOM_TOOL_CALL_OUTPUT("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
        
        The type of the custom tool call. Always custom_tool_call.
        
        CUSTOM_TOOL_CALL("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.
    - JsonValue;
      - JsonValue; type "compaction_trigger"constant
        
        The type of the item. Always compaction_trigger.
        
        COMPACTION_TRIGGER("compaction_trigger")
    - ItemReference
      - String id
        
        The ID of the item to reference.
      - Optional<Type> type
        
        The type of item to reference. Always item_reference.
        
        ITEM_REFERENCE("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.
  - String
  - enum ChatModel:
    - GPT_5_4("gpt-5.4")
    - GPT_5_4_MINI("gpt-5.4-mini")
    - GPT_5_4_NANO("gpt-5.4-nano")
    - GPT_5_4_MINI_2026_03_17("gpt-5.4-mini-2026-03-17")
    - GPT_5_4_NANO_2026_03_17("gpt-5.4-nano-2026-03-17")
    - GPT_5_3_CHAT_LATEST("gpt-5.3-chat-latest")
    - GPT_5_2("gpt-5.2")
    - GPT_5_2_2025_12_11("gpt-5.2-2025-12-11")
    - GPT_5_2_CHAT_LATEST("gpt-5.2-chat-latest")
    - GPT_5_2_PRO("gpt-5.2-pro")
    - GPT_5_2_PRO_2025_12_11("gpt-5.2-pro-2025-12-11")
    - GPT_5_1("gpt-5.1")
    - GPT_5_1_2025_11_13("gpt-5.1-2025-11-13")
    - GPT_5_1_CODEX("gpt-5.1-codex")
    - GPT_5_1_MINI("gpt-5.1-mini")
    - GPT_5_1_CHAT_LATEST("gpt-5.1-chat-latest")
    - GPT_5("gpt-5")
    - GPT_5_MINI("gpt-5-mini")
    - GPT_5_NANO("gpt-5-nano")
    - GPT_5_2025_08_07("gpt-5-2025-08-07")
    - GPT_5_MINI_2025_08_07("gpt-5-mini-2025-08-07")
    - GPT_5_NANO_2025_08_07("gpt-5-nano-2025-08-07")
    - GPT_5_CHAT_LATEST("gpt-5-chat-latest")
    - GPT_4_1("gpt-4.1")
    - GPT_4_1_MINI("gpt-4.1-mini")
    - GPT_4_1_NANO("gpt-4.1-nano")
    - GPT_4_1_2025_04_14("gpt-4.1-2025-04-14")
    - GPT_4_1_MINI_2025_04_14("gpt-4.1-mini-2025-04-14")
    - GPT_4_1_NANO_2025_04_14("gpt-4.1-nano-2025-04-14")
    - O4_MINI("o4-mini")
    - O4_MINI_2025_04_16("o4-mini-2025-04-16")
    - O3("o3")
    - O3_2025_04_16("o3-2025-04-16")
    - O3_MINI("o3-mini")
    - O3_MINI_2025_01_31("o3-mini-2025-01-31")
    - O1("o1")
    - O1_2024_12_17("o1-2024-12-17")
    - O1_PREVIEW("o1-preview")
    - O1_PREVIEW_2024_09_12("o1-preview-2024-09-12")
    - O1_MINI("o1-mini")
    - O1_MINI_2024_09_12("o1-mini-2024-09-12")
    - GPT_4O("gpt-4o")
    - GPT_4O_2024_11_20("gpt-4o-2024-11-20")
    - GPT_4O_2024_08_06("gpt-4o-2024-08-06")
    - GPT_4O_2024_05_13("gpt-4o-2024-05-13")
    - GPT_4O_AUDIO_PREVIEW("gpt-4o-audio-preview")
    - GPT_4O_AUDIO_PREVIEW_2024_10_01("gpt-4o-audio-preview-2024-10-01")
    - GPT_4O_AUDIO_PREVIEW_2024_12_17("gpt-4o-audio-preview-2024-12-17")
    - GPT_4O_AUDIO_PREVIEW_2025_06_03("gpt-4o-audio-preview-2025-06-03")
    - GPT_4O_MINI_AUDIO_PREVIEW("gpt-4o-mini-audio-preview")
    - GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17("gpt-4o-mini-audio-preview-2024-12-17")
    - GPT_4O_SEARCH_PREVIEW("gpt-4o-search-preview")
    - GPT_4O_MINI_SEARCH_PREVIEW("gpt-4o-mini-search-preview")
    - GPT_4O_SEARCH_PREVIEW_2025_03_11("gpt-4o-search-preview-2025-03-11")
    - GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11("gpt-4o-mini-search-preview-2025-03-11")
    - CHATGPT_4O_LATEST("chatgpt-4o-latest")
    - CODEX_MINI_LATEST("codex-mini-latest")
    - GPT_4O_MINI("gpt-4o-mini")
    - GPT_4O_MINI_2024_07_18("gpt-4o-mini-2024-07-18")
    - GPT_4_TURBO("gpt-4-turbo")
    - GPT_4_TURBO_2024_04_09("gpt-4-turbo-2024-04-09")
    - GPT_4_0125_PREVIEW("gpt-4-0125-preview")
    - GPT_4_TURBO_PREVIEW("gpt-4-turbo-preview")
    - GPT_4_1106_PREVIEW("gpt-4-1106-preview")
    - GPT_4_VISION_PREVIEW("gpt-4-vision-preview")
    - GPT_4("gpt-4")
    - GPT_4_0314("gpt-4-0314")
    - GPT_4_0613("gpt-4-0613")
    - GPT_4_32K("gpt-4-32k")
    - GPT_4_32K_0314("gpt-4-32k-0314")
    - GPT_4_32K_0613("gpt-4-32k-0613")
    - GPT_3_5_TURBO("gpt-3.5-turbo")
    - GPT_3_5_TURBO_16K("gpt-3.5-turbo-16k")
    - GPT_3_5_TURBO_0301("gpt-3.5-turbo-0301")
    - GPT_3_5_TURBO_0613("gpt-3.5-turbo-0613")
    - GPT_3_5_TURBO_1106("gpt-3.5-turbo-1106")
    - GPT_3_5_TURBO_0125("gpt-3.5-turbo-0125")
    - GPT_3_5_TURBO_16K_0613("gpt-3.5-turbo-16k-0613")
  - ResponsesOnlyModel
    - O1_PRO("o1-pro")
    - O1_PRO_2025_03_19("o1-pro-2025-03-19")
    - O3_PRO("o3-pro")
    - O3_PRO_2025_06_10("o3-pro-2025-06-10")
    - O3_DEEP_RESEARCH("o3-deep-research")
    - O3_DEEP_RESEARCH_2025_06_26("o3-deep-research-2025-06-26")
    - O4_MINI_DEEP_RESEARCH("o4-mini-deep-research")
    - O4_MINI_DEEP_RESEARCH_2025_06_26("o4-mini-deep-research-2025-06-26")
    - COMPUTER_USE_PREVIEW("computer-use-preview")
    - COMPUTER_USE_PREVIEW_2025_03_11("computer-use-preview-2025-03-11")
    - GPT_5_CODEX("gpt-5-codex")
    - GPT_5_PRO("gpt-5-pro")
    - GPT_5_PRO_2025_10_06("gpt-5-pro-2025-10-06")
    - GPT_5_1_CODEX_MAX("gpt-5.1-codex-max")
- JsonValue; object_ "response"constant
  
  The object type of this resource - always set to response.
  - RESPONSE("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.
  - class ResponseOutputMessage:
    
    An output message from the model.
  - class ResponseFileSearchToolCall:
    
    The results of a file search tool call. See the file search guide for more information.
  - class ResponseFunctionToolCall:
    
    A tool call to run a function. See the function calling guide for more information.
  - 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.
      - String
      - List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
    - Status status
      
      The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "function_call_output"constant
      
      The type of the function tool call output. Always function_call_output.
      - FUNCTION_CALL_OUTPUT("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.
  - class ResponseComputerToolCall:
    
    A tool call to a computer use tool. See the computer use guide for more information.
  - 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.
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
      - FAILED("failed")
      - IN_PROGRESS("in_progress")
    - JsonValue; type "computer_call_output"constant
      
      The type of the computer tool call output. Always computer_call_output.
      - COMPUTER_CALL_OUTPUT("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.
  - 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.
      - SERVER("server")
      - CLIENT("client")
    - Status status
      
      The status of the tool search call item that was recorded.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "tool_search_call"constant
      
      The type of the item. Always tool_search_call.
      - TOOL_SEARCH_CALL("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.
      - SERVER("server")
      - CLIENT("client")
    - Status status
      
      The status of the tool search output item that was recorded.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - List<Tool> tools
      
      The loaded tool definitions returned by tool search.
      - class FunctionTool:
        
        Defines a function in your own code the model can choose to call. Learn more about function calling.
      - class FileSearchTool:
        
        A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
      - class ComputerTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
      - class ComputerUsePreviewTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
      - class WebSearchTool:
        
        Search the Internet for sources related to the prompt. Learn more about the web search tool.
      - Mcp
      - CodeInterpreter
      - ImageGeneration
      - JsonValue;
      - class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
      - class CustomTool:
        
        A custom tool that processes input using a specified format. Learn more about custom tools
      - class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
      - class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
      - class WebSearchPreviewTool:
        
        This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
      - class ApplyPatchTool:
        
        Allows the assistant to create, delete, or update files using unified diffs.
    - JsonValue; type "tool_search_output"constant
      
      The type of the item. Always tool_search_output.
      - TOOL_SEARCH_OUTPUT("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
      
      The type of the item. Always compaction.
      - COMPACTION("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - GENERATING("generating")
      - FAILED("failed")
    - JsonValue; type "image_generation_call"constant
      
      The type of the image generation call. Always image_generation_call.
      - IMAGE_GENERATION_CALL("image_generation_call")
  - class ResponseCodeInterpreterToolCall:
    
    A tool call to run code.
  - 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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "local_shell_call"constant
      
      The type of the local shell call. Always local_shell_call.
      - LOCAL_SHELL_CALL("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
      
      The type of the local shell tool call output. Always local_shell_call_output.
      - LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
    - Optional<Status> status
      
      The status of the item. One of in_progress, completed, or incomplete.
      - 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.
      - class ResponseLocalEnvironment:
        
        Represents the use of a local environment to perform shell actions.
        
        JsonValue; type "local"constant
        
        The environment type. Always local.
        
        LOCAL("local")
      - class ResponseContainerReference:
        
        Represents a container created with /v1/containers.
        
        String containerId
        
        JsonValue; type "container_reference"constant
        
        The environment type. Always container_reference.
        
        CONTAINER_REFERENCE("container_reference")
    - Status status
      
      The status of the shell call. One of in_progress, completed, or incomplete.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "shell_call"constant
      
      The type of the item. Always shell_call.
      - SHELL_CALL("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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "shell_call_output"constant
      
      The type of the shell call output. Always shell_call_output.
      - SHELL_CALL_OUTPUT("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.
      - 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 a new file with the provided diff.
        
        CREATE_FILE("create_file")
      - 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 the specified file.
        
        DELETE_FILE("delete_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 an existing file with the provided diff.
        
        UPDATE_FILE("update_file")
    - Status status
      
      The status of the apply patch tool call. One of in_progress or completed.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
    - JsonValue; type "apply_patch_call"constant
      
      The type of the item. Always apply_patch_call.
      - APPLY_PATCH_CALL("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.
      - COMPLETED("completed")
      - FAILED("failed")
    - JsonValue; type "apply_patch_call_output"constant
      
      The type of the item. Always apply_patch_call_output.
      - APPLY_PATCH_CALL_OUTPUT("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
      
      The type of the item. Always mcp_call.
      - MCP_CALL("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.
      - 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
      
      The type of the item. Always mcp_list_tools.
      - MCP_LIST_TOOLS("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
      
      The type of the item. Always mcp_approval_request.
      - MCP_APPROVAL_REQUEST("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
      
      The type of the item. Always mcp_approval_response.
      - MCP_APPROVAL_RESPONSE("mcp_approval_response")
    - Optional<String> reason
      
      Optional reason for the decision.
  - class ResponseCustomToolCall:
    
    A call to a custom tool created by the model.
  - 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.
      - 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.
- 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.
  - 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.
      - 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 tool configuration type. Always allowed_tools.
      - ALLOWED_TOOLS("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
      - 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
      
      For function calling, the type is always function.
      - FUNCTION("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
      
      For MCP tools, the type is always mcp.
      - MCP("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
      
      For custom tool calling, the type is always custom.
      - CUSTOM("custom")
  - class ToolChoiceApplyPatch:
    
    Forces the model to call the apply_patch tool when executing a tool call.
    - JsonValue; type "apply_patch"constant
      
      The tool to call. Always apply_patch.
      - APPLY_PATCH("apply_patch")
  - class ToolChoiceShell:
    
    Forces the model to call the shell tool when a tool call is required.
    - JsonValue; type "shell"constant
      
      The tool to call. Always shell.
      - SHELL("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.
  - class FunctionTool:
    
    Defines a function in your own code the model can choose to call. Learn more about function calling.
  - class FileSearchTool:
    
    A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
  - class ComputerTool:
    
    A tool that controls a virtual computer. Learn more about the computer tool.
  - class ComputerUsePreviewTool:
    
    A tool that controls a virtual computer. Learn more about the computer tool.
  - class WebSearchTool:
    
    Search the Internet for sources related to the prompt. Learn more about the web search tool.
  - Mcp
  - CodeInterpreter
  - ImageGeneration
  - JsonValue;
  - class FunctionShellTool:
    
    A tool that allows the model to execute shell commands.
  - class CustomTool:
    
    A custom tool that processes input using a specified format. Learn more about custom tools
  - class NamespaceTool:
    
    Groups function/custom tools under a shared namespace.
  - class ToolSearchTool:
    
    Hosted or BYOT tool search configuration for deferred tools.
  - class WebSearchPreviewTool:
    
    This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
  - class ApplyPatchTool:
    
    Allows the assistant to create, delete, or update files using unified diffs.
- 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.
- 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.
  - 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.
    - String
    - class ResponseInputText:
      
      A text input to the model.
    - class ResponseInputImage:
      
      An image input to the model. Learn about image inputs.
    - class ResponseInputFile:
      
      A file input to the model.
  - Optional<String> version
    
    Optional version of the prompt template.
- 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.
  - IN_MEMORY("in_memory")
  - _24H("24h")
- Optional<Reasoning> reasoning
  
  gpt-5 and o-series models only
  
  Configuration options for reasoning models.
  - Optional<ReasoningEffort> effort
    
    Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
    - gpt-5.1 defaults to none, which does not perform reasoning. The supported reasoning values for gpt-5.1 are none, low, medium, and high. Tool calls are supported for all reasoning values in gpt-5.1.
    - All models before gpt-5.1 default to medium reasoning effort, and do not support none.
    - The gpt-5-pro model defaults to (and only supports) high reasoning effort.
    - xhigh is supported for all models after gpt-5.1-codex-max.
    - NONE("none")
    - MINIMAL("minimal")
    - LOW("low")
    - MEDIUM("medium")
    - HIGH("high")
    - XHIGH("xhigh")
  - Optional<GenerateSummary> generateSummary
    
    Deprecated: use summary instead.
    
    A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
    - AUTO("auto")
    - CONCISE("concise")
    - DETAILED("detailed")
  - Optional<Summary> summary
    
    A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
    
    concise is supported for computer-use-preview models and all reasoning models after gpt-5.
    - AUTO("auto")
    - CONCISE("concise")
    - DETAILED("detailed")
- 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.
- 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.
  - 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.
  - COMPLETED("completed")
  - FAILED("failed")
  - IN_PROGRESS("in_progress")
  - CANCELLED("cancelled")
  - QUEUED("queued")
  - INCOMPLETE("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<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.
    - class ResponseFormatText:
      
      Default response format. Used to generate text responses.
      - JsonValue; type "text"constant
        
        The type of response format being defined. Always text.
        
        TEXT("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
        
        The type of response format being defined. Always json_schema.
        
        JSON_SCHEMA("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
        
        The type of response format being defined. Always json_object.
        
        JSON_OBJECT("json_object")
  - 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.
    - LOW("low")
    - MEDIUM("medium")
    - HIGH("high")
- Optional<Long> topLogprobs
  
  An integer between 0 and 20 specifying the maximum number of most likely tokens to return at each token position, each with an associated log probability. In some cases, the number of returned tokens may be fewer than requested.
- 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.
  - 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.
  - 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.
- Optional<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.

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.responses.Response;
import com.openai.models.responses.ResponseCancelParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        Response response = client.responses().cancel("resp_677efb5139a88190b512bc3fef8e535d");
    }
}

Response

{
  "id": "id",
  "created_at": 0,
  "error": {
    "code": "server_error",
    "message": "message"
  },
  "incomplete_details": {
    "reason": "max_output_tokens"
  },
  "instructions": "string",
  "metadata": {
    "foo": "string"
  },
  "model": "gpt-5.1",
  "object": "response",
  "output": [
    {
      "id": "id",
      "content": [
        {
          "annotations": [
            {
              "file_id": "file_id",
              "filename": "filename",
              "index": 0,
              "type": "file_citation"
            }
          ],
          "text": "text",
          "type": "output_text",
          "logprobs": [
            {
              "token": "token",
              "bytes": [
                0
              ],
              "logprob": 0,
              "top_logprobs": [
                {
                  "token": "token",
                  "bytes": [
                    0
                  ],
                  "logprob": 0
                }
              ]
            }
          ]
        }
      ],
      "role": "assistant",
      "status": "in_progress",
      "type": "message",
      "phase": "commentary"
    }
  ],
  "parallel_tool_calls": true,
  "temperature": 1,
  "tool_choice": "none",
  "tools": [
    {
      "name": "name",
      "parameters": {
        "foo": "bar"
      },
      "strict": true,
      "type": "function",
      "defer_loading": true,
      "description": "description"
    }
  ],
  "top_p": 1,
  "background": true,
  "completed_at": 0,
  "conversation": {
    "id": "id"
  },
  "max_output_tokens": 0,
  "max_tool_calls": 0,
  "output_text": "output_text",
  "previous_response_id": "previous_response_id",
  "prompt": {
    "id": "id",
    "variables": {
      "foo": "string"
    },
    "version": "version"
  },
  "prompt_cache_key": "prompt-cache-key-1234",
  "prompt_cache_retention": "in_memory",
  "reasoning": {
    "effort": "none",
    "generate_summary": "auto",
    "summary": "auto"
  },
  "safety_identifier": "safety-identifier-1234",
  "service_tier": "auto",
  "status": "completed",
  "text": {
    "format": {
      "type": "text"
    },
    "verbosity": "low"
  },
  "top_logprobs": 0,
  "truncation": "auto",
  "usage": {
    "input_tokens": 0,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 0,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 0
  },
  "user": "user-1234"
}

Compact a response

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

post /responses/compact

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

Parameters

ResponseCompactParams params
- Optional<Model> model
  
  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.
  - GPT_5_4("gpt-5.4")
  - GPT_5_4_MINI("gpt-5.4-mini")
  - GPT_5_4_NANO("gpt-5.4-nano")
  - GPT_5_4_MINI_2026_03_17("gpt-5.4-mini-2026-03-17")
  - GPT_5_4_NANO_2026_03_17("gpt-5.4-nano-2026-03-17")
  - GPT_5_3_CHAT_LATEST("gpt-5.3-chat-latest")
  - GPT_5_2("gpt-5.2")
  - GPT_5_2_2025_12_11("gpt-5.2-2025-12-11")
  - GPT_5_2_CHAT_LATEST("gpt-5.2-chat-latest")
  - GPT_5_2_PRO("gpt-5.2-pro")
  - GPT_5_2_PRO_2025_12_11("gpt-5.2-pro-2025-12-11")
  - GPT_5_1("gpt-5.1")
  - GPT_5_1_2025_11_13("gpt-5.1-2025-11-13")
  - GPT_5_1_CODEX("gpt-5.1-codex")
  - GPT_5_1_MINI("gpt-5.1-mini")
  - GPT_5_1_CHAT_LATEST("gpt-5.1-chat-latest")
  - GPT_5("gpt-5")
  - GPT_5_MINI("gpt-5-mini")
  - GPT_5_NANO("gpt-5-nano")
  - GPT_5_2025_08_07("gpt-5-2025-08-07")
  - GPT_5_MINI_2025_08_07("gpt-5-mini-2025-08-07")
  - GPT_5_NANO_2025_08_07("gpt-5-nano-2025-08-07")
  - GPT_5_CHAT_LATEST("gpt-5-chat-latest")
  - GPT_4_1("gpt-4.1")
  - GPT_4_1_MINI("gpt-4.1-mini")
  - GPT_4_1_NANO("gpt-4.1-nano")
  - GPT_4_1_2025_04_14("gpt-4.1-2025-04-14")
  - GPT_4_1_MINI_2025_04_14("gpt-4.1-mini-2025-04-14")
  - GPT_4_1_NANO_2025_04_14("gpt-4.1-nano-2025-04-14")
  - O4_MINI("o4-mini")
  - O4_MINI_2025_04_16("o4-mini-2025-04-16")
  - O3("o3")
  - O3_2025_04_16("o3-2025-04-16")
  - O3_MINI("o3-mini")
  - O3_MINI_2025_01_31("o3-mini-2025-01-31")
  - O1("o1")
  - O1_2024_12_17("o1-2024-12-17")
  - O1_PREVIEW("o1-preview")
  - O1_PREVIEW_2024_09_12("o1-preview-2024-09-12")
  - O1_MINI("o1-mini")
  - O1_MINI_2024_09_12("o1-mini-2024-09-12")
  - GPT_4O("gpt-4o")
  - GPT_4O_2024_11_20("gpt-4o-2024-11-20")
  - GPT_4O_2024_08_06("gpt-4o-2024-08-06")
  - GPT_4O_2024_05_13("gpt-4o-2024-05-13")
  - GPT_4O_AUDIO_PREVIEW("gpt-4o-audio-preview")
  - GPT_4O_AUDIO_PREVIEW_2024_10_01("gpt-4o-audio-preview-2024-10-01")
  - GPT_4O_AUDIO_PREVIEW_2024_12_17("gpt-4o-audio-preview-2024-12-17")
  - GPT_4O_AUDIO_PREVIEW_2025_06_03("gpt-4o-audio-preview-2025-06-03")
  - GPT_4O_MINI_AUDIO_PREVIEW("gpt-4o-mini-audio-preview")
  - GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17("gpt-4o-mini-audio-preview-2024-12-17")
  - GPT_4O_SEARCH_PREVIEW("gpt-4o-search-preview")
  - GPT_4O_MINI_SEARCH_PREVIEW("gpt-4o-mini-search-preview")
  - GPT_4O_SEARCH_PREVIEW_2025_03_11("gpt-4o-search-preview-2025-03-11")
  - GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11("gpt-4o-mini-search-preview-2025-03-11")
  - CHATGPT_4O_LATEST("chatgpt-4o-latest")
  - CODEX_MINI_LATEST("codex-mini-latest")
  - GPT_4O_MINI("gpt-4o-mini")
  - GPT_4O_MINI_2024_07_18("gpt-4o-mini-2024-07-18")
  - GPT_4_TURBO("gpt-4-turbo")
  - GPT_4_TURBO_2024_04_09("gpt-4-turbo-2024-04-09")
  - GPT_4_0125_PREVIEW("gpt-4-0125-preview")
  - GPT_4_TURBO_PREVIEW("gpt-4-turbo-preview")
  - GPT_4_1106_PREVIEW("gpt-4-1106-preview")
  - GPT_4_VISION_PREVIEW("gpt-4-vision-preview")
  - GPT_4("gpt-4")
  - GPT_4_0314("gpt-4-0314")
  - GPT_4_0613("gpt-4-0613")
  - GPT_4_32K("gpt-4-32k")
  - GPT_4_32K_0314("gpt-4-32k-0314")
  - GPT_4_32K_0613("gpt-4-32k-0613")
  - GPT_3_5_TURBO("gpt-3.5-turbo")
  - GPT_3_5_TURBO_16K("gpt-3.5-turbo-16k")
  - GPT_3_5_TURBO_0301("gpt-3.5-turbo-0301")
  - GPT_3_5_TURBO_0613("gpt-3.5-turbo-0613")
  - GPT_3_5_TURBO_1106("gpt-3.5-turbo-1106")
  - GPT_3_5_TURBO_0125("gpt-3.5-turbo-0125")
  - GPT_3_5_TURBO_16K_0613("gpt-3.5-turbo-16k-0613")
  - O1_PRO("o1-pro")
  - O1_PRO_2025_03_19("o1-pro-2025-03-19")
  - O3_PRO("o3-pro")
  - O3_PRO_2025_06_10("o3-pro-2025-06-10")
  - O3_DEEP_RESEARCH("o3-deep-research")
  - O3_DEEP_RESEARCH_2025_06_26("o3-deep-research-2025-06-26")
  - O4_MINI_DEEP_RESEARCH("o4-mini-deep-research")
  - O4_MINI_DEEP_RESEARCH_2025_06_26("o4-mini-deep-research-2025-06-26")
  - COMPUTER_USE_PREVIEW("computer-use-preview")
  - COMPUTER_USE_PREVIEW_2025_03_11("computer-use-preview-2025-03-11")
  - GPT_5_CODEX("gpt-5-codex")
  - GPT_5_PRO("gpt-5-pro")
  - GPT_5_PRO_2025_10_06("gpt-5-pro-2025-10-06")
  - GPT_5_1_CODEX_MAX("gpt-5.1-codex-max")
- Optional<Input> input
  
  Text, image, or file inputs to the model, used to generate a response
  - String
  - List<ResponseInputItem>
    - 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.
        
        String
        
        List<ResponseInputContent>
        
        class ResponseInputText:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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.
        
        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.
        
        COMMENTARY("commentary")
        
        FINAL_ANSWER("final_answer")
      - Optional<Type> type
        
        The type of the message input. Always message.
        
        MESSAGE("message")
    - Message
      - List<ResponseInputContent> content
        
        A list of one or many input items to the model, containing different content types.
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
      - Role role
        
        The role of the message input. One of user, system, or developer.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - Optional<Type> type
        
        The type of the message input. Always set to message.
        
        MESSAGE("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.
        
        class ResponseOutputText:
        
        A text output from the model.
        
        List<Annotation> annotations
        
        The annotations of the text output.
        
        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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
        
        String text
        
        The text output from the model.
        
        JsonValue; type "output_text"constant
        
        The type of the output text. Always output_text.
        
        OUTPUT_TEXT("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
        
        The type of the refusal. Always refusal.
        
        REFUSAL("refusal")
      - JsonValue; role "assistant"constant
        
        The role of the output message. Always assistant.
        
        ASSISTANT("assistant")
      - Status status
        
        The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "message"constant
        
        The type of the output message. Always message.
        
        MESSAGE("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.
        
        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,
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        FAILED("failed")
      - JsonValue; type "file_search_call"constant
        
        The type of the file search tool call. Always file_search_call.
        
        FILE_SEARCH_CALL("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.
        
        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.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - Type type
        
        The type of the computer call. Always computer_call.
        
        COMPUTER_CALL("computer_call")
      - Optional<Action> action
        
        A click action.
        
        class Click:
        
        A click action.
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        class Move:
        
        A mouse move action.
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        class Scroll:
        
        A scroll action.
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
      - Optional<List<ComputerAction>> actions
        
        Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.
        
        Click
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        Move
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        Scroll
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
    - ComputerCallOutput
      - 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.
        
        JsonValue; type "computer_screenshot"constant
        
        Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
        
        COMPUTER_SCREENSHOT("computer_screenshot")
        
        Optional<String> fileId
        
        The identifier of an uploaded file that contains the screenshot.
        
        Optional<String> imageUrl
        
        The URL of the screenshot image.
      - JsonValue; type "computer_call_output"constant
        
        The type of the computer tool call output. Always computer_call_output.
        
        COMPUTER_CALL_OUTPUT("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.
        
        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).
        
        class Search:
        
        Action type "search" - Performs a web search query.
        
        String query
        
        [DEPRECATED] The search query.
        
        JsonValue; type "search"constant
        
        The action type.
        
        SEARCH("search")
        
        Optional<List<String>> queries
        
        The search queries.
        
        Optional<List<Source>> sources
        
        The sources used in the search.
        
        JsonValue; type "url"constant
        
        The type of source. Always url.
        
        URL("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
        
        The action type.
        
        OPEN_PAGE("open_page")
        
        Optional<String> url
        
        The URL opened by the model.
        
        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
        
        The action type.
        
        FIND_IN_PAGE("find_in_page")
        
        String url
        
        The URL of the page searched for the pattern.
      - Status status
        
        The status of the web search tool call.
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        FAILED("failed")
      - JsonValue; type "web_search_call"constant
        
        The type of the web search tool call. Always web_search_call.
        
        WEB_SEARCH_CALL("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
        
        The type of the function tool call. Always function_call.
        
        FUNCTION_CALL("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - FunctionCallOutput
      - String callId
        
        The unique ID of the function tool call generated by the model.
      - Output output
        
        Text, image, or file output of the function tool call.
        
        String
        
        List<ResponseFunctionCallOutputItem>
        
        class ResponseInputTextContent:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("input_text")
        
        class ResponseInputImageContent:
        
        An image input to the model. Learn about image inputs
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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.
        
        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.
        
        class ResponseInputFileContent:
        
        A file input to the model.
        
        JsonValue; type "input_file"constant
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        LOW("low")
        
        HIGH("high")
        
        Optional<String> fileData
        
        The base64-encoded data 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 "function_call_output"constant
        
        The type of the function tool call output. Always function_call_output.
        
        FUNCTION_CALL_OUTPUT("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.
        
        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
        
        The item type. Always tool_search_call.
        
        TOOL_SEARCH_CALL("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.
      - Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
      - Optional<Status> status
        
        The status of the tool search call.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - class ResponseToolSearchOutputItemParam:
      - List<Tool> tools
        
        The loaded tool definitions returned by the tool search output.
        
        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
        
        The type of the function tool. Always function.
        
        FUNCTION("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
        
        The type of the file search tool. Always file_search.
        
        FILE_SEARCH("file_search")
        
        List<String> vectorStoreIds
        
        The IDs of the vector stores to search.
        
        Optional<Filters> filters
        
        A filter to apply.
        
        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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
        
        Type type
        
        Type of operation: and or or.
        
        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.
        
        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
        
        The type of the computer tool. Always computer.
        
        COMPUTER("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.
        
        WINDOWS("windows")
        
        MAC("mac")
        
        LINUX("linux")
        
        UBUNTU("ubuntu")
        
        BROWSER("browser")
        
        JsonValue; type "computer_use_preview"constant
        
        The type of the computer use tool. Always computer_use_preview.
        
        COMPUTER_USE_PREVIEW("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.
        
        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.
        
        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.
        
        APPROXIMATE("approximate")
        
        Mcp
        
        String serverLabel
        
        A label for this MCP server, used to identify it in tool calls.
        
        JsonValue; type "mcp"constant
        
        The type of the MCP tool. Always mcp.
        
        MCP("mcp")
        
        Optional<AllowedTools> allowedTools
        
        List of allowed tool names or a filter object.
        
        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
        
        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.
        
        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.
        
        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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
        
        JsonValue; type "code_interpreter"constant
        
        The type of the code interpreter tool. Always code_interpreter.
        
        CODE_INTERPRETER("code_interpreter")
        
        ImageGeneration
        
        JsonValue; type "image_generation"constant
        
        The type of the image generation tool. Always image_generation.
        
        IMAGE_GENERATION("image_generation")
        
        Optional<Action> action
        
        Whether to generate a new image or edit an existing image. Default: auto.
        
        GENERATE("generate")
        
        EDIT("edit")
        
        AUTO("auto")
        
        Optional<Background> background
        
        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.
        
        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.
        
        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.
        
        GPT_IMAGE_1("gpt-image-1")
        
        GPT_IMAGE_1_MINI("gpt-image-1-mini")
        
        GPT_IMAGE_2("gpt-image-2")
        
        GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
        
        GPT_IMAGE_1_5("gpt-image-1.5")
        
        CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
        
        Optional<Moderation> moderation
        
        Moderation level for the generated image. Default: auto.
        
        AUTO("auto")
        
        LOW("low")
        
        Optional<Long> outputCompression
        
        Compression level for the output image. Default: 100.
        
        Optional<OutputFormat> outputFormat
        
        The output format of the generated image. One of png, webp, or jpeg. Default: png.
        
        PNG("png")
        
        WEBP("webp")
        
        JPEG("jpeg")
        
        Optional<Long> partialImages
        
        Number of partial images to generate in streaming mode, from 0 (default value) to 3.
        
        Optional<Quality> quality
        
        The quality of the generated image. One of low, medium, high, or auto. Default: auto.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        AUTO("auto")
        
        Optional<Size> size
        
        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.
        
        _1024X1024("1024x1024")
        
        _1024X1536("1024x1536")
        
        _1536X1024("1536x1024")
        
        AUTO("auto")
        
        JsonValue;
        
        JsonValue; type "local_shell"constant
        
        The type of the local shell tool. Always local_shell.
        
        LOCAL_SHELL("local_shell")
        
        class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        JsonValue; type "shell"constant
        
        The type of the shell tool. Always shell.
        
        SHELL("shell")
        
        Optional<Environment> environment
        
        class ContainerAuto:
        
        JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
        
        Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
        
        class LocalEnvironment:
        
        JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
        
        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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
        
        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
        
        The type of the custom tool. Always custom.
        
        CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
        
        Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
        
        class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        String description
        
        A description of the namespace shown to the model.
        
        String name
        
        The namespace name used in tool calls (for example, crm).
        
        List<Tool> tools
        
        The function/custom tools available inside this namespace.
        
        class Function:
        
        String name
        
        JsonValue; type "function"constant
        
        FUNCTION("function")
        
        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
        
        JsonValue; type "namespace"constant
        
        The type of the tool. Always namespace.
        
        NAMESPACE("namespace")
        
        class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        JsonValue; type "tool_search"constant
        
        The type of the tool. Always tool_search.
        
        TOOL_SEARCH("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.
        
        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.
        
        WEB_SEARCH_PREVIEW("web_search_preview")
        
        WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
        
        Optional<List<SearchContentType>> searchContentTypes
        
        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.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        Optional<UserLocation> userLocation
        
        The user's location.
        
        JsonValue; type "approximate"constant
        
        The type of location approximation. Always approximate.
        
        APPROXIMATE("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
        
        The type of the tool. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
      - JsonValue; type "tool_search_output"constant
        
        The item type. Always tool_search_output.
        
        TOOL_SEARCH_OUTPUT("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.
      - Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
      - Optional<Status> status
        
        The status of the tool search output.
        
        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
        
        The type of the object. Always summary_text.
        
        SUMMARY_TEXT("summary_text")
      - JsonValue; type "reasoning"constant
        
        The type of the object. Always reasoning.
        
        REASONING("reasoning")
      - Optional<List<Content>> content
        
        Reasoning text content.
        
        String text
        
        The reasoning text from the model.
        
        JsonValue; type "reasoning_text"constant
        
        The type of the reasoning text. Always reasoning_text.
        
        REASONING_TEXT("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.
        
        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.
      - JsonValue; type "compaction"constant
        
        The type of the item. Always compaction.
        
        COMPACTION("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        GENERATING("generating")
        
        FAILED("failed")
      - JsonValue; type "image_generation_call"constant
        
        The type of the image generation call. Always image_generation_call.
        
        IMAGE_GENERATION_CALL("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.
        
        class Logs:
        
        The logs output from the code interpreter.
        
        String logs
        
        The logs output from the code interpreter.
        
        JsonValue; type "logs"constant
        
        The type of the output. Always logs.
        
        LOGS("logs")
        
        class Image:
        
        The image output from the code interpreter.
        
        JsonValue; type "image"constant
        
        The type of the output. Always image.
        
        IMAGE("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        INTERPRETING("interpreting")
        
        FAILED("failed")
      - JsonValue; type "code_interpreter_call"constant
        
        The type of the code interpreter tool call. Always code_interpreter_call.
        
        CODE_INTERPRETER_CALL("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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "local_shell_call"constant
        
        The type of the local shell call. Always local_shell_call.
        
        LOCAL_SHELL_CALL("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
        
        The type of the local shell tool call output. Always local_shell_call_output.
        
        LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
      - Optional<Status> status
        
        The status of the item. One of in_progress, completed, or incomplete.
        
        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.
      - JsonValue; type "shell_call"constant
        
        The type of the item. Always shell_call.
        
        SHELL_CALL("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.
        
        class LocalEnvironment:
        
        class ContainerReference:
      - Optional<Status> status
        
        The status of the shell call. One of in_progress, completed, or incomplete.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - ShellCallOutput
      - String callId
        
        The unique ID of the shell tool call generated by the model.
      - 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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("exit")
        
        String stderr
        
        Captured stderr output for the shell call.
        
        String stdout
        
        Captured stdout output for the shell call.
      - JsonValue; type "shell_call_output"constant
        
        The type of the item. Always shell_call_output.
        
        SHELL_CALL_OUTPUT("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - ApplyPatchCall
      - String callId
        
        The unique ID of the apply patch tool call generated by the model.
      - Operation operation
        
        The specific create, delete, or update instruction for the apply_patch tool call.
        
        class CreateFile:
        
        Instruction for creating a new file via the apply_patch tool.
        
        String diff
        
        Unified diff content to apply when creating the file.
        
        String path
        
        Path of the file to create relative to the workspace root.
        
        JsonValue; type "create_file"constant
        
        The operation type. Always create_file.
        
        CREATE_FILE("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.
        
        JsonValue; type "delete_file"constant
        
        The operation type. Always delete_file.
        
        DELETE_FILE("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.
        
        String path
        
        Path of the file to update relative to the workspace root.
        
        JsonValue; type "update_file"constant
        
        The operation type. Always update_file.
        
        UPDATE_FILE("update_file")
      - Status status
        
        The status of the apply patch tool call. One of in_progress or completed.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
      - JsonValue; type "apply_patch_call"constant
        
        The type of the item. Always apply_patch_call.
        
        APPLY_PATCH_CALL("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.
      - Status status
        
        The status of the apply patch tool call output. One of completed or failed.
        
        COMPLETED("completed")
        
        FAILED("failed")
      - JsonValue; type "apply_patch_call_output"constant
        
        The type of the item. Always apply_patch_call_output.
        
        APPLY_PATCH_CALL_OUTPUT("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).
    - 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
        
        The type of the item. Always mcp_list_tools.
        
        MCP_LIST_TOOLS("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
        
        The type of the item. Always mcp_approval_request.
        
        MCP_APPROVAL_REQUEST("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
        
        The type of the item. Always mcp_approval_response.
        
        MCP_APPROVAL_RESPONSE("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
        
        The type of the item. Always mcp_call.
        
        MCP_CALL("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.
        
        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.
        
        String
        
        List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
      - JsonValue; type "custom_tool_call_output"constant
        
        The type of the custom tool call output. Always custom_tool_call_output.
        
        CUSTOM_TOOL_CALL_OUTPUT("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
        
        The type of the custom tool call. Always custom_tool_call.
        
        CUSTOM_TOOL_CALL("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.
    - JsonValue;
      - JsonValue; type "compaction_trigger"constant
        
        The type of the item. Always compaction_trigger.
        
        COMPACTION_TRIGGER("compaction_trigger")
    - ItemReference
      - String id
        
        The ID of the item to reference.
      - Optional<Type> type
        
        The type of item to reference. Always item_reference.
        
        ITEM_REFERENCE("item_reference")
- Optional<String> instructions
  
  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.
- 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<String> promptCacheKey
  
  A key to use when reading from or writing to the prompt cache.
- Optional<PromptCacheRetention> promptCacheRetention
  
  How long to retain a prompt cache entry created by this request.
  - IN_MEMORY("in_memory")
  - _24H("24h")
- Optional<ServiceTier> serviceTier
  
  The service tier to use for this request.
  - AUTO("auto")
  - DEFAULT("default")
  - FLEX("flex")
  - PRIORITY("priority")

Returns

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
  
  The object type. Always response.compaction.
  - RESPONSE_COMPACTION("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.
  - 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.
      - class ResponseOutputText:
        
        A text output from the model.
        
        List<Annotation> annotations
        
        The annotations of the text output.
        
        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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
        
        String text
        
        The text output from the model.
        
        JsonValue; type "output_text"constant
        
        The type of the output text. Always output_text.
        
        OUTPUT_TEXT("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
        
        The type of the refusal. Always refusal.
        
        REFUSAL("refusal")
    - JsonValue; role "assistant"constant
      
      The role of the output message. Always assistant.
      - ASSISTANT("assistant")
    - Status status
      
      The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "message"constant
      
      The type of the output message. Always message.
      - MESSAGE("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.
      - 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,
      - IN_PROGRESS("in_progress")
      - SEARCHING("searching")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
      - FAILED("failed")
    - JsonValue; type "file_search_call"constant
      
      The type of the file search tool call. Always file_search_call.
      - FILE_SEARCH_CALL("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.
        
        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.
      - 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
      
      The type of the function tool call. Always function_call.
      - FUNCTION_CALL("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.
      - 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.
      - String
      - List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "function_call_output"constant
      
      The type of the function tool call output. Always function_call_output.
      - FUNCTION_CALL_OUTPUT("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).
      - class Search:
        
        Action type "search" - Performs a web search query.
        
        String query
        
        [DEPRECATED] The search query.
        
        JsonValue; type "search"constant
        
        The action type.
        
        SEARCH("search")
        
        Optional<List<String>> queries
        
        The search queries.
        
        Optional<List<Source>> sources
        
        The sources used in the search.
        
        JsonValue; type "url"constant
        
        The type of source. Always url.
        
        URL("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
        
        The action type.
        
        OPEN_PAGE("open_page")
        
        Optional<String> url
        
        The URL opened by the model.
      - 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
        
        The action type.
        
        FIND_IN_PAGE("find_in_page")
        
        String url
        
        The URL of the page searched for the pattern.
    - Status status
      
      The status of the web search tool call.
      - IN_PROGRESS("in_progress")
      - SEARCHING("searching")
      - COMPLETED("completed")
      - FAILED("failed")
    - JsonValue; type "web_search_call"constant
      
      The type of the web search tool call. Always web_search_call.
      - WEB_SEARCH_CALL("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - Type type
      
      The type of the computer call. Always computer_call.
      - COMPUTER_CALL("computer_call")
    - Optional<Action> action
      
      A click action.
      - class Click:
        
        A click action.
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
      - class Move:
        
        A mouse move action.
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
      - class Scroll:
        
        A scroll action.
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
      - JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
    - Optional<List<ComputerAction>> actions
      
      Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.
      - Click
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
      - Move
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
      - Scroll
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
      - JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
  - 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.
      - JsonValue; type "computer_screenshot"constant
        
        Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
        
        COMPUTER_SCREENSHOT("computer_screenshot")
      - Optional<String> fileId
        
        The identifier of an uploaded file that contains the screenshot.
      - Optional<String> imageUrl
        
        The URL of the screenshot image.
    - Status status
      
      The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
      - FAILED("failed")
      - IN_PROGRESS("in_progress")
    - JsonValue; type "computer_call_output"constant
      
      The type of the computer tool call output. Always computer_call_output.
      - COMPUTER_CALL_OUTPUT("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
        
        The type of the object. Always summary_text.
        
        SUMMARY_TEXT("summary_text")
    - JsonValue; type "reasoning"constant
      
      The type of the object. Always reasoning.
      - REASONING("reasoning")
    - Optional<List<Content>> content
      
      Reasoning text content.
      - String text
        
        The reasoning text from the model.
      - JsonValue; type "reasoning_text"constant
        
        The type of the reasoning text. Always reasoning_text.
        
        REASONING_TEXT("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.
      - 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.
      - SERVER("server")
      - CLIENT("client")
    - Status status
      
      The status of the tool search call item that was recorded.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "tool_search_call"constant
      
      The type of the item. Always tool_search_call.
      - TOOL_SEARCH_CALL("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.
      - SERVER("server")
      - CLIENT("client")
    - Status status
      
      The status of the tool search output item that was recorded.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - List<Tool> tools
      
      The loaded tool definitions returned by tool search.
      - 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
        
        The type of the function tool. Always function.
        
        FUNCTION("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
        
        The type of the file search tool. Always file_search.
        
        FILE_SEARCH("file_search")
        
        List<String> vectorStoreIds
        
        The IDs of the vector stores to search.
        
        Optional<Filters> filters
        
        A filter to apply.
        
        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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
        
        Type type
        
        Type of operation: and or or.
        
        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.
        
        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
        
        The type of the computer tool. Always computer.
        
        COMPUTER("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.
        
        WINDOWS("windows")
        
        MAC("mac")
        
        LINUX("linux")
        
        UBUNTU("ubuntu")
        
        BROWSER("browser")
        
        JsonValue; type "computer_use_preview"constant
        
        The type of the computer use tool. Always computer_use_preview.
        
        COMPUTER_USE_PREVIEW("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.
        
        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.
        
        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.
        
        APPROXIMATE("approximate")
      - Mcp
        
        String serverLabel
        
        A label for this MCP server, used to identify it in tool calls.
        
        JsonValue; type "mcp"constant
        
        The type of the MCP tool. Always mcp.
        
        MCP("mcp")
        
        Optional<AllowedTools> allowedTools
        
        List of allowed tool names or a filter object.
        
        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
        
        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.
        
        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.
        
        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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
        
        JsonValue; type "code_interpreter"constant
        
        The type of the code interpreter tool. Always code_interpreter.
        
        CODE_INTERPRETER("code_interpreter")
      - ImageGeneration
        
        JsonValue; type "image_generation"constant
        
        The type of the image generation tool. Always image_generation.
        
        IMAGE_GENERATION("image_generation")
        
        Optional<Action> action
        
        Whether to generate a new image or edit an existing image. Default: auto.
        
        GENERATE("generate")
        
        EDIT("edit")
        
        AUTO("auto")
        
        Optional<Background> background
        
        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.
        
        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.
        
        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.
        
        GPT_IMAGE_1("gpt-image-1")
        
        GPT_IMAGE_1_MINI("gpt-image-1-mini")
        
        GPT_IMAGE_2("gpt-image-2")
        
        GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
        
        GPT_IMAGE_1_5("gpt-image-1.5")
        
        CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
        
        Optional<Moderation> moderation
        
        Moderation level for the generated image. Default: auto.
        
        AUTO("auto")
        
        LOW("low")
        
        Optional<Long> outputCompression
        
        Compression level for the output image. Default: 100.
        
        Optional<OutputFormat> outputFormat
        
        The output format of the generated image. One of png, webp, or jpeg. Default: png.
        
        PNG("png")
        
        WEBP("webp")
        
        JPEG("jpeg")
        
        Optional<Long> partialImages
        
        Number of partial images to generate in streaming mode, from 0 (default value) to 3.
        
        Optional<Quality> quality
        
        The quality of the generated image. One of low, medium, high, or auto. Default: auto.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        AUTO("auto")
        
        Optional<Size> size
        
        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.
        
        _1024X1024("1024x1024")
        
        _1024X1536("1024x1536")
        
        _1536X1024("1536x1024")
        
        AUTO("auto")
      - JsonValue;
        
        JsonValue; type "local_shell"constant
        
        The type of the local shell tool. Always local_shell.
        
        LOCAL_SHELL("local_shell")
      - class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        JsonValue; type "shell"constant
        
        The type of the shell tool. Always shell.
        
        SHELL("shell")
        
        Optional<Environment> environment
        
        class ContainerAuto:
        
        JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
        
        Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
        
        class LocalEnvironment:
        
        JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
        
        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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
      - 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
        
        The type of the custom tool. Always custom.
        
        CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
        
        Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
      - class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        String description
        
        A description of the namespace shown to the model.
        
        String name
        
        The namespace name used in tool calls (for example, crm).
        
        List<Tool> tools
        
        The function/custom tools available inside this namespace.
        
        class Function:
        
        String name
        
        JsonValue; type "function"constant
        
        FUNCTION("function")
        
        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
        
        JsonValue; type "namespace"constant
        
        The type of the tool. Always namespace.
        
        NAMESPACE("namespace")
      - class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        JsonValue; type "tool_search"constant
        
        The type of the tool. Always tool_search.
        
        TOOL_SEARCH("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.
        
        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.
        
        WEB_SEARCH_PREVIEW("web_search_preview")
        
        WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
        
        Optional<List<SearchContentType>> searchContentTypes
        
        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.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        Optional<UserLocation> userLocation
        
        The user's location.
        
        JsonValue; type "approximate"constant
        
        The type of location approximation. Always approximate.
        
        APPROXIMATE("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
        
        The type of the tool. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
    - JsonValue; type "tool_search_output"constant
      
      The type of the item. Always tool_search_output.
      - TOOL_SEARCH_OUTPUT("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
      
      The type of the item. Always compaction.
      - COMPACTION("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - GENERATING("generating")
      - FAILED("failed")
    - JsonValue; type "image_generation_call"constant
      
      The type of the image generation call. Always image_generation_call.
      - IMAGE_GENERATION_CALL("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.
      - class Logs:
        
        The logs output from the code interpreter.
        
        String logs
        
        The logs output from the code interpreter.
        
        JsonValue; type "logs"constant
        
        The type of the output. Always logs.
        
        LOGS("logs")
      - class Image:
        
        The image output from the code interpreter.
        
        JsonValue; type "image"constant
        
        The type of the output. Always image.
        
        IMAGE("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
      - INTERPRETING("interpreting")
      - FAILED("failed")
    - JsonValue; type "code_interpreter_call"constant
      
      The type of the code interpreter tool call. Always code_interpreter_call.
      - CODE_INTERPRETER_CALL("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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "local_shell_call"constant
      
      The type of the local shell call. Always local_shell_call.
      - LOCAL_SHELL_CALL("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
      
      The type of the local shell tool call output. Always local_shell_call_output.
      - LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
    - Optional<Status> status
      
      The status of the item. One of in_progress, completed, or incomplete.
      - 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.
      - class ResponseLocalEnvironment:
        
        Represents the use of a local environment to perform shell actions.
        
        JsonValue; type "local"constant
        
        The environment type. Always local.
        
        LOCAL("local")
      - class ResponseContainerReference:
        
        Represents a container created with /v1/containers.
        
        String containerId
        
        JsonValue; type "container_reference"constant
        
        The environment type. Always container_reference.
        
        CONTAINER_REFERENCE("container_reference")
    - Status status
      
      The status of the shell call. One of in_progress, completed, or incomplete.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "shell_call"constant
      
      The type of the item. Always shell_call.
      - SHELL_CALL("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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "shell_call_output"constant
      
      The type of the shell call output. Always shell_call_output.
      - SHELL_CALL_OUTPUT("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.
      - 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 a new file with the provided diff.
        
        CREATE_FILE("create_file")
      - 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 the specified file.
        
        DELETE_FILE("delete_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 an existing file with the provided diff.
        
        UPDATE_FILE("update_file")
    - Status status
      
      The status of the apply patch tool call. One of in_progress or completed.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
    - JsonValue; type "apply_patch_call"constant
      
      The type of the item. Always apply_patch_call.
      - APPLY_PATCH_CALL("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.
      - COMPLETED("completed")
      - FAILED("failed")
    - JsonValue; type "apply_patch_call_output"constant
      
      The type of the item. Always apply_patch_call_output.
      - APPLY_PATCH_CALL_OUTPUT("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
      
      The type of the item. Always mcp_call.
      - MCP_CALL("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.
      - 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
      
      The type of the item. Always mcp_list_tools.
      - MCP_LIST_TOOLS("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
      
      The type of the item. Always mcp_approval_request.
      - MCP_APPROVAL_REQUEST("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
      
      The type of the item. Always mcp_approval_response.
      - MCP_APPROVAL_RESPONSE("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
      
      The type of the custom tool call. Always custom_tool_call.
      - CUSTOM_TOOL_CALL("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.
      - 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.
  - 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.

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.responses.CompactedResponse;
import com.openai.models.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_4)
            .build();
        CompactedResponse compactedResponse = client.responses().compact(params);
    }
}

Response

{
  "id": "id",
  "created_at": 0,
  "object": "response.compaction",
  "output": [
    {
      "id": "id",
      "content": [
        {
          "annotations": [
            {
              "file_id": "file_id",
              "filename": "filename",
              "index": 0,
              "type": "file_citation"
            }
          ],
          "text": "text",
          "type": "output_text",
          "logprobs": [
            {
              "token": "token",
              "bytes": [
                0
              ],
              "logprob": 0,
              "top_logprobs": [
                {
                  "token": "token",
                  "bytes": [
                    0
                  ],
                  "logprob": 0
                }
              ]
            }
          ]
        }
      ],
      "role": "assistant",
      "status": "in_progress",
      "type": "message",
      "phase": "commentary"
    }
  ],
  "usage": {
    "input_tokens": 0,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 0,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 0
  }
}

Domain Types

Apply Patch Tool

class ApplyPatchTool:

Allows the assistant to create, delete, or update files using unified diffs.
- JsonValue; type "apply_patch"constant
  
  The type of the tool. Always apply_patch.
  - APPLY_PATCH("apply_patch")

Compacted Response

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
  
  The object type. Always response.compaction.
  - RESPONSE_COMPACTION("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.
  - 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.
      - class ResponseOutputText:
        
        A text output from the model.
        
        List<Annotation> annotations
        
        The annotations of the text output.
        
        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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
        
        String text
        
        The text output from the model.
        
        JsonValue; type "output_text"constant
        
        The type of the output text. Always output_text.
        
        OUTPUT_TEXT("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
        
        The type of the refusal. Always refusal.
        
        REFUSAL("refusal")
    - JsonValue; role "assistant"constant
      
      The role of the output message. Always assistant.
      - ASSISTANT("assistant")
    - Status status
      
      The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "message"constant
      
      The type of the output message. Always message.
      - MESSAGE("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.
      - 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,
      - IN_PROGRESS("in_progress")
      - SEARCHING("searching")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
      - FAILED("failed")
    - JsonValue; type "file_search_call"constant
      
      The type of the file search tool call. Always file_search_call.
      - FILE_SEARCH_CALL("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.
        
        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.
      - 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
      
      The type of the function tool call. Always function_call.
      - FUNCTION_CALL("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.
      - 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.
      - String
      - List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "function_call_output"constant
      
      The type of the function tool call output. Always function_call_output.
      - FUNCTION_CALL_OUTPUT("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).
      - class Search:
        
        Action type "search" - Performs a web search query.
        
        String query
        
        [DEPRECATED] The search query.
        
        JsonValue; type "search"constant
        
        The action type.
        
        SEARCH("search")
        
        Optional<List<String>> queries
        
        The search queries.
        
        Optional<List<Source>> sources
        
        The sources used in the search.
        
        JsonValue; type "url"constant
        
        The type of source. Always url.
        
        URL("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
        
        The action type.
        
        OPEN_PAGE("open_page")
        
        Optional<String> url
        
        The URL opened by the model.
      - 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
        
        The action type.
        
        FIND_IN_PAGE("find_in_page")
        
        String url
        
        The URL of the page searched for the pattern.
    - Status status
      
      The status of the web search tool call.
      - IN_PROGRESS("in_progress")
      - SEARCHING("searching")
      - COMPLETED("completed")
      - FAILED("failed")
    - JsonValue; type "web_search_call"constant
      
      The type of the web search tool call. Always web_search_call.
      - WEB_SEARCH_CALL("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - Type type
      
      The type of the computer call. Always computer_call.
      - COMPUTER_CALL("computer_call")
    - Optional<Action> action
      
      A click action.
      - class Click:
        
        A click action.
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
      - class Move:
        
        A mouse move action.
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
      - class Scroll:
        
        A scroll action.
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
      - JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
    - Optional<List<ComputerAction>> actions
      
      Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.
      - Click
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
      - Move
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
      - Scroll
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
      - JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
  - 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.
      - JsonValue; type "computer_screenshot"constant
        
        Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
        
        COMPUTER_SCREENSHOT("computer_screenshot")
      - Optional<String> fileId
        
        The identifier of an uploaded file that contains the screenshot.
      - Optional<String> imageUrl
        
        The URL of the screenshot image.
    - Status status
      
      The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
      - FAILED("failed")
      - IN_PROGRESS("in_progress")
    - JsonValue; type "computer_call_output"constant
      
      The type of the computer tool call output. Always computer_call_output.
      - COMPUTER_CALL_OUTPUT("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
        
        The type of the object. Always summary_text.
        
        SUMMARY_TEXT("summary_text")
    - JsonValue; type "reasoning"constant
      
      The type of the object. Always reasoning.
      - REASONING("reasoning")
    - Optional<List<Content>> content
      
      Reasoning text content.
      - String text
        
        The reasoning text from the model.
      - JsonValue; type "reasoning_text"constant
        
        The type of the reasoning text. Always reasoning_text.
        
        REASONING_TEXT("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.
      - 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.
      - SERVER("server")
      - CLIENT("client")
    - Status status
      
      The status of the tool search call item that was recorded.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "tool_search_call"constant
      
      The type of the item. Always tool_search_call.
      - TOOL_SEARCH_CALL("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.
      - SERVER("server")
      - CLIENT("client")
    - Status status
      
      The status of the tool search output item that was recorded.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - List<Tool> tools
      
      The loaded tool definitions returned by tool search.
      - 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
        
        The type of the function tool. Always function.
        
        FUNCTION("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
        
        The type of the file search tool. Always file_search.
        
        FILE_SEARCH("file_search")
        
        List<String> vectorStoreIds
        
        The IDs of the vector stores to search.
        
        Optional<Filters> filters
        
        A filter to apply.
        
        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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
        
        Type type
        
        Type of operation: and or or.
        
        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.
        
        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
        
        The type of the computer tool. Always computer.
        
        COMPUTER("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.
        
        WINDOWS("windows")
        
        MAC("mac")
        
        LINUX("linux")
        
        UBUNTU("ubuntu")
        
        BROWSER("browser")
        
        JsonValue; type "computer_use_preview"constant
        
        The type of the computer use tool. Always computer_use_preview.
        
        COMPUTER_USE_PREVIEW("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.
        
        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.
        
        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.
        
        APPROXIMATE("approximate")
      - Mcp
        
        String serverLabel
        
        A label for this MCP server, used to identify it in tool calls.
        
        JsonValue; type "mcp"constant
        
        The type of the MCP tool. Always mcp.
        
        MCP("mcp")
        
        Optional<AllowedTools> allowedTools
        
        List of allowed tool names or a filter object.
        
        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
        
        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.
        
        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.
        
        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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
        
        JsonValue; type "code_interpreter"constant
        
        The type of the code interpreter tool. Always code_interpreter.
        
        CODE_INTERPRETER("code_interpreter")
      - ImageGeneration
        
        JsonValue; type "image_generation"constant
        
        The type of the image generation tool. Always image_generation.
        
        IMAGE_GENERATION("image_generation")
        
        Optional<Action> action
        
        Whether to generate a new image or edit an existing image. Default: auto.
        
        GENERATE("generate")
        
        EDIT("edit")
        
        AUTO("auto")
        
        Optional<Background> background
        
        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.
        
        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.
        
        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.
        
        GPT_IMAGE_1("gpt-image-1")
        
        GPT_IMAGE_1_MINI("gpt-image-1-mini")
        
        GPT_IMAGE_2("gpt-image-2")
        
        GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
        
        GPT_IMAGE_1_5("gpt-image-1.5")
        
        CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
        
        Optional<Moderation> moderation
        
        Moderation level for the generated image. Default: auto.
        
        AUTO("auto")
        
        LOW("low")
        
        Optional<Long> outputCompression
        
        Compression level for the output image. Default: 100.
        
        Optional<OutputFormat> outputFormat
        
        The output format of the generated image. One of png, webp, or jpeg. Default: png.
        
        PNG("png")
        
        WEBP("webp")
        
        JPEG("jpeg")
        
        Optional<Long> partialImages
        
        Number of partial images to generate in streaming mode, from 0 (default value) to 3.
        
        Optional<Quality> quality
        
        The quality of the generated image. One of low, medium, high, or auto. Default: auto.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        AUTO("auto")
        
        Optional<Size> size
        
        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.
        
        _1024X1024("1024x1024")
        
        _1024X1536("1024x1536")
        
        _1536X1024("1536x1024")
        
        AUTO("auto")
      - JsonValue;
        
        JsonValue; type "local_shell"constant
        
        The type of the local shell tool. Always local_shell.
        
        LOCAL_SHELL("local_shell")
      - class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        JsonValue; type "shell"constant
        
        The type of the shell tool. Always shell.
        
        SHELL("shell")
        
        Optional<Environment> environment
        
        class ContainerAuto:
        
        JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
        
        Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
        
        class LocalEnvironment:
        
        JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
        
        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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
      - 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
        
        The type of the custom tool. Always custom.
        
        CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
        
        Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
      - class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        String description
        
        A description of the namespace shown to the model.
        
        String name
        
        The namespace name used in tool calls (for example, crm).
        
        List<Tool> tools
        
        The function/custom tools available inside this namespace.
        
        class Function:
        
        String name
        
        JsonValue; type "function"constant
        
        FUNCTION("function")
        
        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
        
        JsonValue; type "namespace"constant
        
        The type of the tool. Always namespace.
        
        NAMESPACE("namespace")
      - class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        JsonValue; type "tool_search"constant
        
        The type of the tool. Always tool_search.
        
        TOOL_SEARCH("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.
        
        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.
        
        WEB_SEARCH_PREVIEW("web_search_preview")
        
        WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
        
        Optional<List<SearchContentType>> searchContentTypes
        
        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.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        Optional<UserLocation> userLocation
        
        The user's location.
        
        JsonValue; type "approximate"constant
        
        The type of location approximation. Always approximate.
        
        APPROXIMATE("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
        
        The type of the tool. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
    - JsonValue; type "tool_search_output"constant
      
      The type of the item. Always tool_search_output.
      - TOOL_SEARCH_OUTPUT("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
      
      The type of the item. Always compaction.
      - COMPACTION("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - GENERATING("generating")
      - FAILED("failed")
    - JsonValue; type "image_generation_call"constant
      
      The type of the image generation call. Always image_generation_call.
      - IMAGE_GENERATION_CALL("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.
      - class Logs:
        
        The logs output from the code interpreter.
        
        String logs
        
        The logs output from the code interpreter.
        
        JsonValue; type "logs"constant
        
        The type of the output. Always logs.
        
        LOGS("logs")
      - class Image:
        
        The image output from the code interpreter.
        
        JsonValue; type "image"constant
        
        The type of the output. Always image.
        
        IMAGE("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
      - INTERPRETING("interpreting")
      - FAILED("failed")
    - JsonValue; type "code_interpreter_call"constant
      
      The type of the code interpreter tool call. Always code_interpreter_call.
      - CODE_INTERPRETER_CALL("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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "local_shell_call"constant
      
      The type of the local shell call. Always local_shell_call.
      - LOCAL_SHELL_CALL("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
      
      The type of the local shell tool call output. Always local_shell_call_output.
      - LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
    - Optional<Status> status
      
      The status of the item. One of in_progress, completed, or incomplete.
      - 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.
      - class ResponseLocalEnvironment:
        
        Represents the use of a local environment to perform shell actions.
        
        JsonValue; type "local"constant
        
        The environment type. Always local.
        
        LOCAL("local")
      - class ResponseContainerReference:
        
        Represents a container created with /v1/containers.
        
        String containerId
        
        JsonValue; type "container_reference"constant
        
        The environment type. Always container_reference.
        
        CONTAINER_REFERENCE("container_reference")
    - Status status
      
      The status of the shell call. One of in_progress, completed, or incomplete.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "shell_call"constant
      
      The type of the item. Always shell_call.
      - SHELL_CALL("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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "shell_call_output"constant
      
      The type of the shell call output. Always shell_call_output.
      - SHELL_CALL_OUTPUT("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.
      - 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 a new file with the provided diff.
        
        CREATE_FILE("create_file")
      - 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 the specified file.
        
        DELETE_FILE("delete_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 an existing file with the provided diff.
        
        UPDATE_FILE("update_file")
    - Status status
      
      The status of the apply patch tool call. One of in_progress or completed.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
    - JsonValue; type "apply_patch_call"constant
      
      The type of the item. Always apply_patch_call.
      - APPLY_PATCH_CALL("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.
      - COMPLETED("completed")
      - FAILED("failed")
    - JsonValue; type "apply_patch_call_output"constant
      
      The type of the item. Always apply_patch_call_output.
      - APPLY_PATCH_CALL_OUTPUT("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
      
      The type of the item. Always mcp_call.
      - MCP_CALL("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.
      - 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
      
      The type of the item. Always mcp_list_tools.
      - MCP_LIST_TOOLS("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
      
      The type of the item. Always mcp_approval_request.
      - MCP_APPROVAL_REQUEST("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
      
      The type of the item. Always mcp_approval_response.
      - MCP_APPROVAL_RESPONSE("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
      
      The type of the custom tool call. Always custom_tool_call.
      - CUSTOM_TOOL_CALL("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.
      - 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.
  - 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.

Computer Action

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.
    - LEFT("left")
    - RIGHT("right")
    - WHEEL("wheel")
    - BACK("back")
    - FORWARD("forward")
  - JsonValue; type "click"constant
    
    Specifies the event type. For a click action, this property is always click.
    - CLICK("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
    
    Specifies the event type. For a double click action, this property is always set to double_click.
    - DOUBLE_CLICK("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
    
    Specifies the event type. For a drag action, this property is always set to drag.
    - DRAG("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
    
    Specifies the event type. For a keypress action, this property is always set to keypress.
    - KEYPRESS("keypress")
- Move
  - JsonValue; type "move"constant
    
    Specifies the event type. For a move action, this property is always set to move.
    - MOVE("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
    
    Specifies the event type. For a screenshot action, this property is always set to screenshot.
    - SCREENSHOT("screenshot")
- Scroll
  - long scrollX
    
    The horizontal scroll distance.
  - long scrollY
    
    The vertical scroll distance.
  - JsonValue; type "scroll"constant
    
    Specifies the event type. For a scroll action, this property is always set to scroll.
    - SCROLL("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
    
    Specifies the event type. For a type action, this property is always set to type.
    - TYPE("type")
- JsonValue;
  - JsonValue; type "wait"constant
    
    Specifies the event type. For a wait action, this property is always set to wait.
    - WAIT("wait")

Computer Tool

class ComputerTool:

A tool that controls a virtual computer. Learn more about the computer tool.
- JsonValue; type "computer"constant
  
  The type of the computer tool. Always computer.
  - COMPUTER("computer")

Computer Use Preview Tool

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.
  - WINDOWS("windows")
  - MAC("mac")
  - LINUX("linux")
  - UBUNTU("ubuntu")
  - BROWSER("browser")
- JsonValue; type "computer_use_preview"constant
  
  The type of the computer use tool. Always computer_use_preview.
  - COMPUTER_USE_PREVIEW("computer_use_preview")

Container Auto

class ContainerAuto:
- JsonValue; type "container_auto"constant
  
  Automatically creates a container for this request
  - CONTAINER_AUTO("container_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 container.
  - _1G("1g")
  - _4G("4g")
  - _16G("16g")
  - _64G("64g")
- Optional<NetworkPolicy> networkPolicy
  
  Network access policy for the container.
  - class ContainerNetworkPolicyDisabled:
    - JsonValue; type "disabled"constant
      
      Disable outbound network access. Always disabled.
      - DISABLED("disabled")
  - class ContainerNetworkPolicyAllowlist:
    - List<String> allowedDomains
      
      A list of allowed domains when type is allowlist.
    - JsonValue; type "allowlist"constant
      
      Allow outbound network access only to specified domains. Always allowlist.
      - ALLOWLIST("allowlist")
    - Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
      
      Optional domain-scoped secrets for allowlisted domains.
      - String domain
        
        The domain associated with the secret.
      - String name
        
        The name of the secret to inject for the domain.
      - String value
        
        The secret value to inject for the domain.
- Optional<List<Skill>> skills
  
  An optional list of skills referenced by id or inline data.
  - class SkillReference:
    - String skillId
      
      The ID of the referenced skill.
    - JsonValue; type "skill_reference"constant
      
      References a skill created with the /v1/skills endpoint.
      - SKILL_REFERENCE("skill_reference")
    - 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
      - String data
        
        Base64-encoded skill zip bundle.
      - JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
      - JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
    - JsonValue; type "inline"constant
      
      Defines an inline skill for this request.
      - INLINE("inline")

Container Network Policy Allowlist

class ContainerNetworkPolicyAllowlist:
- List<String> allowedDomains
  
  A list of allowed domains when type is allowlist.
- JsonValue; type "allowlist"constant
  
  Allow outbound network access only to specified domains. Always allowlist.
  - ALLOWLIST("allowlist")
- Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
  
  Optional domain-scoped secrets for allowlisted domains.
  - String domain
    
    The domain associated with the secret.
  - String name
    
    The name of the secret to inject for the domain.
  - String value
    
    The secret value to inject for the domain.

Container Network Policy Disabled

class ContainerNetworkPolicyDisabled:
- JsonValue; type "disabled"constant
  
  Disable outbound network access. Always disabled.
  - DISABLED("disabled")

Container Network Policy Domain Secret

class ContainerNetworkPolicyDomainSecret:
- String domain
  
  The domain associated with the secret.
- String name
  
  The name of the secret to inject for the domain.
- String value
  
  The secret value to inject for the domain.

Container Reference

class ContainerReference:
- String containerId
  
  The ID of the referenced container.
- JsonValue; type "container_reference"constant
  
  References a container created with the /v1/containers endpoint
  - CONTAINER_REFERENCE("container_reference")

Custom Tool

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
  
  The type of the custom tool. Always custom.
  - CUSTOM("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;
    - JsonValue; type "text"constant
      
      Unconstrained text format. Always text.
      - TEXT("text")
  - Grammar
    - String definition
      
      The grammar definition.
    - Syntax syntax
      
      The syntax of the grammar definition. One of lark or regex.
      - LARK("lark")
      - REGEX("regex")
    - JsonValue; type "grammar"constant
      
      Grammar format. Always grammar.
      - GRAMMAR("grammar")

Easy Input Message

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.
  - String
  - List<ResponseInputContent>
    - class ResponseInputText:
      
      A text input to the model.
      - String text
        
        The text input to the model.
      - JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
      - JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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.
  - 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.
  - COMMENTARY("commentary")
  - FINAL_ANSWER("final_answer")
- Optional<Type> type
  
  The type of the message input. Always message.
  - MESSAGE("message")

File Search Tool

class FileSearchTool:

A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
- JsonValue; type "file_search"constant
  
  The type of the file search tool. Always file_search.
  - FILE_SEARCH("file_search")
- List<String> vectorStoreIds
  
  The IDs of the vector stores to search.
- Optional<Filters> filters
  
  A filter to apply.
  - 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
      - 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.
      - String
      - double
      - boolean
      - List<ComparisonFilterValueItem>
        
        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.
      - class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
      - JsonValue
    - Type type
      
      Type of operation: and or or.
      - 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.
    - 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.

Function Shell Tool

class FunctionShellTool:

A tool that allows the model to execute shell commands.
- JsonValue; type "shell"constant
  
  The type of the shell tool. Always shell.
  - SHELL("shell")
- Optional<Environment> environment
  - class ContainerAuto:
    - JsonValue; type "container_auto"constant
      
      Automatically creates a container for this request
      - CONTAINER_AUTO("container_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 container.
      - _1G("1g")
      - _4G("4g")
      - _16G("16g")
      - _64G("64g")
    - Optional<NetworkPolicy> networkPolicy
      
      Network access policy for the container.
      - class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
      - class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
    - Optional<List<Skill>> skills
      
      An optional list of skills referenced by id or inline data.
      - class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
  - class LocalEnvironment:
    - JsonValue; type "local"constant
      
      Use a local computer environment.
      - LOCAL("local")
    - 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
      
      References a container created with the /v1/containers endpoint
      - CONTAINER_REFERENCE("container_reference")

Function Tool

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
  
  The type of the function tool. Always function.
  - FUNCTION("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.

Inline Skill

class InlineSkill:
- String description
  
  The description of the skill.
- String name
  
  The name of the skill.
- InlineSkillSource source
  
  Inline skill payload
  - String data
    
    Base64-encoded skill zip bundle.
  - JsonValue; mediaType "application/zip"constant
    
    The media type of the inline skill payload. Must be application/zip.
    - APPLICATION_ZIP("application/zip")
  - JsonValue; type "base64"constant
    
    The type of the inline skill source. Must be base64.
    - BASE64("base64")
- JsonValue; type "inline"constant
  
  Defines an inline skill for this request.
  - INLINE("inline")

Inline Skill Source

class InlineSkillSource:

Inline skill payload
- String data
  
  Base64-encoded skill zip bundle.
- JsonValue; mediaType "application/zip"constant
  
  The media type of the inline skill payload. Must be application/zip.
  - APPLICATION_ZIP("application/zip")
- JsonValue; type "base64"constant
  
  The type of the inline skill source. Must be base64.
  - BASE64("base64")

Local Environment

class LocalEnvironment:
- JsonValue; type "local"constant
  
  Use a local computer environment.
  - LOCAL("local")
- 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.

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

Namespace Tool

class NamespaceTool:

Groups function/custom tools under a shared namespace.
- String description
  
  A description of the namespace shown to the model.
- String name
  
  The namespace name used in tool calls (for example, crm).
- List<Tool> tools
  
  The function/custom tools available inside this namespace.
  - class Function:
    - String name
    - JsonValue; type "function"constant
      - FUNCTION("function")
    - 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
      
      The type of the custom tool. Always custom.
      - CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
      - Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
- JsonValue; type "namespace"constant
  
  The type of the tool. Always namespace.
  - NAMESPACE("namespace")

Response

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.
  - Code code
    
    The error code for the response.
    - 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.
- Optional<IncompleteDetails> incompleteDetails
  
  Details about why the response is incomplete.
  - Optional<Reason> reason
    
    The reason why the response is incomplete.
    - 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.
  - String
  - List<ResponseInputItem>
    - 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.
        
        String
        
        List<ResponseInputContent>
        
        class ResponseInputText:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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.
        
        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.
        
        COMMENTARY("commentary")
        
        FINAL_ANSWER("final_answer")
      - Optional<Type> type
        
        The type of the message input. Always message.
        
        MESSAGE("message")
    - Message
      - List<ResponseInputContent> content
        
        A list of one or many input items to the model, containing different content types.
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
      - Role role
        
        The role of the message input. One of user, system, or developer.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - Optional<Type> type
        
        The type of the message input. Always set to message.
        
        MESSAGE("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.
        
        class ResponseOutputText:
        
        A text output from the model.
        
        List<Annotation> annotations
        
        The annotations of the text output.
        
        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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
        
        String text
        
        The text output from the model.
        
        JsonValue; type "output_text"constant
        
        The type of the output text. Always output_text.
        
        OUTPUT_TEXT("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
        
        The type of the refusal. Always refusal.
        
        REFUSAL("refusal")
      - JsonValue; role "assistant"constant
        
        The role of the output message. Always assistant.
        
        ASSISTANT("assistant")
      - Status status
        
        The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "message"constant
        
        The type of the output message. Always message.
        
        MESSAGE("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.
        
        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,
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        FAILED("failed")
      - JsonValue; type "file_search_call"constant
        
        The type of the file search tool call. Always file_search_call.
        
        FILE_SEARCH_CALL("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.
        
        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.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - Type type
        
        The type of the computer call. Always computer_call.
        
        COMPUTER_CALL("computer_call")
      - Optional<Action> action
        
        A click action.
        
        class Click:
        
        A click action.
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        class Move:
        
        A mouse move action.
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        class Scroll:
        
        A scroll action.
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
      - Optional<List<ComputerAction>> actions
        
        Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.
        
        Click
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        Move
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        Scroll
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
    - ComputerCallOutput
      - 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.
        
        JsonValue; type "computer_screenshot"constant
        
        Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
        
        COMPUTER_SCREENSHOT("computer_screenshot")
        
        Optional<String> fileId
        
        The identifier of an uploaded file that contains the screenshot.
        
        Optional<String> imageUrl
        
        The URL of the screenshot image.
      - JsonValue; type "computer_call_output"constant
        
        The type of the computer tool call output. Always computer_call_output.
        
        COMPUTER_CALL_OUTPUT("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.
        
        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).
        
        class Search:
        
        Action type "search" - Performs a web search query.
        
        String query
        
        [DEPRECATED] The search query.
        
        JsonValue; type "search"constant
        
        The action type.
        
        SEARCH("search")
        
        Optional<List<String>> queries
        
        The search queries.
        
        Optional<List<Source>> sources
        
        The sources used in the search.
        
        JsonValue; type "url"constant
        
        The type of source. Always url.
        
        URL("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
        
        The action type.
        
        OPEN_PAGE("open_page")
        
        Optional<String> url
        
        The URL opened by the model.
        
        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
        
        The action type.
        
        FIND_IN_PAGE("find_in_page")
        
        String url
        
        The URL of the page searched for the pattern.
      - Status status
        
        The status of the web search tool call.
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        FAILED("failed")
      - JsonValue; type "web_search_call"constant
        
        The type of the web search tool call. Always web_search_call.
        
        WEB_SEARCH_CALL("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
        
        The type of the function tool call. Always function_call.
        
        FUNCTION_CALL("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - FunctionCallOutput
      - String callId
        
        The unique ID of the function tool call generated by the model.
      - Output output
        
        Text, image, or file output of the function tool call.
        
        String
        
        List<ResponseFunctionCallOutputItem>
        
        class ResponseInputTextContent:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("input_text")
        
        class ResponseInputImageContent:
        
        An image input to the model. Learn about image inputs
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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.
        
        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.
        
        class ResponseInputFileContent:
        
        A file input to the model.
        
        JsonValue; type "input_file"constant
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        LOW("low")
        
        HIGH("high")
        
        Optional<String> fileData
        
        The base64-encoded data 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 "function_call_output"constant
        
        The type of the function tool call output. Always function_call_output.
        
        FUNCTION_CALL_OUTPUT("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.
        
        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
        
        The item type. Always tool_search_call.
        
        TOOL_SEARCH_CALL("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.
      - Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
      - Optional<Status> status
        
        The status of the tool search call.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - class ResponseToolSearchOutputItemParam:
      - List<Tool> tools
        
        The loaded tool definitions returned by the tool search output.
        
        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
        
        The type of the function tool. Always function.
        
        FUNCTION("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
        
        The type of the file search tool. Always file_search.
        
        FILE_SEARCH("file_search")
        
        List<String> vectorStoreIds
        
        The IDs of the vector stores to search.
        
        Optional<Filters> filters
        
        A filter to apply.
        
        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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
        
        Type type
        
        Type of operation: and or or.
        
        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.
        
        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
        
        The type of the computer tool. Always computer.
        
        COMPUTER("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.
        
        WINDOWS("windows")
        
        MAC("mac")
        
        LINUX("linux")
        
        UBUNTU("ubuntu")
        
        BROWSER("browser")
        
        JsonValue; type "computer_use_preview"constant
        
        The type of the computer use tool. Always computer_use_preview.
        
        COMPUTER_USE_PREVIEW("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.
        
        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.
        
        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.
        
        APPROXIMATE("approximate")
        
        Mcp
        
        String serverLabel
        
        A label for this MCP server, used to identify it in tool calls.
        
        JsonValue; type "mcp"constant
        
        The type of the MCP tool. Always mcp.
        
        MCP("mcp")
        
        Optional<AllowedTools> allowedTools
        
        List of allowed tool names or a filter object.
        
        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
        
        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.
        
        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.
        
        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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
        
        JsonValue; type "code_interpreter"constant
        
        The type of the code interpreter tool. Always code_interpreter.
        
        CODE_INTERPRETER("code_interpreter")
        
        ImageGeneration
        
        JsonValue; type "image_generation"constant
        
        The type of the image generation tool. Always image_generation.
        
        IMAGE_GENERATION("image_generation")
        
        Optional<Action> action
        
        Whether to generate a new image or edit an existing image. Default: auto.
        
        GENERATE("generate")
        
        EDIT("edit")
        
        AUTO("auto")
        
        Optional<Background> background
        
        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.
        
        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.
        
        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.
        
        GPT_IMAGE_1("gpt-image-1")
        
        GPT_IMAGE_1_MINI("gpt-image-1-mini")
        
        GPT_IMAGE_2("gpt-image-2")
        
        GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
        
        GPT_IMAGE_1_5("gpt-image-1.5")
        
        CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
        
        Optional<Moderation> moderation
        
        Moderation level for the generated image. Default: auto.
        
        AUTO("auto")
        
        LOW("low")
        
        Optional<Long> outputCompression
        
        Compression level for the output image. Default: 100.
        
        Optional<OutputFormat> outputFormat
        
        The output format of the generated image. One of png, webp, or jpeg. Default: png.
        
        PNG("png")
        
        WEBP("webp")
        
        JPEG("jpeg")
        
        Optional<Long> partialImages
        
        Number of partial images to generate in streaming mode, from 0 (default value) to 3.
        
        Optional<Quality> quality
        
        The quality of the generated image. One of low, medium, high, or auto. Default: auto.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        AUTO("auto")
        
        Optional<Size> size
        
        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.
        
        _1024X1024("1024x1024")
        
        _1024X1536("1024x1536")
        
        _1536X1024("1536x1024")
        
        AUTO("auto")
        
        JsonValue;
        
        JsonValue; type "local_shell"constant
        
        The type of the local shell tool. Always local_shell.
        
        LOCAL_SHELL("local_shell")
        
        class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        JsonValue; type "shell"constant
        
        The type of the shell tool. Always shell.
        
        SHELL("shell")
        
        Optional<Environment> environment
        
        class ContainerAuto:
        
        JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
        
        Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
        
        class LocalEnvironment:
        
        JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
        
        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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
        
        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
        
        The type of the custom tool. Always custom.
        
        CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
        
        Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
        
        class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        String description
        
        A description of the namespace shown to the model.
        
        String name
        
        The namespace name used in tool calls (for example, crm).
        
        List<Tool> tools
        
        The function/custom tools available inside this namespace.
        
        class Function:
        
        String name
        
        JsonValue; type "function"constant
        
        FUNCTION("function")
        
        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
        
        JsonValue; type "namespace"constant
        
        The type of the tool. Always namespace.
        
        NAMESPACE("namespace")
        
        class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        JsonValue; type "tool_search"constant
        
        The type of the tool. Always tool_search.
        
        TOOL_SEARCH("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.
        
        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.
        
        WEB_SEARCH_PREVIEW("web_search_preview")
        
        WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
        
        Optional<List<SearchContentType>> searchContentTypes
        
        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.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        Optional<UserLocation> userLocation
        
        The user's location.
        
        JsonValue; type "approximate"constant
        
        The type of location approximation. Always approximate.
        
        APPROXIMATE("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
        
        The type of the tool. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
      - JsonValue; type "tool_search_output"constant
        
        The item type. Always tool_search_output.
        
        TOOL_SEARCH_OUTPUT("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.
      - Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
      - Optional<Status> status
        
        The status of the tool search output.
        
        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
        
        The type of the object. Always summary_text.
        
        SUMMARY_TEXT("summary_text")
      - JsonValue; type "reasoning"constant
        
        The type of the object. Always reasoning.
        
        REASONING("reasoning")
      - Optional<List<Content>> content
        
        Reasoning text content.
        
        String text
        
        The reasoning text from the model.
        
        JsonValue; type "reasoning_text"constant
        
        The type of the reasoning text. Always reasoning_text.
        
        REASONING_TEXT("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.
        
        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.
      - JsonValue; type "compaction"constant
        
        The type of the item. Always compaction.
        
        COMPACTION("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        GENERATING("generating")
        
        FAILED("failed")
      - JsonValue; type "image_generation_call"constant
        
        The type of the image generation call. Always image_generation_call.
        
        IMAGE_GENERATION_CALL("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.
        
        class Logs:
        
        The logs output from the code interpreter.
        
        String logs
        
        The logs output from the code interpreter.
        
        JsonValue; type "logs"constant
        
        The type of the output. Always logs.
        
        LOGS("logs")
        
        class Image:
        
        The image output from the code interpreter.
        
        JsonValue; type "image"constant
        
        The type of the output. Always image.
        
        IMAGE("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        INTERPRETING("interpreting")
        
        FAILED("failed")
      - JsonValue; type "code_interpreter_call"constant
        
        The type of the code interpreter tool call. Always code_interpreter_call.
        
        CODE_INTERPRETER_CALL("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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "local_shell_call"constant
        
        The type of the local shell call. Always local_shell_call.
        
        LOCAL_SHELL_CALL("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
        
        The type of the local shell tool call output. Always local_shell_call_output.
        
        LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
      - Optional<Status> status
        
        The status of the item. One of in_progress, completed, or incomplete.
        
        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.
      - JsonValue; type "shell_call"constant
        
        The type of the item. Always shell_call.
        
        SHELL_CALL("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.
        
        class LocalEnvironment:
        
        class ContainerReference:
      - Optional<Status> status
        
        The status of the shell call. One of in_progress, completed, or incomplete.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - ShellCallOutput
      - String callId
        
        The unique ID of the shell tool call generated by the model.
      - 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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("exit")
        
        String stderr
        
        Captured stderr output for the shell call.
        
        String stdout
        
        Captured stdout output for the shell call.
      - JsonValue; type "shell_call_output"constant
        
        The type of the item. Always shell_call_output.
        
        SHELL_CALL_OUTPUT("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - ApplyPatchCall
      - String callId
        
        The unique ID of the apply patch tool call generated by the model.
      - Operation operation
        
        The specific create, delete, or update instruction for the apply_patch tool call.
        
        class CreateFile:
        
        Instruction for creating a new file via the apply_patch tool.
        
        String diff
        
        Unified diff content to apply when creating the file.
        
        String path
        
        Path of the file to create relative to the workspace root.
        
        JsonValue; type "create_file"constant
        
        The operation type. Always create_file.
        
        CREATE_FILE("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.
        
        JsonValue; type "delete_file"constant
        
        The operation type. Always delete_file.
        
        DELETE_FILE("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.
        
        String path
        
        Path of the file to update relative to the workspace root.
        
        JsonValue; type "update_file"constant
        
        The operation type. Always update_file.
        
        UPDATE_FILE("update_file")
      - Status status
        
        The status of the apply patch tool call. One of in_progress or completed.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
      - JsonValue; type "apply_patch_call"constant
        
        The type of the item. Always apply_patch_call.
        
        APPLY_PATCH_CALL("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.
      - Status status
        
        The status of the apply patch tool call output. One of completed or failed.
        
        COMPLETED("completed")
        
        FAILED("failed")
      - JsonValue; type "apply_patch_call_output"constant
        
        The type of the item. Always apply_patch_call_output.
        
        APPLY_PATCH_CALL_OUTPUT("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).
    - 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
        
        The type of the item. Always mcp_list_tools.
        
        MCP_LIST_TOOLS("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
        
        The type of the item. Always mcp_approval_request.
        
        MCP_APPROVAL_REQUEST("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
        
        The type of the item. Always mcp_approval_response.
        
        MCP_APPROVAL_RESPONSE("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
        
        The type of the item. Always mcp_call.
        
        MCP_CALL("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.
        
        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.
        
        String
        
        List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
      - JsonValue; type "custom_tool_call_output"constant
        
        The type of the custom tool call output. Always custom_tool_call_output.
        
        CUSTOM_TOOL_CALL_OUTPUT("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
        
        The type of the custom tool call. Always custom_tool_call.
        
        CUSTOM_TOOL_CALL("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.
    - JsonValue;
      - JsonValue; type "compaction_trigger"constant
        
        The type of the item. Always compaction_trigger.
        
        COMPACTION_TRIGGER("compaction_trigger")
    - ItemReference
      - String id
        
        The ID of the item to reference.
      - Optional<Type> type
        
        The type of item to reference. Always item_reference.
        
        ITEM_REFERENCE("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.
  - String
  - enum ChatModel:
    - GPT_5_4("gpt-5.4")
    - GPT_5_4_MINI("gpt-5.4-mini")
    - GPT_5_4_NANO("gpt-5.4-nano")
    - GPT_5_4_MINI_2026_03_17("gpt-5.4-mini-2026-03-17")
    - GPT_5_4_NANO_2026_03_17("gpt-5.4-nano-2026-03-17")
    - GPT_5_3_CHAT_LATEST("gpt-5.3-chat-latest")
    - GPT_5_2("gpt-5.2")
    - GPT_5_2_2025_12_11("gpt-5.2-2025-12-11")
    - GPT_5_2_CHAT_LATEST("gpt-5.2-chat-latest")
    - GPT_5_2_PRO("gpt-5.2-pro")
    - GPT_5_2_PRO_2025_12_11("gpt-5.2-pro-2025-12-11")
    - GPT_5_1("gpt-5.1")
    - GPT_5_1_2025_11_13("gpt-5.1-2025-11-13")
    - GPT_5_1_CODEX("gpt-5.1-codex")
    - GPT_5_1_MINI("gpt-5.1-mini")
    - GPT_5_1_CHAT_LATEST("gpt-5.1-chat-latest")
    - GPT_5("gpt-5")
    - GPT_5_MINI("gpt-5-mini")
    - GPT_5_NANO("gpt-5-nano")
    - GPT_5_2025_08_07("gpt-5-2025-08-07")
    - GPT_5_MINI_2025_08_07("gpt-5-mini-2025-08-07")
    - GPT_5_NANO_2025_08_07("gpt-5-nano-2025-08-07")
    - GPT_5_CHAT_LATEST("gpt-5-chat-latest")
    - GPT_4_1("gpt-4.1")
    - GPT_4_1_MINI("gpt-4.1-mini")
    - GPT_4_1_NANO("gpt-4.1-nano")
    - GPT_4_1_2025_04_14("gpt-4.1-2025-04-14")
    - GPT_4_1_MINI_2025_04_14("gpt-4.1-mini-2025-04-14")
    - GPT_4_1_NANO_2025_04_14("gpt-4.1-nano-2025-04-14")
    - O4_MINI("o4-mini")
    - O4_MINI_2025_04_16("o4-mini-2025-04-16")
    - O3("o3")
    - O3_2025_04_16("o3-2025-04-16")
    - O3_MINI("o3-mini")
    - O3_MINI_2025_01_31("o3-mini-2025-01-31")
    - O1("o1")
    - O1_2024_12_17("o1-2024-12-17")
    - O1_PREVIEW("o1-preview")
    - O1_PREVIEW_2024_09_12("o1-preview-2024-09-12")
    - O1_MINI("o1-mini")
    - O1_MINI_2024_09_12("o1-mini-2024-09-12")
    - GPT_4O("gpt-4o")
    - GPT_4O_2024_11_20("gpt-4o-2024-11-20")
    - GPT_4O_2024_08_06("gpt-4o-2024-08-06")
    - GPT_4O_2024_05_13("gpt-4o-2024-05-13")
    - GPT_4O_AUDIO_PREVIEW("gpt-4o-audio-preview")
    - GPT_4O_AUDIO_PREVIEW_2024_10_01("gpt-4o-audio-preview-2024-10-01")
    - GPT_4O_AUDIO_PREVIEW_2024_12_17("gpt-4o-audio-preview-2024-12-17")
    - GPT_4O_AUDIO_PREVIEW_2025_06_03("gpt-4o-audio-preview-2025-06-03")
    - GPT_4O_MINI_AUDIO_PREVIEW("gpt-4o-mini-audio-preview")
    - GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17("gpt-4o-mini-audio-preview-2024-12-17")
    - GPT_4O_SEARCH_PREVIEW("gpt-4o-search-preview")
    - GPT_4O_MINI_SEARCH_PREVIEW("gpt-4o-mini-search-preview")
    - GPT_4O_SEARCH_PREVIEW_2025_03_11("gpt-4o-search-preview-2025-03-11")
    - GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11("gpt-4o-mini-search-preview-2025-03-11")
    - CHATGPT_4O_LATEST("chatgpt-4o-latest")
    - CODEX_MINI_LATEST("codex-mini-latest")
    - GPT_4O_MINI("gpt-4o-mini")
    - GPT_4O_MINI_2024_07_18("gpt-4o-mini-2024-07-18")
    - GPT_4_TURBO("gpt-4-turbo")
    - GPT_4_TURBO_2024_04_09("gpt-4-turbo-2024-04-09")
    - GPT_4_0125_PREVIEW("gpt-4-0125-preview")
    - GPT_4_TURBO_PREVIEW("gpt-4-turbo-preview")
    - GPT_4_1106_PREVIEW("gpt-4-1106-preview")
    - GPT_4_VISION_PREVIEW("gpt-4-vision-preview")
    - GPT_4("gpt-4")
    - GPT_4_0314("gpt-4-0314")
    - GPT_4_0613("gpt-4-0613")
    - GPT_4_32K("gpt-4-32k")
    - GPT_4_32K_0314("gpt-4-32k-0314")
    - GPT_4_32K_0613("gpt-4-32k-0613")
    - GPT_3_5_TURBO("gpt-3.5-turbo")
    - GPT_3_5_TURBO_16K("gpt-3.5-turbo-16k")
    - GPT_3_5_TURBO_0301("gpt-3.5-turbo-0301")
    - GPT_3_5_TURBO_0613("gpt-3.5-turbo-0613")
    - GPT_3_5_TURBO_1106("gpt-3.5-turbo-1106")
    - GPT_3_5_TURBO_0125("gpt-3.5-turbo-0125")
    - GPT_3_5_TURBO_16K_0613("gpt-3.5-turbo-16k-0613")
  - ResponsesOnlyModel
    - O1_PRO("o1-pro")
    - O1_PRO_2025_03_19("o1-pro-2025-03-19")
    - O3_PRO("o3-pro")
    - O3_PRO_2025_06_10("o3-pro-2025-06-10")
    - O3_DEEP_RESEARCH("o3-deep-research")
    - O3_DEEP_RESEARCH_2025_06_26("o3-deep-research-2025-06-26")
    - O4_MINI_DEEP_RESEARCH("o4-mini-deep-research")
    - O4_MINI_DEEP_RESEARCH_2025_06_26("o4-mini-deep-research-2025-06-26")
    - COMPUTER_USE_PREVIEW("computer-use-preview")
    - COMPUTER_USE_PREVIEW_2025_03_11("computer-use-preview-2025-03-11")
    - GPT_5_CODEX("gpt-5-codex")
    - GPT_5_PRO("gpt-5-pro")
    - GPT_5_PRO_2025_10_06("gpt-5-pro-2025-10-06")
    - GPT_5_1_CODEX_MAX("gpt-5.1-codex-max")
- JsonValue; object_ "response"constant
  
  The object type of this resource - always set to response.
  - RESPONSE("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.
  - class ResponseOutputMessage:
    
    An output message from the model.
  - class ResponseFileSearchToolCall:
    
    The results of a file search tool call. See the file search guide for more information.
  - class ResponseFunctionToolCall:
    
    A tool call to run a function. See the function calling guide for more information.
  - 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.
      - String
      - List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
    - Status status
      
      The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "function_call_output"constant
      
      The type of the function tool call output. Always function_call_output.
      - FUNCTION_CALL_OUTPUT("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.
  - class ResponseComputerToolCall:
    
    A tool call to a computer use tool. See the computer use guide for more information.
  - 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.
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
      - FAILED("failed")
      - IN_PROGRESS("in_progress")
    - JsonValue; type "computer_call_output"constant
      
      The type of the computer tool call output. Always computer_call_output.
      - COMPUTER_CALL_OUTPUT("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.
  - 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.
      - SERVER("server")
      - CLIENT("client")
    - Status status
      
      The status of the tool search call item that was recorded.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "tool_search_call"constant
      
      The type of the item. Always tool_search_call.
      - TOOL_SEARCH_CALL("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.
      - SERVER("server")
      - CLIENT("client")
    - Status status
      
      The status of the tool search output item that was recorded.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - List<Tool> tools
      
      The loaded tool definitions returned by tool search.
      - class FunctionTool:
        
        Defines a function in your own code the model can choose to call. Learn more about function calling.
      - class FileSearchTool:
        
        A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
      - class ComputerTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
      - class ComputerUsePreviewTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
      - class WebSearchTool:
        
        Search the Internet for sources related to the prompt. Learn more about the web search tool.
      - Mcp
      - CodeInterpreter
      - ImageGeneration
      - JsonValue;
      - class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
      - class CustomTool:
        
        A custom tool that processes input using a specified format. Learn more about custom tools
      - class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
      - class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
      - class WebSearchPreviewTool:
        
        This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
      - class ApplyPatchTool:
        
        Allows the assistant to create, delete, or update files using unified diffs.
    - JsonValue; type "tool_search_output"constant
      
      The type of the item. Always tool_search_output.
      - TOOL_SEARCH_OUTPUT("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
      
      The type of the item. Always compaction.
      - COMPACTION("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - GENERATING("generating")
      - FAILED("failed")
    - JsonValue; type "image_generation_call"constant
      
      The type of the image generation call. Always image_generation_call.
      - IMAGE_GENERATION_CALL("image_generation_call")
  - class ResponseCodeInterpreterToolCall:
    
    A tool call to run code.
  - 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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "local_shell_call"constant
      
      The type of the local shell call. Always local_shell_call.
      - LOCAL_SHELL_CALL("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
      
      The type of the local shell tool call output. Always local_shell_call_output.
      - LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
    - Optional<Status> status
      
      The status of the item. One of in_progress, completed, or incomplete.
      - 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.
      - class ResponseLocalEnvironment:
        
        Represents the use of a local environment to perform shell actions.
        
        JsonValue; type "local"constant
        
        The environment type. Always local.
        
        LOCAL("local")
      - class ResponseContainerReference:
        
        Represents a container created with /v1/containers.
        
        String containerId
        
        JsonValue; type "container_reference"constant
        
        The environment type. Always container_reference.
        
        CONTAINER_REFERENCE("container_reference")
    - Status status
      
      The status of the shell call. One of in_progress, completed, or incomplete.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "shell_call"constant
      
      The type of the item. Always shell_call.
      - SHELL_CALL("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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "shell_call_output"constant
      
      The type of the shell call output. Always shell_call_output.
      - SHELL_CALL_OUTPUT("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.
      - 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 a new file with the provided diff.
        
        CREATE_FILE("create_file")
      - 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 the specified file.
        
        DELETE_FILE("delete_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 an existing file with the provided diff.
        
        UPDATE_FILE("update_file")
    - Status status
      
      The status of the apply patch tool call. One of in_progress or completed.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
    - JsonValue; type "apply_patch_call"constant
      
      The type of the item. Always apply_patch_call.
      - APPLY_PATCH_CALL("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.
      - COMPLETED("completed")
      - FAILED("failed")
    - JsonValue; type "apply_patch_call_output"constant
      
      The type of the item. Always apply_patch_call_output.
      - APPLY_PATCH_CALL_OUTPUT("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
      
      The type of the item. Always mcp_call.
      - MCP_CALL("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.
      - 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
      
      The type of the item. Always mcp_list_tools.
      - MCP_LIST_TOOLS("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
      
      The type of the item. Always mcp_approval_request.
      - MCP_APPROVAL_REQUEST("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
      
      The type of the item. Always mcp_approval_response.
      - MCP_APPROVAL_RESPONSE("mcp_approval_response")
    - Optional<String> reason
      
      Optional reason for the decision.
  - class ResponseCustomToolCall:
    
    A call to a custom tool created by the model.
  - 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.
      - 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.
- 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.
  - 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.
      - 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 tool configuration type. Always allowed_tools.
      - ALLOWED_TOOLS("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
      - 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
      
      For function calling, the type is always function.
      - FUNCTION("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
      
      For MCP tools, the type is always mcp.
      - MCP("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
      
      For custom tool calling, the type is always custom.
      - CUSTOM("custom")
  - class ToolChoiceApplyPatch:
    
    Forces the model to call the apply_patch tool when executing a tool call.
    - JsonValue; type "apply_patch"constant
      
      The tool to call. Always apply_patch.
      - APPLY_PATCH("apply_patch")
  - class ToolChoiceShell:
    
    Forces the model to call the shell tool when a tool call is required.
    - JsonValue; type "shell"constant
      
      The tool to call. Always shell.
      - SHELL("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.
  - class FunctionTool:
    
    Defines a function in your own code the model can choose to call. Learn more about function calling.
  - class FileSearchTool:
    
    A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
  - class ComputerTool:
    
    A tool that controls a virtual computer. Learn more about the computer tool.
  - class ComputerUsePreviewTool:
    
    A tool that controls a virtual computer. Learn more about the computer tool.
  - class WebSearchTool:
    
    Search the Internet for sources related to the prompt. Learn more about the web search tool.
  - Mcp
  - CodeInterpreter
  - ImageGeneration
  - JsonValue;
  - class FunctionShellTool:
    
    A tool that allows the model to execute shell commands.
  - class CustomTool:
    
    A custom tool that processes input using a specified format. Learn more about custom tools
  - class NamespaceTool:
    
    Groups function/custom tools under a shared namespace.
  - class ToolSearchTool:
    
    Hosted or BYOT tool search configuration for deferred tools.
  - class WebSearchPreviewTool:
    
    This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
  - class ApplyPatchTool:
    
    Allows the assistant to create, delete, or update files using unified diffs.
- 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.
- 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.
  - 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.
    - String
    - class ResponseInputText:
      
      A text input to the model.
    - class ResponseInputImage:
      
      An image input to the model. Learn about image inputs.
    - class ResponseInputFile:
      
      A file input to the model.
  - Optional<String> version
    
    Optional version of the prompt template.
- 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.
  - IN_MEMORY("in_memory")
  - _24H("24h")
- Optional<Reasoning> reasoning
  
  gpt-5 and o-series models only
  
  Configuration options for reasoning models.
  - Optional<ReasoningEffort> effort
    
    Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
    - gpt-5.1 defaults to none, which does not perform reasoning. The supported reasoning values for gpt-5.1 are none, low, medium, and high. Tool calls are supported for all reasoning values in gpt-5.1.
    - All models before gpt-5.1 default to medium reasoning effort, and do not support none.
    - The gpt-5-pro model defaults to (and only supports) high reasoning effort.
    - xhigh is supported for all models after gpt-5.1-codex-max.
    - NONE("none")
    - MINIMAL("minimal")
    - LOW("low")
    - MEDIUM("medium")
    - HIGH("high")
    - XHIGH("xhigh")
  - Optional<GenerateSummary> generateSummary
    
    Deprecated: use summary instead.
    
    A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
    - AUTO("auto")
    - CONCISE("concise")
    - DETAILED("detailed")
  - Optional<Summary> summary
    
    A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
    
    concise is supported for computer-use-preview models and all reasoning models after gpt-5.
    - AUTO("auto")
    - CONCISE("concise")
    - DETAILED("detailed")
- 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.
- 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.
  - 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.
  - COMPLETED("completed")
  - FAILED("failed")
  - IN_PROGRESS("in_progress")
  - CANCELLED("cancelled")
  - QUEUED("queued")
  - INCOMPLETE("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<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.
    - class ResponseFormatText:
      
      Default response format. Used to generate text responses.
      - JsonValue; type "text"constant
        
        The type of response format being defined. Always text.
        
        TEXT("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
        
        The type of response format being defined. Always json_schema.
        
        JSON_SCHEMA("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
        
        The type of response format being defined. Always json_object.
        
        JSON_OBJECT("json_object")
  - 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.
    - LOW("low")
    - MEDIUM("medium")
    - HIGH("high")
- Optional<Long> topLogprobs
  
  An integer between 0 and 20 specifying the maximum number of most likely tokens to return at each token position, each with an associated log probability. In some cases, the number of returned tokens may be fewer than requested.
- 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.
  - 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.
  - 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.
- Optional<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.

Response Apply Patch Tool Call

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.
  - 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 a new file with the provided diff.
      - CREATE_FILE("create_file")
  - 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 the specified file.
      - DELETE_FILE("delete_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 an existing file with the provided diff.
      - UPDATE_FILE("update_file")
- Status status
  
  The status of the apply patch tool call. One of in_progress or completed.
  - IN_PROGRESS("in_progress")
  - COMPLETED("completed")
- JsonValue; type "apply_patch_call"constant
  
  The type of the item. Always apply_patch_call.
  - APPLY_PATCH_CALL("apply_patch_call")
- Optional<String> createdBy
  
  The ID of the entity that created this tool call.

Response Apply Patch Tool Call Output

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.
  - COMPLETED("completed")
  - FAILED("failed")
- JsonValue; type "apply_patch_call_output"constant
  
  The type of the item. Always apply_patch_call_output.
  - APPLY_PATCH_CALL_OUTPUT("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.

Response Audio Delta Event

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
  
  The type of the event. Always response.audio.delta.
  - RESPONSE_AUDIO_DELTA("response.audio.delta")

Response Audio Done Event

class ResponseAudioDoneEvent:

Emitted when the audio response is complete.
- long sequenceNumber
  
  The sequence number of the delta.
- JsonValue; type "response.audio.done"constant
  
  The type of the event. Always response.audio.done.
  - RESPONSE_AUDIO_DONE("response.audio.done")

Response Audio Transcript Delta Event

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
  
  The type of the event. Always response.audio.transcript.delta.
  - RESPONSE_AUDIO_TRANSCRIPT_DELTA("response.audio.transcript.delta")

Response Audio Transcript Done Event

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
  
  The type of the event. Always response.audio.transcript.done.
  - RESPONSE_AUDIO_TRANSCRIPT_DONE("response.audio.transcript.done")

Response Code Interpreter Call Code Delta Event

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
  
  The type of the event. Always response.code_interpreter_call_code.delta.
  - RESPONSE_CODE_INTERPRETER_CALL_CODE_DELTA("response.code_interpreter_call_code.delta")

Response Code Interpreter Call Code Done Event

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
  
  The type of the event. Always response.code_interpreter_call_code.done.
  - RESPONSE_CODE_INTERPRETER_CALL_CODE_DONE("response.code_interpreter_call_code.done")

Response Code Interpreter Call Completed Event

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
  
  The type of the event. Always response.code_interpreter_call.completed.
  - RESPONSE_CODE_INTERPRETER_CALL_COMPLETED("response.code_interpreter_call.completed")

Response Code Interpreter Call In Progress Event

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
  
  The type of the event. Always response.code_interpreter_call.in_progress.
  - RESPONSE_CODE_INTERPRETER_CALL_IN_PROGRESS("response.code_interpreter_call.in_progress")

Response Code Interpreter Call Interpreting Event

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
  
  The type of the event. Always response.code_interpreter_call.interpreting.
  - RESPONSE_CODE_INTERPRETER_CALL_INTERPRETING("response.code_interpreter_call.interpreting")

Response Code Interpreter Tool 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.
  - class Logs:
    
    The logs output from the code interpreter.
    - String logs
      
      The logs output from the code interpreter.
    - JsonValue; type "logs"constant
      
      The type of the output. Always logs.
      - LOGS("logs")
  - class Image:
    
    The image output from the code interpreter.
    - JsonValue; type "image"constant
      
      The type of the output. Always image.
      - IMAGE("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.
  - IN_PROGRESS("in_progress")
  - COMPLETED("completed")
  - INCOMPLETE("incomplete")
  - INTERPRETING("interpreting")
  - FAILED("failed")
- JsonValue; type "code_interpreter_call"constant
  
  The type of the code interpreter tool call. Always code_interpreter_call.
  - CODE_INTERPRETER_CALL("code_interpreter_call")

Response Compaction 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
  
  The type of the item. Always compaction.
  - COMPACTION("compaction")
- Optional<String> createdBy
  
  The identifier of the actor that created the item.

Response Compaction Item Param

class ResponseCompactionItemParam:

A compaction item generated by the v1/responses/compact API.
- String encryptedContent
  
  The encrypted content of the compaction summary.
- JsonValue; type "compaction"constant
  
  The type of the item. Always compaction.
  - COMPACTION("compaction")
- Optional<String> id
  
  The ID of the compaction item.

Response Completed Event

class ResponseCompletedEvent:

Emitted when the model response is complete.
- Response response
  
  Properties of the completed 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.
    - Code code
      
      The error code for the response.
      - 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.
  - Optional<IncompleteDetails> incompleteDetails
    
    Details about why the response is incomplete.
    - Optional<Reason> reason
      
      The reason why the response is incomplete.
      - 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.
    - String
    - List<ResponseInputItem>
      - 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.
        
        String
        
        List<ResponseInputContent>
        
        class ResponseInputText:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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.
        
        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.
        
        COMMENTARY("commentary")
        
        FINAL_ANSWER("final_answer")
        
        Optional<Type> type
        
        The type of the message input. Always message.
        
        MESSAGE("message")
      - Message
        
        List<ResponseInputContent> content
        
        A list of one or many input items to the model, containing different content types.
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
        
        Role role
        
        The role of the message input. One of user, system, or developer.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        Optional<Type> type
        
        The type of the message input. Always set to message.
        
        MESSAGE("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.
        
        class ResponseOutputText:
        
        A text output from the model.
        
        List<Annotation> annotations
        
        The annotations of the text output.
        
        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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
        
        String text
        
        The text output from the model.
        
        JsonValue; type "output_text"constant
        
        The type of the output text. Always output_text.
        
        OUTPUT_TEXT("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
        
        The type of the refusal. Always refusal.
        
        REFUSAL("refusal")
        
        JsonValue; role "assistant"constant
        
        The role of the output message. Always assistant.
        
        ASSISTANT("assistant")
        
        Status status
        
        The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        JsonValue; type "message"constant
        
        The type of the output message. Always message.
        
        MESSAGE("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.
        
        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,
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        FAILED("failed")
        
        JsonValue; type "file_search_call"constant
        
        The type of the file search tool call. Always file_search_call.
        
        FILE_SEARCH_CALL("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.
        
        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.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        Type type
        
        The type of the computer call. Always computer_call.
        
        COMPUTER_CALL("computer_call")
        
        Optional<Action> action
        
        A click action.
        
        class Click:
        
        A click action.
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        class Move:
        
        A mouse move action.
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        class Scroll:
        
        A scroll action.
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
        
        Optional<List<ComputerAction>> actions
        
        Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.
        
        Click
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        Move
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        Scroll
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
      - ComputerCallOutput
        
        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.
        
        JsonValue; type "computer_screenshot"constant
        
        Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
        
        COMPUTER_SCREENSHOT("computer_screenshot")
        
        Optional<String> fileId
        
        The identifier of an uploaded file that contains the screenshot.
        
        Optional<String> imageUrl
        
        The URL of the screenshot image.
        
        JsonValue; type "computer_call_output"constant
        
        The type of the computer tool call output. Always computer_call_output.
        
        COMPUTER_CALL_OUTPUT("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.
        
        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).
        
        class Search:
        
        Action type "search" - Performs a web search query.
        
        String query
        
        [DEPRECATED] The search query.
        
        JsonValue; type "search"constant
        
        The action type.
        
        SEARCH("search")
        
        Optional<List<String>> queries
        
        The search queries.
        
        Optional<List<Source>> sources
        
        The sources used in the search.
        
        JsonValue; type "url"constant
        
        The type of source. Always url.
        
        URL("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
        
        The action type.
        
        OPEN_PAGE("open_page")
        
        Optional<String> url
        
        The URL opened by the model.
        
        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
        
        The action type.
        
        FIND_IN_PAGE("find_in_page")
        
        String url
        
        The URL of the page searched for the pattern.
        
        Status status
        
        The status of the web search tool call.
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        FAILED("failed")
        
        JsonValue; type "web_search_call"constant
        
        The type of the web search tool call. Always web_search_call.
        
        WEB_SEARCH_CALL("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
        
        The type of the function tool call. Always function_call.
        
        FUNCTION_CALL("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - FunctionCallOutput
        
        String callId
        
        The unique ID of the function tool call generated by the model.
        
        Output output
        
        Text, image, or file output of the function tool call.
        
        String
        
        List<ResponseFunctionCallOutputItem>
        
        class ResponseInputTextContent:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("input_text")
        
        class ResponseInputImageContent:
        
        An image input to the model. Learn about image inputs
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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.
        
        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.
        
        class ResponseInputFileContent:
        
        A file input to the model.
        
        JsonValue; type "input_file"constant
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        LOW("low")
        
        HIGH("high")
        
        Optional<String> fileData
        
        The base64-encoded data 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 "function_call_output"constant
        
        The type of the function tool call output. Always function_call_output.
        
        FUNCTION_CALL_OUTPUT("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.
        
        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
        
        The item type. Always tool_search_call.
        
        TOOL_SEARCH_CALL("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.
        
        Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
        
        Optional<Status> status
        
        The status of the tool search call.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - class ResponseToolSearchOutputItemParam:
        
        List<Tool> tools
        
        The loaded tool definitions returned by the tool search output.
        
        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
        
        The type of the function tool. Always function.
        
        FUNCTION("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
        
        The type of the file search tool. Always file_search.
        
        FILE_SEARCH("file_search")
        
        List<String> vectorStoreIds
        
        The IDs of the vector stores to search.
        
        Optional<Filters> filters
        
        A filter to apply.
        
        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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
        
        Type type
        
        Type of operation: and or or.
        
        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.
        
        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
        
        The type of the computer tool. Always computer.
        
        COMPUTER("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.
        
        WINDOWS("windows")
        
        MAC("mac")
        
        LINUX("linux")
        
        UBUNTU("ubuntu")
        
        BROWSER("browser")
        
        JsonValue; type "computer_use_preview"constant
        
        The type of the computer use tool. Always computer_use_preview.
        
        COMPUTER_USE_PREVIEW("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.
        
        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.
        
        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.
        
        APPROXIMATE("approximate")
        
        Mcp
        
        String serverLabel
        
        A label for this MCP server, used to identify it in tool calls.
        
        JsonValue; type "mcp"constant
        
        The type of the MCP tool. Always mcp.
        
        MCP("mcp")
        
        Optional<AllowedTools> allowedTools
        
        List of allowed tool names or a filter object.
        
        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
        
        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.
        
        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.
        
        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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
        
        JsonValue; type "code_interpreter"constant
        
        The type of the code interpreter tool. Always code_interpreter.
        
        CODE_INTERPRETER("code_interpreter")
        
        ImageGeneration
        
        JsonValue; type "image_generation"constant
        
        The type of the image generation tool. Always image_generation.
        
        IMAGE_GENERATION("image_generation")
        
        Optional<Action> action
        
        Whether to generate a new image or edit an existing image. Default: auto.
        
        GENERATE("generate")
        
        EDIT("edit")
        
        AUTO("auto")
        
        Optional<Background> background
        
        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.
        
        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.
        
        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.
        
        GPT_IMAGE_1("gpt-image-1")
        
        GPT_IMAGE_1_MINI("gpt-image-1-mini")
        
        GPT_IMAGE_2("gpt-image-2")
        
        GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
        
        GPT_IMAGE_1_5("gpt-image-1.5")
        
        CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
        
        Optional<Moderation> moderation
        
        Moderation level for the generated image. Default: auto.
        
        AUTO("auto")
        
        LOW("low")
        
        Optional<Long> outputCompression
        
        Compression level for the output image. Default: 100.
        
        Optional<OutputFormat> outputFormat
        
        The output format of the generated image. One of png, webp, or jpeg. Default: png.
        
        PNG("png")
        
        WEBP("webp")
        
        JPEG("jpeg")
        
        Optional<Long> partialImages
        
        Number of partial images to generate in streaming mode, from 0 (default value) to 3.
        
        Optional<Quality> quality
        
        The quality of the generated image. One of low, medium, high, or auto. Default: auto.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        AUTO("auto")
        
        Optional<Size> size
        
        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.
        
        _1024X1024("1024x1024")
        
        _1024X1536("1024x1536")
        
        _1536X1024("1536x1024")
        
        AUTO("auto")
        
        JsonValue;
        
        JsonValue; type "local_shell"constant
        
        The type of the local shell tool. Always local_shell.
        
        LOCAL_SHELL("local_shell")
        
        class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        JsonValue; type "shell"constant
        
        The type of the shell tool. Always shell.
        
        SHELL("shell")
        
        Optional<Environment> environment
        
        class ContainerAuto:
        
        JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
        
        Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
        
        class LocalEnvironment:
        
        JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
        
        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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
        
        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
        
        The type of the custom tool. Always custom.
        
        CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
        
        Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
        
        class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        String description
        
        A description of the namespace shown to the model.
        
        String name
        
        The namespace name used in tool calls (for example, crm).
        
        List<Tool> tools
        
        The function/custom tools available inside this namespace.
        
        class Function:
        
        String name
        
        JsonValue; type "function"constant
        
        FUNCTION("function")
        
        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
        
        JsonValue; type "namespace"constant
        
        The type of the tool. Always namespace.
        
        NAMESPACE("namespace")
        
        class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        JsonValue; type "tool_search"constant
        
        The type of the tool. Always tool_search.
        
        TOOL_SEARCH("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.
        
        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.
        
        WEB_SEARCH_PREVIEW("web_search_preview")
        
        WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
        
        Optional<List<SearchContentType>> searchContentTypes
        
        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.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        Optional<UserLocation> userLocation
        
        The user's location.
        
        JsonValue; type "approximate"constant
        
        The type of location approximation. Always approximate.
        
        APPROXIMATE("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
        
        The type of the tool. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
        
        JsonValue; type "tool_search_output"constant
        
        The item type. Always tool_search_output.
        
        TOOL_SEARCH_OUTPUT("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.
        
        Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
        
        Optional<Status> status
        
        The status of the tool search output.
        
        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
        
        The type of the object. Always summary_text.
        
        SUMMARY_TEXT("summary_text")
        
        JsonValue; type "reasoning"constant
        
        The type of the object. Always reasoning.
        
        REASONING("reasoning")
        
        Optional<List<Content>> content
        
        Reasoning text content.
        
        String text
        
        The reasoning text from the model.
        
        JsonValue; type "reasoning_text"constant
        
        The type of the reasoning text. Always reasoning_text.
        
        REASONING_TEXT("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.
        
        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.
        
        JsonValue; type "compaction"constant
        
        The type of the item. Always compaction.
        
        COMPACTION("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        GENERATING("generating")
        
        FAILED("failed")
        
        JsonValue; type "image_generation_call"constant
        
        The type of the image generation call. Always image_generation_call.
        
        IMAGE_GENERATION_CALL("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.
        
        class Logs:
        
        The logs output from the code interpreter.
        
        String logs
        
        The logs output from the code interpreter.
        
        JsonValue; type "logs"constant
        
        The type of the output. Always logs.
        
        LOGS("logs")
        
        class Image:
        
        The image output from the code interpreter.
        
        JsonValue; type "image"constant
        
        The type of the output. Always image.
        
        IMAGE("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        INTERPRETING("interpreting")
        
        FAILED("failed")
        
        JsonValue; type "code_interpreter_call"constant
        
        The type of the code interpreter tool call. Always code_interpreter_call.
        
        CODE_INTERPRETER_CALL("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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        JsonValue; type "local_shell_call"constant
        
        The type of the local shell call. Always local_shell_call.
        
        LOCAL_SHELL_CALL("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
        
        The type of the local shell tool call output. Always local_shell_call_output.
        
        LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
        
        Optional<Status> status
        
        The status of the item. One of in_progress, completed, or incomplete.
        
        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.
        
        JsonValue; type "shell_call"constant
        
        The type of the item. Always shell_call.
        
        SHELL_CALL("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.
        
        class LocalEnvironment:
        
        class ContainerReference:
        
        Optional<Status> status
        
        The status of the shell call. One of in_progress, completed, or incomplete.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - ShellCallOutput
        
        String callId
        
        The unique ID of the shell tool call generated by the model.
        
        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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("exit")
        
        String stderr
        
        Captured stderr output for the shell call.
        
        String stdout
        
        Captured stdout output for the shell call.
        
        JsonValue; type "shell_call_output"constant
        
        The type of the item. Always shell_call_output.
        
        SHELL_CALL_OUTPUT("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - ApplyPatchCall
        
        String callId
        
        The unique ID of the apply patch tool call generated by the model.
        
        Operation operation
        
        The specific create, delete, or update instruction for the apply_patch tool call.
        
        class CreateFile:
        
        Instruction for creating a new file via the apply_patch tool.
        
        String diff
        
        Unified diff content to apply when creating the file.
        
        String path
        
        Path of the file to create relative to the workspace root.
        
        JsonValue; type "create_file"constant
        
        The operation type. Always create_file.
        
        CREATE_FILE("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.
        
        JsonValue; type "delete_file"constant
        
        The operation type. Always delete_file.
        
        DELETE_FILE("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.
        
        String path
        
        Path of the file to update relative to the workspace root.
        
        JsonValue; type "update_file"constant
        
        The operation type. Always update_file.
        
        UPDATE_FILE("update_file")
        
        Status status
        
        The status of the apply patch tool call. One of in_progress or completed.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        JsonValue; type "apply_patch_call"constant
        
        The type of the item. Always apply_patch_call.
        
        APPLY_PATCH_CALL("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.
        
        Status status
        
        The status of the apply patch tool call output. One of completed or failed.
        
        COMPLETED("completed")
        
        FAILED("failed")
        
        JsonValue; type "apply_patch_call_output"constant
        
        The type of the item. Always apply_patch_call_output.
        
        APPLY_PATCH_CALL_OUTPUT("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).
      - 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
        
        The type of the item. Always mcp_list_tools.
        
        MCP_LIST_TOOLS("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
        
        The type of the item. Always mcp_approval_request.
        
        MCP_APPROVAL_REQUEST("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
        
        The type of the item. Always mcp_approval_response.
        
        MCP_APPROVAL_RESPONSE("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
        
        The type of the item. Always mcp_call.
        
        MCP_CALL("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.
        
        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.
        
        String
        
        List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
        
        JsonValue; type "custom_tool_call_output"constant
        
        The type of the custom tool call output. Always custom_tool_call_output.
        
        CUSTOM_TOOL_CALL_OUTPUT("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
        
        The type of the custom tool call. Always custom_tool_call.
        
        CUSTOM_TOOL_CALL("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.
      - JsonValue;
        
        JsonValue; type "compaction_trigger"constant
        
        The type of the item. Always compaction_trigger.
        
        COMPACTION_TRIGGER("compaction_trigger")
      - ItemReference
        
        String id
        
        The ID of the item to reference.
        
        Optional<Type> type
        
        The type of item to reference. Always item_reference.
        
        ITEM_REFERENCE("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.
    - String
    - enum ChatModel:
      - GPT_5_4("gpt-5.4")
      - GPT_5_4_MINI("gpt-5.4-mini")
      - GPT_5_4_NANO("gpt-5.4-nano")
      - GPT_5_4_MINI_2026_03_17("gpt-5.4-mini-2026-03-17")
      - GPT_5_4_NANO_2026_03_17("gpt-5.4-nano-2026-03-17")
      - GPT_5_3_CHAT_LATEST("gpt-5.3-chat-latest")
      - GPT_5_2("gpt-5.2")
      - GPT_5_2_2025_12_11("gpt-5.2-2025-12-11")
      - GPT_5_2_CHAT_LATEST("gpt-5.2-chat-latest")
      - GPT_5_2_PRO("gpt-5.2-pro")
      - GPT_5_2_PRO_2025_12_11("gpt-5.2-pro-2025-12-11")
      - GPT_5_1("gpt-5.1")
      - GPT_5_1_2025_11_13("gpt-5.1-2025-11-13")
      - GPT_5_1_CODEX("gpt-5.1-codex")
      - GPT_5_1_MINI("gpt-5.1-mini")
      - GPT_5_1_CHAT_LATEST("gpt-5.1-chat-latest")
      - GPT_5("gpt-5")
      - GPT_5_MINI("gpt-5-mini")
      - GPT_5_NANO("gpt-5-nano")
      - GPT_5_2025_08_07("gpt-5-2025-08-07")
      - GPT_5_MINI_2025_08_07("gpt-5-mini-2025-08-07")
      - GPT_5_NANO_2025_08_07("gpt-5-nano-2025-08-07")
      - GPT_5_CHAT_LATEST("gpt-5-chat-latest")
      - GPT_4_1("gpt-4.1")
      - GPT_4_1_MINI("gpt-4.1-mini")
      - GPT_4_1_NANO("gpt-4.1-nano")
      - GPT_4_1_2025_04_14("gpt-4.1-2025-04-14")
      - GPT_4_1_MINI_2025_04_14("gpt-4.1-mini-2025-04-14")
      - GPT_4_1_NANO_2025_04_14("gpt-4.1-nano-2025-04-14")
      - O4_MINI("o4-mini")
      - O4_MINI_2025_04_16("o4-mini-2025-04-16")
      - O3("o3")
      - O3_2025_04_16("o3-2025-04-16")
      - O3_MINI("o3-mini")
      - O3_MINI_2025_01_31("o3-mini-2025-01-31")
      - O1("o1")
      - O1_2024_12_17("o1-2024-12-17")
      - O1_PREVIEW("o1-preview")
      - O1_PREVIEW_2024_09_12("o1-preview-2024-09-12")
      - O1_MINI("o1-mini")
      - O1_MINI_2024_09_12("o1-mini-2024-09-12")
      - GPT_4O("gpt-4o")
      - GPT_4O_2024_11_20("gpt-4o-2024-11-20")
      - GPT_4O_2024_08_06("gpt-4o-2024-08-06")
      - GPT_4O_2024_05_13("gpt-4o-2024-05-13")
      - GPT_4O_AUDIO_PREVIEW("gpt-4o-audio-preview")
      - GPT_4O_AUDIO_PREVIEW_2024_10_01("gpt-4o-audio-preview-2024-10-01")
      - GPT_4O_AUDIO_PREVIEW_2024_12_17("gpt-4o-audio-preview-2024-12-17")
      - GPT_4O_AUDIO_PREVIEW_2025_06_03("gpt-4o-audio-preview-2025-06-03")
      - GPT_4O_MINI_AUDIO_PREVIEW("gpt-4o-mini-audio-preview")
      - GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17("gpt-4o-mini-audio-preview-2024-12-17")
      - GPT_4O_SEARCH_PREVIEW("gpt-4o-search-preview")
      - GPT_4O_MINI_SEARCH_PREVIEW("gpt-4o-mini-search-preview")
      - GPT_4O_SEARCH_PREVIEW_2025_03_11("gpt-4o-search-preview-2025-03-11")
      - GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11("gpt-4o-mini-search-preview-2025-03-11")
      - CHATGPT_4O_LATEST("chatgpt-4o-latest")
      - CODEX_MINI_LATEST("codex-mini-latest")
      - GPT_4O_MINI("gpt-4o-mini")
      - GPT_4O_MINI_2024_07_18("gpt-4o-mini-2024-07-18")
      - GPT_4_TURBO("gpt-4-turbo")
      - GPT_4_TURBO_2024_04_09("gpt-4-turbo-2024-04-09")
      - GPT_4_0125_PREVIEW("gpt-4-0125-preview")
      - GPT_4_TURBO_PREVIEW("gpt-4-turbo-preview")
      - GPT_4_1106_PREVIEW("gpt-4-1106-preview")
      - GPT_4_VISION_PREVIEW("gpt-4-vision-preview")
      - GPT_4("gpt-4")
      - GPT_4_0314("gpt-4-0314")
      - GPT_4_0613("gpt-4-0613")
      - GPT_4_32K("gpt-4-32k")
      - GPT_4_32K_0314("gpt-4-32k-0314")
      - GPT_4_32K_0613("gpt-4-32k-0613")
      - GPT_3_5_TURBO("gpt-3.5-turbo")
      - GPT_3_5_TURBO_16K("gpt-3.5-turbo-16k")
      - GPT_3_5_TURBO_0301("gpt-3.5-turbo-0301")
      - GPT_3_5_TURBO_0613("gpt-3.5-turbo-0613")
      - GPT_3_5_TURBO_1106("gpt-3.5-turbo-1106")
      - GPT_3_5_TURBO_0125("gpt-3.5-turbo-0125")
      - GPT_3_5_TURBO_16K_0613("gpt-3.5-turbo-16k-0613")
    - ResponsesOnlyModel
      - O1_PRO("o1-pro")
      - O1_PRO_2025_03_19("o1-pro-2025-03-19")
      - O3_PRO("o3-pro")
      - O3_PRO_2025_06_10("o3-pro-2025-06-10")
      - O3_DEEP_RESEARCH("o3-deep-research")
      - O3_DEEP_RESEARCH_2025_06_26("o3-deep-research-2025-06-26")
      - O4_MINI_DEEP_RESEARCH("o4-mini-deep-research")
      - O4_MINI_DEEP_RESEARCH_2025_06_26("o4-mini-deep-research-2025-06-26")
      - COMPUTER_USE_PREVIEW("computer-use-preview")
      - COMPUTER_USE_PREVIEW_2025_03_11("computer-use-preview-2025-03-11")
      - GPT_5_CODEX("gpt-5-codex")
      - GPT_5_PRO("gpt-5-pro")
      - GPT_5_PRO_2025_10_06("gpt-5-pro-2025-10-06")
      - GPT_5_1_CODEX_MAX("gpt-5.1-codex-max")
  - JsonValue; object_ "response"constant
    
    The object type of this resource - always set to response.
    - RESPONSE("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.
    - class ResponseOutputMessage:
      
      An output message from the model.
    - class ResponseFileSearchToolCall:
      
      The results of a file search tool call. See the file search guide for more information.
    - class ResponseFunctionToolCall:
      
      A tool call to run a function. See the function calling guide for more information.
    - 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.
        
        String
        
        List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
      - Status status
        
        The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "function_call_output"constant
        
        The type of the function tool call output. Always function_call_output.
        
        FUNCTION_CALL_OUTPUT("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.
    - class ResponseComputerToolCall:
      
      A tool call to a computer use tool. See the computer use guide for more information.
    - 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.
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        FAILED("failed")
        
        IN_PROGRESS("in_progress")
      - JsonValue; type "computer_call_output"constant
        
        The type of the computer tool call output. Always computer_call_output.
        
        COMPUTER_CALL_OUTPUT("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.
    - 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.
        
        SERVER("server")
        
        CLIENT("client")
      - Status status
        
        The status of the tool search call item that was recorded.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "tool_search_call"constant
        
        The type of the item. Always tool_search_call.
        
        TOOL_SEARCH_CALL("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.
        
        SERVER("server")
        
        CLIENT("client")
      - Status status
        
        The status of the tool search output item that was recorded.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - List<Tool> tools
        
        The loaded tool definitions returned by tool search.
        
        class FunctionTool:
        
        Defines a function in your own code the model can choose to call. Learn more about function calling.
        
        class FileSearchTool:
        
        A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
        
        class ComputerTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
        
        class ComputerUsePreviewTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
        
        class WebSearchTool:
        
        Search the Internet for sources related to the prompt. Learn more about the web search tool.
        
        Mcp
        
        CodeInterpreter
        
        ImageGeneration
        
        JsonValue;
        
        class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        class CustomTool:
        
        A custom tool that processes input using a specified format. Learn more about custom tools
        
        class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        class WebSearchPreviewTool:
        
        This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
        
        class ApplyPatchTool:
        
        Allows the assistant to create, delete, or update files using unified diffs.
      - JsonValue; type "tool_search_output"constant
        
        The type of the item. Always tool_search_output.
        
        TOOL_SEARCH_OUTPUT("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
        
        The type of the item. Always compaction.
        
        COMPACTION("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        GENERATING("generating")
        
        FAILED("failed")
      - JsonValue; type "image_generation_call"constant
        
        The type of the image generation call. Always image_generation_call.
        
        IMAGE_GENERATION_CALL("image_generation_call")
    - class ResponseCodeInterpreterToolCall:
      
      A tool call to run code.
    - 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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "local_shell_call"constant
        
        The type of the local shell call. Always local_shell_call.
        
        LOCAL_SHELL_CALL("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
        
        The type of the local shell tool call output. Always local_shell_call_output.
        
        LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
      - Optional<Status> status
        
        The status of the item. One of in_progress, completed, or incomplete.
        
        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.
        
        class ResponseLocalEnvironment:
        
        Represents the use of a local environment to perform shell actions.
        
        JsonValue; type "local"constant
        
        The environment type. Always local.
        
        LOCAL("local")
        
        class ResponseContainerReference:
        
        Represents a container created with /v1/containers.
        
        String containerId
        
        JsonValue; type "container_reference"constant
        
        The environment type. Always container_reference.
        
        CONTAINER_REFERENCE("container_reference")
      - Status status
        
        The status of the shell call. One of in_progress, completed, or incomplete.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "shell_call"constant
        
        The type of the item. Always shell_call.
        
        SHELL_CALL("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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "shell_call_output"constant
        
        The type of the shell call output. Always shell_call_output.
        
        SHELL_CALL_OUTPUT("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.
        
        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 a new file with the provided diff.
        
        CREATE_FILE("create_file")
        
        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 the specified file.
        
        DELETE_FILE("delete_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 an existing file with the provided diff.
        
        UPDATE_FILE("update_file")
      - Status status
        
        The status of the apply patch tool call. One of in_progress or completed.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
      - JsonValue; type "apply_patch_call"constant
        
        The type of the item. Always apply_patch_call.
        
        APPLY_PATCH_CALL("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.
        
        COMPLETED("completed")
        
        FAILED("failed")
      - JsonValue; type "apply_patch_call_output"constant
        
        The type of the item. Always apply_patch_call_output.
        
        APPLY_PATCH_CALL_OUTPUT("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
        
        The type of the item. Always mcp_call.
        
        MCP_CALL("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.
        
        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
        
        The type of the item. Always mcp_list_tools.
        
        MCP_LIST_TOOLS("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
        
        The type of the item. Always mcp_approval_request.
        
        MCP_APPROVAL_REQUEST("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
        
        The type of the item. Always mcp_approval_response.
        
        MCP_APPROVAL_RESPONSE("mcp_approval_response")
      - Optional<String> reason
        
        Optional reason for the decision.
    - class ResponseCustomToolCall:
      
      A call to a custom tool created by the model.
    - 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.
        
        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.
  - 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.
    - 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.
        
        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 tool configuration type. Always allowed_tools.
        
        ALLOWED_TOOLS("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
        
        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
        
        For function calling, the type is always function.
        
        FUNCTION("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
        
        For MCP tools, the type is always mcp.
        
        MCP("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
        
        For custom tool calling, the type is always custom.
        
        CUSTOM("custom")
    - class ToolChoiceApplyPatch:
      
      Forces the model to call the apply_patch tool when executing a tool call.
      - JsonValue; type "apply_patch"constant
        
        The tool to call. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
    - class ToolChoiceShell:
      
      Forces the model to call the shell tool when a tool call is required.
      - JsonValue; type "shell"constant
        
        The tool to call. Always shell.
        
        SHELL("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.
    - class FunctionTool:
      
      Defines a function in your own code the model can choose to call. Learn more about function calling.
    - class FileSearchTool:
      
      A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
    - class ComputerTool:
      
      A tool that controls a virtual computer. Learn more about the computer tool.
    - class ComputerUsePreviewTool:
      
      A tool that controls a virtual computer. Learn more about the computer tool.
    - class WebSearchTool:
      
      Search the Internet for sources related to the prompt. Learn more about the web search tool.
    - Mcp
    - CodeInterpreter
    - ImageGeneration
    - JsonValue;
    - class FunctionShellTool:
      
      A tool that allows the model to execute shell commands.
    - class CustomTool:
      
      A custom tool that processes input using a specified format. Learn more about custom tools
    - class NamespaceTool:
      
      Groups function/custom tools under a shared namespace.
    - class ToolSearchTool:
      
      Hosted or BYOT tool search configuration for deferred tools.
    - class WebSearchPreviewTool:
      
      This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
    - class ApplyPatchTool:
      
      Allows the assistant to create, delete, or update files using unified diffs.
  - 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.
  - 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.
    - 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.
      - String
      - class ResponseInputText:
        
        A text input to the model.
      - class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
      - class ResponseInputFile:
        
        A file input to the model.
    - Optional<String> version
      
      Optional version of the prompt template.
  - 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.
    - IN_MEMORY("in_memory")
    - _24H("24h")
  - Optional<Reasoning> reasoning
    
    gpt-5 and o-series models only
    
    Configuration options for reasoning models.
    - Optional<ReasoningEffort> effort
      
      Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
      - gpt-5.1 defaults to none, which does not perform reasoning. The supported reasoning values for gpt-5.1 are none, low, medium, and high. Tool calls are supported for all reasoning values in gpt-5.1.
      - All models before gpt-5.1 default to medium reasoning effort, and do not support none.
      - The gpt-5-pro model defaults to (and only supports) high reasoning effort.
      - xhigh is supported for all models after gpt-5.1-codex-max.
      - NONE("none")
      - MINIMAL("minimal")
      - LOW("low")
      - MEDIUM("medium")
      - HIGH("high")
      - XHIGH("xhigh")
    - Optional<GenerateSummary> generateSummary
      
      Deprecated: use summary instead.
      
      A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
      - AUTO("auto")
      - CONCISE("concise")
      - DETAILED("detailed")
    - Optional<Summary> summary
      
      A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
      
      concise is supported for computer-use-preview models and all reasoning models after gpt-5.
      - AUTO("auto")
      - CONCISE("concise")
      - DETAILED("detailed")
  - 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.
  - 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.
    - 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.
    - COMPLETED("completed")
    - FAILED("failed")
    - IN_PROGRESS("in_progress")
    - CANCELLED("cancelled")
    - QUEUED("queued")
    - INCOMPLETE("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<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.
      - class ResponseFormatText:
        
        Default response format. Used to generate text responses.
        
        JsonValue; type "text"constant
        
        The type of response format being defined. Always text.
        
        TEXT("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
        
        The type of response format being defined. Always json_schema.
        
        JSON_SCHEMA("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
        
        The type of response format being defined. Always json_object.
        
        JSON_OBJECT("json_object")
    - 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.
      - LOW("low")
      - MEDIUM("medium")
      - HIGH("high")
  - Optional<Long> topLogprobs
    
    An integer between 0 and 20 specifying the maximum number of most likely tokens to return at each token position, each with an associated log probability. In some cases, the number of returned tokens may be fewer than requested.
  - 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.
    - 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.
    - 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.
  - Optional<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.
- long sequenceNumber
  
  The sequence number for this event.
- JsonValue; type "response.completed"constant
  
  The type of the event. Always response.completed.
  - RESPONSE_COMPLETED("response.completed")

Response Computer Tool 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.
  - IN_PROGRESS("in_progress")
  - COMPLETED("completed")
  - INCOMPLETE("incomplete")
- Type type
  
  The type of the computer call. Always computer_call.
  - COMPUTER_CALL("computer_call")
- Optional<Action> action
  
  A click action.
  - class Click:
    
    A click action.
    - Button button
      
      Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
      - LEFT("left")
      - RIGHT("right")
      - WHEEL("wheel")
      - BACK("back")
      - FORWARD("forward")
    - JsonValue; type "click"constant
      
      Specifies the event type. For a click action, this property is always click.
      - CLICK("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
      
      Specifies the event type. For a double click action, this property is always set to double_click.
      - DOUBLE_CLICK("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
      
      Specifies the event type. For a drag action, this property is always set to drag.
      - DRAG("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
      
      Specifies the event type. For a keypress action, this property is always set to keypress.
      - KEYPRESS("keypress")
  - class Move:
    
    A mouse move action.
    - JsonValue; type "move"constant
      
      Specifies the event type. For a move action, this property is always set to move.
      - MOVE("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
      
      Specifies the event type. For a screenshot action, this property is always set to screenshot.
      - SCREENSHOT("screenshot")
  - class Scroll:
    
    A scroll action.
    - long scrollX
      
      The horizontal scroll distance.
    - long scrollY
      
      The vertical scroll distance.
    - JsonValue; type "scroll"constant
      
      Specifies the event type. For a scroll action, this property is always set to scroll.
      - SCROLL("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
      
      Specifies the event type. For a type action, this property is always set to type.
      - TYPE("type")
  - JsonValue;
    - JsonValue; type "wait"constant
      
      Specifies the event type. For a wait action, this property is always set to wait.
      - WAIT("wait")
- Optional<List<ComputerAction>> actions
  
  Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.
  - Click
    - Button button
      
      Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
      - LEFT("left")
      - RIGHT("right")
      - WHEEL("wheel")
      - BACK("back")
      - FORWARD("forward")
    - JsonValue; type "click"constant
      
      Specifies the event type. For a click action, this property is always click.
      - CLICK("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
      
      Specifies the event type. For a double click action, this property is always set to double_click.
      - DOUBLE_CLICK("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
      
      Specifies the event type. For a drag action, this property is always set to drag.
      - DRAG("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
      
      Specifies the event type. For a keypress action, this property is always set to keypress.
      - KEYPRESS("keypress")
  - Move
    - JsonValue; type "move"constant
      
      Specifies the event type. For a move action, this property is always set to move.
      - MOVE("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
      
      Specifies the event type. For a screenshot action, this property is always set to screenshot.
      - SCREENSHOT("screenshot")
  - Scroll
    - long scrollX
      
      The horizontal scroll distance.
    - long scrollY
      
      The vertical scroll distance.
    - JsonValue; type "scroll"constant
      
      Specifies the event type. For a scroll action, this property is always set to scroll.
      - SCROLL("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
      
      Specifies the event type. For a type action, this property is always set to type.
      - TYPE("type")
  - JsonValue;
    - JsonValue; type "wait"constant
      
      Specifies the event type. For a wait action, this property is always set to wait.
      - WAIT("wait")

Response Computer Tool Call Output Item

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.
  - JsonValue; type "computer_screenshot"constant
    
    Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
    - COMPUTER_SCREENSHOT("computer_screenshot")
  - Optional<String> fileId
    
    The identifier of an uploaded file that contains the screenshot.
  - Optional<String> imageUrl
    
    The URL of the screenshot image.
- Status status
  
  The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
  - COMPLETED("completed")
  - INCOMPLETE("incomplete")
  - FAILED("failed")
  - IN_PROGRESS("in_progress")
- JsonValue; type "computer_call_output"constant
  
  The type of the computer tool call output. Always computer_call_output.
  - COMPUTER_CALL_OUTPUT("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.

Response Computer Tool Call Output Screenshot

class ResponseComputerToolCallOutputScreenshot:

A computer screenshot image used with the computer use tool.
- JsonValue; type "computer_screenshot"constant
  
  Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
  - COMPUTER_SCREENSHOT("computer_screenshot")
- Optional<String> fileId
  
  The identifier of an uploaded file that contains the screenshot.
- Optional<String> imageUrl
  
  The URL of the screenshot image.

Response Container Reference

class ResponseContainerReference:

Represents a container created with /v1/containers.
- String containerId
- JsonValue; type "container_reference"constant
  
  The environment type. Always container_reference.
  - CONTAINER_REFERENCE("container_reference")

Response Content

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
    
    The type of the input item. Always input_text.
    - INPUT_TEXT("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.
    - LOW("low")
    - HIGH("high")
    - AUTO("auto")
    - ORIGINAL("original")
  - JsonValue; type "input_image"constant
    
    The type of the input item. Always input_image.
    - INPUT_IMAGE("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
    
    The type of the input item. Always input_file.
    - INPUT_FILE("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.
    - 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.
    - 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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
  - String text
    
    The text output from the model.
  - JsonValue; type "output_text"constant
    
    The type of the output text. Always output_text.
    - OUTPUT_TEXT("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
    
    The type of the refusal. Always refusal.
    - REFUSAL("refusal")
- ReasoningTextContent
  - String text
    
    The reasoning text from the model.
  - JsonValue; type "reasoning_text"constant
    
    The type of the reasoning text. Always reasoning_text.
    - REASONING_TEXT("reasoning_text")

Response Content Part Added Event

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.
  - class ResponseOutputText:
    
    A text output from the model.
    - List<Annotation> annotations
      
      The annotations of the text output.
      - 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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
    - String text
      
      The text output from the model.
    - JsonValue; type "output_text"constant
      
      The type of the output text. Always output_text.
      - OUTPUT_TEXT("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
      
      The type of the refusal. Always refusal.
      - REFUSAL("refusal")
  - class ReasoningText:
    
    Reasoning text from the model.
    - String text
      
      The reasoning text from the model.
    - JsonValue; type "reasoning_text"constant
      
      The type of the reasoning text. Always reasoning_text.
      - REASONING_TEXT("reasoning_text")
- long sequenceNumber
  
  The sequence number of this event.
- JsonValue; type "response.content_part.added"constant
  
  The type of the event. Always response.content_part.added.
  - RESPONSE_CONTENT_PART_ADDED("response.content_part.added")

Response Content Part Done Event

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.
  - class ResponseOutputText:
    
    A text output from the model.
    - List<Annotation> annotations
      
      The annotations of the text output.
      - 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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
    - String text
      
      The text output from the model.
    - JsonValue; type "output_text"constant
      
      The type of the output text. Always output_text.
      - OUTPUT_TEXT("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
      
      The type of the refusal. Always refusal.
      - REFUSAL("refusal")
  - class ReasoningText:
    
    Reasoning text from the model.
    - String text
      
      The reasoning text from the model.
    - JsonValue; type "reasoning_text"constant
      
      The type of the reasoning text. Always reasoning_text.
      - REASONING_TEXT("reasoning_text")
- long sequenceNumber
  
  The sequence number of this event.
- JsonValue; type "response.content_part.done"constant
  
  The type of the event. Always response.content_part.done.
  - RESPONSE_CONTENT_PART_DONE("response.content_part.done")

Response Conversation Param

class ResponseConversationParam:

The conversation that this response belongs to.
- String id
  
  The unique ID of the conversation.

Response Created Event

class ResponseCreatedEvent:

An event that is emitted when a response is created.
- Response response
  
  The response that was created.
  - 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.
    - Code code
      
      The error code for the response.
      - 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.
  - Optional<IncompleteDetails> incompleteDetails
    
    Details about why the response is incomplete.
    - Optional<Reason> reason
      
      The reason why the response is incomplete.
      - 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.
    - String
    - List<ResponseInputItem>
      - 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.
        
        String
        
        List<ResponseInputContent>
        
        class ResponseInputText:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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.
        
        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.
        
        COMMENTARY("commentary")
        
        FINAL_ANSWER("final_answer")
        
        Optional<Type> type
        
        The type of the message input. Always message.
        
        MESSAGE("message")
      - Message
        
        List<ResponseInputContent> content
        
        A list of one or many input items to the model, containing different content types.
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
        
        Role role
        
        The role of the message input. One of user, system, or developer.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        Optional<Type> type
        
        The type of the message input. Always set to message.
        
        MESSAGE("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.
        
        class ResponseOutputText:
        
        A text output from the model.
        
        List<Annotation> annotations
        
        The annotations of the text output.
        
        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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
        
        String text
        
        The text output from the model.
        
        JsonValue; type "output_text"constant
        
        The type of the output text. Always output_text.
        
        OUTPUT_TEXT("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
        
        The type of the refusal. Always refusal.
        
        REFUSAL("refusal")
        
        JsonValue; role "assistant"constant
        
        The role of the output message. Always assistant.
        
        ASSISTANT("assistant")
        
        Status status
        
        The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        JsonValue; type "message"constant
        
        The type of the output message. Always message.
        
        MESSAGE("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.
        
        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,
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        FAILED("failed")
        
        JsonValue; type "file_search_call"constant
        
        The type of the file search tool call. Always file_search_call.
        
        FILE_SEARCH_CALL("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.
        
        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.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        Type type
        
        The type of the computer call. Always computer_call.
        
        COMPUTER_CALL("computer_call")
        
        Optional<Action> action
        
        A click action.
        
        class Click:
        
        A click action.
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        class Move:
        
        A mouse move action.
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        class Scroll:
        
        A scroll action.
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
        
        Optional<List<ComputerAction>> actions
        
        Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.
        
        Click
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        Move
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        Scroll
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
      - ComputerCallOutput
        
        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.
        
        JsonValue; type "computer_screenshot"constant
        
        Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
        
        COMPUTER_SCREENSHOT("computer_screenshot")
        
        Optional<String> fileId
        
        The identifier of an uploaded file that contains the screenshot.
        
        Optional<String> imageUrl
        
        The URL of the screenshot image.
        
        JsonValue; type "computer_call_output"constant
        
        The type of the computer tool call output. Always computer_call_output.
        
        COMPUTER_CALL_OUTPUT("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.
        
        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).
        
        class Search:
        
        Action type "search" - Performs a web search query.
        
        String query
        
        [DEPRECATED] The search query.
        
        JsonValue; type "search"constant
        
        The action type.
        
        SEARCH("search")
        
        Optional<List<String>> queries
        
        The search queries.
        
        Optional<List<Source>> sources
        
        The sources used in the search.
        
        JsonValue; type "url"constant
        
        The type of source. Always url.
        
        URL("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
        
        The action type.
        
        OPEN_PAGE("open_page")
        
        Optional<String> url
        
        The URL opened by the model.
        
        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
        
        The action type.
        
        FIND_IN_PAGE("find_in_page")
        
        String url
        
        The URL of the page searched for the pattern.
        
        Status status
        
        The status of the web search tool call.
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        FAILED("failed")
        
        JsonValue; type "web_search_call"constant
        
        The type of the web search tool call. Always web_search_call.
        
        WEB_SEARCH_CALL("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
        
        The type of the function tool call. Always function_call.
        
        FUNCTION_CALL("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - FunctionCallOutput
        
        String callId
        
        The unique ID of the function tool call generated by the model.
        
        Output output
        
        Text, image, or file output of the function tool call.
        
        String
        
        List<ResponseFunctionCallOutputItem>
        
        class ResponseInputTextContent:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("input_text")
        
        class ResponseInputImageContent:
        
        An image input to the model. Learn about image inputs
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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.
        
        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.
        
        class ResponseInputFileContent:
        
        A file input to the model.
        
        JsonValue; type "input_file"constant
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        LOW("low")
        
        HIGH("high")
        
        Optional<String> fileData
        
        The base64-encoded data 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 "function_call_output"constant
        
        The type of the function tool call output. Always function_call_output.
        
        FUNCTION_CALL_OUTPUT("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.
        
        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
        
        The item type. Always tool_search_call.
        
        TOOL_SEARCH_CALL("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.
        
        Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
        
        Optional<Status> status
        
        The status of the tool search call.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - class ResponseToolSearchOutputItemParam:
        
        List<Tool> tools
        
        The loaded tool definitions returned by the tool search output.
        
        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
        
        The type of the function tool. Always function.
        
        FUNCTION("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
        
        The type of the file search tool. Always file_search.
        
        FILE_SEARCH("file_search")
        
        List<String> vectorStoreIds
        
        The IDs of the vector stores to search.
        
        Optional<Filters> filters
        
        A filter to apply.
        
        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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
        
        Type type
        
        Type of operation: and or or.
        
        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.
        
        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
        
        The type of the computer tool. Always computer.
        
        COMPUTER("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.
        
        WINDOWS("windows")
        
        MAC("mac")
        
        LINUX("linux")
        
        UBUNTU("ubuntu")
        
        BROWSER("browser")
        
        JsonValue; type "computer_use_preview"constant
        
        The type of the computer use tool. Always computer_use_preview.
        
        COMPUTER_USE_PREVIEW("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.
        
        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.
        
        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.
        
        APPROXIMATE("approximate")
        
        Mcp
        
        String serverLabel
        
        A label for this MCP server, used to identify it in tool calls.
        
        JsonValue; type "mcp"constant
        
        The type of the MCP tool. Always mcp.
        
        MCP("mcp")
        
        Optional<AllowedTools> allowedTools
        
        List of allowed tool names or a filter object.
        
        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
        
        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.
        
        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.
        
        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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
        
        JsonValue; type "code_interpreter"constant
        
        The type of the code interpreter tool. Always code_interpreter.
        
        CODE_INTERPRETER("code_interpreter")
        
        ImageGeneration
        
        JsonValue; type "image_generation"constant
        
        The type of the image generation tool. Always image_generation.
        
        IMAGE_GENERATION("image_generation")
        
        Optional<Action> action
        
        Whether to generate a new image or edit an existing image. Default: auto.
        
        GENERATE("generate")
        
        EDIT("edit")
        
        AUTO("auto")
        
        Optional<Background> background
        
        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.
        
        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.
        
        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.
        
        GPT_IMAGE_1("gpt-image-1")
        
        GPT_IMAGE_1_MINI("gpt-image-1-mini")
        
        GPT_IMAGE_2("gpt-image-2")
        
        GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
        
        GPT_IMAGE_1_5("gpt-image-1.5")
        
        CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
        
        Optional<Moderation> moderation
        
        Moderation level for the generated image. Default: auto.
        
        AUTO("auto")
        
        LOW("low")
        
        Optional<Long> outputCompression
        
        Compression level for the output image. Default: 100.
        
        Optional<OutputFormat> outputFormat
        
        The output format of the generated image. One of png, webp, or jpeg. Default: png.
        
        PNG("png")
        
        WEBP("webp")
        
        JPEG("jpeg")
        
        Optional<Long> partialImages
        
        Number of partial images to generate in streaming mode, from 0 (default value) to 3.
        
        Optional<Quality> quality
        
        The quality of the generated image. One of low, medium, high, or auto. Default: auto.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        AUTO("auto")
        
        Optional<Size> size
        
        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.
        
        _1024X1024("1024x1024")
        
        _1024X1536("1024x1536")
        
        _1536X1024("1536x1024")
        
        AUTO("auto")
        
        JsonValue;
        
        JsonValue; type "local_shell"constant
        
        The type of the local shell tool. Always local_shell.
        
        LOCAL_SHELL("local_shell")
        
        class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        JsonValue; type "shell"constant
        
        The type of the shell tool. Always shell.
        
        SHELL("shell")
        
        Optional<Environment> environment
        
        class ContainerAuto:
        
        JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
        
        Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
        
        class LocalEnvironment:
        
        JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
        
        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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
        
        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
        
        The type of the custom tool. Always custom.
        
        CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
        
        Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
        
        class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        String description
        
        A description of the namespace shown to the model.
        
        String name
        
        The namespace name used in tool calls (for example, crm).
        
        List<Tool> tools
        
        The function/custom tools available inside this namespace.
        
        class Function:
        
        String name
        
        JsonValue; type "function"constant
        
        FUNCTION("function")
        
        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
        
        JsonValue; type "namespace"constant
        
        The type of the tool. Always namespace.
        
        NAMESPACE("namespace")
        
        class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        JsonValue; type "tool_search"constant
        
        The type of the tool. Always tool_search.
        
        TOOL_SEARCH("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.
        
        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.
        
        WEB_SEARCH_PREVIEW("web_search_preview")
        
        WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
        
        Optional<List<SearchContentType>> searchContentTypes
        
        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.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        Optional<UserLocation> userLocation
        
        The user's location.
        
        JsonValue; type "approximate"constant
        
        The type of location approximation. Always approximate.
        
        APPROXIMATE("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
        
        The type of the tool. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
        
        JsonValue; type "tool_search_output"constant
        
        The item type. Always tool_search_output.
        
        TOOL_SEARCH_OUTPUT("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.
        
        Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
        
        Optional<Status> status
        
        The status of the tool search output.
        
        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
        
        The type of the object. Always summary_text.
        
        SUMMARY_TEXT("summary_text")
        
        JsonValue; type "reasoning"constant
        
        The type of the object. Always reasoning.
        
        REASONING("reasoning")
        
        Optional<List<Content>> content
        
        Reasoning text content.
        
        String text
        
        The reasoning text from the model.
        
        JsonValue; type "reasoning_text"constant
        
        The type of the reasoning text. Always reasoning_text.
        
        REASONING_TEXT("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.
        
        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.
        
        JsonValue; type "compaction"constant
        
        The type of the item. Always compaction.
        
        COMPACTION("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        GENERATING("generating")
        
        FAILED("failed")
        
        JsonValue; type "image_generation_call"constant
        
        The type of the image generation call. Always image_generation_call.
        
        IMAGE_GENERATION_CALL("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.
        
        class Logs:
        
        The logs output from the code interpreter.
        
        String logs
        
        The logs output from the code interpreter.
        
        JsonValue; type "logs"constant
        
        The type of the output. Always logs.
        
        LOGS("logs")
        
        class Image:
        
        The image output from the code interpreter.
        
        JsonValue; type "image"constant
        
        The type of the output. Always image.
        
        IMAGE("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        INTERPRETING("interpreting")
        
        FAILED("failed")
        
        JsonValue; type "code_interpreter_call"constant
        
        The type of the code interpreter tool call. Always code_interpreter_call.
        
        CODE_INTERPRETER_CALL("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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        JsonValue; type "local_shell_call"constant
        
        The type of the local shell call. Always local_shell_call.
        
        LOCAL_SHELL_CALL("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
        
        The type of the local shell tool call output. Always local_shell_call_output.
        
        LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
        
        Optional<Status> status
        
        The status of the item. One of in_progress, completed, or incomplete.
        
        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.
        
        JsonValue; type "shell_call"constant
        
        The type of the item. Always shell_call.
        
        SHELL_CALL("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.
        
        class LocalEnvironment:
        
        class ContainerReference:
        
        Optional<Status> status
        
        The status of the shell call. One of in_progress, completed, or incomplete.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - ShellCallOutput
        
        String callId
        
        The unique ID of the shell tool call generated by the model.
        
        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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("exit")
        
        String stderr
        
        Captured stderr output for the shell call.
        
        String stdout
        
        Captured stdout output for the shell call.
        
        JsonValue; type "shell_call_output"constant
        
        The type of the item. Always shell_call_output.
        
        SHELL_CALL_OUTPUT("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - ApplyPatchCall
        
        String callId
        
        The unique ID of the apply patch tool call generated by the model.
        
        Operation operation
        
        The specific create, delete, or update instruction for the apply_patch tool call.
        
        class CreateFile:
        
        Instruction for creating a new file via the apply_patch tool.
        
        String diff
        
        Unified diff content to apply when creating the file.
        
        String path
        
        Path of the file to create relative to the workspace root.
        
        JsonValue; type "create_file"constant
        
        The operation type. Always create_file.
        
        CREATE_FILE("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.
        
        JsonValue; type "delete_file"constant
        
        The operation type. Always delete_file.
        
        DELETE_FILE("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.
        
        String path
        
        Path of the file to update relative to the workspace root.
        
        JsonValue; type "update_file"constant
        
        The operation type. Always update_file.
        
        UPDATE_FILE("update_file")
        
        Status status
        
        The status of the apply patch tool call. One of in_progress or completed.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        JsonValue; type "apply_patch_call"constant
        
        The type of the item. Always apply_patch_call.
        
        APPLY_PATCH_CALL("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.
        
        Status status
        
        The status of the apply patch tool call output. One of completed or failed.
        
        COMPLETED("completed")
        
        FAILED("failed")
        
        JsonValue; type "apply_patch_call_output"constant
        
        The type of the item. Always apply_patch_call_output.
        
        APPLY_PATCH_CALL_OUTPUT("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).
      - 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
        
        The type of the item. Always mcp_list_tools.
        
        MCP_LIST_TOOLS("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
        
        The type of the item. Always mcp_approval_request.
        
        MCP_APPROVAL_REQUEST("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
        
        The type of the item. Always mcp_approval_response.
        
        MCP_APPROVAL_RESPONSE("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
        
        The type of the item. Always mcp_call.
        
        MCP_CALL("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.
        
        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.
        
        String
        
        List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
        
        JsonValue; type "custom_tool_call_output"constant
        
        The type of the custom tool call output. Always custom_tool_call_output.
        
        CUSTOM_TOOL_CALL_OUTPUT("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
        
        The type of the custom tool call. Always custom_tool_call.
        
        CUSTOM_TOOL_CALL("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.
      - JsonValue;
        
        JsonValue; type "compaction_trigger"constant
        
        The type of the item. Always compaction_trigger.
        
        COMPACTION_TRIGGER("compaction_trigger")
      - ItemReference
        
        String id
        
        The ID of the item to reference.
        
        Optional<Type> type
        
        The type of item to reference. Always item_reference.
        
        ITEM_REFERENCE("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.
    - String
    - enum ChatModel:
      - GPT_5_4("gpt-5.4")
      - GPT_5_4_MINI("gpt-5.4-mini")
      - GPT_5_4_NANO("gpt-5.4-nano")
      - GPT_5_4_MINI_2026_03_17("gpt-5.4-mini-2026-03-17")
      - GPT_5_4_NANO_2026_03_17("gpt-5.4-nano-2026-03-17")
      - GPT_5_3_CHAT_LATEST("gpt-5.3-chat-latest")
      - GPT_5_2("gpt-5.2")
      - GPT_5_2_2025_12_11("gpt-5.2-2025-12-11")
      - GPT_5_2_CHAT_LATEST("gpt-5.2-chat-latest")
      - GPT_5_2_PRO("gpt-5.2-pro")
      - GPT_5_2_PRO_2025_12_11("gpt-5.2-pro-2025-12-11")
      - GPT_5_1("gpt-5.1")
      - GPT_5_1_2025_11_13("gpt-5.1-2025-11-13")
      - GPT_5_1_CODEX("gpt-5.1-codex")
      - GPT_5_1_MINI("gpt-5.1-mini")
      - GPT_5_1_CHAT_LATEST("gpt-5.1-chat-latest")
      - GPT_5("gpt-5")
      - GPT_5_MINI("gpt-5-mini")
      - GPT_5_NANO("gpt-5-nano")
      - GPT_5_2025_08_07("gpt-5-2025-08-07")
      - GPT_5_MINI_2025_08_07("gpt-5-mini-2025-08-07")
      - GPT_5_NANO_2025_08_07("gpt-5-nano-2025-08-07")
      - GPT_5_CHAT_LATEST("gpt-5-chat-latest")
      - GPT_4_1("gpt-4.1")
      - GPT_4_1_MINI("gpt-4.1-mini")
      - GPT_4_1_NANO("gpt-4.1-nano")
      - GPT_4_1_2025_04_14("gpt-4.1-2025-04-14")
      - GPT_4_1_MINI_2025_04_14("gpt-4.1-mini-2025-04-14")
      - GPT_4_1_NANO_2025_04_14("gpt-4.1-nano-2025-04-14")
      - O4_MINI("o4-mini")
      - O4_MINI_2025_04_16("o4-mini-2025-04-16")
      - O3("o3")
      - O3_2025_04_16("o3-2025-04-16")
      - O3_MINI("o3-mini")
      - O3_MINI_2025_01_31("o3-mini-2025-01-31")
      - O1("o1")
      - O1_2024_12_17("o1-2024-12-17")
      - O1_PREVIEW("o1-preview")
      - O1_PREVIEW_2024_09_12("o1-preview-2024-09-12")
      - O1_MINI("o1-mini")
      - O1_MINI_2024_09_12("o1-mini-2024-09-12")
      - GPT_4O("gpt-4o")
      - GPT_4O_2024_11_20("gpt-4o-2024-11-20")
      - GPT_4O_2024_08_06("gpt-4o-2024-08-06")
      - GPT_4O_2024_05_13("gpt-4o-2024-05-13")
      - GPT_4O_AUDIO_PREVIEW("gpt-4o-audio-preview")
      - GPT_4O_AUDIO_PREVIEW_2024_10_01("gpt-4o-audio-preview-2024-10-01")
      - GPT_4O_AUDIO_PREVIEW_2024_12_17("gpt-4o-audio-preview-2024-12-17")
      - GPT_4O_AUDIO_PREVIEW_2025_06_03("gpt-4o-audio-preview-2025-06-03")
      - GPT_4O_MINI_AUDIO_PREVIEW("gpt-4o-mini-audio-preview")
      - GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17("gpt-4o-mini-audio-preview-2024-12-17")
      - GPT_4O_SEARCH_PREVIEW("gpt-4o-search-preview")
      - GPT_4O_MINI_SEARCH_PREVIEW("gpt-4o-mini-search-preview")
      - GPT_4O_SEARCH_PREVIEW_2025_03_11("gpt-4o-search-preview-2025-03-11")
      - GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11("gpt-4o-mini-search-preview-2025-03-11")
      - CHATGPT_4O_LATEST("chatgpt-4o-latest")
      - CODEX_MINI_LATEST("codex-mini-latest")
      - GPT_4O_MINI("gpt-4o-mini")
      - GPT_4O_MINI_2024_07_18("gpt-4o-mini-2024-07-18")
      - GPT_4_TURBO("gpt-4-turbo")
      - GPT_4_TURBO_2024_04_09("gpt-4-turbo-2024-04-09")
      - GPT_4_0125_PREVIEW("gpt-4-0125-preview")
      - GPT_4_TURBO_PREVIEW("gpt-4-turbo-preview")
      - GPT_4_1106_PREVIEW("gpt-4-1106-preview")
      - GPT_4_VISION_PREVIEW("gpt-4-vision-preview")
      - GPT_4("gpt-4")
      - GPT_4_0314("gpt-4-0314")
      - GPT_4_0613("gpt-4-0613")
      - GPT_4_32K("gpt-4-32k")
      - GPT_4_32K_0314("gpt-4-32k-0314")
      - GPT_4_32K_0613("gpt-4-32k-0613")
      - GPT_3_5_TURBO("gpt-3.5-turbo")
      - GPT_3_5_TURBO_16K("gpt-3.5-turbo-16k")
      - GPT_3_5_TURBO_0301("gpt-3.5-turbo-0301")
      - GPT_3_5_TURBO_0613("gpt-3.5-turbo-0613")
      - GPT_3_5_TURBO_1106("gpt-3.5-turbo-1106")
      - GPT_3_5_TURBO_0125("gpt-3.5-turbo-0125")
      - GPT_3_5_TURBO_16K_0613("gpt-3.5-turbo-16k-0613")
    - ResponsesOnlyModel
      - O1_PRO("o1-pro")
      - O1_PRO_2025_03_19("o1-pro-2025-03-19")
      - O3_PRO("o3-pro")
      - O3_PRO_2025_06_10("o3-pro-2025-06-10")
      - O3_DEEP_RESEARCH("o3-deep-research")
      - O3_DEEP_RESEARCH_2025_06_26("o3-deep-research-2025-06-26")
      - O4_MINI_DEEP_RESEARCH("o4-mini-deep-research")
      - O4_MINI_DEEP_RESEARCH_2025_06_26("o4-mini-deep-research-2025-06-26")
      - COMPUTER_USE_PREVIEW("computer-use-preview")
      - COMPUTER_USE_PREVIEW_2025_03_11("computer-use-preview-2025-03-11")
      - GPT_5_CODEX("gpt-5-codex")
      - GPT_5_PRO("gpt-5-pro")
      - GPT_5_PRO_2025_10_06("gpt-5-pro-2025-10-06")
      - GPT_5_1_CODEX_MAX("gpt-5.1-codex-max")
  - JsonValue; object_ "response"constant
    
    The object type of this resource - always set to response.
    - RESPONSE("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.
    - class ResponseOutputMessage:
      
      An output message from the model.
    - class ResponseFileSearchToolCall:
      
      The results of a file search tool call. See the file search guide for more information.
    - class ResponseFunctionToolCall:
      
      A tool call to run a function. See the function calling guide for more information.
    - 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.
        
        String
        
        List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
      - Status status
        
        The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "function_call_output"constant
        
        The type of the function tool call output. Always function_call_output.
        
        FUNCTION_CALL_OUTPUT("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.
    - class ResponseComputerToolCall:
      
      A tool call to a computer use tool. See the computer use guide for more information.
    - 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.
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        FAILED("failed")
        
        IN_PROGRESS("in_progress")
      - JsonValue; type "computer_call_output"constant
        
        The type of the computer tool call output. Always computer_call_output.
        
        COMPUTER_CALL_OUTPUT("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.
    - 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.
        
        SERVER("server")
        
        CLIENT("client")
      - Status status
        
        The status of the tool search call item that was recorded.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "tool_search_call"constant
        
        The type of the item. Always tool_search_call.
        
        TOOL_SEARCH_CALL("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.
        
        SERVER("server")
        
        CLIENT("client")
      - Status status
        
        The status of the tool search output item that was recorded.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - List<Tool> tools
        
        The loaded tool definitions returned by tool search.
        
        class FunctionTool:
        
        Defines a function in your own code the model can choose to call. Learn more about function calling.
        
        class FileSearchTool:
        
        A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
        
        class ComputerTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
        
        class ComputerUsePreviewTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
        
        class WebSearchTool:
        
        Search the Internet for sources related to the prompt. Learn more about the web search tool.
        
        Mcp
        
        CodeInterpreter
        
        ImageGeneration
        
        JsonValue;
        
        class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        class CustomTool:
        
        A custom tool that processes input using a specified format. Learn more about custom tools
        
        class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        class WebSearchPreviewTool:
        
        This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
        
        class ApplyPatchTool:
        
        Allows the assistant to create, delete, or update files using unified diffs.
      - JsonValue; type "tool_search_output"constant
        
        The type of the item. Always tool_search_output.
        
        TOOL_SEARCH_OUTPUT("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
        
        The type of the item. Always compaction.
        
        COMPACTION("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        GENERATING("generating")
        
        FAILED("failed")
      - JsonValue; type "image_generation_call"constant
        
        The type of the image generation call. Always image_generation_call.
        
        IMAGE_GENERATION_CALL("image_generation_call")
    - class ResponseCodeInterpreterToolCall:
      
      A tool call to run code.
    - 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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "local_shell_call"constant
        
        The type of the local shell call. Always local_shell_call.
        
        LOCAL_SHELL_CALL("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
        
        The type of the local shell tool call output. Always local_shell_call_output.
        
        LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
      - Optional<Status> status
        
        The status of the item. One of in_progress, completed, or incomplete.
        
        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.
        
        class ResponseLocalEnvironment:
        
        Represents the use of a local environment to perform shell actions.
        
        JsonValue; type "local"constant
        
        The environment type. Always local.
        
        LOCAL("local")
        
        class ResponseContainerReference:
        
        Represents a container created with /v1/containers.
        
        String containerId
        
        JsonValue; type "container_reference"constant
        
        The environment type. Always container_reference.
        
        CONTAINER_REFERENCE("container_reference")
      - Status status
        
        The status of the shell call. One of in_progress, completed, or incomplete.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "shell_call"constant
        
        The type of the item. Always shell_call.
        
        SHELL_CALL("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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "shell_call_output"constant
        
        The type of the shell call output. Always shell_call_output.
        
        SHELL_CALL_OUTPUT("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.
        
        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 a new file with the provided diff.
        
        CREATE_FILE("create_file")
        
        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 the specified file.
        
        DELETE_FILE("delete_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 an existing file with the provided diff.
        
        UPDATE_FILE("update_file")
      - Status status
        
        The status of the apply patch tool call. One of in_progress or completed.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
      - JsonValue; type "apply_patch_call"constant
        
        The type of the item. Always apply_patch_call.
        
        APPLY_PATCH_CALL("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.
        
        COMPLETED("completed")
        
        FAILED("failed")
      - JsonValue; type "apply_patch_call_output"constant
        
        The type of the item. Always apply_patch_call_output.
        
        APPLY_PATCH_CALL_OUTPUT("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
        
        The type of the item. Always mcp_call.
        
        MCP_CALL("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.
        
        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
        
        The type of the item. Always mcp_list_tools.
        
        MCP_LIST_TOOLS("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
        
        The type of the item. Always mcp_approval_request.
        
        MCP_APPROVAL_REQUEST("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
        
        The type of the item. Always mcp_approval_response.
        
        MCP_APPROVAL_RESPONSE("mcp_approval_response")
      - Optional<String> reason
        
        Optional reason for the decision.
    - class ResponseCustomToolCall:
      
      A call to a custom tool created by the model.
    - 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.
        
        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.
  - 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.
    - 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.
        
        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 tool configuration type. Always allowed_tools.
        
        ALLOWED_TOOLS("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
        
        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
        
        For function calling, the type is always function.
        
        FUNCTION("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
        
        For MCP tools, the type is always mcp.
        
        MCP("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
        
        For custom tool calling, the type is always custom.
        
        CUSTOM("custom")
    - class ToolChoiceApplyPatch:
      
      Forces the model to call the apply_patch tool when executing a tool call.
      - JsonValue; type "apply_patch"constant
        
        The tool to call. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
    - class ToolChoiceShell:
      
      Forces the model to call the shell tool when a tool call is required.
      - JsonValue; type "shell"constant
        
        The tool to call. Always shell.
        
        SHELL("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.
    - class FunctionTool:
      
      Defines a function in your own code the model can choose to call. Learn more about function calling.
    - class FileSearchTool:
      
      A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
    - class ComputerTool:
      
      A tool that controls a virtual computer. Learn more about the computer tool.
    - class ComputerUsePreviewTool:
      
      A tool that controls a virtual computer. Learn more about the computer tool.
    - class WebSearchTool:
      
      Search the Internet for sources related to the prompt. Learn more about the web search tool.
    - Mcp
    - CodeInterpreter
    - ImageGeneration
    - JsonValue;
    - class FunctionShellTool:
      
      A tool that allows the model to execute shell commands.
    - class CustomTool:
      
      A custom tool that processes input using a specified format. Learn more about custom tools
    - class NamespaceTool:
      
      Groups function/custom tools under a shared namespace.
    - class ToolSearchTool:
      
      Hosted or BYOT tool search configuration for deferred tools.
    - class WebSearchPreviewTool:
      
      This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
    - class ApplyPatchTool:
      
      Allows the assistant to create, delete, or update files using unified diffs.
  - 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.
  - 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.
    - 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.
      - String
      - class ResponseInputText:
        
        A text input to the model.
      - class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
      - class ResponseInputFile:
        
        A file input to the model.
    - Optional<String> version
      
      Optional version of the prompt template.
  - 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.
    - IN_MEMORY("in_memory")
    - _24H("24h")
  - Optional<Reasoning> reasoning
    
    gpt-5 and o-series models only
    
    Configuration options for reasoning models.
    - Optional<ReasoningEffort> effort
      
      Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
      - gpt-5.1 defaults to none, which does not perform reasoning. The supported reasoning values for gpt-5.1 are none, low, medium, and high. Tool calls are supported for all reasoning values in gpt-5.1.
      - All models before gpt-5.1 default to medium reasoning effort, and do not support none.
      - The gpt-5-pro model defaults to (and only supports) high reasoning effort.
      - xhigh is supported for all models after gpt-5.1-codex-max.
      - NONE("none")
      - MINIMAL("minimal")
      - LOW("low")
      - MEDIUM("medium")
      - HIGH("high")
      - XHIGH("xhigh")
    - Optional<GenerateSummary> generateSummary
      
      Deprecated: use summary instead.
      
      A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
      - AUTO("auto")
      - CONCISE("concise")
      - DETAILED("detailed")
    - Optional<Summary> summary
      
      A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
      
      concise is supported for computer-use-preview models and all reasoning models after gpt-5.
      - AUTO("auto")
      - CONCISE("concise")
      - DETAILED("detailed")
  - 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.
  - 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.
    - 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.
    - COMPLETED("completed")
    - FAILED("failed")
    - IN_PROGRESS("in_progress")
    - CANCELLED("cancelled")
    - QUEUED("queued")
    - INCOMPLETE("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<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.
      - class ResponseFormatText:
        
        Default response format. Used to generate text responses.
        
        JsonValue; type "text"constant
        
        The type of response format being defined. Always text.
        
        TEXT("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
        
        The type of response format being defined. Always json_schema.
        
        JSON_SCHEMA("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
        
        The type of response format being defined. Always json_object.
        
        JSON_OBJECT("json_object")
    - 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.
      - LOW("low")
      - MEDIUM("medium")
      - HIGH("high")
  - Optional<Long> topLogprobs
    
    An integer between 0 and 20 specifying the maximum number of most likely tokens to return at each token position, each with an associated log probability. In some cases, the number of returned tokens may be fewer than requested.
  - 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.
    - 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.
    - 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.
  - Optional<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.
- long sequenceNumber
  
  The sequence number for this event.
- JsonValue; type "response.created"constant
  
  The type of the event. Always response.created.
  - RESPONSE_CREATED("response.created")

Response Custom Tool Call

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
  
  The type of the custom tool call. Always custom_tool_call.
  - CUSTOM_TOOL_CALL("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.

Response Custom Tool Call Input Delta Event

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
  
  The event type identifier.
  - RESPONSE_CUSTOM_TOOL_CALL_INPUT_DELTA("response.custom_tool_call_input.delta")

Response Custom Tool Call Input Done Event

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
  
  The event type identifier.
  - RESPONSE_CUSTOM_TOOL_CALL_INPUT_DONE("response.custom_tool_call_input.done")

Response Custom Tool Call Item

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.
  - IN_PROGRESS("in_progress")
  - COMPLETED("completed")
  - INCOMPLETE("incomplete")
- Optional<String> createdBy
  
  The identifier of the actor that created the item.

Response Custom Tool Call Output

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.
  - String
  - List<FunctionAndCustomToolCallOutput>
    - class ResponseInputText:
      
      A text input to the model.
      - String text
        
        The text input to the model.
      - JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
      - JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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
  
  The type of the custom tool call output. Always custom_tool_call_output.
  - CUSTOM_TOOL_CALL_OUTPUT("custom_tool_call_output")
- Optional<String> id
  
  The unique ID of the custom tool call output in the OpenAI platform.

Response Custom Tool Call Output 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.
  - IN_PROGRESS("in_progress")
  - COMPLETED("completed")
  - INCOMPLETE("incomplete")
- Optional<String> createdBy
  
  The identifier of the actor that created the item.

Response Error

class ResponseError:

An error object returned when the model fails to generate a Response.
- Code code
  
  The error code for the response.
  - 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.

Response Error Event

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
  
  The type of the event. Always error.
  - ERROR("error")

Response Failed Event

class ResponseFailedEvent:

An event that is emitted when a response fails.
- Response response
  
  The response that failed.
  - 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.
    - Code code
      
      The error code for the response.
      - 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.
  - Optional<IncompleteDetails> incompleteDetails
    
    Details about why the response is incomplete.
    - Optional<Reason> reason
      
      The reason why the response is incomplete.
      - 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.
    - String
    - List<ResponseInputItem>
      - 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.
        
        String
        
        List<ResponseInputContent>
        
        class ResponseInputText:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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.
        
        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.
        
        COMMENTARY("commentary")
        
        FINAL_ANSWER("final_answer")
        
        Optional<Type> type
        
        The type of the message input. Always message.
        
        MESSAGE("message")
      - Message
        
        List<ResponseInputContent> content
        
        A list of one or many input items to the model, containing different content types.
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
        
        Role role
        
        The role of the message input. One of user, system, or developer.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        Optional<Type> type
        
        The type of the message input. Always set to message.
        
        MESSAGE("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.
        
        class ResponseOutputText:
        
        A text output from the model.
        
        List<Annotation> annotations
        
        The annotations of the text output.
        
        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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
        
        String text
        
        The text output from the model.
        
        JsonValue; type "output_text"constant
        
        The type of the output text. Always output_text.
        
        OUTPUT_TEXT("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
        
        The type of the refusal. Always refusal.
        
        REFUSAL("refusal")
        
        JsonValue; role "assistant"constant
        
        The role of the output message. Always assistant.
        
        ASSISTANT("assistant")
        
        Status status
        
        The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        JsonValue; type "message"constant
        
        The type of the output message. Always message.
        
        MESSAGE("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.
        
        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,
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        FAILED("failed")
        
        JsonValue; type "file_search_call"constant
        
        The type of the file search tool call. Always file_search_call.
        
        FILE_SEARCH_CALL("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.
        
        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.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        Type type
        
        The type of the computer call. Always computer_call.
        
        COMPUTER_CALL("computer_call")
        
        Optional<Action> action
        
        A click action.
        
        class Click:
        
        A click action.
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        class Move:
        
        A mouse move action.
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        class Scroll:
        
        A scroll action.
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
        
        Optional<List<ComputerAction>> actions
        
        Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.
        
        Click
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        Move
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        Scroll
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
      - ComputerCallOutput
        
        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.
        
        JsonValue; type "computer_screenshot"constant
        
        Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
        
        COMPUTER_SCREENSHOT("computer_screenshot")
        
        Optional<String> fileId
        
        The identifier of an uploaded file that contains the screenshot.
        
        Optional<String> imageUrl
        
        The URL of the screenshot image.
        
        JsonValue; type "computer_call_output"constant
        
        The type of the computer tool call output. Always computer_call_output.
        
        COMPUTER_CALL_OUTPUT("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.
        
        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).
        
        class Search:
        
        Action type "search" - Performs a web search query.
        
        String query
        
        [DEPRECATED] The search query.
        
        JsonValue; type "search"constant
        
        The action type.
        
        SEARCH("search")
        
        Optional<List<String>> queries
        
        The search queries.
        
        Optional<List<Source>> sources
        
        The sources used in the search.
        
        JsonValue; type "url"constant
        
        The type of source. Always url.
        
        URL("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
        
        The action type.
        
        OPEN_PAGE("open_page")
        
        Optional<String> url
        
        The URL opened by the model.
        
        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
        
        The action type.
        
        FIND_IN_PAGE("find_in_page")
        
        String url
        
        The URL of the page searched for the pattern.
        
        Status status
        
        The status of the web search tool call.
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        FAILED("failed")
        
        JsonValue; type "web_search_call"constant
        
        The type of the web search tool call. Always web_search_call.
        
        WEB_SEARCH_CALL("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
        
        The type of the function tool call. Always function_call.
        
        FUNCTION_CALL("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - FunctionCallOutput
        
        String callId
        
        The unique ID of the function tool call generated by the model.
        
        Output output
        
        Text, image, or file output of the function tool call.
        
        String
        
        List<ResponseFunctionCallOutputItem>
        
        class ResponseInputTextContent:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("input_text")
        
        class ResponseInputImageContent:
        
        An image input to the model. Learn about image inputs
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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.
        
        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.
        
        class ResponseInputFileContent:
        
        A file input to the model.
        
        JsonValue; type "input_file"constant
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        LOW("low")
        
        HIGH("high")
        
        Optional<String> fileData
        
        The base64-encoded data 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 "function_call_output"constant
        
        The type of the function tool call output. Always function_call_output.
        
        FUNCTION_CALL_OUTPUT("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.
        
        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
        
        The item type. Always tool_search_call.
        
        TOOL_SEARCH_CALL("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.
        
        Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
        
        Optional<Status> status
        
        The status of the tool search call.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - class ResponseToolSearchOutputItemParam:
        
        List<Tool> tools
        
        The loaded tool definitions returned by the tool search output.
        
        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
        
        The type of the function tool. Always function.
        
        FUNCTION("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
        
        The type of the file search tool. Always file_search.
        
        FILE_SEARCH("file_search")
        
        List<String> vectorStoreIds
        
        The IDs of the vector stores to search.
        
        Optional<Filters> filters
        
        A filter to apply.
        
        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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
        
        Type type
        
        Type of operation: and or or.
        
        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.
        
        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
        
        The type of the computer tool. Always computer.
        
        COMPUTER("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.
        
        WINDOWS("windows")
        
        MAC("mac")
        
        LINUX("linux")
        
        UBUNTU("ubuntu")
        
        BROWSER("browser")
        
        JsonValue; type "computer_use_preview"constant
        
        The type of the computer use tool. Always computer_use_preview.
        
        COMPUTER_USE_PREVIEW("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.
        
        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.
        
        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.
        
        APPROXIMATE("approximate")
        
        Mcp
        
        String serverLabel
        
        A label for this MCP server, used to identify it in tool calls.
        
        JsonValue; type "mcp"constant
        
        The type of the MCP tool. Always mcp.
        
        MCP("mcp")
        
        Optional<AllowedTools> allowedTools
        
        List of allowed tool names or a filter object.
        
        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
        
        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.
        
        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.
        
        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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
        
        JsonValue; type "code_interpreter"constant
        
        The type of the code interpreter tool. Always code_interpreter.
        
        CODE_INTERPRETER("code_interpreter")
        
        ImageGeneration
        
        JsonValue; type "image_generation"constant
        
        The type of the image generation tool. Always image_generation.
        
        IMAGE_GENERATION("image_generation")
        
        Optional<Action> action
        
        Whether to generate a new image or edit an existing image. Default: auto.
        
        GENERATE("generate")
        
        EDIT("edit")
        
        AUTO("auto")
        
        Optional<Background> background
        
        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.
        
        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.
        
        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.
        
        GPT_IMAGE_1("gpt-image-1")
        
        GPT_IMAGE_1_MINI("gpt-image-1-mini")
        
        GPT_IMAGE_2("gpt-image-2")
        
        GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
        
        GPT_IMAGE_1_5("gpt-image-1.5")
        
        CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
        
        Optional<Moderation> moderation
        
        Moderation level for the generated image. Default: auto.
        
        AUTO("auto")
        
        LOW("low")
        
        Optional<Long> outputCompression
        
        Compression level for the output image. Default: 100.
        
        Optional<OutputFormat> outputFormat
        
        The output format of the generated image. One of png, webp, or jpeg. Default: png.
        
        PNG("png")
        
        WEBP("webp")
        
        JPEG("jpeg")
        
        Optional<Long> partialImages
        
        Number of partial images to generate in streaming mode, from 0 (default value) to 3.
        
        Optional<Quality> quality
        
        The quality of the generated image. One of low, medium, high, or auto. Default: auto.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        AUTO("auto")
        
        Optional<Size> size
        
        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.
        
        _1024X1024("1024x1024")
        
        _1024X1536("1024x1536")
        
        _1536X1024("1536x1024")
        
        AUTO("auto")
        
        JsonValue;
        
        JsonValue; type "local_shell"constant
        
        The type of the local shell tool. Always local_shell.
        
        LOCAL_SHELL("local_shell")
        
        class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        JsonValue; type "shell"constant
        
        The type of the shell tool. Always shell.
        
        SHELL("shell")
        
        Optional<Environment> environment
        
        class ContainerAuto:
        
        JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
        
        Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
        
        class LocalEnvironment:
        
        JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
        
        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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
        
        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
        
        The type of the custom tool. Always custom.
        
        CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
        
        Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
        
        class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        String description
        
        A description of the namespace shown to the model.
        
        String name
        
        The namespace name used in tool calls (for example, crm).
        
        List<Tool> tools
        
        The function/custom tools available inside this namespace.
        
        class Function:
        
        String name
        
        JsonValue; type "function"constant
        
        FUNCTION("function")
        
        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
        
        JsonValue; type "namespace"constant
        
        The type of the tool. Always namespace.
        
        NAMESPACE("namespace")
        
        class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        JsonValue; type "tool_search"constant
        
        The type of the tool. Always tool_search.
        
        TOOL_SEARCH("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.
        
        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.
        
        WEB_SEARCH_PREVIEW("web_search_preview")
        
        WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
        
        Optional<List<SearchContentType>> searchContentTypes
        
        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.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        Optional<UserLocation> userLocation
        
        The user's location.
        
        JsonValue; type "approximate"constant
        
        The type of location approximation. Always approximate.
        
        APPROXIMATE("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
        
        The type of the tool. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
        
        JsonValue; type "tool_search_output"constant
        
        The item type. Always tool_search_output.
        
        TOOL_SEARCH_OUTPUT("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.
        
        Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
        
        Optional<Status> status
        
        The status of the tool search output.
        
        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
        
        The type of the object. Always summary_text.
        
        SUMMARY_TEXT("summary_text")
        
        JsonValue; type "reasoning"constant
        
        The type of the object. Always reasoning.
        
        REASONING("reasoning")
        
        Optional<List<Content>> content
        
        Reasoning text content.
        
        String text
        
        The reasoning text from the model.
        
        JsonValue; type "reasoning_text"constant
        
        The type of the reasoning text. Always reasoning_text.
        
        REASONING_TEXT("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.
        
        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.
        
        JsonValue; type "compaction"constant
        
        The type of the item. Always compaction.
        
        COMPACTION("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        GENERATING("generating")
        
        FAILED("failed")
        
        JsonValue; type "image_generation_call"constant
        
        The type of the image generation call. Always image_generation_call.
        
        IMAGE_GENERATION_CALL("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.
        
        class Logs:
        
        The logs output from the code interpreter.
        
        String logs
        
        The logs output from the code interpreter.
        
        JsonValue; type "logs"constant
        
        The type of the output. Always logs.
        
        LOGS("logs")
        
        class Image:
        
        The image output from the code interpreter.
        
        JsonValue; type "image"constant
        
        The type of the output. Always image.
        
        IMAGE("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        INTERPRETING("interpreting")
        
        FAILED("failed")
        
        JsonValue; type "code_interpreter_call"constant
        
        The type of the code interpreter tool call. Always code_interpreter_call.
        
        CODE_INTERPRETER_CALL("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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        JsonValue; type "local_shell_call"constant
        
        The type of the local shell call. Always local_shell_call.
        
        LOCAL_SHELL_CALL("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
        
        The type of the local shell tool call output. Always local_shell_call_output.
        
        LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
        
        Optional<Status> status
        
        The status of the item. One of in_progress, completed, or incomplete.
        
        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.
        
        JsonValue; type "shell_call"constant
        
        The type of the item. Always shell_call.
        
        SHELL_CALL("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.
        
        class LocalEnvironment:
        
        class ContainerReference:
        
        Optional<Status> status
        
        The status of the shell call. One of in_progress, completed, or incomplete.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - ShellCallOutput
        
        String callId
        
        The unique ID of the shell tool call generated by the model.
        
        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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("exit")
        
        String stderr
        
        Captured stderr output for the shell call.
        
        String stdout
        
        Captured stdout output for the shell call.
        
        JsonValue; type "shell_call_output"constant
        
        The type of the item. Always shell_call_output.
        
        SHELL_CALL_OUTPUT("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - ApplyPatchCall
        
        String callId
        
        The unique ID of the apply patch tool call generated by the model.
        
        Operation operation
        
        The specific create, delete, or update instruction for the apply_patch tool call.
        
        class CreateFile:
        
        Instruction for creating a new file via the apply_patch tool.
        
        String diff
        
        Unified diff content to apply when creating the file.
        
        String path
        
        Path of the file to create relative to the workspace root.
        
        JsonValue; type "create_file"constant
        
        The operation type. Always create_file.
        
        CREATE_FILE("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.
        
        JsonValue; type "delete_file"constant
        
        The operation type. Always delete_file.
        
        DELETE_FILE("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.
        
        String path
        
        Path of the file to update relative to the workspace root.
        
        JsonValue; type "update_file"constant
        
        The operation type. Always update_file.
        
        UPDATE_FILE("update_file")
        
        Status status
        
        The status of the apply patch tool call. One of in_progress or completed.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        JsonValue; type "apply_patch_call"constant
        
        The type of the item. Always apply_patch_call.
        
        APPLY_PATCH_CALL("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.
        
        Status status
        
        The status of the apply patch tool call output. One of completed or failed.
        
        COMPLETED("completed")
        
        FAILED("failed")
        
        JsonValue; type "apply_patch_call_output"constant
        
        The type of the item. Always apply_patch_call_output.
        
        APPLY_PATCH_CALL_OUTPUT("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).
      - 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
        
        The type of the item. Always mcp_list_tools.
        
        MCP_LIST_TOOLS("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
        
        The type of the item. Always mcp_approval_request.
        
        MCP_APPROVAL_REQUEST("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
        
        The type of the item. Always mcp_approval_response.
        
        MCP_APPROVAL_RESPONSE("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
        
        The type of the item. Always mcp_call.
        
        MCP_CALL("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.
        
        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.
        
        String
        
        List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
        
        JsonValue; type "custom_tool_call_output"constant
        
        The type of the custom tool call output. Always custom_tool_call_output.
        
        CUSTOM_TOOL_CALL_OUTPUT("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
        
        The type of the custom tool call. Always custom_tool_call.
        
        CUSTOM_TOOL_CALL("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.
      - JsonValue;
        
        JsonValue; type "compaction_trigger"constant
        
        The type of the item. Always compaction_trigger.
        
        COMPACTION_TRIGGER("compaction_trigger")
      - ItemReference
        
        String id
        
        The ID of the item to reference.
        
        Optional<Type> type
        
        The type of item to reference. Always item_reference.
        
        ITEM_REFERENCE("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.
    - String
    - enum ChatModel:
      - GPT_5_4("gpt-5.4")
      - GPT_5_4_MINI("gpt-5.4-mini")
      - GPT_5_4_NANO("gpt-5.4-nano")
      - GPT_5_4_MINI_2026_03_17("gpt-5.4-mini-2026-03-17")
      - GPT_5_4_NANO_2026_03_17("gpt-5.4-nano-2026-03-17")
      - GPT_5_3_CHAT_LATEST("gpt-5.3-chat-latest")
      - GPT_5_2("gpt-5.2")
      - GPT_5_2_2025_12_11("gpt-5.2-2025-12-11")
      - GPT_5_2_CHAT_LATEST("gpt-5.2-chat-latest")
      - GPT_5_2_PRO("gpt-5.2-pro")
      - GPT_5_2_PRO_2025_12_11("gpt-5.2-pro-2025-12-11")
      - GPT_5_1("gpt-5.1")
      - GPT_5_1_2025_11_13("gpt-5.1-2025-11-13")
      - GPT_5_1_CODEX("gpt-5.1-codex")
      - GPT_5_1_MINI("gpt-5.1-mini")
      - GPT_5_1_CHAT_LATEST("gpt-5.1-chat-latest")
      - GPT_5("gpt-5")
      - GPT_5_MINI("gpt-5-mini")
      - GPT_5_NANO("gpt-5-nano")
      - GPT_5_2025_08_07("gpt-5-2025-08-07")
      - GPT_5_MINI_2025_08_07("gpt-5-mini-2025-08-07")
      - GPT_5_NANO_2025_08_07("gpt-5-nano-2025-08-07")
      - GPT_5_CHAT_LATEST("gpt-5-chat-latest")
      - GPT_4_1("gpt-4.1")
      - GPT_4_1_MINI("gpt-4.1-mini")
      - GPT_4_1_NANO("gpt-4.1-nano")
      - GPT_4_1_2025_04_14("gpt-4.1-2025-04-14")
      - GPT_4_1_MINI_2025_04_14("gpt-4.1-mini-2025-04-14")
      - GPT_4_1_NANO_2025_04_14("gpt-4.1-nano-2025-04-14")
      - O4_MINI("o4-mini")
      - O4_MINI_2025_04_16("o4-mini-2025-04-16")
      - O3("o3")
      - O3_2025_04_16("o3-2025-04-16")
      - O3_MINI("o3-mini")
      - O3_MINI_2025_01_31("o3-mini-2025-01-31")
      - O1("o1")
      - O1_2024_12_17("o1-2024-12-17")
      - O1_PREVIEW("o1-preview")
      - O1_PREVIEW_2024_09_12("o1-preview-2024-09-12")
      - O1_MINI("o1-mini")
      - O1_MINI_2024_09_12("o1-mini-2024-09-12")
      - GPT_4O("gpt-4o")
      - GPT_4O_2024_11_20("gpt-4o-2024-11-20")
      - GPT_4O_2024_08_06("gpt-4o-2024-08-06")
      - GPT_4O_2024_05_13("gpt-4o-2024-05-13")
      - GPT_4O_AUDIO_PREVIEW("gpt-4o-audio-preview")
      - GPT_4O_AUDIO_PREVIEW_2024_10_01("gpt-4o-audio-preview-2024-10-01")
      - GPT_4O_AUDIO_PREVIEW_2024_12_17("gpt-4o-audio-preview-2024-12-17")
      - GPT_4O_AUDIO_PREVIEW_2025_06_03("gpt-4o-audio-preview-2025-06-03")
      - GPT_4O_MINI_AUDIO_PREVIEW("gpt-4o-mini-audio-preview")
      - GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17("gpt-4o-mini-audio-preview-2024-12-17")
      - GPT_4O_SEARCH_PREVIEW("gpt-4o-search-preview")
      - GPT_4O_MINI_SEARCH_PREVIEW("gpt-4o-mini-search-preview")
      - GPT_4O_SEARCH_PREVIEW_2025_03_11("gpt-4o-search-preview-2025-03-11")
      - GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11("gpt-4o-mini-search-preview-2025-03-11")
      - CHATGPT_4O_LATEST("chatgpt-4o-latest")
      - CODEX_MINI_LATEST("codex-mini-latest")
      - GPT_4O_MINI("gpt-4o-mini")
      - GPT_4O_MINI_2024_07_18("gpt-4o-mini-2024-07-18")
      - GPT_4_TURBO("gpt-4-turbo")
      - GPT_4_TURBO_2024_04_09("gpt-4-turbo-2024-04-09")
      - GPT_4_0125_PREVIEW("gpt-4-0125-preview")
      - GPT_4_TURBO_PREVIEW("gpt-4-turbo-preview")
      - GPT_4_1106_PREVIEW("gpt-4-1106-preview")
      - GPT_4_VISION_PREVIEW("gpt-4-vision-preview")
      - GPT_4("gpt-4")
      - GPT_4_0314("gpt-4-0314")
      - GPT_4_0613("gpt-4-0613")
      - GPT_4_32K("gpt-4-32k")
      - GPT_4_32K_0314("gpt-4-32k-0314")
      - GPT_4_32K_0613("gpt-4-32k-0613")
      - GPT_3_5_TURBO("gpt-3.5-turbo")
      - GPT_3_5_TURBO_16K("gpt-3.5-turbo-16k")
      - GPT_3_5_TURBO_0301("gpt-3.5-turbo-0301")
      - GPT_3_5_TURBO_0613("gpt-3.5-turbo-0613")
      - GPT_3_5_TURBO_1106("gpt-3.5-turbo-1106")
      - GPT_3_5_TURBO_0125("gpt-3.5-turbo-0125")
      - GPT_3_5_TURBO_16K_0613("gpt-3.5-turbo-16k-0613")
    - ResponsesOnlyModel
      - O1_PRO("o1-pro")
      - O1_PRO_2025_03_19("o1-pro-2025-03-19")
      - O3_PRO("o3-pro")
      - O3_PRO_2025_06_10("o3-pro-2025-06-10")
      - O3_DEEP_RESEARCH("o3-deep-research")
      - O3_DEEP_RESEARCH_2025_06_26("o3-deep-research-2025-06-26")
      - O4_MINI_DEEP_RESEARCH("o4-mini-deep-research")
      - O4_MINI_DEEP_RESEARCH_2025_06_26("o4-mini-deep-research-2025-06-26")
      - COMPUTER_USE_PREVIEW("computer-use-preview")
      - COMPUTER_USE_PREVIEW_2025_03_11("computer-use-preview-2025-03-11")
      - GPT_5_CODEX("gpt-5-codex")
      - GPT_5_PRO("gpt-5-pro")
      - GPT_5_PRO_2025_10_06("gpt-5-pro-2025-10-06")
      - GPT_5_1_CODEX_MAX("gpt-5.1-codex-max")
  - JsonValue; object_ "response"constant
    
    The object type of this resource - always set to response.
    - RESPONSE("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.
    - class ResponseOutputMessage:
      
      An output message from the model.
    - class ResponseFileSearchToolCall:
      
      The results of a file search tool call. See the file search guide for more information.
    - class ResponseFunctionToolCall:
      
      A tool call to run a function. See the function calling guide for more information.
    - 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.
        
        String
        
        List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
      - Status status
        
        The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "function_call_output"constant
        
        The type of the function tool call output. Always function_call_output.
        
        FUNCTION_CALL_OUTPUT("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.
    - class ResponseComputerToolCall:
      
      A tool call to a computer use tool. See the computer use guide for more information.
    - 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.
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        FAILED("failed")
        
        IN_PROGRESS("in_progress")
      - JsonValue; type "computer_call_output"constant
        
        The type of the computer tool call output. Always computer_call_output.
        
        COMPUTER_CALL_OUTPUT("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.
    - 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.
        
        SERVER("server")
        
        CLIENT("client")
      - Status status
        
        The status of the tool search call item that was recorded.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "tool_search_call"constant
        
        The type of the item. Always tool_search_call.
        
        TOOL_SEARCH_CALL("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.
        
        SERVER("server")
        
        CLIENT("client")
      - Status status
        
        The status of the tool search output item that was recorded.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - List<Tool> tools
        
        The loaded tool definitions returned by tool search.
        
        class FunctionTool:
        
        Defines a function in your own code the model can choose to call. Learn more about function calling.
        
        class FileSearchTool:
        
        A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
        
        class ComputerTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
        
        class ComputerUsePreviewTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
        
        class WebSearchTool:
        
        Search the Internet for sources related to the prompt. Learn more about the web search tool.
        
        Mcp
        
        CodeInterpreter
        
        ImageGeneration
        
        JsonValue;
        
        class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        class CustomTool:
        
        A custom tool that processes input using a specified format. Learn more about custom tools
        
        class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        class WebSearchPreviewTool:
        
        This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
        
        class ApplyPatchTool:
        
        Allows the assistant to create, delete, or update files using unified diffs.
      - JsonValue; type "tool_search_output"constant
        
        The type of the item. Always tool_search_output.
        
        TOOL_SEARCH_OUTPUT("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
        
        The type of the item. Always compaction.
        
        COMPACTION("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        GENERATING("generating")
        
        FAILED("failed")
      - JsonValue; type "image_generation_call"constant
        
        The type of the image generation call. Always image_generation_call.
        
        IMAGE_GENERATION_CALL("image_generation_call")
    - class ResponseCodeInterpreterToolCall:
      
      A tool call to run code.
    - 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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "local_shell_call"constant
        
        The type of the local shell call. Always local_shell_call.
        
        LOCAL_SHELL_CALL("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
        
        The type of the local shell tool call output. Always local_shell_call_output.
        
        LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
      - Optional<Status> status
        
        The status of the item. One of in_progress, completed, or incomplete.
        
        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.
        
        class ResponseLocalEnvironment:
        
        Represents the use of a local environment to perform shell actions.
        
        JsonValue; type "local"constant
        
        The environment type. Always local.
        
        LOCAL("local")
        
        class ResponseContainerReference:
        
        Represents a container created with /v1/containers.
        
        String containerId
        
        JsonValue; type "container_reference"constant
        
        The environment type. Always container_reference.
        
        CONTAINER_REFERENCE("container_reference")
      - Status status
        
        The status of the shell call. One of in_progress, completed, or incomplete.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "shell_call"constant
        
        The type of the item. Always shell_call.
        
        SHELL_CALL("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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "shell_call_output"constant
        
        The type of the shell call output. Always shell_call_output.
        
        SHELL_CALL_OUTPUT("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.
        
        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 a new file with the provided diff.
        
        CREATE_FILE("create_file")
        
        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 the specified file.
        
        DELETE_FILE("delete_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 an existing file with the provided diff.
        
        UPDATE_FILE("update_file")
      - Status status
        
        The status of the apply patch tool call. One of in_progress or completed.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
      - JsonValue; type "apply_patch_call"constant
        
        The type of the item. Always apply_patch_call.
        
        APPLY_PATCH_CALL("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.
        
        COMPLETED("completed")
        
        FAILED("failed")
      - JsonValue; type "apply_patch_call_output"constant
        
        The type of the item. Always apply_patch_call_output.
        
        APPLY_PATCH_CALL_OUTPUT("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
        
        The type of the item. Always mcp_call.
        
        MCP_CALL("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.
        
        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
        
        The type of the item. Always mcp_list_tools.
        
        MCP_LIST_TOOLS("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
        
        The type of the item. Always mcp_approval_request.
        
        MCP_APPROVAL_REQUEST("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
        
        The type of the item. Always mcp_approval_response.
        
        MCP_APPROVAL_RESPONSE("mcp_approval_response")
      - Optional<String> reason
        
        Optional reason for the decision.
    - class ResponseCustomToolCall:
      
      A call to a custom tool created by the model.
    - 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.
        
        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.
  - 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.
    - 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.
        
        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 tool configuration type. Always allowed_tools.
        
        ALLOWED_TOOLS("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
        
        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
        
        For function calling, the type is always function.
        
        FUNCTION("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
        
        For MCP tools, the type is always mcp.
        
        MCP("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
        
        For custom tool calling, the type is always custom.
        
        CUSTOM("custom")
    - class ToolChoiceApplyPatch:
      
      Forces the model to call the apply_patch tool when executing a tool call.
      - JsonValue; type "apply_patch"constant
        
        The tool to call. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
    - class ToolChoiceShell:
      
      Forces the model to call the shell tool when a tool call is required.
      - JsonValue; type "shell"constant
        
        The tool to call. Always shell.
        
        SHELL("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.
    - class FunctionTool:
      
      Defines a function in your own code the model can choose to call. Learn more about function calling.
    - class FileSearchTool:
      
      A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
    - class ComputerTool:
      
      A tool that controls a virtual computer. Learn more about the computer tool.
    - class ComputerUsePreviewTool:
      
      A tool that controls a virtual computer. Learn more about the computer tool.
    - class WebSearchTool:
      
      Search the Internet for sources related to the prompt. Learn more about the web search tool.
    - Mcp
    - CodeInterpreter
    - ImageGeneration
    - JsonValue;
    - class FunctionShellTool:
      
      A tool that allows the model to execute shell commands.
    - class CustomTool:
      
      A custom tool that processes input using a specified format. Learn more about custom tools
    - class NamespaceTool:
      
      Groups function/custom tools under a shared namespace.
    - class ToolSearchTool:
      
      Hosted or BYOT tool search configuration for deferred tools.
    - class WebSearchPreviewTool:
      
      This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
    - class ApplyPatchTool:
      
      Allows the assistant to create, delete, or update files using unified diffs.
  - 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.
  - 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.
    - 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.
      - String
      - class ResponseInputText:
        
        A text input to the model.
      - class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
      - class ResponseInputFile:
        
        A file input to the model.
    - Optional<String> version
      
      Optional version of the prompt template.
  - 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.
    - IN_MEMORY("in_memory")
    - _24H("24h")
  - Optional<Reasoning> reasoning
    
    gpt-5 and o-series models only
    
    Configuration options for reasoning models.
    - Optional<ReasoningEffort> effort
      
      Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
      - gpt-5.1 defaults to none, which does not perform reasoning. The supported reasoning values for gpt-5.1 are none, low, medium, and high. Tool calls are supported for all reasoning values in gpt-5.1.
      - All models before gpt-5.1 default to medium reasoning effort, and do not support none.
      - The gpt-5-pro model defaults to (and only supports) high reasoning effort.
      - xhigh is supported for all models after gpt-5.1-codex-max.
      - NONE("none")
      - MINIMAL("minimal")
      - LOW("low")
      - MEDIUM("medium")
      - HIGH("high")
      - XHIGH("xhigh")
    - Optional<GenerateSummary> generateSummary
      
      Deprecated: use summary instead.
      
      A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
      - AUTO("auto")
      - CONCISE("concise")
      - DETAILED("detailed")
    - Optional<Summary> summary
      
      A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
      
      concise is supported for computer-use-preview models and all reasoning models after gpt-5.
      - AUTO("auto")
      - CONCISE("concise")
      - DETAILED("detailed")
  - 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.
  - 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.
    - 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.
    - COMPLETED("completed")
    - FAILED("failed")
    - IN_PROGRESS("in_progress")
    - CANCELLED("cancelled")
    - QUEUED("queued")
    - INCOMPLETE("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<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.
      - class ResponseFormatText:
        
        Default response format. Used to generate text responses.
        
        JsonValue; type "text"constant
        
        The type of response format being defined. Always text.
        
        TEXT("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
        
        The type of response format being defined. Always json_schema.
        
        JSON_SCHEMA("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
        
        The type of response format being defined. Always json_object.
        
        JSON_OBJECT("json_object")
    - 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.
      - LOW("low")
      - MEDIUM("medium")
      - HIGH("high")
  - Optional<Long> topLogprobs
    
    An integer between 0 and 20 specifying the maximum number of most likely tokens to return at each token position, each with an associated log probability. In some cases, the number of returned tokens may be fewer than requested.
  - 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.
    - 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.
    - 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.
  - Optional<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.
- long sequenceNumber
  
  The sequence number of this event.
- JsonValue; type "response.failed"constant
  
  The type of the event. Always response.failed.
  - RESPONSE_FAILED("response.failed")

Response File Search Call Completed Event

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
  
  The type of the event. Always response.file_search_call.completed.
  - RESPONSE_FILE_SEARCH_CALL_COMPLETED("response.file_search_call.completed")

Response File Search Call In Progress Event

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
  
  The type of the event. Always response.file_search_call.in_progress.
  - RESPONSE_FILE_SEARCH_CALL_IN_PROGRESS("response.file_search_call.in_progress")

Response File Search Call Searching Event

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
  
  The type of the event. Always response.file_search_call.searching.
  - RESPONSE_FILE_SEARCH_CALL_SEARCHING("response.file_search_call.searching")

Response File Search Tool Call

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,
  - IN_PROGRESS("in_progress")
  - SEARCHING("searching")
  - COMPLETED("completed")
  - INCOMPLETE("incomplete")
  - FAILED("failed")
- JsonValue; type "file_search_call"constant
  
  The type of the file search tool call. Always file_search_call.
  - FILE_SEARCH_CALL("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.
    - 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.
  - Optional<String> text
    
    The text that was retrieved from the file.

Response Format Text Config

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
    
    The type of response format being defined. Always text.
    - TEXT("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
    
    The type of response format being defined. Always json_schema.
    - JSON_SCHEMA("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
    
    The type of response format being defined. Always json_object.
    - JSON_OBJECT("json_object")

Response Format Text JSON Schema Config

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
  
  The type of response format being defined. Always json_schema.
  - JSON_SCHEMA("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.

Response Function Call Arguments Delta Event

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
  
  The type of the event. Always response.function_call_arguments.delta.
  - RESPONSE_FUNCTION_CALL_ARGUMENTS_DELTA("response.function_call_arguments.delta")

Response Function Call Arguments Done Event

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("response.function_call_arguments.done")

Response Function Call Output Item

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.
  - JsonValue; type "input_text"constant
    
    The type of the input item. Always input_text.
    - INPUT_TEXT("input_text")
- class ResponseInputImageContent:
  
  An image input to the model. Learn about image inputs
  - JsonValue; type "input_image"constant
    
    The type of the input item. Always input_image.
    - INPUT_IMAGE("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.
    - 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.
- class ResponseInputFileContent:
  
  A file input to the model.
  - JsonValue; type "input_file"constant
    
    The type of the input item. Always input_file.
    - INPUT_FILE("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.
    - LOW("low")
    - HIGH("high")
  - Optional<String> fileData
    
    The base64-encoded data 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.

Response Function Shell Call Output Content

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.
  - JsonValue;
    - JsonValue; type "timeout"constant
      
      The outcome type. Always timeout.
      - TIMEOUT("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
      
      The outcome type. Always exit.
      - EXIT("exit")
- String stderr
  
  Captured stderr output for the shell call.
- String stdout
  
  Captured stdout output for the shell call.

Response Function Shell Tool Call

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.
  - class ResponseLocalEnvironment:
    
    Represents the use of a local environment to perform shell actions.
    - JsonValue; type "local"constant
      
      The environment type. Always local.
      - LOCAL("local")
  - class ResponseContainerReference:
    
    Represents a container created with /v1/containers.
    - String containerId
    - JsonValue; type "container_reference"constant
      
      The environment type. Always container_reference.
      - CONTAINER_REFERENCE("container_reference")
- Status status
  
  The status of the shell call. One of in_progress, completed, or incomplete.
  - IN_PROGRESS("in_progress")
  - COMPLETED("completed")
  - INCOMPLETE("incomplete")
- JsonValue; type "shell_call"constant
  
  The type of the item. Always shell_call.
  - SHELL_CALL("shell_call")
- Optional<String> createdBy
  
  The ID of the entity that created this tool call.

Response Function Shell Tool Call Output

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.
    - JsonValue;
      - JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("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.
  - IN_PROGRESS("in_progress")
  - COMPLETED("completed")
  - INCOMPLETE("incomplete")
- JsonValue; type "shell_call_output"constant
  
  The type of the shell call output. Always shell_call_output.
  - SHELL_CALL_OUTPUT("shell_call_output")
- Optional<String> createdBy
  
  The identifier of the actor that created the item.

Response Function Tool 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
  
  The type of the function tool call. Always function_call.
  - FUNCTION_CALL("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.
  - IN_PROGRESS("in_progress")
  - COMPLETED("completed")
  - INCOMPLETE("incomplete")

Response Function Tool Call Item

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.
  - IN_PROGRESS("in_progress")
  - COMPLETED("completed")
  - INCOMPLETE("incomplete")
- Optional<String> createdBy
  
  The identifier of the actor that created the item.

Response Function Tool Call Output 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.
  - String
  - List<FunctionAndCustomToolCallOutput>
    - class ResponseInputText:
      
      A text input to the model.
      - String text
        
        The text input to the model.
      - JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
      - JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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.
  - IN_PROGRESS("in_progress")
  - COMPLETED("completed")
  - INCOMPLETE("incomplete")
- JsonValue; type "function_call_output"constant
  
  The type of the function tool call output. Always function_call_output.
  - FUNCTION_CALL_OUTPUT("function_call_output")
- Optional<String> createdBy
  
  The identifier of the actor that created the item.

Response Function Web Search

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).
  - class Search:
    
    Action type "search" - Performs a web search query.
    - String query
      
      [DEPRECATED] The search query.
    - JsonValue; type "search"constant
      
      The action type.
      - SEARCH("search")
    - Optional<List<String>> queries
      
      The search queries.
    - Optional<List<Source>> sources
      
      The sources used in the search.
      - JsonValue; type "url"constant
        
        The type of source. Always url.
        
        URL("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
      
      The action type.
      - OPEN_PAGE("open_page")
    - Optional<String> url
      
      The URL opened by the model.
  - 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
      
      The action type.
      - FIND_IN_PAGE("find_in_page")
    - String url
      
      The URL of the page searched for the pattern.
- Status status
  
  The status of the web search tool call.
  - IN_PROGRESS("in_progress")
  - SEARCHING("searching")
  - COMPLETED("completed")
  - FAILED("failed")
- JsonValue; type "web_search_call"constant
  
  The type of the web search tool call. Always web_search_call.
  - WEB_SEARCH_CALL("web_search_call")

Response Image Gen Call Completed Event

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
  
  The type of the event. Always 'response.image_generation_call.completed'.
  - RESPONSE_IMAGE_GENERATION_CALL_COMPLETED("response.image_generation_call.completed")

Response Image Gen Call Generating Event

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
  
  The type of the event. Always 'response.image_generation_call.generating'.
  - RESPONSE_IMAGE_GENERATION_CALL_GENERATING("response.image_generation_call.generating")

Response Image Gen Call In Progress Event

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
  
  The type of the event. Always 'response.image_generation_call.in_progress'.
  - RESPONSE_IMAGE_GENERATION_CALL_IN_PROGRESS("response.image_generation_call.in_progress")

Response Image Gen Call Partial Image Event

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
  
  The type of the event. Always 'response.image_generation_call.partial_image'.
  - RESPONSE_IMAGE_GENERATION_CALL_PARTIAL_IMAGE("response.image_generation_call.partial_image")

Response In Progress Event

class ResponseInProgressEvent:

Emitted when the response is in progress.
- Response response
  
  The response that is in progress.
  - 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.
    - Code code
      
      The error code for the response.
      - 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.
  - Optional<IncompleteDetails> incompleteDetails
    
    Details about why the response is incomplete.
    - Optional<Reason> reason
      
      The reason why the response is incomplete.
      - 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.
    - String
    - List<ResponseInputItem>
      - 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.
        
        String
        
        List<ResponseInputContent>
        
        class ResponseInputText:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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.
        
        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.
        
        COMMENTARY("commentary")
        
        FINAL_ANSWER("final_answer")
        
        Optional<Type> type
        
        The type of the message input. Always message.
        
        MESSAGE("message")
      - Message
        
        List<ResponseInputContent> content
        
        A list of one or many input items to the model, containing different content types.
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
        
        Role role
        
        The role of the message input. One of user, system, or developer.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        Optional<Type> type
        
        The type of the message input. Always set to message.
        
        MESSAGE("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.
        
        class ResponseOutputText:
        
        A text output from the model.
        
        List<Annotation> annotations
        
        The annotations of the text output.
        
        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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
        
        String text
        
        The text output from the model.
        
        JsonValue; type "output_text"constant
        
        The type of the output text. Always output_text.
        
        OUTPUT_TEXT("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
        
        The type of the refusal. Always refusal.
        
        REFUSAL("refusal")
        
        JsonValue; role "assistant"constant
        
        The role of the output message. Always assistant.
        
        ASSISTANT("assistant")
        
        Status status
        
        The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        JsonValue; type "message"constant
        
        The type of the output message. Always message.
        
        MESSAGE("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.
        
        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,
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        FAILED("failed")
        
        JsonValue; type "file_search_call"constant
        
        The type of the file search tool call. Always file_search_call.
        
        FILE_SEARCH_CALL("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.
        
        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.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        Type type
        
        The type of the computer call. Always computer_call.
        
        COMPUTER_CALL("computer_call")
        
        Optional<Action> action
        
        A click action.
        
        class Click:
        
        A click action.
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        class Move:
        
        A mouse move action.
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        class Scroll:
        
        A scroll action.
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
        
        Optional<List<ComputerAction>> actions
        
        Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.
        
        Click
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        Move
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        Scroll
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
      - ComputerCallOutput
        
        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.
        
        JsonValue; type "computer_screenshot"constant
        
        Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
        
        COMPUTER_SCREENSHOT("computer_screenshot")
        
        Optional<String> fileId
        
        The identifier of an uploaded file that contains the screenshot.
        
        Optional<String> imageUrl
        
        The URL of the screenshot image.
        
        JsonValue; type "computer_call_output"constant
        
        The type of the computer tool call output. Always computer_call_output.
        
        COMPUTER_CALL_OUTPUT("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.
        
        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).
        
        class Search:
        
        Action type "search" - Performs a web search query.
        
        String query
        
        [DEPRECATED] The search query.
        
        JsonValue; type "search"constant
        
        The action type.
        
        SEARCH("search")
        
        Optional<List<String>> queries
        
        The search queries.
        
        Optional<List<Source>> sources
        
        The sources used in the search.
        
        JsonValue; type "url"constant
        
        The type of source. Always url.
        
        URL("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
        
        The action type.
        
        OPEN_PAGE("open_page")
        
        Optional<String> url
        
        The URL opened by the model.
        
        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
        
        The action type.
        
        FIND_IN_PAGE("find_in_page")
        
        String url
        
        The URL of the page searched for the pattern.
        
        Status status
        
        The status of the web search tool call.
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        FAILED("failed")
        
        JsonValue; type "web_search_call"constant
        
        The type of the web search tool call. Always web_search_call.
        
        WEB_SEARCH_CALL("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
        
        The type of the function tool call. Always function_call.
        
        FUNCTION_CALL("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - FunctionCallOutput
        
        String callId
        
        The unique ID of the function tool call generated by the model.
        
        Output output
        
        Text, image, or file output of the function tool call.
        
        String
        
        List<ResponseFunctionCallOutputItem>
        
        class ResponseInputTextContent:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("input_text")
        
        class ResponseInputImageContent:
        
        An image input to the model. Learn about image inputs
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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.
        
        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.
        
        class ResponseInputFileContent:
        
        A file input to the model.
        
        JsonValue; type "input_file"constant
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        LOW("low")
        
        HIGH("high")
        
        Optional<String> fileData
        
        The base64-encoded data 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 "function_call_output"constant
        
        The type of the function tool call output. Always function_call_output.
        
        FUNCTION_CALL_OUTPUT("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.
        
        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
        
        The item type. Always tool_search_call.
        
        TOOL_SEARCH_CALL("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.
        
        Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
        
        Optional<Status> status
        
        The status of the tool search call.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - class ResponseToolSearchOutputItemParam:
        
        List<Tool> tools
        
        The loaded tool definitions returned by the tool search output.
        
        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
        
        The type of the function tool. Always function.
        
        FUNCTION("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
        
        The type of the file search tool. Always file_search.
        
        FILE_SEARCH("file_search")
        
        List<String> vectorStoreIds
        
        The IDs of the vector stores to search.
        
        Optional<Filters> filters
        
        A filter to apply.
        
        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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
        
        Type type
        
        Type of operation: and or or.
        
        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.
        
        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
        
        The type of the computer tool. Always computer.
        
        COMPUTER("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.
        
        WINDOWS("windows")
        
        MAC("mac")
        
        LINUX("linux")
        
        UBUNTU("ubuntu")
        
        BROWSER("browser")
        
        JsonValue; type "computer_use_preview"constant
        
        The type of the computer use tool. Always computer_use_preview.
        
        COMPUTER_USE_PREVIEW("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.
        
        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.
        
        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.
        
        APPROXIMATE("approximate")
        
        Mcp
        
        String serverLabel
        
        A label for this MCP server, used to identify it in tool calls.
        
        JsonValue; type "mcp"constant
        
        The type of the MCP tool. Always mcp.
        
        MCP("mcp")
        
        Optional<AllowedTools> allowedTools
        
        List of allowed tool names or a filter object.
        
        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
        
        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.
        
        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.
        
        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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
        
        JsonValue; type "code_interpreter"constant
        
        The type of the code interpreter tool. Always code_interpreter.
        
        CODE_INTERPRETER("code_interpreter")
        
        ImageGeneration
        
        JsonValue; type "image_generation"constant
        
        The type of the image generation tool. Always image_generation.
        
        IMAGE_GENERATION("image_generation")
        
        Optional<Action> action
        
        Whether to generate a new image or edit an existing image. Default: auto.
        
        GENERATE("generate")
        
        EDIT("edit")
        
        AUTO("auto")
        
        Optional<Background> background
        
        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.
        
        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.
        
        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.
        
        GPT_IMAGE_1("gpt-image-1")
        
        GPT_IMAGE_1_MINI("gpt-image-1-mini")
        
        GPT_IMAGE_2("gpt-image-2")
        
        GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
        
        GPT_IMAGE_1_5("gpt-image-1.5")
        
        CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
        
        Optional<Moderation> moderation
        
        Moderation level for the generated image. Default: auto.
        
        AUTO("auto")
        
        LOW("low")
        
        Optional<Long> outputCompression
        
        Compression level for the output image. Default: 100.
        
        Optional<OutputFormat> outputFormat
        
        The output format of the generated image. One of png, webp, or jpeg. Default: png.
        
        PNG("png")
        
        WEBP("webp")
        
        JPEG("jpeg")
        
        Optional<Long> partialImages
        
        Number of partial images to generate in streaming mode, from 0 (default value) to 3.
        
        Optional<Quality> quality
        
        The quality of the generated image. One of low, medium, high, or auto. Default: auto.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        AUTO("auto")
        
        Optional<Size> size
        
        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.
        
        _1024X1024("1024x1024")
        
        _1024X1536("1024x1536")
        
        _1536X1024("1536x1024")
        
        AUTO("auto")
        
        JsonValue;
        
        JsonValue; type "local_shell"constant
        
        The type of the local shell tool. Always local_shell.
        
        LOCAL_SHELL("local_shell")
        
        class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        JsonValue; type "shell"constant
        
        The type of the shell tool. Always shell.
        
        SHELL("shell")
        
        Optional<Environment> environment
        
        class ContainerAuto:
        
        JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
        
        Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
        
        class LocalEnvironment:
        
        JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
        
        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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
        
        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
        
        The type of the custom tool. Always custom.
        
        CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
        
        Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
        
        class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        String description
        
        A description of the namespace shown to the model.
        
        String name
        
        The namespace name used in tool calls (for example, crm).
        
        List<Tool> tools
        
        The function/custom tools available inside this namespace.
        
        class Function:
        
        String name
        
        JsonValue; type "function"constant
        
        FUNCTION("function")
        
        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
        
        JsonValue; type "namespace"constant
        
        The type of the tool. Always namespace.
        
        NAMESPACE("namespace")
        
        class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        JsonValue; type "tool_search"constant
        
        The type of the tool. Always tool_search.
        
        TOOL_SEARCH("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.
        
        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.
        
        WEB_SEARCH_PREVIEW("web_search_preview")
        
        WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
        
        Optional<List<SearchContentType>> searchContentTypes
        
        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.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        Optional<UserLocation> userLocation
        
        The user's location.
        
        JsonValue; type "approximate"constant
        
        The type of location approximation. Always approximate.
        
        APPROXIMATE("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
        
        The type of the tool. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
        
        JsonValue; type "tool_search_output"constant
        
        The item type. Always tool_search_output.
        
        TOOL_SEARCH_OUTPUT("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.
        
        Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
        
        Optional<Status> status
        
        The status of the tool search output.
        
        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
        
        The type of the object. Always summary_text.
        
        SUMMARY_TEXT("summary_text")
        
        JsonValue; type "reasoning"constant
        
        The type of the object. Always reasoning.
        
        REASONING("reasoning")
        
        Optional<List<Content>> content
        
        Reasoning text content.
        
        String text
        
        The reasoning text from the model.
        
        JsonValue; type "reasoning_text"constant
        
        The type of the reasoning text. Always reasoning_text.
        
        REASONING_TEXT("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.
        
        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.
        
        JsonValue; type "compaction"constant
        
        The type of the item. Always compaction.
        
        COMPACTION("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        GENERATING("generating")
        
        FAILED("failed")
        
        JsonValue; type "image_generation_call"constant
        
        The type of the image generation call. Always image_generation_call.
        
        IMAGE_GENERATION_CALL("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.
        
        class Logs:
        
        The logs output from the code interpreter.
        
        String logs
        
        The logs output from the code interpreter.
        
        JsonValue; type "logs"constant
        
        The type of the output. Always logs.
        
        LOGS("logs")
        
        class Image:
        
        The image output from the code interpreter.
        
        JsonValue; type "image"constant
        
        The type of the output. Always image.
        
        IMAGE("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        INTERPRETING("interpreting")
        
        FAILED("failed")
        
        JsonValue; type "code_interpreter_call"constant
        
        The type of the code interpreter tool call. Always code_interpreter_call.
        
        CODE_INTERPRETER_CALL("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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        JsonValue; type "local_shell_call"constant
        
        The type of the local shell call. Always local_shell_call.
        
        LOCAL_SHELL_CALL("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
        
        The type of the local shell tool call output. Always local_shell_call_output.
        
        LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
        
        Optional<Status> status
        
        The status of the item. One of in_progress, completed, or incomplete.
        
        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.
        
        JsonValue; type "shell_call"constant
        
        The type of the item. Always shell_call.
        
        SHELL_CALL("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.
        
        class LocalEnvironment:
        
        class ContainerReference:
        
        Optional<Status> status
        
        The status of the shell call. One of in_progress, completed, or incomplete.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - ShellCallOutput
        
        String callId
        
        The unique ID of the shell tool call generated by the model.
        
        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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("exit")
        
        String stderr
        
        Captured stderr output for the shell call.
        
        String stdout
        
        Captured stdout output for the shell call.
        
        JsonValue; type "shell_call_output"constant
        
        The type of the item. Always shell_call_output.
        
        SHELL_CALL_OUTPUT("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - ApplyPatchCall
        
        String callId
        
        The unique ID of the apply patch tool call generated by the model.
        
        Operation operation
        
        The specific create, delete, or update instruction for the apply_patch tool call.
        
        class CreateFile:
        
        Instruction for creating a new file via the apply_patch tool.
        
        String diff
        
        Unified diff content to apply when creating the file.
        
        String path
        
        Path of the file to create relative to the workspace root.
        
        JsonValue; type "create_file"constant
        
        The operation type. Always create_file.
        
        CREATE_FILE("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.
        
        JsonValue; type "delete_file"constant
        
        The operation type. Always delete_file.
        
        DELETE_FILE("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.
        
        String path
        
        Path of the file to update relative to the workspace root.
        
        JsonValue; type "update_file"constant
        
        The operation type. Always update_file.
        
        UPDATE_FILE("update_file")
        
        Status status
        
        The status of the apply patch tool call. One of in_progress or completed.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        JsonValue; type "apply_patch_call"constant
        
        The type of the item. Always apply_patch_call.
        
        APPLY_PATCH_CALL("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.
        
        Status status
        
        The status of the apply patch tool call output. One of completed or failed.
        
        COMPLETED("completed")
        
        FAILED("failed")
        
        JsonValue; type "apply_patch_call_output"constant
        
        The type of the item. Always apply_patch_call_output.
        
        APPLY_PATCH_CALL_OUTPUT("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).
      - 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
        
        The type of the item. Always mcp_list_tools.
        
        MCP_LIST_TOOLS("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
        
        The type of the item. Always mcp_approval_request.
        
        MCP_APPROVAL_REQUEST("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
        
        The type of the item. Always mcp_approval_response.
        
        MCP_APPROVAL_RESPONSE("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
        
        The type of the item. Always mcp_call.
        
        MCP_CALL("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.
        
        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.
        
        String
        
        List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
        
        JsonValue; type "custom_tool_call_output"constant
        
        The type of the custom tool call output. Always custom_tool_call_output.
        
        CUSTOM_TOOL_CALL_OUTPUT("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
        
        The type of the custom tool call. Always custom_tool_call.
        
        CUSTOM_TOOL_CALL("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.
      - JsonValue;
        
        JsonValue; type "compaction_trigger"constant
        
        The type of the item. Always compaction_trigger.
        
        COMPACTION_TRIGGER("compaction_trigger")
      - ItemReference
        
        String id
        
        The ID of the item to reference.
        
        Optional<Type> type
        
        The type of item to reference. Always item_reference.
        
        ITEM_REFERENCE("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.
    - String
    - enum ChatModel:
      - GPT_5_4("gpt-5.4")
      - GPT_5_4_MINI("gpt-5.4-mini")
      - GPT_5_4_NANO("gpt-5.4-nano")
      - GPT_5_4_MINI_2026_03_17("gpt-5.4-mini-2026-03-17")
      - GPT_5_4_NANO_2026_03_17("gpt-5.4-nano-2026-03-17")
      - GPT_5_3_CHAT_LATEST("gpt-5.3-chat-latest")
      - GPT_5_2("gpt-5.2")
      - GPT_5_2_2025_12_11("gpt-5.2-2025-12-11")
      - GPT_5_2_CHAT_LATEST("gpt-5.2-chat-latest")
      - GPT_5_2_PRO("gpt-5.2-pro")
      - GPT_5_2_PRO_2025_12_11("gpt-5.2-pro-2025-12-11")
      - GPT_5_1("gpt-5.1")
      - GPT_5_1_2025_11_13("gpt-5.1-2025-11-13")
      - GPT_5_1_CODEX("gpt-5.1-codex")
      - GPT_5_1_MINI("gpt-5.1-mini")
      - GPT_5_1_CHAT_LATEST("gpt-5.1-chat-latest")
      - GPT_5("gpt-5")
      - GPT_5_MINI("gpt-5-mini")
      - GPT_5_NANO("gpt-5-nano")
      - GPT_5_2025_08_07("gpt-5-2025-08-07")
      - GPT_5_MINI_2025_08_07("gpt-5-mini-2025-08-07")
      - GPT_5_NANO_2025_08_07("gpt-5-nano-2025-08-07")
      - GPT_5_CHAT_LATEST("gpt-5-chat-latest")
      - GPT_4_1("gpt-4.1")
      - GPT_4_1_MINI("gpt-4.1-mini")
      - GPT_4_1_NANO("gpt-4.1-nano")
      - GPT_4_1_2025_04_14("gpt-4.1-2025-04-14")
      - GPT_4_1_MINI_2025_04_14("gpt-4.1-mini-2025-04-14")
      - GPT_4_1_NANO_2025_04_14("gpt-4.1-nano-2025-04-14")
      - O4_MINI("o4-mini")
      - O4_MINI_2025_04_16("o4-mini-2025-04-16")
      - O3("o3")
      - O3_2025_04_16("o3-2025-04-16")
      - O3_MINI("o3-mini")
      - O3_MINI_2025_01_31("o3-mini-2025-01-31")
      - O1("o1")
      - O1_2024_12_17("o1-2024-12-17")
      - O1_PREVIEW("o1-preview")
      - O1_PREVIEW_2024_09_12("o1-preview-2024-09-12")
      - O1_MINI("o1-mini")
      - O1_MINI_2024_09_12("o1-mini-2024-09-12")
      - GPT_4O("gpt-4o")
      - GPT_4O_2024_11_20("gpt-4o-2024-11-20")
      - GPT_4O_2024_08_06("gpt-4o-2024-08-06")
      - GPT_4O_2024_05_13("gpt-4o-2024-05-13")
      - GPT_4O_AUDIO_PREVIEW("gpt-4o-audio-preview")
      - GPT_4O_AUDIO_PREVIEW_2024_10_01("gpt-4o-audio-preview-2024-10-01")
      - GPT_4O_AUDIO_PREVIEW_2024_12_17("gpt-4o-audio-preview-2024-12-17")
      - GPT_4O_AUDIO_PREVIEW_2025_06_03("gpt-4o-audio-preview-2025-06-03")
      - GPT_4O_MINI_AUDIO_PREVIEW("gpt-4o-mini-audio-preview")
      - GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17("gpt-4o-mini-audio-preview-2024-12-17")
      - GPT_4O_SEARCH_PREVIEW("gpt-4o-search-preview")
      - GPT_4O_MINI_SEARCH_PREVIEW("gpt-4o-mini-search-preview")
      - GPT_4O_SEARCH_PREVIEW_2025_03_11("gpt-4o-search-preview-2025-03-11")
      - GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11("gpt-4o-mini-search-preview-2025-03-11")
      - CHATGPT_4O_LATEST("chatgpt-4o-latest")
      - CODEX_MINI_LATEST("codex-mini-latest")
      - GPT_4O_MINI("gpt-4o-mini")
      - GPT_4O_MINI_2024_07_18("gpt-4o-mini-2024-07-18")
      - GPT_4_TURBO("gpt-4-turbo")
      - GPT_4_TURBO_2024_04_09("gpt-4-turbo-2024-04-09")
      - GPT_4_0125_PREVIEW("gpt-4-0125-preview")
      - GPT_4_TURBO_PREVIEW("gpt-4-turbo-preview")
      - GPT_4_1106_PREVIEW("gpt-4-1106-preview")
      - GPT_4_VISION_PREVIEW("gpt-4-vision-preview")
      - GPT_4("gpt-4")
      - GPT_4_0314("gpt-4-0314")
      - GPT_4_0613("gpt-4-0613")
      - GPT_4_32K("gpt-4-32k")
      - GPT_4_32K_0314("gpt-4-32k-0314")
      - GPT_4_32K_0613("gpt-4-32k-0613")
      - GPT_3_5_TURBO("gpt-3.5-turbo")
      - GPT_3_5_TURBO_16K("gpt-3.5-turbo-16k")
      - GPT_3_5_TURBO_0301("gpt-3.5-turbo-0301")
      - GPT_3_5_TURBO_0613("gpt-3.5-turbo-0613")
      - GPT_3_5_TURBO_1106("gpt-3.5-turbo-1106")
      - GPT_3_5_TURBO_0125("gpt-3.5-turbo-0125")
      - GPT_3_5_TURBO_16K_0613("gpt-3.5-turbo-16k-0613")
    - ResponsesOnlyModel
      - O1_PRO("o1-pro")
      - O1_PRO_2025_03_19("o1-pro-2025-03-19")
      - O3_PRO("o3-pro")
      - O3_PRO_2025_06_10("o3-pro-2025-06-10")
      - O3_DEEP_RESEARCH("o3-deep-research")
      - O3_DEEP_RESEARCH_2025_06_26("o3-deep-research-2025-06-26")
      - O4_MINI_DEEP_RESEARCH("o4-mini-deep-research")
      - O4_MINI_DEEP_RESEARCH_2025_06_26("o4-mini-deep-research-2025-06-26")
      - COMPUTER_USE_PREVIEW("computer-use-preview")
      - COMPUTER_USE_PREVIEW_2025_03_11("computer-use-preview-2025-03-11")
      - GPT_5_CODEX("gpt-5-codex")
      - GPT_5_PRO("gpt-5-pro")
      - GPT_5_PRO_2025_10_06("gpt-5-pro-2025-10-06")
      - GPT_5_1_CODEX_MAX("gpt-5.1-codex-max")
  - JsonValue; object_ "response"constant
    
    The object type of this resource - always set to response.
    - RESPONSE("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.
    - class ResponseOutputMessage:
      
      An output message from the model.
    - class ResponseFileSearchToolCall:
      
      The results of a file search tool call. See the file search guide for more information.
    - class ResponseFunctionToolCall:
      
      A tool call to run a function. See the function calling guide for more information.
    - 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.
        
        String
        
        List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
      - Status status
        
        The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "function_call_output"constant
        
        The type of the function tool call output. Always function_call_output.
        
        FUNCTION_CALL_OUTPUT("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.
    - class ResponseComputerToolCall:
      
      A tool call to a computer use tool. See the computer use guide for more information.
    - 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.
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        FAILED("failed")
        
        IN_PROGRESS("in_progress")
      - JsonValue; type "computer_call_output"constant
        
        The type of the computer tool call output. Always computer_call_output.
        
        COMPUTER_CALL_OUTPUT("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.
    - 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.
        
        SERVER("server")
        
        CLIENT("client")
      - Status status
        
        The status of the tool search call item that was recorded.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "tool_search_call"constant
        
        The type of the item. Always tool_search_call.
        
        TOOL_SEARCH_CALL("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.
        
        SERVER("server")
        
        CLIENT("client")
      - Status status
        
        The status of the tool search output item that was recorded.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - List<Tool> tools
        
        The loaded tool definitions returned by tool search.
        
        class FunctionTool:
        
        Defines a function in your own code the model can choose to call. Learn more about function calling.
        
        class FileSearchTool:
        
        A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
        
        class ComputerTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
        
        class ComputerUsePreviewTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
        
        class WebSearchTool:
        
        Search the Internet for sources related to the prompt. Learn more about the web search tool.
        
        Mcp
        
        CodeInterpreter
        
        ImageGeneration
        
        JsonValue;
        
        class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        class CustomTool:
        
        A custom tool that processes input using a specified format. Learn more about custom tools
        
        class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        class WebSearchPreviewTool:
        
        This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
        
        class ApplyPatchTool:
        
        Allows the assistant to create, delete, or update files using unified diffs.
      - JsonValue; type "tool_search_output"constant
        
        The type of the item. Always tool_search_output.
        
        TOOL_SEARCH_OUTPUT("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
        
        The type of the item. Always compaction.
        
        COMPACTION("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        GENERATING("generating")
        
        FAILED("failed")
      - JsonValue; type "image_generation_call"constant
        
        The type of the image generation call. Always image_generation_call.
        
        IMAGE_GENERATION_CALL("image_generation_call")
    - class ResponseCodeInterpreterToolCall:
      
      A tool call to run code.
    - 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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "local_shell_call"constant
        
        The type of the local shell call. Always local_shell_call.
        
        LOCAL_SHELL_CALL("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
        
        The type of the local shell tool call output. Always local_shell_call_output.
        
        LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
      - Optional<Status> status
        
        The status of the item. One of in_progress, completed, or incomplete.
        
        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.
        
        class ResponseLocalEnvironment:
        
        Represents the use of a local environment to perform shell actions.
        
        JsonValue; type "local"constant
        
        The environment type. Always local.
        
        LOCAL("local")
        
        class ResponseContainerReference:
        
        Represents a container created with /v1/containers.
        
        String containerId
        
        JsonValue; type "container_reference"constant
        
        The environment type. Always container_reference.
        
        CONTAINER_REFERENCE("container_reference")
      - Status status
        
        The status of the shell call. One of in_progress, completed, or incomplete.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "shell_call"constant
        
        The type of the item. Always shell_call.
        
        SHELL_CALL("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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "shell_call_output"constant
        
        The type of the shell call output. Always shell_call_output.
        
        SHELL_CALL_OUTPUT("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.
        
        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 a new file with the provided diff.
        
        CREATE_FILE("create_file")
        
        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 the specified file.
        
        DELETE_FILE("delete_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 an existing file with the provided diff.
        
        UPDATE_FILE("update_file")
      - Status status
        
        The status of the apply patch tool call. One of in_progress or completed.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
      - JsonValue; type "apply_patch_call"constant
        
        The type of the item. Always apply_patch_call.
        
        APPLY_PATCH_CALL("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.
        
        COMPLETED("completed")
        
        FAILED("failed")
      - JsonValue; type "apply_patch_call_output"constant
        
        The type of the item. Always apply_patch_call_output.
        
        APPLY_PATCH_CALL_OUTPUT("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
        
        The type of the item. Always mcp_call.
        
        MCP_CALL("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.
        
        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
        
        The type of the item. Always mcp_list_tools.
        
        MCP_LIST_TOOLS("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
        
        The type of the item. Always mcp_approval_request.
        
        MCP_APPROVAL_REQUEST("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
        
        The type of the item. Always mcp_approval_response.
        
        MCP_APPROVAL_RESPONSE("mcp_approval_response")
      - Optional<String> reason
        
        Optional reason for the decision.
    - class ResponseCustomToolCall:
      
      A call to a custom tool created by the model.
    - 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.
        
        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.
  - 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.
    - 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.
        
        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 tool configuration type. Always allowed_tools.
        
        ALLOWED_TOOLS("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
        
        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
        
        For function calling, the type is always function.
        
        FUNCTION("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
        
        For MCP tools, the type is always mcp.
        
        MCP("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
        
        For custom tool calling, the type is always custom.
        
        CUSTOM("custom")
    - class ToolChoiceApplyPatch:
      
      Forces the model to call the apply_patch tool when executing a tool call.
      - JsonValue; type "apply_patch"constant
        
        The tool to call. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
    - class ToolChoiceShell:
      
      Forces the model to call the shell tool when a tool call is required.
      - JsonValue; type "shell"constant
        
        The tool to call. Always shell.
        
        SHELL("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.
    - class FunctionTool:
      
      Defines a function in your own code the model can choose to call. Learn more about function calling.
    - class FileSearchTool:
      
      A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
    - class ComputerTool:
      
      A tool that controls a virtual computer. Learn more about the computer tool.
    - class ComputerUsePreviewTool:
      
      A tool that controls a virtual computer. Learn more about the computer tool.
    - class WebSearchTool:
      
      Search the Internet for sources related to the prompt. Learn more about the web search tool.
    - Mcp
    - CodeInterpreter
    - ImageGeneration
    - JsonValue;
    - class FunctionShellTool:
      
      A tool that allows the model to execute shell commands.
    - class CustomTool:
      
      A custom tool that processes input using a specified format. Learn more about custom tools
    - class NamespaceTool:
      
      Groups function/custom tools under a shared namespace.
    - class ToolSearchTool:
      
      Hosted or BYOT tool search configuration for deferred tools.
    - class WebSearchPreviewTool:
      
      This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
    - class ApplyPatchTool:
      
      Allows the assistant to create, delete, or update files using unified diffs.
  - 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.
  - 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.
    - 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.
      - String
      - class ResponseInputText:
        
        A text input to the model.
      - class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
      - class ResponseInputFile:
        
        A file input to the model.
    - Optional<String> version
      
      Optional version of the prompt template.
  - 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.
    - IN_MEMORY("in_memory")
    - _24H("24h")
  - Optional<Reasoning> reasoning
    
    gpt-5 and o-series models only
    
    Configuration options for reasoning models.
    - Optional<ReasoningEffort> effort
      
      Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
      - gpt-5.1 defaults to none, which does not perform reasoning. The supported reasoning values for gpt-5.1 are none, low, medium, and high. Tool calls are supported for all reasoning values in gpt-5.1.
      - All models before gpt-5.1 default to medium reasoning effort, and do not support none.
      - The gpt-5-pro model defaults to (and only supports) high reasoning effort.
      - xhigh is supported for all models after gpt-5.1-codex-max.
      - NONE("none")
      - MINIMAL("minimal")
      - LOW("low")
      - MEDIUM("medium")
      - HIGH("high")
      - XHIGH("xhigh")
    - Optional<GenerateSummary> generateSummary
      
      Deprecated: use summary instead.
      
      A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
      - AUTO("auto")
      - CONCISE("concise")
      - DETAILED("detailed")
    - Optional<Summary> summary
      
      A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
      
      concise is supported for computer-use-preview models and all reasoning models after gpt-5.
      - AUTO("auto")
      - CONCISE("concise")
      - DETAILED("detailed")
  - 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.
  - 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.
    - 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.
    - COMPLETED("completed")
    - FAILED("failed")
    - IN_PROGRESS("in_progress")
    - CANCELLED("cancelled")
    - QUEUED("queued")
    - INCOMPLETE("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<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.
      - class ResponseFormatText:
        
        Default response format. Used to generate text responses.
        
        JsonValue; type "text"constant
        
        The type of response format being defined. Always text.
        
        TEXT("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
        
        The type of response format being defined. Always json_schema.
        
        JSON_SCHEMA("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
        
        The type of response format being defined. Always json_object.
        
        JSON_OBJECT("json_object")
    - 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.
      - LOW("low")
      - MEDIUM("medium")
      - HIGH("high")
  - Optional<Long> topLogprobs
    
    An integer between 0 and 20 specifying the maximum number of most likely tokens to return at each token position, each with an associated log probability. In some cases, the number of returned tokens may be fewer than requested.
  - 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.
    - 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.
    - 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.
  - Optional<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.
- long sequenceNumber
  
  The sequence number of this event.
- JsonValue; type "response.in_progress"constant
  
  The type of the event. Always response.in_progress.
  - RESPONSE_IN_PROGRESS("response.in_progress")

Response Includable

enum ResponseIncludable:

Specify additional output data to include in the model response. Currently supported values are:
- web_search_call.results: Include the search results of the web search tool call.
- 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")

Response Incomplete Event

class ResponseIncompleteEvent:

An event that is emitted when a response finishes as incomplete.
- Response response
  
  The response that was incomplete.
  - 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.
    - Code code
      
      The error code for the response.
      - 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.
  - Optional<IncompleteDetails> incompleteDetails
    
    Details about why the response is incomplete.
    - Optional<Reason> reason
      
      The reason why the response is incomplete.
      - 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.
    - String
    - List<ResponseInputItem>
      - 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.
        
        String
        
        List<ResponseInputContent>
        
        class ResponseInputText:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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.
        
        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.
        
        COMMENTARY("commentary")
        
        FINAL_ANSWER("final_answer")
        
        Optional<Type> type
        
        The type of the message input. Always message.
        
        MESSAGE("message")
      - Message
        
        List<ResponseInputContent> content
        
        A list of one or many input items to the model, containing different content types.
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
        
        Role role
        
        The role of the message input. One of user, system, or developer.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        Optional<Type> type
        
        The type of the message input. Always set to message.
        
        MESSAGE("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.
        
        class ResponseOutputText:
        
        A text output from the model.
        
        List<Annotation> annotations
        
        The annotations of the text output.
        
        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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
        
        String text
        
        The text output from the model.
        
        JsonValue; type "output_text"constant
        
        The type of the output text. Always output_text.
        
        OUTPUT_TEXT("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
        
        The type of the refusal. Always refusal.
        
        REFUSAL("refusal")
        
        JsonValue; role "assistant"constant
        
        The role of the output message. Always assistant.
        
        ASSISTANT("assistant")
        
        Status status
        
        The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        JsonValue; type "message"constant
        
        The type of the output message. Always message.
        
        MESSAGE("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.
        
        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,
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        FAILED("failed")
        
        JsonValue; type "file_search_call"constant
        
        The type of the file search tool call. Always file_search_call.
        
        FILE_SEARCH_CALL("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.
        
        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.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        Type type
        
        The type of the computer call. Always computer_call.
        
        COMPUTER_CALL("computer_call")
        
        Optional<Action> action
        
        A click action.
        
        class Click:
        
        A click action.
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        class Move:
        
        A mouse move action.
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        class Scroll:
        
        A scroll action.
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
        
        Optional<List<ComputerAction>> actions
        
        Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.
        
        Click
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        Move
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        Scroll
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
      - ComputerCallOutput
        
        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.
        
        JsonValue; type "computer_screenshot"constant
        
        Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
        
        COMPUTER_SCREENSHOT("computer_screenshot")
        
        Optional<String> fileId
        
        The identifier of an uploaded file that contains the screenshot.
        
        Optional<String> imageUrl
        
        The URL of the screenshot image.
        
        JsonValue; type "computer_call_output"constant
        
        The type of the computer tool call output. Always computer_call_output.
        
        COMPUTER_CALL_OUTPUT("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.
        
        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).
        
        class Search:
        
        Action type "search" - Performs a web search query.
        
        String query
        
        [DEPRECATED] The search query.
        
        JsonValue; type "search"constant
        
        The action type.
        
        SEARCH("search")
        
        Optional<List<String>> queries
        
        The search queries.
        
        Optional<List<Source>> sources
        
        The sources used in the search.
        
        JsonValue; type "url"constant
        
        The type of source. Always url.
        
        URL("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
        
        The action type.
        
        OPEN_PAGE("open_page")
        
        Optional<String> url
        
        The URL opened by the model.
        
        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
        
        The action type.
        
        FIND_IN_PAGE("find_in_page")
        
        String url
        
        The URL of the page searched for the pattern.
        
        Status status
        
        The status of the web search tool call.
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        FAILED("failed")
        
        JsonValue; type "web_search_call"constant
        
        The type of the web search tool call. Always web_search_call.
        
        WEB_SEARCH_CALL("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
        
        The type of the function tool call. Always function_call.
        
        FUNCTION_CALL("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - FunctionCallOutput
        
        String callId
        
        The unique ID of the function tool call generated by the model.
        
        Output output
        
        Text, image, or file output of the function tool call.
        
        String
        
        List<ResponseFunctionCallOutputItem>
        
        class ResponseInputTextContent:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("input_text")
        
        class ResponseInputImageContent:
        
        An image input to the model. Learn about image inputs
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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.
        
        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.
        
        class ResponseInputFileContent:
        
        A file input to the model.
        
        JsonValue; type "input_file"constant
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        LOW("low")
        
        HIGH("high")
        
        Optional<String> fileData
        
        The base64-encoded data 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 "function_call_output"constant
        
        The type of the function tool call output. Always function_call_output.
        
        FUNCTION_CALL_OUTPUT("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.
        
        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
        
        The item type. Always tool_search_call.
        
        TOOL_SEARCH_CALL("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.
        
        Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
        
        Optional<Status> status
        
        The status of the tool search call.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - class ResponseToolSearchOutputItemParam:
        
        List<Tool> tools
        
        The loaded tool definitions returned by the tool search output.
        
        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
        
        The type of the function tool. Always function.
        
        FUNCTION("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
        
        The type of the file search tool. Always file_search.
        
        FILE_SEARCH("file_search")
        
        List<String> vectorStoreIds
        
        The IDs of the vector stores to search.
        
        Optional<Filters> filters
        
        A filter to apply.
        
        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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
        
        Type type
        
        Type of operation: and or or.
        
        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.
        
        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
        
        The type of the computer tool. Always computer.
        
        COMPUTER("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.
        
        WINDOWS("windows")
        
        MAC("mac")
        
        LINUX("linux")
        
        UBUNTU("ubuntu")
        
        BROWSER("browser")
        
        JsonValue; type "computer_use_preview"constant
        
        The type of the computer use tool. Always computer_use_preview.
        
        COMPUTER_USE_PREVIEW("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.
        
        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.
        
        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.
        
        APPROXIMATE("approximate")
        
        Mcp
        
        String serverLabel
        
        A label for this MCP server, used to identify it in tool calls.
        
        JsonValue; type "mcp"constant
        
        The type of the MCP tool. Always mcp.
        
        MCP("mcp")
        
        Optional<AllowedTools> allowedTools
        
        List of allowed tool names or a filter object.
        
        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
        
        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.
        
        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.
        
        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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
        
        JsonValue; type "code_interpreter"constant
        
        The type of the code interpreter tool. Always code_interpreter.
        
        CODE_INTERPRETER("code_interpreter")
        
        ImageGeneration
        
        JsonValue; type "image_generation"constant
        
        The type of the image generation tool. Always image_generation.
        
        IMAGE_GENERATION("image_generation")
        
        Optional<Action> action
        
        Whether to generate a new image or edit an existing image. Default: auto.
        
        GENERATE("generate")
        
        EDIT("edit")
        
        AUTO("auto")
        
        Optional<Background> background
        
        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.
        
        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.
        
        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.
        
        GPT_IMAGE_1("gpt-image-1")
        
        GPT_IMAGE_1_MINI("gpt-image-1-mini")
        
        GPT_IMAGE_2("gpt-image-2")
        
        GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
        
        GPT_IMAGE_1_5("gpt-image-1.5")
        
        CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
        
        Optional<Moderation> moderation
        
        Moderation level for the generated image. Default: auto.
        
        AUTO("auto")
        
        LOW("low")
        
        Optional<Long> outputCompression
        
        Compression level for the output image. Default: 100.
        
        Optional<OutputFormat> outputFormat
        
        The output format of the generated image. One of png, webp, or jpeg. Default: png.
        
        PNG("png")
        
        WEBP("webp")
        
        JPEG("jpeg")
        
        Optional<Long> partialImages
        
        Number of partial images to generate in streaming mode, from 0 (default value) to 3.
        
        Optional<Quality> quality
        
        The quality of the generated image. One of low, medium, high, or auto. Default: auto.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        AUTO("auto")
        
        Optional<Size> size
        
        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.
        
        _1024X1024("1024x1024")
        
        _1024X1536("1024x1536")
        
        _1536X1024("1536x1024")
        
        AUTO("auto")
        
        JsonValue;
        
        JsonValue; type "local_shell"constant
        
        The type of the local shell tool. Always local_shell.
        
        LOCAL_SHELL("local_shell")
        
        class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        JsonValue; type "shell"constant
        
        The type of the shell tool. Always shell.
        
        SHELL("shell")
        
        Optional<Environment> environment
        
        class ContainerAuto:
        
        JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
        
        Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
        
        class LocalEnvironment:
        
        JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
        
        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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
        
        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
        
        The type of the custom tool. Always custom.
        
        CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
        
        Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
        
        class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        String description
        
        A description of the namespace shown to the model.
        
        String name
        
        The namespace name used in tool calls (for example, crm).
        
        List<Tool> tools
        
        The function/custom tools available inside this namespace.
        
        class Function:
        
        String name
        
        JsonValue; type "function"constant
        
        FUNCTION("function")
        
        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
        
        JsonValue; type "namespace"constant
        
        The type of the tool. Always namespace.
        
        NAMESPACE("namespace")
        
        class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        JsonValue; type "tool_search"constant
        
        The type of the tool. Always tool_search.
        
        TOOL_SEARCH("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.
        
        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.
        
        WEB_SEARCH_PREVIEW("web_search_preview")
        
        WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
        
        Optional<List<SearchContentType>> searchContentTypes
        
        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.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        Optional<UserLocation> userLocation
        
        The user's location.
        
        JsonValue; type "approximate"constant
        
        The type of location approximation. Always approximate.
        
        APPROXIMATE("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
        
        The type of the tool. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
        
        JsonValue; type "tool_search_output"constant
        
        The item type. Always tool_search_output.
        
        TOOL_SEARCH_OUTPUT("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.
        
        Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
        
        Optional<Status> status
        
        The status of the tool search output.
        
        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
        
        The type of the object. Always summary_text.
        
        SUMMARY_TEXT("summary_text")
        
        JsonValue; type "reasoning"constant
        
        The type of the object. Always reasoning.
        
        REASONING("reasoning")
        
        Optional<List<Content>> content
        
        Reasoning text content.
        
        String text
        
        The reasoning text from the model.
        
        JsonValue; type "reasoning_text"constant
        
        The type of the reasoning text. Always reasoning_text.
        
        REASONING_TEXT("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.
        
        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.
        
        JsonValue; type "compaction"constant
        
        The type of the item. Always compaction.
        
        COMPACTION("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        GENERATING("generating")
        
        FAILED("failed")
        
        JsonValue; type "image_generation_call"constant
        
        The type of the image generation call. Always image_generation_call.
        
        IMAGE_GENERATION_CALL("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.
        
        class Logs:
        
        The logs output from the code interpreter.
        
        String logs
        
        The logs output from the code interpreter.
        
        JsonValue; type "logs"constant
        
        The type of the output. Always logs.
        
        LOGS("logs")
        
        class Image:
        
        The image output from the code interpreter.
        
        JsonValue; type "image"constant
        
        The type of the output. Always image.
        
        IMAGE("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        INTERPRETING("interpreting")
        
        FAILED("failed")
        
        JsonValue; type "code_interpreter_call"constant
        
        The type of the code interpreter tool call. Always code_interpreter_call.
        
        CODE_INTERPRETER_CALL("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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        JsonValue; type "local_shell_call"constant
        
        The type of the local shell call. Always local_shell_call.
        
        LOCAL_SHELL_CALL("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
        
        The type of the local shell tool call output. Always local_shell_call_output.
        
        LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
        
        Optional<Status> status
        
        The status of the item. One of in_progress, completed, or incomplete.
        
        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.
        
        JsonValue; type "shell_call"constant
        
        The type of the item. Always shell_call.
        
        SHELL_CALL("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.
        
        class LocalEnvironment:
        
        class ContainerReference:
        
        Optional<Status> status
        
        The status of the shell call. One of in_progress, completed, or incomplete.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - ShellCallOutput
        
        String callId
        
        The unique ID of the shell tool call generated by the model.
        
        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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("exit")
        
        String stderr
        
        Captured stderr output for the shell call.
        
        String stdout
        
        Captured stdout output for the shell call.
        
        JsonValue; type "shell_call_output"constant
        
        The type of the item. Always shell_call_output.
        
        SHELL_CALL_OUTPUT("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - ApplyPatchCall
        
        String callId
        
        The unique ID of the apply patch tool call generated by the model.
        
        Operation operation
        
        The specific create, delete, or update instruction for the apply_patch tool call.
        
        class CreateFile:
        
        Instruction for creating a new file via the apply_patch tool.
        
        String diff
        
        Unified diff content to apply when creating the file.
        
        String path
        
        Path of the file to create relative to the workspace root.
        
        JsonValue; type "create_file"constant
        
        The operation type. Always create_file.
        
        CREATE_FILE("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.
        
        JsonValue; type "delete_file"constant
        
        The operation type. Always delete_file.
        
        DELETE_FILE("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.
        
        String path
        
        Path of the file to update relative to the workspace root.
        
        JsonValue; type "update_file"constant
        
        The operation type. Always update_file.
        
        UPDATE_FILE("update_file")
        
        Status status
        
        The status of the apply patch tool call. One of in_progress or completed.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        JsonValue; type "apply_patch_call"constant
        
        The type of the item. Always apply_patch_call.
        
        APPLY_PATCH_CALL("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.
        
        Status status
        
        The status of the apply patch tool call output. One of completed or failed.
        
        COMPLETED("completed")
        
        FAILED("failed")
        
        JsonValue; type "apply_patch_call_output"constant
        
        The type of the item. Always apply_patch_call_output.
        
        APPLY_PATCH_CALL_OUTPUT("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).
      - 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
        
        The type of the item. Always mcp_list_tools.
        
        MCP_LIST_TOOLS("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
        
        The type of the item. Always mcp_approval_request.
        
        MCP_APPROVAL_REQUEST("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
        
        The type of the item. Always mcp_approval_response.
        
        MCP_APPROVAL_RESPONSE("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
        
        The type of the item. Always mcp_call.
        
        MCP_CALL("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.
        
        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.
        
        String
        
        List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
        
        JsonValue; type "custom_tool_call_output"constant
        
        The type of the custom tool call output. Always custom_tool_call_output.
        
        CUSTOM_TOOL_CALL_OUTPUT("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
        
        The type of the custom tool call. Always custom_tool_call.
        
        CUSTOM_TOOL_CALL("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.
      - JsonValue;
        
        JsonValue; type "compaction_trigger"constant
        
        The type of the item. Always compaction_trigger.
        
        COMPACTION_TRIGGER("compaction_trigger")
      - ItemReference
        
        String id
        
        The ID of the item to reference.
        
        Optional<Type> type
        
        The type of item to reference. Always item_reference.
        
        ITEM_REFERENCE("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.
    - String
    - enum ChatModel:
      - GPT_5_4("gpt-5.4")
      - GPT_5_4_MINI("gpt-5.4-mini")
      - GPT_5_4_NANO("gpt-5.4-nano")
      - GPT_5_4_MINI_2026_03_17("gpt-5.4-mini-2026-03-17")
      - GPT_5_4_NANO_2026_03_17("gpt-5.4-nano-2026-03-17")
      - GPT_5_3_CHAT_LATEST("gpt-5.3-chat-latest")
      - GPT_5_2("gpt-5.2")
      - GPT_5_2_2025_12_11("gpt-5.2-2025-12-11")
      - GPT_5_2_CHAT_LATEST("gpt-5.2-chat-latest")
      - GPT_5_2_PRO("gpt-5.2-pro")
      - GPT_5_2_PRO_2025_12_11("gpt-5.2-pro-2025-12-11")
      - GPT_5_1("gpt-5.1")
      - GPT_5_1_2025_11_13("gpt-5.1-2025-11-13")
      - GPT_5_1_CODEX("gpt-5.1-codex")
      - GPT_5_1_MINI("gpt-5.1-mini")
      - GPT_5_1_CHAT_LATEST("gpt-5.1-chat-latest")
      - GPT_5("gpt-5")
      - GPT_5_MINI("gpt-5-mini")
      - GPT_5_NANO("gpt-5-nano")
      - GPT_5_2025_08_07("gpt-5-2025-08-07")
      - GPT_5_MINI_2025_08_07("gpt-5-mini-2025-08-07")
      - GPT_5_NANO_2025_08_07("gpt-5-nano-2025-08-07")
      - GPT_5_CHAT_LATEST("gpt-5-chat-latest")
      - GPT_4_1("gpt-4.1")
      - GPT_4_1_MINI("gpt-4.1-mini")
      - GPT_4_1_NANO("gpt-4.1-nano")
      - GPT_4_1_2025_04_14("gpt-4.1-2025-04-14")
      - GPT_4_1_MINI_2025_04_14("gpt-4.1-mini-2025-04-14")
      - GPT_4_1_NANO_2025_04_14("gpt-4.1-nano-2025-04-14")
      - O4_MINI("o4-mini")
      - O4_MINI_2025_04_16("o4-mini-2025-04-16")
      - O3("o3")
      - O3_2025_04_16("o3-2025-04-16")
      - O3_MINI("o3-mini")
      - O3_MINI_2025_01_31("o3-mini-2025-01-31")
      - O1("o1")
      - O1_2024_12_17("o1-2024-12-17")
      - O1_PREVIEW("o1-preview")
      - O1_PREVIEW_2024_09_12("o1-preview-2024-09-12")
      - O1_MINI("o1-mini")
      - O1_MINI_2024_09_12("o1-mini-2024-09-12")
      - GPT_4O("gpt-4o")
      - GPT_4O_2024_11_20("gpt-4o-2024-11-20")
      - GPT_4O_2024_08_06("gpt-4o-2024-08-06")
      - GPT_4O_2024_05_13("gpt-4o-2024-05-13")
      - GPT_4O_AUDIO_PREVIEW("gpt-4o-audio-preview")
      - GPT_4O_AUDIO_PREVIEW_2024_10_01("gpt-4o-audio-preview-2024-10-01")
      - GPT_4O_AUDIO_PREVIEW_2024_12_17("gpt-4o-audio-preview-2024-12-17")
      - GPT_4O_AUDIO_PREVIEW_2025_06_03("gpt-4o-audio-preview-2025-06-03")
      - GPT_4O_MINI_AUDIO_PREVIEW("gpt-4o-mini-audio-preview")
      - GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17("gpt-4o-mini-audio-preview-2024-12-17")
      - GPT_4O_SEARCH_PREVIEW("gpt-4o-search-preview")
      - GPT_4O_MINI_SEARCH_PREVIEW("gpt-4o-mini-search-preview")
      - GPT_4O_SEARCH_PREVIEW_2025_03_11("gpt-4o-search-preview-2025-03-11")
      - GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11("gpt-4o-mini-search-preview-2025-03-11")
      - CHATGPT_4O_LATEST("chatgpt-4o-latest")
      - CODEX_MINI_LATEST("codex-mini-latest")
      - GPT_4O_MINI("gpt-4o-mini")
      - GPT_4O_MINI_2024_07_18("gpt-4o-mini-2024-07-18")
      - GPT_4_TURBO("gpt-4-turbo")
      - GPT_4_TURBO_2024_04_09("gpt-4-turbo-2024-04-09")
      - GPT_4_0125_PREVIEW("gpt-4-0125-preview")
      - GPT_4_TURBO_PREVIEW("gpt-4-turbo-preview")
      - GPT_4_1106_PREVIEW("gpt-4-1106-preview")
      - GPT_4_VISION_PREVIEW("gpt-4-vision-preview")
      - GPT_4("gpt-4")
      - GPT_4_0314("gpt-4-0314")
      - GPT_4_0613("gpt-4-0613")
      - GPT_4_32K("gpt-4-32k")
      - GPT_4_32K_0314("gpt-4-32k-0314")
      - GPT_4_32K_0613("gpt-4-32k-0613")
      - GPT_3_5_TURBO("gpt-3.5-turbo")
      - GPT_3_5_TURBO_16K("gpt-3.5-turbo-16k")
      - GPT_3_5_TURBO_0301("gpt-3.5-turbo-0301")
      - GPT_3_5_TURBO_0613("gpt-3.5-turbo-0613")
      - GPT_3_5_TURBO_1106("gpt-3.5-turbo-1106")
      - GPT_3_5_TURBO_0125("gpt-3.5-turbo-0125")
      - GPT_3_5_TURBO_16K_0613("gpt-3.5-turbo-16k-0613")
    - ResponsesOnlyModel
      - O1_PRO("o1-pro")
      - O1_PRO_2025_03_19("o1-pro-2025-03-19")
      - O3_PRO("o3-pro")
      - O3_PRO_2025_06_10("o3-pro-2025-06-10")
      - O3_DEEP_RESEARCH("o3-deep-research")
      - O3_DEEP_RESEARCH_2025_06_26("o3-deep-research-2025-06-26")
      - O4_MINI_DEEP_RESEARCH("o4-mini-deep-research")
      - O4_MINI_DEEP_RESEARCH_2025_06_26("o4-mini-deep-research-2025-06-26")
      - COMPUTER_USE_PREVIEW("computer-use-preview")
      - COMPUTER_USE_PREVIEW_2025_03_11("computer-use-preview-2025-03-11")
      - GPT_5_CODEX("gpt-5-codex")
      - GPT_5_PRO("gpt-5-pro")
      - GPT_5_PRO_2025_10_06("gpt-5-pro-2025-10-06")
      - GPT_5_1_CODEX_MAX("gpt-5.1-codex-max")
  - JsonValue; object_ "response"constant
    
    The object type of this resource - always set to response.
    - RESPONSE("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.
    - class ResponseOutputMessage:
      
      An output message from the model.
    - class ResponseFileSearchToolCall:
      
      The results of a file search tool call. See the file search guide for more information.
    - class ResponseFunctionToolCall:
      
      A tool call to run a function. See the function calling guide for more information.
    - 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.
        
        String
        
        List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
      - Status status
        
        The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "function_call_output"constant
        
        The type of the function tool call output. Always function_call_output.
        
        FUNCTION_CALL_OUTPUT("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.
    - class ResponseComputerToolCall:
      
      A tool call to a computer use tool. See the computer use guide for more information.
    - 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.
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        FAILED("failed")
        
        IN_PROGRESS("in_progress")
      - JsonValue; type "computer_call_output"constant
        
        The type of the computer tool call output. Always computer_call_output.
        
        COMPUTER_CALL_OUTPUT("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.
    - 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.
        
        SERVER("server")
        
        CLIENT("client")
      - Status status
        
        The status of the tool search call item that was recorded.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "tool_search_call"constant
        
        The type of the item. Always tool_search_call.
        
        TOOL_SEARCH_CALL("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.
        
        SERVER("server")
        
        CLIENT("client")
      - Status status
        
        The status of the tool search output item that was recorded.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - List<Tool> tools
        
        The loaded tool definitions returned by tool search.
        
        class FunctionTool:
        
        Defines a function in your own code the model can choose to call. Learn more about function calling.
        
        class FileSearchTool:
        
        A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
        
        class ComputerTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
        
        class ComputerUsePreviewTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
        
        class WebSearchTool:
        
        Search the Internet for sources related to the prompt. Learn more about the web search tool.
        
        Mcp
        
        CodeInterpreter
        
        ImageGeneration
        
        JsonValue;
        
        class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        class CustomTool:
        
        A custom tool that processes input using a specified format. Learn more about custom tools
        
        class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        class WebSearchPreviewTool:
        
        This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
        
        class ApplyPatchTool:
        
        Allows the assistant to create, delete, or update files using unified diffs.
      - JsonValue; type "tool_search_output"constant
        
        The type of the item. Always tool_search_output.
        
        TOOL_SEARCH_OUTPUT("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
        
        The type of the item. Always compaction.
        
        COMPACTION("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        GENERATING("generating")
        
        FAILED("failed")
      - JsonValue; type "image_generation_call"constant
        
        The type of the image generation call. Always image_generation_call.
        
        IMAGE_GENERATION_CALL("image_generation_call")
    - class ResponseCodeInterpreterToolCall:
      
      A tool call to run code.
    - 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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "local_shell_call"constant
        
        The type of the local shell call. Always local_shell_call.
        
        LOCAL_SHELL_CALL("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
        
        The type of the local shell tool call output. Always local_shell_call_output.
        
        LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
      - Optional<Status> status
        
        The status of the item. One of in_progress, completed, or incomplete.
        
        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.
        
        class ResponseLocalEnvironment:
        
        Represents the use of a local environment to perform shell actions.
        
        JsonValue; type "local"constant
        
        The environment type. Always local.
        
        LOCAL("local")
        
        class ResponseContainerReference:
        
        Represents a container created with /v1/containers.
        
        String containerId
        
        JsonValue; type "container_reference"constant
        
        The environment type. Always container_reference.
        
        CONTAINER_REFERENCE("container_reference")
      - Status status
        
        The status of the shell call. One of in_progress, completed, or incomplete.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "shell_call"constant
        
        The type of the item. Always shell_call.
        
        SHELL_CALL("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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "shell_call_output"constant
        
        The type of the shell call output. Always shell_call_output.
        
        SHELL_CALL_OUTPUT("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.
        
        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 a new file with the provided diff.
        
        CREATE_FILE("create_file")
        
        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 the specified file.
        
        DELETE_FILE("delete_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 an existing file with the provided diff.
        
        UPDATE_FILE("update_file")
      - Status status
        
        The status of the apply patch tool call. One of in_progress or completed.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
      - JsonValue; type "apply_patch_call"constant
        
        The type of the item. Always apply_patch_call.
        
        APPLY_PATCH_CALL("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.
        
        COMPLETED("completed")
        
        FAILED("failed")
      - JsonValue; type "apply_patch_call_output"constant
        
        The type of the item. Always apply_patch_call_output.
        
        APPLY_PATCH_CALL_OUTPUT("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
        
        The type of the item. Always mcp_call.
        
        MCP_CALL("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.
        
        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
        
        The type of the item. Always mcp_list_tools.
        
        MCP_LIST_TOOLS("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
        
        The type of the item. Always mcp_approval_request.
        
        MCP_APPROVAL_REQUEST("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
        
        The type of the item. Always mcp_approval_response.
        
        MCP_APPROVAL_RESPONSE("mcp_approval_response")
      - Optional<String> reason
        
        Optional reason for the decision.
    - class ResponseCustomToolCall:
      
      A call to a custom tool created by the model.
    - 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.
        
        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.
  - 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.
    - 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.
        
        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 tool configuration type. Always allowed_tools.
        
        ALLOWED_TOOLS("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
        
        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
        
        For function calling, the type is always function.
        
        FUNCTION("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
        
        For MCP tools, the type is always mcp.
        
        MCP("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
        
        For custom tool calling, the type is always custom.
        
        CUSTOM("custom")
    - class ToolChoiceApplyPatch:
      
      Forces the model to call the apply_patch tool when executing a tool call.
      - JsonValue; type "apply_patch"constant
        
        The tool to call. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
    - class ToolChoiceShell:
      
      Forces the model to call the shell tool when a tool call is required.
      - JsonValue; type "shell"constant
        
        The tool to call. Always shell.
        
        SHELL("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.
    - class FunctionTool:
      
      Defines a function in your own code the model can choose to call. Learn more about function calling.
    - class FileSearchTool:
      
      A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
    - class ComputerTool:
      
      A tool that controls a virtual computer. Learn more about the computer tool.
    - class ComputerUsePreviewTool:
      
      A tool that controls a virtual computer. Learn more about the computer tool.
    - class WebSearchTool:
      
      Search the Internet for sources related to the prompt. Learn more about the web search tool.
    - Mcp
    - CodeInterpreter
    - ImageGeneration
    - JsonValue;
    - class FunctionShellTool:
      
      A tool that allows the model to execute shell commands.
    - class CustomTool:
      
      A custom tool that processes input using a specified format. Learn more about custom tools
    - class NamespaceTool:
      
      Groups function/custom tools under a shared namespace.
    - class ToolSearchTool:
      
      Hosted or BYOT tool search configuration for deferred tools.
    - class WebSearchPreviewTool:
      
      This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
    - class ApplyPatchTool:
      
      Allows the assistant to create, delete, or update files using unified diffs.
  - 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.
  - 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.
    - 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.
      - String
      - class ResponseInputText:
        
        A text input to the model.
      - class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
      - class ResponseInputFile:
        
        A file input to the model.
    - Optional<String> version
      
      Optional version of the prompt template.
  - 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.
    - IN_MEMORY("in_memory")
    - _24H("24h")
  - Optional<Reasoning> reasoning
    
    gpt-5 and o-series models only
    
    Configuration options for reasoning models.
    - Optional<ReasoningEffort> effort
      
      Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
      - gpt-5.1 defaults to none, which does not perform reasoning. The supported reasoning values for gpt-5.1 are none, low, medium, and high. Tool calls are supported for all reasoning values in gpt-5.1.
      - All models before gpt-5.1 default to medium reasoning effort, and do not support none.
      - The gpt-5-pro model defaults to (and only supports) high reasoning effort.
      - xhigh is supported for all models after gpt-5.1-codex-max.
      - NONE("none")
      - MINIMAL("minimal")
      - LOW("low")
      - MEDIUM("medium")
      - HIGH("high")
      - XHIGH("xhigh")
    - Optional<GenerateSummary> generateSummary
      
      Deprecated: use summary instead.
      
      A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
      - AUTO("auto")
      - CONCISE("concise")
      - DETAILED("detailed")
    - Optional<Summary> summary
      
      A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
      
      concise is supported for computer-use-preview models and all reasoning models after gpt-5.
      - AUTO("auto")
      - CONCISE("concise")
      - DETAILED("detailed")
  - 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.
  - 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.
    - 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.
    - COMPLETED("completed")
    - FAILED("failed")
    - IN_PROGRESS("in_progress")
    - CANCELLED("cancelled")
    - QUEUED("queued")
    - INCOMPLETE("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<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.
      - class ResponseFormatText:
        
        Default response format. Used to generate text responses.
        
        JsonValue; type "text"constant
        
        The type of response format being defined. Always text.
        
        TEXT("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
        
        The type of response format being defined. Always json_schema.
        
        JSON_SCHEMA("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
        
        The type of response format being defined. Always json_object.
        
        JSON_OBJECT("json_object")
    - 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.
      - LOW("low")
      - MEDIUM("medium")
      - HIGH("high")
  - Optional<Long> topLogprobs
    
    An integer between 0 and 20 specifying the maximum number of most likely tokens to return at each token position, each with an associated log probability. In some cases, the number of returned tokens may be fewer than requested.
  - 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.
    - 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.
    - 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.
  - Optional<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.
- long sequenceNumber
  
  The sequence number of this event.
- JsonValue; type "response.incomplete"constant
  
  The type of the event. Always response.incomplete.
  - RESPONSE_INCOMPLETE("response.incomplete")

Response Input Audio

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.
    - MP3("mp3")
    - WAV("wav")
- JsonValue; type "input_audio"constant
  
  The type of the input item. Always input_audio.
  - INPUT_AUDIO("input_audio")

Response Input Content

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
    
    The type of the input item. Always input_text.
    - INPUT_TEXT("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.
    - LOW("low")
    - HIGH("high")
    - AUTO("auto")
    - ORIGINAL("original")
  - JsonValue; type "input_image"constant
    
    The type of the input item. Always input_image.
    - INPUT_IMAGE("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
    
    The type of the input item. Always input_file.
    - INPUT_FILE("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.
    - 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.

Response Input File

class ResponseInputFile:

A file input to the model.
- JsonValue; type "input_file"constant
  
  The type of the input item. Always input_file.
  - INPUT_FILE("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.
  - 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.

Response Input File Content

class ResponseInputFileContent:

A file input to the model.
- JsonValue; type "input_file"constant
  
  The type of the input item. Always input_file.
  - INPUT_FILE("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.
  - LOW("low")
  - HIGH("high")
- Optional<String> fileData
  
  The base64-encoded data 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.

Response Input Image

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.
  - LOW("low")
  - HIGH("high")
  - AUTO("auto")
  - ORIGINAL("original")
- JsonValue; type "input_image"constant
  
  The type of the input item. Always input_image.
  - INPUT_IMAGE("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.

Response Input Image Content

class ResponseInputImageContent:

An image input to the model. Learn about image inputs
- JsonValue; type "input_image"constant
  
  The type of the input item. Always input_image.
  - INPUT_IMAGE("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.
  - 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.

Response Input Item

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.
    - String
    - List<ResponseInputContent>
      - class ResponseInputText:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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.
    - 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.
    - COMMENTARY("commentary")
    - FINAL_ANSWER("final_answer")
  - Optional<Type> type
    
    The type of the message input. Always message.
    - MESSAGE("message")
- Message
  - List<ResponseInputContent> content
    
    A list of one or many input items to the model, containing different content types.
    - class ResponseInputText:
      
      A text input to the model.
    - class ResponseInputImage:
      
      An image input to the model. Learn about image inputs.
    - class ResponseInputFile:
      
      A file input to the model.
  - Role role
    
    The role of the message input. One of user, system, or developer.
    - 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.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - Optional<Type> type
    
    The type of the message input. Always set to message.
    - MESSAGE("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.
    - class ResponseOutputText:
      
      A text output from the model.
      - List<Annotation> annotations
        
        The annotations of the text output.
        
        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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
      - String text
        
        The text output from the model.
      - JsonValue; type "output_text"constant
        
        The type of the output text. Always output_text.
        
        OUTPUT_TEXT("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
        
        The type of the refusal. Always refusal.
        
        REFUSAL("refusal")
  - JsonValue; role "assistant"constant
    
    The role of the output message. Always assistant.
    - ASSISTANT("assistant")
  - Status status
    
    The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - JsonValue; type "message"constant
    
    The type of the output message. Always message.
    - MESSAGE("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.
    - 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,
    - IN_PROGRESS("in_progress")
    - SEARCHING("searching")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
    - FAILED("failed")
  - JsonValue; type "file_search_call"constant
    
    The type of the file search tool call. Always file_search_call.
    - FILE_SEARCH_CALL("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.
      - 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.
    - 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.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - Type type
    
    The type of the computer call. Always computer_call.
    - COMPUTER_CALL("computer_call")
  - Optional<Action> action
    
    A click action.
    - class Click:
      
      A click action.
      - Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
      - JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
    - class Move:
      
      A mouse move action.
      - JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
    - class Scroll:
      
      A scroll action.
      - long scrollX
        
        The horizontal scroll distance.
      - long scrollY
        
        The vertical scroll distance.
      - JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
    - JsonValue;
      - JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
  - Optional<List<ComputerAction>> actions
    
    Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.
    - Click
      - Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
      - JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
    - Move
      - JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
    - Scroll
      - long scrollX
        
        The horizontal scroll distance.
      - long scrollY
        
        The vertical scroll distance.
      - JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
    - JsonValue;
      - JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
- ComputerCallOutput
  - 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.
    - JsonValue; type "computer_screenshot"constant
      
      Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
      - COMPUTER_SCREENSHOT("computer_screenshot")
    - Optional<String> fileId
      
      The identifier of an uploaded file that contains the screenshot.
    - Optional<String> imageUrl
      
      The URL of the screenshot image.
  - JsonValue; type "computer_call_output"constant
    
    The type of the computer tool call output. Always computer_call_output.
    - COMPUTER_CALL_OUTPUT("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.
    - 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).
    - class Search:
      
      Action type "search" - Performs a web search query.
      - String query
        
        [DEPRECATED] The search query.
      - JsonValue; type "search"constant
        
        The action type.
        
        SEARCH("search")
      - Optional<List<String>> queries
        
        The search queries.
      - Optional<List<Source>> sources
        
        The sources used in the search.
        
        JsonValue; type "url"constant
        
        The type of source. Always url.
        
        URL("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
        
        The action type.
        
        OPEN_PAGE("open_page")
      - Optional<String> url
        
        The URL opened by the model.
    - 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
        
        The action type.
        
        FIND_IN_PAGE("find_in_page")
      - String url
        
        The URL of the page searched for the pattern.
  - Status status
    
    The status of the web search tool call.
    - IN_PROGRESS("in_progress")
    - SEARCHING("searching")
    - COMPLETED("completed")
    - FAILED("failed")
  - JsonValue; type "web_search_call"constant
    
    The type of the web search tool call. Always web_search_call.
    - WEB_SEARCH_CALL("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
    
    The type of the function tool call. Always function_call.
    - FUNCTION_CALL("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.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
- FunctionCallOutput
  - String callId
    
    The unique ID of the function tool call generated by the model.
  - Output output
    
    Text, image, or file output of the function tool call.
    - String
    - List<ResponseFunctionCallOutputItem>
      - class ResponseInputTextContent:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("input_text")
      - class ResponseInputImageContent:
        
        An image input to the model. Learn about image inputs
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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.
        
        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.
      - class ResponseInputFileContent:
        
        A file input to the model.
        
        JsonValue; type "input_file"constant
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        LOW("low")
        
        HIGH("high")
        
        Optional<String> fileData
        
        The base64-encoded data 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 "function_call_output"constant
    
    The type of the function tool call output. Always function_call_output.
    - FUNCTION_CALL_OUTPUT("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.
    - 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
    
    The item type. Always tool_search_call.
    - TOOL_SEARCH_CALL("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.
  - Optional<Execution> execution
    
    Whether tool search was executed by the server or by the client.
    - SERVER("server")
    - CLIENT("client")
  - Optional<Status> status
    
    The status of the tool search call.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
- class ResponseToolSearchOutputItemParam:
  - List<Tool> tools
    
    The loaded tool definitions returned by the tool search output.
    - 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
        
        The type of the function tool. Always function.
        
        FUNCTION("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
        
        The type of the file search tool. Always file_search.
        
        FILE_SEARCH("file_search")
      - List<String> vectorStoreIds
        
        The IDs of the vector stores to search.
      - Optional<Filters> filters
        
        A filter to apply.
        
        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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
        
        Type type
        
        Type of operation: and or or.
        
        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.
        
        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
        
        The type of the computer tool. Always computer.
        
        COMPUTER("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.
        
        WINDOWS("windows")
        
        MAC("mac")
        
        LINUX("linux")
        
        UBUNTU("ubuntu")
        
        BROWSER("browser")
      - JsonValue; type "computer_use_preview"constant
        
        The type of the computer use tool. Always computer_use_preview.
        
        COMPUTER_USE_PREVIEW("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.
        
        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.
        
        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.
        
        APPROXIMATE("approximate")
    - Mcp
      - String serverLabel
        
        A label for this MCP server, used to identify it in tool calls.
      - JsonValue; type "mcp"constant
        
        The type of the MCP tool. Always mcp.
        
        MCP("mcp")
      - Optional<AllowedTools> allowedTools
        
        List of allowed tool names or a filter object.
        
        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
        
        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.
        
        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.
        
        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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
      - JsonValue; type "code_interpreter"constant
        
        The type of the code interpreter tool. Always code_interpreter.
        
        CODE_INTERPRETER("code_interpreter")
    - ImageGeneration
      - JsonValue; type "image_generation"constant
        
        The type of the image generation tool. Always image_generation.
        
        IMAGE_GENERATION("image_generation")
      - Optional<Action> action
        
        Whether to generate a new image or edit an existing image. Default: auto.
        
        GENERATE("generate")
        
        EDIT("edit")
        
        AUTO("auto")
      - Optional<Background> background
        
        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.
        
        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.
        
        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.
        
        GPT_IMAGE_1("gpt-image-1")
        
        GPT_IMAGE_1_MINI("gpt-image-1-mini")
        
        GPT_IMAGE_2("gpt-image-2")
        
        GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
        
        GPT_IMAGE_1_5("gpt-image-1.5")
        
        CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
      - Optional<Moderation> moderation
        
        Moderation level for the generated image. Default: auto.
        
        AUTO("auto")
        
        LOW("low")
      - Optional<Long> outputCompression
        
        Compression level for the output image. Default: 100.
      - Optional<OutputFormat> outputFormat
        
        The output format of the generated image. One of png, webp, or jpeg. Default: png.
        
        PNG("png")
        
        WEBP("webp")
        
        JPEG("jpeg")
      - Optional<Long> partialImages
        
        Number of partial images to generate in streaming mode, from 0 (default value) to 3.
      - Optional<Quality> quality
        
        The quality of the generated image. One of low, medium, high, or auto. Default: auto.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        AUTO("auto")
      - Optional<Size> size
        
        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.
        
        _1024X1024("1024x1024")
        
        _1024X1536("1024x1536")
        
        _1536X1024("1536x1024")
        
        AUTO("auto")
    - JsonValue;
      - JsonValue; type "local_shell"constant
        
        The type of the local shell tool. Always local_shell.
        
        LOCAL_SHELL("local_shell")
    - class FunctionShellTool:
      
      A tool that allows the model to execute shell commands.
      - JsonValue; type "shell"constant
        
        The type of the shell tool. Always shell.
        
        SHELL("shell")
      - Optional<Environment> environment
        
        class ContainerAuto:
        
        JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
        
        Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
        
        class LocalEnvironment:
        
        JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
        
        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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
    - 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
        
        The type of the custom tool. Always custom.
        
        CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
        
        Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
    - class NamespaceTool:
      
      Groups function/custom tools under a shared namespace.
      - String description
        
        A description of the namespace shown to the model.
      - String name
        
        The namespace name used in tool calls (for example, crm).
      - List<Tool> tools
        
        The function/custom tools available inside this namespace.
        
        class Function:
        
        String name
        
        JsonValue; type "function"constant
        
        FUNCTION("function")
        
        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
      - JsonValue; type "namespace"constant
        
        The type of the tool. Always namespace.
        
        NAMESPACE("namespace")
    - class ToolSearchTool:
      
      Hosted or BYOT tool search configuration for deferred tools.
      - JsonValue; type "tool_search"constant
        
        The type of the tool. Always tool_search.
        
        TOOL_SEARCH("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.
        
        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.
        
        WEB_SEARCH_PREVIEW("web_search_preview")
        
        WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
      - Optional<List<SearchContentType>> searchContentTypes
        
        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.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
      - Optional<UserLocation> userLocation
        
        The user's location.
        
        JsonValue; type "approximate"constant
        
        The type of location approximation. Always approximate.
        
        APPROXIMATE("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
        
        The type of the tool. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
  - JsonValue; type "tool_search_output"constant
    
    The item type. Always tool_search_output.
    - TOOL_SEARCH_OUTPUT("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.
  - Optional<Execution> execution
    
    Whether tool search was executed by the server or by the client.
    - SERVER("server")
    - CLIENT("client")
  - Optional<Status> status
    
    The status of the tool search output.
    - 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
      
      The type of the object. Always summary_text.
      - SUMMARY_TEXT("summary_text")
  - JsonValue; type "reasoning"constant
    
    The type of the object. Always reasoning.
    - REASONING("reasoning")
  - Optional<List<Content>> content
    
    Reasoning text content.
    - String text
      
      The reasoning text from the model.
    - JsonValue; type "reasoning_text"constant
      
      The type of the reasoning text. Always reasoning_text.
      - REASONING_TEXT("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.
    - 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.
  - JsonValue; type "compaction"constant
    
    The type of the item. Always compaction.
    - COMPACTION("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.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - GENERATING("generating")
    - FAILED("failed")
  - JsonValue; type "image_generation_call"constant
    
    The type of the image generation call. Always image_generation_call.
    - IMAGE_GENERATION_CALL("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.
    - class Logs:
      
      The logs output from the code interpreter.
      - String logs
        
        The logs output from the code interpreter.
      - JsonValue; type "logs"constant
        
        The type of the output. Always logs.
        
        LOGS("logs")
    - class Image:
      
      The image output from the code interpreter.
      - JsonValue; type "image"constant
        
        The type of the output. Always image.
        
        IMAGE("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.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
    - INTERPRETING("interpreting")
    - FAILED("failed")
  - JsonValue; type "code_interpreter_call"constant
    
    The type of the code interpreter tool call. Always code_interpreter_call.
    - CODE_INTERPRETER_CALL("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
      
      The type of the local shell action. Always exec.
      - EXEC("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.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - JsonValue; type "local_shell_call"constant
    
    The type of the local shell call. Always local_shell_call.
    - LOCAL_SHELL_CALL("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
    
    The type of the local shell tool call output. Always local_shell_call_output.
    - LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
  - Optional<Status> status
    
    The status of the item. One of in_progress, completed, or incomplete.
    - 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.
  - JsonValue; type "shell_call"constant
    
    The type of the item. Always shell_call.
    - SHELL_CALL("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.
    - class LocalEnvironment:
    - class ContainerReference:
  - Optional<Status> status
    
    The status of the shell call. One of in_progress, completed, or incomplete.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
- ShellCallOutput
  - String callId
    
    The unique ID of the shell tool call generated by the model.
  - 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.
      - JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("exit")
    - String stderr
      
      Captured stderr output for the shell call.
    - String stdout
      
      Captured stdout output for the shell call.
  - JsonValue; type "shell_call_output"constant
    
    The type of the item. Always shell_call_output.
    - SHELL_CALL_OUTPUT("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.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
- ApplyPatchCall
  - String callId
    
    The unique ID of the apply patch tool call generated by the model.
  - Operation operation
    
    The specific create, delete, or update instruction for the apply_patch tool call.
    - class CreateFile:
      
      Instruction for creating a new file via the apply_patch tool.
      - String diff
        
        Unified diff content to apply when creating the file.
      - String path
        
        Path of the file to create relative to the workspace root.
      - JsonValue; type "create_file"constant
        
        The operation type. Always create_file.
        
        CREATE_FILE("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.
      - JsonValue; type "delete_file"constant
        
        The operation type. Always delete_file.
        
        DELETE_FILE("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.
      - String path
        
        Path of the file to update relative to the workspace root.
      - JsonValue; type "update_file"constant
        
        The operation type. Always update_file.
        
        UPDATE_FILE("update_file")
  - Status status
    
    The status of the apply patch tool call. One of in_progress or completed.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
  - JsonValue; type "apply_patch_call"constant
    
    The type of the item. Always apply_patch_call.
    - APPLY_PATCH_CALL("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.
  - Status status
    
    The status of the apply patch tool call output. One of completed or failed.
    - COMPLETED("completed")
    - FAILED("failed")
  - JsonValue; type "apply_patch_call_output"constant
    
    The type of the item. Always apply_patch_call_output.
    - APPLY_PATCH_CALL_OUTPUT("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).
- 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
    
    The type of the item. Always mcp_list_tools.
    - MCP_LIST_TOOLS("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
    
    The type of the item. Always mcp_approval_request.
    - MCP_APPROVAL_REQUEST("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
    
    The type of the item. Always mcp_approval_response.
    - MCP_APPROVAL_RESPONSE("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
    
    The type of the item. Always mcp_call.
    - MCP_CALL("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.
    - 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.
    - String
    - List<FunctionAndCustomToolCallOutput>
      - class ResponseInputText:
        
        A text input to the model.
      - class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
      - class ResponseInputFile:
        
        A file input to the model.
  - JsonValue; type "custom_tool_call_output"constant
    
    The type of the custom tool call output. Always custom_tool_call_output.
    - CUSTOM_TOOL_CALL_OUTPUT("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
    
    The type of the custom tool call. Always custom_tool_call.
    - CUSTOM_TOOL_CALL("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.
- JsonValue;
  - JsonValue; type "compaction_trigger"constant
    
    The type of the item. Always compaction_trigger.
    - COMPACTION_TRIGGER("compaction_trigger")
- ItemReference
  - String id
    
    The ID of the item to reference.
  - Optional<Type> type
    
    The type of item to reference. Always item_reference.
    - ITEM_REFERENCE("item_reference")

Response Input Message Item

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.
  - class ResponseInputText:
    
    A text input to the model.
    - String text
      
      The text input to the model.
    - JsonValue; type "input_text"constant
      
      The type of the input item. Always input_text.
      - INPUT_TEXT("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.
      - LOW("low")
      - HIGH("high")
      - AUTO("auto")
      - ORIGINAL("original")
    - JsonValue; type "input_image"constant
      
      The type of the input item. Always input_image.
      - INPUT_IMAGE("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
      
      The type of the input item. Always input_file.
      - INPUT_FILE("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.
      - 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, system, or developer.
  - USER("user")
  - SYSTEM("system")
  - DEVELOPER("developer")
- JsonValue; type "message"constant
  
  The type of the message input. Always set to message.
  - MESSAGE("message")
- Optional<Status> status
  
  The status of item. One of in_progress, completed, or incomplete. Populated when items are returned via API.
  - IN_PROGRESS("in_progress")
  - COMPLETED("completed")
  - INCOMPLETE("incomplete")

Response Input Text

class ResponseInputText:

A text input to the model.
- String text
  
  The text input to the model.
- JsonValue; type "input_text"constant
  
  The type of the input item. Always input_text.
  - INPUT_TEXT("input_text")

Response Input Text Content

class ResponseInputTextContent:

A text input to the model.
- String text
  
  The text input to the model.
- JsonValue; type "input_text"constant
  
  The type of the input item. Always input_text.
  - INPUT_TEXT("input_text")

Response Item

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.
    - class ResponseInputText:
      
      A text input to the model.
      - String text
        
        The text input to the model.
      - JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
      - JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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, system, or developer.
    - USER("user")
    - SYSTEM("system")
    - DEVELOPER("developer")
  - JsonValue; type "message"constant
    
    The type of the message input. Always set to message.
    - MESSAGE("message")
  - Optional<Status> status
    
    The status of item. One of in_progress, completed, or incomplete. Populated when items are returned via API.
    - 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.
    - class ResponseOutputText:
      
      A text output from the model.
      - List<Annotation> annotations
        
        The annotations of the text output.
        
        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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
      - String text
        
        The text output from the model.
      - JsonValue; type "output_text"constant
        
        The type of the output text. Always output_text.
        
        OUTPUT_TEXT("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
        
        The type of the refusal. Always refusal.
        
        REFUSAL("refusal")
  - JsonValue; role "assistant"constant
    
    The role of the output message. Always assistant.
    - ASSISTANT("assistant")
  - Status status
    
    The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - JsonValue; type "message"constant
    
    The type of the output message. Always message.
    - MESSAGE("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.
    - 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,
    - IN_PROGRESS("in_progress")
    - SEARCHING("searching")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
    - FAILED("failed")
  - JsonValue; type "file_search_call"constant
    
    The type of the file search tool call. Always file_search_call.
    - FILE_SEARCH_CALL("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.
      - 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.
    - 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.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - Type type
    
    The type of the computer call. Always computer_call.
    - COMPUTER_CALL("computer_call")
  - Optional<Action> action
    
    A click action.
    - class Click:
      
      A click action.
      - Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
      - JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
    - class Move:
      
      A mouse move action.
      - JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
    - class Scroll:
      
      A scroll action.
      - long scrollX
        
        The horizontal scroll distance.
      - long scrollY
        
        The vertical scroll distance.
      - JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
    - JsonValue;
      - JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
  - Optional<List<ComputerAction>> actions
    
    Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.
    - Click
      - Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
      - JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
    - Move
      - JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
    - Scroll
      - long scrollX
        
        The horizontal scroll distance.
      - long scrollY
        
        The vertical scroll distance.
      - JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
    - JsonValue;
      - JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
- 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.
    - JsonValue; type "computer_screenshot"constant
      
      Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
      - COMPUTER_SCREENSHOT("computer_screenshot")
    - Optional<String> fileId
      
      The identifier of an uploaded file that contains the screenshot.
    - Optional<String> imageUrl
      
      The URL of the screenshot image.
  - Status status
    
    The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
    - FAILED("failed")
    - IN_PROGRESS("in_progress")
  - JsonValue; type "computer_call_output"constant
    
    The type of the computer tool call output. Always computer_call_output.
    - COMPUTER_CALL_OUTPUT("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).
    - class Search:
      
      Action type "search" - Performs a web search query.
      - String query
        
        [DEPRECATED] The search query.
      - JsonValue; type "search"constant
        
        The action type.
        
        SEARCH("search")
      - Optional<List<String>> queries
        
        The search queries.
      - Optional<List<Source>> sources
        
        The sources used in the search.
        
        JsonValue; type "url"constant
        
        The type of source. Always url.
        
        URL("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
        
        The action type.
        
        OPEN_PAGE("open_page")
      - Optional<String> url
        
        The URL opened by the model.
    - 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
        
        The action type.
        
        FIND_IN_PAGE("find_in_page")
      - String url
        
        The URL of the page searched for the pattern.
  - Status status
    
    The status of the web search tool call.
    - IN_PROGRESS("in_progress")
    - SEARCHING("searching")
    - COMPLETED("completed")
    - FAILED("failed")
  - JsonValue; type "web_search_call"constant
    
    The type of the web search tool call. Always web_search_call.
    - WEB_SEARCH_CALL("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.
    - 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.
    - String
    - List<FunctionAndCustomToolCallOutput>
      - class ResponseInputText:
        
        A text input to the model.
      - class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
      - class ResponseInputFile:
        
        A file input to the model.
  - Status status
    
    The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - JsonValue; type "function_call_output"constant
    
    The type of the function tool call output. Always function_call_output.
    - FUNCTION_CALL_OUTPUT("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.
    - SERVER("server")
    - CLIENT("client")
  - Status status
    
    The status of the tool search call item that was recorded.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - JsonValue; type "tool_search_call"constant
    
    The type of the item. Always tool_search_call.
    - TOOL_SEARCH_CALL("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.
    - SERVER("server")
    - CLIENT("client")
  - Status status
    
    The status of the tool search output item that was recorded.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - List<Tool> tools
    
    The loaded tool definitions returned by tool search.
    - 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
        
        The type of the function tool. Always function.
        
        FUNCTION("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
        
        The type of the file search tool. Always file_search.
        
        FILE_SEARCH("file_search")
      - List<String> vectorStoreIds
        
        The IDs of the vector stores to search.
      - Optional<Filters> filters
        
        A filter to apply.
        
        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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
        
        Type type
        
        Type of operation: and or or.
        
        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.
        
        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
        
        The type of the computer tool. Always computer.
        
        COMPUTER("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.
        
        WINDOWS("windows")
        
        MAC("mac")
        
        LINUX("linux")
        
        UBUNTU("ubuntu")
        
        BROWSER("browser")
      - JsonValue; type "computer_use_preview"constant
        
        The type of the computer use tool. Always computer_use_preview.
        
        COMPUTER_USE_PREVIEW("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.
        
        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.
        
        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.
        
        APPROXIMATE("approximate")
    - Mcp
      - String serverLabel
        
        A label for this MCP server, used to identify it in tool calls.
      - JsonValue; type "mcp"constant
        
        The type of the MCP tool. Always mcp.
        
        MCP("mcp")
      - Optional<AllowedTools> allowedTools
        
        List of allowed tool names or a filter object.
        
        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
        
        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.
        
        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.
        
        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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
      - JsonValue; type "code_interpreter"constant
        
        The type of the code interpreter tool. Always code_interpreter.
        
        CODE_INTERPRETER("code_interpreter")
    - ImageGeneration
      - JsonValue; type "image_generation"constant
        
        The type of the image generation tool. Always image_generation.
        
        IMAGE_GENERATION("image_generation")
      - Optional<Action> action
        
        Whether to generate a new image or edit an existing image. Default: auto.
        
        GENERATE("generate")
        
        EDIT("edit")
        
        AUTO("auto")
      - Optional<Background> background
        
        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.
        
        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.
        
        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.
        
        GPT_IMAGE_1("gpt-image-1")
        
        GPT_IMAGE_1_MINI("gpt-image-1-mini")
        
        GPT_IMAGE_2("gpt-image-2")
        
        GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
        
        GPT_IMAGE_1_5("gpt-image-1.5")
        
        CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
      - Optional<Moderation> moderation
        
        Moderation level for the generated image. Default: auto.
        
        AUTO("auto")
        
        LOW("low")
      - Optional<Long> outputCompression
        
        Compression level for the output image. Default: 100.
      - Optional<OutputFormat> outputFormat
        
        The output format of the generated image. One of png, webp, or jpeg. Default: png.
        
        PNG("png")
        
        WEBP("webp")
        
        JPEG("jpeg")
      - Optional<Long> partialImages
        
        Number of partial images to generate in streaming mode, from 0 (default value) to 3.
      - Optional<Quality> quality
        
        The quality of the generated image. One of low, medium, high, or auto. Default: auto.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        AUTO("auto")
      - Optional<Size> size
        
        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.
        
        _1024X1024("1024x1024")
        
        _1024X1536("1024x1536")
        
        _1536X1024("1536x1024")
        
        AUTO("auto")
    - JsonValue;
      - JsonValue; type "local_shell"constant
        
        The type of the local shell tool. Always local_shell.
        
        LOCAL_SHELL("local_shell")
    - class FunctionShellTool:
      
      A tool that allows the model to execute shell commands.
      - JsonValue; type "shell"constant
        
        The type of the shell tool. Always shell.
        
        SHELL("shell")
      - Optional<Environment> environment
        
        class ContainerAuto:
        
        JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
        
        Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
        
        class LocalEnvironment:
        
        JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
        
        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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
    - 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
        
        The type of the custom tool. Always custom.
        
        CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
        
        Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
    - class NamespaceTool:
      
      Groups function/custom tools under a shared namespace.
      - String description
        
        A description of the namespace shown to the model.
      - String name
        
        The namespace name used in tool calls (for example, crm).
      - List<Tool> tools
        
        The function/custom tools available inside this namespace.
        
        class Function:
        
        String name
        
        JsonValue; type "function"constant
        
        FUNCTION("function")
        
        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
      - JsonValue; type "namespace"constant
        
        The type of the tool. Always namespace.
        
        NAMESPACE("namespace")
    - class ToolSearchTool:
      
      Hosted or BYOT tool search configuration for deferred tools.
      - JsonValue; type "tool_search"constant
        
        The type of the tool. Always tool_search.
        
        TOOL_SEARCH("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.
        
        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.
        
        WEB_SEARCH_PREVIEW("web_search_preview")
        
        WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
      - Optional<List<SearchContentType>> searchContentTypes
        
        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.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
      - Optional<UserLocation> userLocation
        
        The user's location.
        
        JsonValue; type "approximate"constant
        
        The type of location approximation. Always approximate.
        
        APPROXIMATE("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
        
        The type of the tool. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
  - JsonValue; type "tool_search_output"constant
    
    The type of the item. Always tool_search_output.
    - TOOL_SEARCH_OUTPUT("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
      
      The type of the object. Always summary_text.
      - SUMMARY_TEXT("summary_text")
  - JsonValue; type "reasoning"constant
    
    The type of the object. Always reasoning.
    - REASONING("reasoning")
  - Optional<List<Content>> content
    
    Reasoning text content.
    - String text
      
      The reasoning text from the model.
    - JsonValue; type "reasoning_text"constant
      
      The type of the reasoning text. Always reasoning_text.
      - REASONING_TEXT("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.
    - 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
    
    The type of the item. Always compaction.
    - COMPACTION("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.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - GENERATING("generating")
    - FAILED("failed")
  - JsonValue; type "image_generation_call"constant
    
    The type of the image generation call. Always image_generation_call.
    - IMAGE_GENERATION_CALL("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.
    - class Logs:
      
      The logs output from the code interpreter.
      - String logs
        
        The logs output from the code interpreter.
      - JsonValue; type "logs"constant
        
        The type of the output. Always logs.
        
        LOGS("logs")
    - class Image:
      
      The image output from the code interpreter.
      - JsonValue; type "image"constant
        
        The type of the output. Always image.
        
        IMAGE("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.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
    - INTERPRETING("interpreting")
    - FAILED("failed")
  - JsonValue; type "code_interpreter_call"constant
    
    The type of the code interpreter tool call. Always code_interpreter_call.
    - CODE_INTERPRETER_CALL("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
      
      The type of the local shell action. Always exec.
      - EXEC("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.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - JsonValue; type "local_shell_call"constant
    
    The type of the local shell call. Always local_shell_call.
    - LOCAL_SHELL_CALL("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
    
    The type of the local shell tool call output. Always local_shell_call_output.
    - LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
  - Optional<Status> status
    
    The status of the item. One of in_progress, completed, or incomplete.
    - 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.
    - class ResponseLocalEnvironment:
      
      Represents the use of a local environment to perform shell actions.
      - JsonValue; type "local"constant
        
        The environment type. Always local.
        
        LOCAL("local")
    - class ResponseContainerReference:
      
      Represents a container created with /v1/containers.
      - String containerId
      - JsonValue; type "container_reference"constant
        
        The environment type. Always container_reference.
        
        CONTAINER_REFERENCE("container_reference")
  - Status status
    
    The status of the shell call. One of in_progress, completed, or incomplete.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - JsonValue; type "shell_call"constant
    
    The type of the item. Always shell_call.
    - SHELL_CALL("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.
      - JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("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.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - JsonValue; type "shell_call_output"constant
    
    The type of the shell call output. Always shell_call_output.
    - SHELL_CALL_OUTPUT("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.
    - 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 a new file with the provided diff.
        
        CREATE_FILE("create_file")
    - 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 the specified file.
        
        DELETE_FILE("delete_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 an existing file with the provided diff.
        
        UPDATE_FILE("update_file")
  - Status status
    
    The status of the apply patch tool call. One of in_progress or completed.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
  - JsonValue; type "apply_patch_call"constant
    
    The type of the item. Always apply_patch_call.
    - APPLY_PATCH_CALL("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.
    - COMPLETED("completed")
    - FAILED("failed")
  - JsonValue; type "apply_patch_call_output"constant
    
    The type of the item. Always apply_patch_call_output.
    - APPLY_PATCH_CALL_OUTPUT("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
    
    The type of the item. Always mcp_list_tools.
    - MCP_LIST_TOOLS("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
    
    The type of the item. Always mcp_approval_request.
    - MCP_APPROVAL_REQUEST("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
    
    The type of the item. Always mcp_approval_response.
    - MCP_APPROVAL_RESPONSE("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
    
    The type of the item. Always mcp_call.
    - MCP_CALL("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.
    - 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.
    - 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.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - Optional<String> createdBy
    
    The identifier of the actor that created the item.

Response Local Environment

class ResponseLocalEnvironment:

Represents the use of a local environment to perform shell actions.
- JsonValue; type "local"constant
  
  The environment type. Always local.
  - LOCAL("local")

Response Mcp Call Arguments Delta Event

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
  
  The type of the event. Always 'response.mcp_call_arguments.delta'.
  - RESPONSE_MCP_CALL_ARGUMENTS_DELTA("response.mcp_call_arguments.delta")

Response Mcp Call Arguments Done Event

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
  
  The type of the event. Always 'response.mcp_call_arguments.done'.
  - RESPONSE_MCP_CALL_ARGUMENTS_DONE("response.mcp_call_arguments.done")

Response Mcp Call Completed Event

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
  
  The type of the event. Always 'response.mcp_call.completed'.
  - RESPONSE_MCP_CALL_COMPLETED("response.mcp_call.completed")

Response Mcp Call Failed Event

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
  
  The type of the event. Always 'response.mcp_call.failed'.
  - RESPONSE_MCP_CALL_FAILED("response.mcp_call.failed")

Response Mcp Call In Progress Event

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
  
  The type of the event. Always 'response.mcp_call.in_progress'.
  - RESPONSE_MCP_CALL_IN_PROGRESS("response.mcp_call.in_progress")

Response Mcp List Tools Completed Event

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
  
  The type of the event. Always 'response.mcp_list_tools.completed'.
  - RESPONSE_MCP_LIST_TOOLS_COMPLETED("response.mcp_list_tools.completed")

Response Mcp List Tools Failed Event

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
  
  The type of the event. Always 'response.mcp_list_tools.failed'.
  - RESPONSE_MCP_LIST_TOOLS_FAILED("response.mcp_list_tools.failed")

Response Mcp List Tools In Progress Event

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
  
  The type of the event. Always 'response.mcp_list_tools.in_progress'.
  - RESPONSE_MCP_LIST_TOOLS_IN_PROGRESS("response.mcp_list_tools.in_progress")

Response Output Audio

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
  
  The type of the output audio. Always output_audio.
  - OUTPUT_AUDIO("output_audio")

Response Output Item

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.
    - class ResponseOutputText:
      
      A text output from the model.
      - List<Annotation> annotations
        
        The annotations of the text output.
        
        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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
      - String text
        
        The text output from the model.
      - JsonValue; type "output_text"constant
        
        The type of the output text. Always output_text.
        
        OUTPUT_TEXT("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
        
        The type of the refusal. Always refusal.
        
        REFUSAL("refusal")
  - JsonValue; role "assistant"constant
    
    The role of the output message. Always assistant.
    - ASSISTANT("assistant")
  - Status status
    
    The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - JsonValue; type "message"constant
    
    The type of the output message. Always message.
    - MESSAGE("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.
    - 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,
    - IN_PROGRESS("in_progress")
    - SEARCHING("searching")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
    - FAILED("failed")
  - JsonValue; type "file_search_call"constant
    
    The type of the file search tool call. Always file_search_call.
    - FILE_SEARCH_CALL("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.
      - 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.
    - 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
    
    The type of the function tool call. Always function_call.
    - FUNCTION_CALL("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.
    - 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.
    - String
    - List<FunctionAndCustomToolCallOutput>
      - class ResponseInputText:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - JsonValue; type "function_call_output"constant
    
    The type of the function tool call output. Always function_call_output.
    - FUNCTION_CALL_OUTPUT("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).
    - class Search:
      
      Action type "search" - Performs a web search query.
      - String query
        
        [DEPRECATED] The search query.
      - JsonValue; type "search"constant
        
        The action type.
        
        SEARCH("search")
      - Optional<List<String>> queries
        
        The search queries.
      - Optional<List<Source>> sources
        
        The sources used in the search.
        
        JsonValue; type "url"constant
        
        The type of source. Always url.
        
        URL("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
        
        The action type.
        
        OPEN_PAGE("open_page")
      - Optional<String> url
        
        The URL opened by the model.
    - 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
        
        The action type.
        
        FIND_IN_PAGE("find_in_page")
      - String url
        
        The URL of the page searched for the pattern.
  - Status status
    
    The status of the web search tool call.
    - IN_PROGRESS("in_progress")
    - SEARCHING("searching")
    - COMPLETED("completed")
    - FAILED("failed")
  - JsonValue; type "web_search_call"constant
    
    The type of the web search tool call. Always web_search_call.
    - WEB_SEARCH_CALL("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.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - Type type
    
    The type of the computer call. Always computer_call.
    - COMPUTER_CALL("computer_call")
  - Optional<Action> action
    
    A click action.
    - class Click:
      
      A click action.
      - Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
      - JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
    - class Move:
      
      A mouse move action.
      - JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
    - class Scroll:
      
      A scroll action.
      - long scrollX
        
        The horizontal scroll distance.
      - long scrollY
        
        The vertical scroll distance.
      - JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
    - JsonValue;
      - JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
  - Optional<List<ComputerAction>> actions
    
    Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.
    - Click
      - Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
      - JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
    - Move
      - JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
    - Scroll
      - long scrollX
        
        The horizontal scroll distance.
      - long scrollY
        
        The vertical scroll distance.
      - JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
    - JsonValue;
      - JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
- 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.
    - JsonValue; type "computer_screenshot"constant
      
      Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
      - COMPUTER_SCREENSHOT("computer_screenshot")
    - Optional<String> fileId
      
      The identifier of an uploaded file that contains the screenshot.
    - Optional<String> imageUrl
      
      The URL of the screenshot image.
  - Status status
    
    The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
    - FAILED("failed")
    - IN_PROGRESS("in_progress")
  - JsonValue; type "computer_call_output"constant
    
    The type of the computer tool call output. Always computer_call_output.
    - COMPUTER_CALL_OUTPUT("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
      
      The type of the object. Always summary_text.
      - SUMMARY_TEXT("summary_text")
  - JsonValue; type "reasoning"constant
    
    The type of the object. Always reasoning.
    - REASONING("reasoning")
  - Optional<List<Content>> content
    
    Reasoning text content.
    - String text
      
      The reasoning text from the model.
    - JsonValue; type "reasoning_text"constant
      
      The type of the reasoning text. Always reasoning_text.
      - REASONING_TEXT("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.
    - 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.
    - SERVER("server")
    - CLIENT("client")
  - Status status
    
    The status of the tool search call item that was recorded.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - JsonValue; type "tool_search_call"constant
    
    The type of the item. Always tool_search_call.
    - TOOL_SEARCH_CALL("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.
    - SERVER("server")
    - CLIENT("client")
  - Status status
    
    The status of the tool search output item that was recorded.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - List<Tool> tools
    
    The loaded tool definitions returned by tool search.
    - 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
        
        The type of the function tool. Always function.
        
        FUNCTION("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
        
        The type of the file search tool. Always file_search.
        
        FILE_SEARCH("file_search")
      - List<String> vectorStoreIds
        
        The IDs of the vector stores to search.
      - Optional<Filters> filters
        
        A filter to apply.
        
        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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
        
        Type type
        
        Type of operation: and or or.
        
        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.
        
        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
        
        The type of the computer tool. Always computer.
        
        COMPUTER("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.
        
        WINDOWS("windows")
        
        MAC("mac")
        
        LINUX("linux")
        
        UBUNTU("ubuntu")
        
        BROWSER("browser")
      - JsonValue; type "computer_use_preview"constant
        
        The type of the computer use tool. Always computer_use_preview.
        
        COMPUTER_USE_PREVIEW("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.
        
        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.
        
        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.
        
        APPROXIMATE("approximate")
    - Mcp
      - String serverLabel
        
        A label for this MCP server, used to identify it in tool calls.
      - JsonValue; type "mcp"constant
        
        The type of the MCP tool. Always mcp.
        
        MCP("mcp")
      - Optional<AllowedTools> allowedTools
        
        List of allowed tool names or a filter object.
        
        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
        
        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.
        
        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.
        
        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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
      - JsonValue; type "code_interpreter"constant
        
        The type of the code interpreter tool. Always code_interpreter.
        
        CODE_INTERPRETER("code_interpreter")
    - ImageGeneration
      - JsonValue; type "image_generation"constant
        
        The type of the image generation tool. Always image_generation.
        
        IMAGE_GENERATION("image_generation")
      - Optional<Action> action
        
        Whether to generate a new image or edit an existing image. Default: auto.
        
        GENERATE("generate")
        
        EDIT("edit")
        
        AUTO("auto")
      - Optional<Background> background
        
        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.
        
        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.
        
        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.
        
        GPT_IMAGE_1("gpt-image-1")
        
        GPT_IMAGE_1_MINI("gpt-image-1-mini")
        
        GPT_IMAGE_2("gpt-image-2")
        
        GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
        
        GPT_IMAGE_1_5("gpt-image-1.5")
        
        CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
      - Optional<Moderation> moderation
        
        Moderation level for the generated image. Default: auto.
        
        AUTO("auto")
        
        LOW("low")
      - Optional<Long> outputCompression
        
        Compression level for the output image. Default: 100.
      - Optional<OutputFormat> outputFormat
        
        The output format of the generated image. One of png, webp, or jpeg. Default: png.
        
        PNG("png")
        
        WEBP("webp")
        
        JPEG("jpeg")
      - Optional<Long> partialImages
        
        Number of partial images to generate in streaming mode, from 0 (default value) to 3.
      - Optional<Quality> quality
        
        The quality of the generated image. One of low, medium, high, or auto. Default: auto.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        AUTO("auto")
      - Optional<Size> size
        
        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.
        
        _1024X1024("1024x1024")
        
        _1024X1536("1024x1536")
        
        _1536X1024("1536x1024")
        
        AUTO("auto")
    - JsonValue;
      - JsonValue; type "local_shell"constant
        
        The type of the local shell tool. Always local_shell.
        
        LOCAL_SHELL("local_shell")
    - class FunctionShellTool:
      
      A tool that allows the model to execute shell commands.
      - JsonValue; type "shell"constant
        
        The type of the shell tool. Always shell.
        
        SHELL("shell")
      - Optional<Environment> environment
        
        class ContainerAuto:
        
        JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
        
        Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
        
        class LocalEnvironment:
        
        JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
        
        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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
    - 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
        
        The type of the custom tool. Always custom.
        
        CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
        
        Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
    - class NamespaceTool:
      
      Groups function/custom tools under a shared namespace.
      - String description
        
        A description of the namespace shown to the model.
      - String name
        
        The namespace name used in tool calls (for example, crm).
      - List<Tool> tools
        
        The function/custom tools available inside this namespace.
        
        class Function:
        
        String name
        
        JsonValue; type "function"constant
        
        FUNCTION("function")
        
        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
      - JsonValue; type "namespace"constant
        
        The type of the tool. Always namespace.
        
        NAMESPACE("namespace")
    - class ToolSearchTool:
      
      Hosted or BYOT tool search configuration for deferred tools.
      - JsonValue; type "tool_search"constant
        
        The type of the tool. Always tool_search.
        
        TOOL_SEARCH("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.
        
        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.
        
        WEB_SEARCH_PREVIEW("web_search_preview")
        
        WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
      - Optional<List<SearchContentType>> searchContentTypes
        
        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.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
      - Optional<UserLocation> userLocation
        
        The user's location.
        
        JsonValue; type "approximate"constant
        
        The type of location approximation. Always approximate.
        
        APPROXIMATE("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
        
        The type of the tool. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
  - JsonValue; type "tool_search_output"constant
    
    The type of the item. Always tool_search_output.
    - TOOL_SEARCH_OUTPUT("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
    
    The type of the item. Always compaction.
    - COMPACTION("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.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - GENERATING("generating")
    - FAILED("failed")
  - JsonValue; type "image_generation_call"constant
    
    The type of the image generation call. Always image_generation_call.
    - IMAGE_GENERATION_CALL("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.
    - class Logs:
      
      The logs output from the code interpreter.
      - String logs
        
        The logs output from the code interpreter.
      - JsonValue; type "logs"constant
        
        The type of the output. Always logs.
        
        LOGS("logs")
    - class Image:
      
      The image output from the code interpreter.
      - JsonValue; type "image"constant
        
        The type of the output. Always image.
        
        IMAGE("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.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
    - INTERPRETING("interpreting")
    - FAILED("failed")
  - JsonValue; type "code_interpreter_call"constant
    
    The type of the code interpreter tool call. Always code_interpreter_call.
    - CODE_INTERPRETER_CALL("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
      
      The type of the local shell action. Always exec.
      - EXEC("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.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - JsonValue; type "local_shell_call"constant
    
    The type of the local shell call. Always local_shell_call.
    - LOCAL_SHELL_CALL("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
    
    The type of the local shell tool call output. Always local_shell_call_output.
    - LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
  - Optional<Status> status
    
    The status of the item. One of in_progress, completed, or incomplete.
    - 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.
    - class ResponseLocalEnvironment:
      
      Represents the use of a local environment to perform shell actions.
      - JsonValue; type "local"constant
        
        The environment type. Always local.
        
        LOCAL("local")
    - class ResponseContainerReference:
      
      Represents a container created with /v1/containers.
      - String containerId
      - JsonValue; type "container_reference"constant
        
        The environment type. Always container_reference.
        
        CONTAINER_REFERENCE("container_reference")
  - Status status
    
    The status of the shell call. One of in_progress, completed, or incomplete.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - JsonValue; type "shell_call"constant
    
    The type of the item. Always shell_call.
    - SHELL_CALL("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.
      - JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("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.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - JsonValue; type "shell_call_output"constant
    
    The type of the shell call output. Always shell_call_output.
    - SHELL_CALL_OUTPUT("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.
    - 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 a new file with the provided diff.
        
        CREATE_FILE("create_file")
    - 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 the specified file.
        
        DELETE_FILE("delete_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 an existing file with the provided diff.
        
        UPDATE_FILE("update_file")
  - Status status
    
    The status of the apply patch tool call. One of in_progress or completed.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
  - JsonValue; type "apply_patch_call"constant
    
    The type of the item. Always apply_patch_call.
    - APPLY_PATCH_CALL("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.
    - COMPLETED("completed")
    - FAILED("failed")
  - JsonValue; type "apply_patch_call_output"constant
    
    The type of the item. Always apply_patch_call_output.
    - APPLY_PATCH_CALL_OUTPUT("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
    
    The type of the item. Always mcp_call.
    - MCP_CALL("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.
    - 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
    
    The type of the item. Always mcp_list_tools.
    - MCP_LIST_TOOLS("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
    
    The type of the item. Always mcp_approval_request.
    - MCP_APPROVAL_REQUEST("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
    
    The type of the item. Always mcp_approval_response.
    - MCP_APPROVAL_RESPONSE("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
    
    The type of the custom tool call. Always custom_tool_call.
    - CUSTOM_TOOL_CALL("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.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - Optional<String> createdBy
    
    The identifier of the actor that created the item.

Response Output Item Added Event

class ResponseOutputItemAddedEvent:

Emitted when a new output item is added.
- ResponseOutputItem item
  
  The output item that was added.
  - 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.
      - class ResponseOutputText:
        
        A text output from the model.
        
        List<Annotation> annotations
        
        The annotations of the text output.
        
        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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
        
        String text
        
        The text output from the model.
        
        JsonValue; type "output_text"constant
        
        The type of the output text. Always output_text.
        
        OUTPUT_TEXT("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
        
        The type of the refusal. Always refusal.
        
        REFUSAL("refusal")
    - JsonValue; role "assistant"constant
      
      The role of the output message. Always assistant.
      - ASSISTANT("assistant")
    - Status status
      
      The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "message"constant
      
      The type of the output message. Always message.
      - MESSAGE("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.
      - 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,
      - IN_PROGRESS("in_progress")
      - SEARCHING("searching")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
      - FAILED("failed")
    - JsonValue; type "file_search_call"constant
      
      The type of the file search tool call. Always file_search_call.
      - FILE_SEARCH_CALL("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.
        
        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.
      - 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
      
      The type of the function tool call. Always function_call.
      - FUNCTION_CALL("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.
      - 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.
      - String
      - List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "function_call_output"constant
      
      The type of the function tool call output. Always function_call_output.
      - FUNCTION_CALL_OUTPUT("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).
      - class Search:
        
        Action type "search" - Performs a web search query.
        
        String query
        
        [DEPRECATED] The search query.
        
        JsonValue; type "search"constant
        
        The action type.
        
        SEARCH("search")
        
        Optional<List<String>> queries
        
        The search queries.
        
        Optional<List<Source>> sources
        
        The sources used in the search.
        
        JsonValue; type "url"constant
        
        The type of source. Always url.
        
        URL("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
        
        The action type.
        
        OPEN_PAGE("open_page")
        
        Optional<String> url
        
        The URL opened by the model.
      - 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
        
        The action type.
        
        FIND_IN_PAGE("find_in_page")
        
        String url
        
        The URL of the page searched for the pattern.
    - Status status
      
      The status of the web search tool call.
      - IN_PROGRESS("in_progress")
      - SEARCHING("searching")
      - COMPLETED("completed")
      - FAILED("failed")
    - JsonValue; type "web_search_call"constant
      
      The type of the web search tool call. Always web_search_call.
      - WEB_SEARCH_CALL("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - Type type
      
      The type of the computer call. Always computer_call.
      - COMPUTER_CALL("computer_call")
    - Optional<Action> action
      
      A click action.
      - class Click:
        
        A click action.
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
      - class Move:
        
        A mouse move action.
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
      - class Scroll:
        
        A scroll action.
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
      - JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
    - Optional<List<ComputerAction>> actions
      
      Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.
      - Click
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
      - Move
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
      - Scroll
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
      - JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
  - 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.
      - JsonValue; type "computer_screenshot"constant
        
        Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
        
        COMPUTER_SCREENSHOT("computer_screenshot")
      - Optional<String> fileId
        
        The identifier of an uploaded file that contains the screenshot.
      - Optional<String> imageUrl
        
        The URL of the screenshot image.
    - Status status
      
      The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
      - FAILED("failed")
      - IN_PROGRESS("in_progress")
    - JsonValue; type "computer_call_output"constant
      
      The type of the computer tool call output. Always computer_call_output.
      - COMPUTER_CALL_OUTPUT("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
        
        The type of the object. Always summary_text.
        
        SUMMARY_TEXT("summary_text")
    - JsonValue; type "reasoning"constant
      
      The type of the object. Always reasoning.
      - REASONING("reasoning")
    - Optional<List<Content>> content
      
      Reasoning text content.
      - String text
        
        The reasoning text from the model.
      - JsonValue; type "reasoning_text"constant
        
        The type of the reasoning text. Always reasoning_text.
        
        REASONING_TEXT("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.
      - 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.
      - SERVER("server")
      - CLIENT("client")
    - Status status
      
      The status of the tool search call item that was recorded.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "tool_search_call"constant
      
      The type of the item. Always tool_search_call.
      - TOOL_SEARCH_CALL("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.
      - SERVER("server")
      - CLIENT("client")
    - Status status
      
      The status of the tool search output item that was recorded.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - List<Tool> tools
      
      The loaded tool definitions returned by tool search.
      - 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
        
        The type of the function tool. Always function.
        
        FUNCTION("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
        
        The type of the file search tool. Always file_search.
        
        FILE_SEARCH("file_search")
        
        List<String> vectorStoreIds
        
        The IDs of the vector stores to search.
        
        Optional<Filters> filters
        
        A filter to apply.
        
        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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
        
        Type type
        
        Type of operation: and or or.
        
        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.
        
        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
        
        The type of the computer tool. Always computer.
        
        COMPUTER("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.
        
        WINDOWS("windows")
        
        MAC("mac")
        
        LINUX("linux")
        
        UBUNTU("ubuntu")
        
        BROWSER("browser")
        
        JsonValue; type "computer_use_preview"constant
        
        The type of the computer use tool. Always computer_use_preview.
        
        COMPUTER_USE_PREVIEW("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.
        
        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.
        
        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.
        
        APPROXIMATE("approximate")
      - Mcp
        
        String serverLabel
        
        A label for this MCP server, used to identify it in tool calls.
        
        JsonValue; type "mcp"constant
        
        The type of the MCP tool. Always mcp.
        
        MCP("mcp")
        
        Optional<AllowedTools> allowedTools
        
        List of allowed tool names or a filter object.
        
        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
        
        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.
        
        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.
        
        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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
        
        JsonValue; type "code_interpreter"constant
        
        The type of the code interpreter tool. Always code_interpreter.
        
        CODE_INTERPRETER("code_interpreter")
      - ImageGeneration
        
        JsonValue; type "image_generation"constant
        
        The type of the image generation tool. Always image_generation.
        
        IMAGE_GENERATION("image_generation")
        
        Optional<Action> action
        
        Whether to generate a new image or edit an existing image. Default: auto.
        
        GENERATE("generate")
        
        EDIT("edit")
        
        AUTO("auto")
        
        Optional<Background> background
        
        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.
        
        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.
        
        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.
        
        GPT_IMAGE_1("gpt-image-1")
        
        GPT_IMAGE_1_MINI("gpt-image-1-mini")
        
        GPT_IMAGE_2("gpt-image-2")
        
        GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
        
        GPT_IMAGE_1_5("gpt-image-1.5")
        
        CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
        
        Optional<Moderation> moderation
        
        Moderation level for the generated image. Default: auto.
        
        AUTO("auto")
        
        LOW("low")
        
        Optional<Long> outputCompression
        
        Compression level for the output image. Default: 100.
        
        Optional<OutputFormat> outputFormat
        
        The output format of the generated image. One of png, webp, or jpeg. Default: png.
        
        PNG("png")
        
        WEBP("webp")
        
        JPEG("jpeg")
        
        Optional<Long> partialImages
        
        Number of partial images to generate in streaming mode, from 0 (default value) to 3.
        
        Optional<Quality> quality
        
        The quality of the generated image. One of low, medium, high, or auto. Default: auto.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        AUTO("auto")
        
        Optional<Size> size
        
        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.
        
        _1024X1024("1024x1024")
        
        _1024X1536("1024x1536")
        
        _1536X1024("1536x1024")
        
        AUTO("auto")
      - JsonValue;
        
        JsonValue; type "local_shell"constant
        
        The type of the local shell tool. Always local_shell.
        
        LOCAL_SHELL("local_shell")
      - class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        JsonValue; type "shell"constant
        
        The type of the shell tool. Always shell.
        
        SHELL("shell")
        
        Optional<Environment> environment
        
        class ContainerAuto:
        
        JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
        
        Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
        
        class LocalEnvironment:
        
        JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
        
        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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
      - 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
        
        The type of the custom tool. Always custom.
        
        CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
        
        Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
      - class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        String description
        
        A description of the namespace shown to the model.
        
        String name
        
        The namespace name used in tool calls (for example, crm).
        
        List<Tool> tools
        
        The function/custom tools available inside this namespace.
        
        class Function:
        
        String name
        
        JsonValue; type "function"constant
        
        FUNCTION("function")
        
        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
        
        JsonValue; type "namespace"constant
        
        The type of the tool. Always namespace.
        
        NAMESPACE("namespace")
      - class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        JsonValue; type "tool_search"constant
        
        The type of the tool. Always tool_search.
        
        TOOL_SEARCH("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.
        
        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.
        
        WEB_SEARCH_PREVIEW("web_search_preview")
        
        WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
        
        Optional<List<SearchContentType>> searchContentTypes
        
        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.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        Optional<UserLocation> userLocation
        
        The user's location.
        
        JsonValue; type "approximate"constant
        
        The type of location approximation. Always approximate.
        
        APPROXIMATE("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
        
        The type of the tool. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
    - JsonValue; type "tool_search_output"constant
      
      The type of the item. Always tool_search_output.
      - TOOL_SEARCH_OUTPUT("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
      
      The type of the item. Always compaction.
      - COMPACTION("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - GENERATING("generating")
      - FAILED("failed")
    - JsonValue; type "image_generation_call"constant
      
      The type of the image generation call. Always image_generation_call.
      - IMAGE_GENERATION_CALL("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.
      - class Logs:
        
        The logs output from the code interpreter.
        
        String logs
        
        The logs output from the code interpreter.
        
        JsonValue; type "logs"constant
        
        The type of the output. Always logs.
        
        LOGS("logs")
      - class Image:
        
        The image output from the code interpreter.
        
        JsonValue; type "image"constant
        
        The type of the output. Always image.
        
        IMAGE("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
      - INTERPRETING("interpreting")
      - FAILED("failed")
    - JsonValue; type "code_interpreter_call"constant
      
      The type of the code interpreter tool call. Always code_interpreter_call.
      - CODE_INTERPRETER_CALL("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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "local_shell_call"constant
      
      The type of the local shell call. Always local_shell_call.
      - LOCAL_SHELL_CALL("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
      
      The type of the local shell tool call output. Always local_shell_call_output.
      - LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
    - Optional<Status> status
      
      The status of the item. One of in_progress, completed, or incomplete.
      - 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.
      - class ResponseLocalEnvironment:
        
        Represents the use of a local environment to perform shell actions.
        
        JsonValue; type "local"constant
        
        The environment type. Always local.
        
        LOCAL("local")
      - class ResponseContainerReference:
        
        Represents a container created with /v1/containers.
        
        String containerId
        
        JsonValue; type "container_reference"constant
        
        The environment type. Always container_reference.
        
        CONTAINER_REFERENCE("container_reference")
    - Status status
      
      The status of the shell call. One of in_progress, completed, or incomplete.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "shell_call"constant
      
      The type of the item. Always shell_call.
      - SHELL_CALL("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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "shell_call_output"constant
      
      The type of the shell call output. Always shell_call_output.
      - SHELL_CALL_OUTPUT("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.
      - 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 a new file with the provided diff.
        
        CREATE_FILE("create_file")
      - 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 the specified file.
        
        DELETE_FILE("delete_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 an existing file with the provided diff.
        
        UPDATE_FILE("update_file")
    - Status status
      
      The status of the apply patch tool call. One of in_progress or completed.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
    - JsonValue; type "apply_patch_call"constant
      
      The type of the item. Always apply_patch_call.
      - APPLY_PATCH_CALL("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.
      - COMPLETED("completed")
      - FAILED("failed")
    - JsonValue; type "apply_patch_call_output"constant
      
      The type of the item. Always apply_patch_call_output.
      - APPLY_PATCH_CALL_OUTPUT("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
      
      The type of the item. Always mcp_call.
      - MCP_CALL("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.
      - 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
      
      The type of the item. Always mcp_list_tools.
      - MCP_LIST_TOOLS("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
      
      The type of the item. Always mcp_approval_request.
      - MCP_APPROVAL_REQUEST("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
      
      The type of the item. Always mcp_approval_response.
      - MCP_APPROVAL_RESPONSE("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
      
      The type of the custom tool call. Always custom_tool_call.
      - CUSTOM_TOOL_CALL("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - Optional<String> createdBy
      
      The identifier of the actor that created the item.
- 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
  
  The type of the event. Always response.output_item.added.
  - RESPONSE_OUTPUT_ITEM_ADDED("response.output_item.added")

Response Output Item Done Event

class ResponseOutputItemDoneEvent:

Emitted when an output item is marked done.
- ResponseOutputItem item
  
  The output item that was marked 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.
      - class ResponseOutputText:
        
        A text output from the model.
        
        List<Annotation> annotations
        
        The annotations of the text output.
        
        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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
        
        String text
        
        The text output from the model.
        
        JsonValue; type "output_text"constant
        
        The type of the output text. Always output_text.
        
        OUTPUT_TEXT("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
        
        The type of the refusal. Always refusal.
        
        REFUSAL("refusal")
    - JsonValue; role "assistant"constant
      
      The role of the output message. Always assistant.
      - ASSISTANT("assistant")
    - Status status
      
      The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "message"constant
      
      The type of the output message. Always message.
      - MESSAGE("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.
      - 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,
      - IN_PROGRESS("in_progress")
      - SEARCHING("searching")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
      - FAILED("failed")
    - JsonValue; type "file_search_call"constant
      
      The type of the file search tool call. Always file_search_call.
      - FILE_SEARCH_CALL("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.
        
        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.
      - 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
      
      The type of the function tool call. Always function_call.
      - FUNCTION_CALL("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.
      - 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.
      - String
      - List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "function_call_output"constant
      
      The type of the function tool call output. Always function_call_output.
      - FUNCTION_CALL_OUTPUT("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).
      - class Search:
        
        Action type "search" - Performs a web search query.
        
        String query
        
        [DEPRECATED] The search query.
        
        JsonValue; type "search"constant
        
        The action type.
        
        SEARCH("search")
        
        Optional<List<String>> queries
        
        The search queries.
        
        Optional<List<Source>> sources
        
        The sources used in the search.
        
        JsonValue; type "url"constant
        
        The type of source. Always url.
        
        URL("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
        
        The action type.
        
        OPEN_PAGE("open_page")
        
        Optional<String> url
        
        The URL opened by the model.
      - 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
        
        The action type.
        
        FIND_IN_PAGE("find_in_page")
        
        String url
        
        The URL of the page searched for the pattern.
    - Status status
      
      The status of the web search tool call.
      - IN_PROGRESS("in_progress")
      - SEARCHING("searching")
      - COMPLETED("completed")
      - FAILED("failed")
    - JsonValue; type "web_search_call"constant
      
      The type of the web search tool call. Always web_search_call.
      - WEB_SEARCH_CALL("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - Type type
      
      The type of the computer call. Always computer_call.
      - COMPUTER_CALL("computer_call")
    - Optional<Action> action
      
      A click action.
      - class Click:
        
        A click action.
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
      - class Move:
        
        A mouse move action.
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
      - class Scroll:
        
        A scroll action.
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
      - JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
    - Optional<List<ComputerAction>> actions
      
      Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.
      - Click
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
      - Move
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
      - Scroll
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
      - JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
  - 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.
      - JsonValue; type "computer_screenshot"constant
        
        Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
        
        COMPUTER_SCREENSHOT("computer_screenshot")
      - Optional<String> fileId
        
        The identifier of an uploaded file that contains the screenshot.
      - Optional<String> imageUrl
        
        The URL of the screenshot image.
    - Status status
      
      The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
      - FAILED("failed")
      - IN_PROGRESS("in_progress")
    - JsonValue; type "computer_call_output"constant
      
      The type of the computer tool call output. Always computer_call_output.
      - COMPUTER_CALL_OUTPUT("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
        
        The type of the object. Always summary_text.
        
        SUMMARY_TEXT("summary_text")
    - JsonValue; type "reasoning"constant
      
      The type of the object. Always reasoning.
      - REASONING("reasoning")
    - Optional<List<Content>> content
      
      Reasoning text content.
      - String text
        
        The reasoning text from the model.
      - JsonValue; type "reasoning_text"constant
        
        The type of the reasoning text. Always reasoning_text.
        
        REASONING_TEXT("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.
      - 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.
      - SERVER("server")
      - CLIENT("client")
    - Status status
      
      The status of the tool search call item that was recorded.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "tool_search_call"constant
      
      The type of the item. Always tool_search_call.
      - TOOL_SEARCH_CALL("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.
      - SERVER("server")
      - CLIENT("client")
    - Status status
      
      The status of the tool search output item that was recorded.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - List<Tool> tools
      
      The loaded tool definitions returned by tool search.
      - 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
        
        The type of the function tool. Always function.
        
        FUNCTION("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
        
        The type of the file search tool. Always file_search.
        
        FILE_SEARCH("file_search")
        
        List<String> vectorStoreIds
        
        The IDs of the vector stores to search.
        
        Optional<Filters> filters
        
        A filter to apply.
        
        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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
        
        Type type
        
        Type of operation: and or or.
        
        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.
        
        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
        
        The type of the computer tool. Always computer.
        
        COMPUTER("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.
        
        WINDOWS("windows")
        
        MAC("mac")
        
        LINUX("linux")
        
        UBUNTU("ubuntu")
        
        BROWSER("browser")
        
        JsonValue; type "computer_use_preview"constant
        
        The type of the computer use tool. Always computer_use_preview.
        
        COMPUTER_USE_PREVIEW("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.
        
        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.
        
        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.
        
        APPROXIMATE("approximate")
      - Mcp
        
        String serverLabel
        
        A label for this MCP server, used to identify it in tool calls.
        
        JsonValue; type "mcp"constant
        
        The type of the MCP tool. Always mcp.
        
        MCP("mcp")
        
        Optional<AllowedTools> allowedTools
        
        List of allowed tool names or a filter object.
        
        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
        
        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.
        
        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.
        
        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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
        
        JsonValue; type "code_interpreter"constant
        
        The type of the code interpreter tool. Always code_interpreter.
        
        CODE_INTERPRETER("code_interpreter")
      - ImageGeneration
        
        JsonValue; type "image_generation"constant
        
        The type of the image generation tool. Always image_generation.
        
        IMAGE_GENERATION("image_generation")
        
        Optional<Action> action
        
        Whether to generate a new image or edit an existing image. Default: auto.
        
        GENERATE("generate")
        
        EDIT("edit")
        
        AUTO("auto")
        
        Optional<Background> background
        
        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.
        
        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.
        
        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.
        
        GPT_IMAGE_1("gpt-image-1")
        
        GPT_IMAGE_1_MINI("gpt-image-1-mini")
        
        GPT_IMAGE_2("gpt-image-2")
        
        GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
        
        GPT_IMAGE_1_5("gpt-image-1.5")
        
        CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
        
        Optional<Moderation> moderation
        
        Moderation level for the generated image. Default: auto.
        
        AUTO("auto")
        
        LOW("low")
        
        Optional<Long> outputCompression
        
        Compression level for the output image. Default: 100.
        
        Optional<OutputFormat> outputFormat
        
        The output format of the generated image. One of png, webp, or jpeg. Default: png.
        
        PNG("png")
        
        WEBP("webp")
        
        JPEG("jpeg")
        
        Optional<Long> partialImages
        
        Number of partial images to generate in streaming mode, from 0 (default value) to 3.
        
        Optional<Quality> quality
        
        The quality of the generated image. One of low, medium, high, or auto. Default: auto.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        AUTO("auto")
        
        Optional<Size> size
        
        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.
        
        _1024X1024("1024x1024")
        
        _1024X1536("1024x1536")
        
        _1536X1024("1536x1024")
        
        AUTO("auto")
      - JsonValue;
        
        JsonValue; type "local_shell"constant
        
        The type of the local shell tool. Always local_shell.
        
        LOCAL_SHELL("local_shell")
      - class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        JsonValue; type "shell"constant
        
        The type of the shell tool. Always shell.
        
        SHELL("shell")
        
        Optional<Environment> environment
        
        class ContainerAuto:
        
        JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
        
        Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
        
        class LocalEnvironment:
        
        JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
        
        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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
      - 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
        
        The type of the custom tool. Always custom.
        
        CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
        
        Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
      - class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        String description
        
        A description of the namespace shown to the model.
        
        String name
        
        The namespace name used in tool calls (for example, crm).
        
        List<Tool> tools
        
        The function/custom tools available inside this namespace.
        
        class Function:
        
        String name
        
        JsonValue; type "function"constant
        
        FUNCTION("function")
        
        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
        
        JsonValue; type "namespace"constant
        
        The type of the tool. Always namespace.
        
        NAMESPACE("namespace")
      - class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        JsonValue; type "tool_search"constant
        
        The type of the tool. Always tool_search.
        
        TOOL_SEARCH("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.
        
        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.
        
        WEB_SEARCH_PREVIEW("web_search_preview")
        
        WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
        
        Optional<List<SearchContentType>> searchContentTypes
        
        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.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        Optional<UserLocation> userLocation
        
        The user's location.
        
        JsonValue; type "approximate"constant
        
        The type of location approximation. Always approximate.
        
        APPROXIMATE("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
        
        The type of the tool. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
    - JsonValue; type "tool_search_output"constant
      
      The type of the item. Always tool_search_output.
      - TOOL_SEARCH_OUTPUT("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
      
      The type of the item. Always compaction.
      - COMPACTION("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - GENERATING("generating")
      - FAILED("failed")
    - JsonValue; type "image_generation_call"constant
      
      The type of the image generation call. Always image_generation_call.
      - IMAGE_GENERATION_CALL("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.
      - class Logs:
        
        The logs output from the code interpreter.
        
        String logs
        
        The logs output from the code interpreter.
        
        JsonValue; type "logs"constant
        
        The type of the output. Always logs.
        
        LOGS("logs")
      - class Image:
        
        The image output from the code interpreter.
        
        JsonValue; type "image"constant
        
        The type of the output. Always image.
        
        IMAGE("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
      - INTERPRETING("interpreting")
      - FAILED("failed")
    - JsonValue; type "code_interpreter_call"constant
      
      The type of the code interpreter tool call. Always code_interpreter_call.
      - CODE_INTERPRETER_CALL("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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "local_shell_call"constant
      
      The type of the local shell call. Always local_shell_call.
      - LOCAL_SHELL_CALL("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
      
      The type of the local shell tool call output. Always local_shell_call_output.
      - LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
    - Optional<Status> status
      
      The status of the item. One of in_progress, completed, or incomplete.
      - 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.
      - class ResponseLocalEnvironment:
        
        Represents the use of a local environment to perform shell actions.
        
        JsonValue; type "local"constant
        
        The environment type. Always local.
        
        LOCAL("local")
      - class ResponseContainerReference:
        
        Represents a container created with /v1/containers.
        
        String containerId
        
        JsonValue; type "container_reference"constant
        
        The environment type. Always container_reference.
        
        CONTAINER_REFERENCE("container_reference")
    - Status status
      
      The status of the shell call. One of in_progress, completed, or incomplete.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "shell_call"constant
      
      The type of the item. Always shell_call.
      - SHELL_CALL("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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "shell_call_output"constant
      
      The type of the shell call output. Always shell_call_output.
      - SHELL_CALL_OUTPUT("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.
      - 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 a new file with the provided diff.
        
        CREATE_FILE("create_file")
      - 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 the specified file.
        
        DELETE_FILE("delete_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 an existing file with the provided diff.
        
        UPDATE_FILE("update_file")
    - Status status
      
      The status of the apply patch tool call. One of in_progress or completed.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
    - JsonValue; type "apply_patch_call"constant
      
      The type of the item. Always apply_patch_call.
      - APPLY_PATCH_CALL("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.
      - COMPLETED("completed")
      - FAILED("failed")
    - JsonValue; type "apply_patch_call_output"constant
      
      The type of the item. Always apply_patch_call_output.
      - APPLY_PATCH_CALL_OUTPUT("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
      
      The type of the item. Always mcp_call.
      - MCP_CALL("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.
      - 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
      
      The type of the item. Always mcp_list_tools.
      - MCP_LIST_TOOLS("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
      
      The type of the item. Always mcp_approval_request.
      - MCP_APPROVAL_REQUEST("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
      
      The type of the item. Always mcp_approval_response.
      - MCP_APPROVAL_RESPONSE("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
      
      The type of the custom tool call. Always custom_tool_call.
      - CUSTOM_TOOL_CALL("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - Optional<String> createdBy
      
      The identifier of the actor that created the item.
- 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
  
  The type of the event. Always response.output_item.done.
  - RESPONSE_OUTPUT_ITEM_DONE("response.output_item.done")

Response Output 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.
  - class ResponseOutputText:
    
    A text output from the model.
    - List<Annotation> annotations
      
      The annotations of the text output.
      - 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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
    - String text
      
      The text output from the model.
    - JsonValue; type "output_text"constant
      
      The type of the output text. Always output_text.
      - OUTPUT_TEXT("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
      
      The type of the refusal. Always refusal.
      - REFUSAL("refusal")
- JsonValue; role "assistant"constant
  
  The role of the output message. Always assistant.
  - ASSISTANT("assistant")
- Status status
  
  The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
  - IN_PROGRESS("in_progress")
  - COMPLETED("completed")
  - INCOMPLETE("incomplete")
- JsonValue; type "message"constant
  
  The type of the output message. Always message.
  - MESSAGE("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.
  - COMMENTARY("commentary")
  - FINAL_ANSWER("final_answer")

Response Output Refusal

class ResponseOutputRefusal:

A refusal from the model.
- String refusal
  
  The refusal explanation from the model.
- JsonValue; type "refusal"constant
  
  The type of the refusal. Always refusal.
  - REFUSAL("refusal")

Response Output Text

class ResponseOutputText:

A text output from the model.
- List<Annotation> annotations
  
  The annotations of the text output.
  - 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
      
      The type of the file citation. Always file_citation.
      - FILE_CITATION("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
      
      The type of the URL citation. Always url_citation.
      - URL_CITATION("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
      
      The type of the container file citation. Always container_file_citation.
      - CONTAINER_FILE_CITATION("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
      
      The type of the file path. Always file_path.
      - FILE_PATH("file_path")
- String text
  
  The text output from the model.
- JsonValue; type "output_text"constant
  
  The type of the output text. Always output_text.
  - OUTPUT_TEXT("output_text")
- Optional<List<Logprob>> logprobs
  - String token
  - List<long> bytes
  - double logprob
  - List<TopLogprob> topLogprobs
    - String token
    - List<long> bytes
    - double logprob

Response Output Text Annotation Added Event

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
  
  The type of the event. Always 'response.output_text.annotation.added'.
  - RESPONSE_OUTPUT_TEXT_ANNOTATION_ADDED("response.output_text.annotation.added")

Response Prompt

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.
  - String
  - class ResponseInputText:
    
    A text input to the model.
    - String text
      
      The text input to the model.
    - JsonValue; type "input_text"constant
      
      The type of the input item. Always input_text.
      - INPUT_TEXT("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.
      - LOW("low")
      - HIGH("high")
      - AUTO("auto")
      - ORIGINAL("original")
    - JsonValue; type "input_image"constant
      
      The type of the input item. Always input_image.
      - INPUT_IMAGE("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
      
      The type of the input item. Always input_file.
      - INPUT_FILE("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.
      - 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.

Response Queued Event

class ResponseQueuedEvent:

Emitted when a response is queued and waiting to be processed.
- Response response
  
  The full response object that is queued.
  - 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.
    - Code code
      
      The error code for the response.
      - 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.
  - Optional<IncompleteDetails> incompleteDetails
    
    Details about why the response is incomplete.
    - Optional<Reason> reason
      
      The reason why the response is incomplete.
      - 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.
    - String
    - List<ResponseInputItem>
      - 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.
        
        String
        
        List<ResponseInputContent>
        
        class ResponseInputText:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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.
        
        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.
        
        COMMENTARY("commentary")
        
        FINAL_ANSWER("final_answer")
        
        Optional<Type> type
        
        The type of the message input. Always message.
        
        MESSAGE("message")
      - Message
        
        List<ResponseInputContent> content
        
        A list of one or many input items to the model, containing different content types.
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
        
        Role role
        
        The role of the message input. One of user, system, or developer.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        Optional<Type> type
        
        The type of the message input. Always set to message.
        
        MESSAGE("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.
        
        class ResponseOutputText:
        
        A text output from the model.
        
        List<Annotation> annotations
        
        The annotations of the text output.
        
        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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
        
        String text
        
        The text output from the model.
        
        JsonValue; type "output_text"constant
        
        The type of the output text. Always output_text.
        
        OUTPUT_TEXT("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
        
        The type of the refusal. Always refusal.
        
        REFUSAL("refusal")
        
        JsonValue; role "assistant"constant
        
        The role of the output message. Always assistant.
        
        ASSISTANT("assistant")
        
        Status status
        
        The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        JsonValue; type "message"constant
        
        The type of the output message. Always message.
        
        MESSAGE("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.
        
        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,
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        FAILED("failed")
        
        JsonValue; type "file_search_call"constant
        
        The type of the file search tool call. Always file_search_call.
        
        FILE_SEARCH_CALL("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.
        
        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.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        Type type
        
        The type of the computer call. Always computer_call.
        
        COMPUTER_CALL("computer_call")
        
        Optional<Action> action
        
        A click action.
        
        class Click:
        
        A click action.
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        class Move:
        
        A mouse move action.
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        class Scroll:
        
        A scroll action.
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
        
        Optional<List<ComputerAction>> actions
        
        Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.
        
        Click
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        Move
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        Scroll
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
      - ComputerCallOutput
        
        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.
        
        JsonValue; type "computer_screenshot"constant
        
        Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
        
        COMPUTER_SCREENSHOT("computer_screenshot")
        
        Optional<String> fileId
        
        The identifier of an uploaded file that contains the screenshot.
        
        Optional<String> imageUrl
        
        The URL of the screenshot image.
        
        JsonValue; type "computer_call_output"constant
        
        The type of the computer tool call output. Always computer_call_output.
        
        COMPUTER_CALL_OUTPUT("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.
        
        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).
        
        class Search:
        
        Action type "search" - Performs a web search query.
        
        String query
        
        [DEPRECATED] The search query.
        
        JsonValue; type "search"constant
        
        The action type.
        
        SEARCH("search")
        
        Optional<List<String>> queries
        
        The search queries.
        
        Optional<List<Source>> sources
        
        The sources used in the search.
        
        JsonValue; type "url"constant
        
        The type of source. Always url.
        
        URL("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
        
        The action type.
        
        OPEN_PAGE("open_page")
        
        Optional<String> url
        
        The URL opened by the model.
        
        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
        
        The action type.
        
        FIND_IN_PAGE("find_in_page")
        
        String url
        
        The URL of the page searched for the pattern.
        
        Status status
        
        The status of the web search tool call.
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        FAILED("failed")
        
        JsonValue; type "web_search_call"constant
        
        The type of the web search tool call. Always web_search_call.
        
        WEB_SEARCH_CALL("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
        
        The type of the function tool call. Always function_call.
        
        FUNCTION_CALL("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - FunctionCallOutput
        
        String callId
        
        The unique ID of the function tool call generated by the model.
        
        Output output
        
        Text, image, or file output of the function tool call.
        
        String
        
        List<ResponseFunctionCallOutputItem>
        
        class ResponseInputTextContent:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("input_text")
        
        class ResponseInputImageContent:
        
        An image input to the model. Learn about image inputs
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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.
        
        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.
        
        class ResponseInputFileContent:
        
        A file input to the model.
        
        JsonValue; type "input_file"constant
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        LOW("low")
        
        HIGH("high")
        
        Optional<String> fileData
        
        The base64-encoded data 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 "function_call_output"constant
        
        The type of the function tool call output. Always function_call_output.
        
        FUNCTION_CALL_OUTPUT("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.
        
        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
        
        The item type. Always tool_search_call.
        
        TOOL_SEARCH_CALL("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.
        
        Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
        
        Optional<Status> status
        
        The status of the tool search call.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - class ResponseToolSearchOutputItemParam:
        
        List<Tool> tools
        
        The loaded tool definitions returned by the tool search output.
        
        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
        
        The type of the function tool. Always function.
        
        FUNCTION("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
        
        The type of the file search tool. Always file_search.
        
        FILE_SEARCH("file_search")
        
        List<String> vectorStoreIds
        
        The IDs of the vector stores to search.
        
        Optional<Filters> filters
        
        A filter to apply.
        
        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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
        
        Type type
        
        Type of operation: and or or.
        
        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.
        
        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
        
        The type of the computer tool. Always computer.
        
        COMPUTER("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.
        
        WINDOWS("windows")
        
        MAC("mac")
        
        LINUX("linux")
        
        UBUNTU("ubuntu")
        
        BROWSER("browser")
        
        JsonValue; type "computer_use_preview"constant
        
        The type of the computer use tool. Always computer_use_preview.
        
        COMPUTER_USE_PREVIEW("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.
        
        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.
        
        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.
        
        APPROXIMATE("approximate")
        
        Mcp
        
        String serverLabel
        
        A label for this MCP server, used to identify it in tool calls.
        
        JsonValue; type "mcp"constant
        
        The type of the MCP tool. Always mcp.
        
        MCP("mcp")
        
        Optional<AllowedTools> allowedTools
        
        List of allowed tool names or a filter object.
        
        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
        
        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.
        
        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.
        
        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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
        
        JsonValue; type "code_interpreter"constant
        
        The type of the code interpreter tool. Always code_interpreter.
        
        CODE_INTERPRETER("code_interpreter")
        
        ImageGeneration
        
        JsonValue; type "image_generation"constant
        
        The type of the image generation tool. Always image_generation.
        
        IMAGE_GENERATION("image_generation")
        
        Optional<Action> action
        
        Whether to generate a new image or edit an existing image. Default: auto.
        
        GENERATE("generate")
        
        EDIT("edit")
        
        AUTO("auto")
        
        Optional<Background> background
        
        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.
        
        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.
        
        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.
        
        GPT_IMAGE_1("gpt-image-1")
        
        GPT_IMAGE_1_MINI("gpt-image-1-mini")
        
        GPT_IMAGE_2("gpt-image-2")
        
        GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
        
        GPT_IMAGE_1_5("gpt-image-1.5")
        
        CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
        
        Optional<Moderation> moderation
        
        Moderation level for the generated image. Default: auto.
        
        AUTO("auto")
        
        LOW("low")
        
        Optional<Long> outputCompression
        
        Compression level for the output image. Default: 100.
        
        Optional<OutputFormat> outputFormat
        
        The output format of the generated image. One of png, webp, or jpeg. Default: png.
        
        PNG("png")
        
        WEBP("webp")
        
        JPEG("jpeg")
        
        Optional<Long> partialImages
        
        Number of partial images to generate in streaming mode, from 0 (default value) to 3.
        
        Optional<Quality> quality
        
        The quality of the generated image. One of low, medium, high, or auto. Default: auto.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        AUTO("auto")
        
        Optional<Size> size
        
        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.
        
        _1024X1024("1024x1024")
        
        _1024X1536("1024x1536")
        
        _1536X1024("1536x1024")
        
        AUTO("auto")
        
        JsonValue;
        
        JsonValue; type "local_shell"constant
        
        The type of the local shell tool. Always local_shell.
        
        LOCAL_SHELL("local_shell")
        
        class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        JsonValue; type "shell"constant
        
        The type of the shell tool. Always shell.
        
        SHELL("shell")
        
        Optional<Environment> environment
        
        class ContainerAuto:
        
        JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
        
        Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
        
        class LocalEnvironment:
        
        JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
        
        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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
        
        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
        
        The type of the custom tool. Always custom.
        
        CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
        
        Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
        
        class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        String description
        
        A description of the namespace shown to the model.
        
        String name
        
        The namespace name used in tool calls (for example, crm).
        
        List<Tool> tools
        
        The function/custom tools available inside this namespace.
        
        class Function:
        
        String name
        
        JsonValue; type "function"constant
        
        FUNCTION("function")
        
        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
        
        JsonValue; type "namespace"constant
        
        The type of the tool. Always namespace.
        
        NAMESPACE("namespace")
        
        class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        JsonValue; type "tool_search"constant
        
        The type of the tool. Always tool_search.
        
        TOOL_SEARCH("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.
        
        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.
        
        WEB_SEARCH_PREVIEW("web_search_preview")
        
        WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
        
        Optional<List<SearchContentType>> searchContentTypes
        
        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.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        Optional<UserLocation> userLocation
        
        The user's location.
        
        JsonValue; type "approximate"constant
        
        The type of location approximation. Always approximate.
        
        APPROXIMATE("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
        
        The type of the tool. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
        
        JsonValue; type "tool_search_output"constant
        
        The item type. Always tool_search_output.
        
        TOOL_SEARCH_OUTPUT("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.
        
        Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
        
        Optional<Status> status
        
        The status of the tool search output.
        
        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
        
        The type of the object. Always summary_text.
        
        SUMMARY_TEXT("summary_text")
        
        JsonValue; type "reasoning"constant
        
        The type of the object. Always reasoning.
        
        REASONING("reasoning")
        
        Optional<List<Content>> content
        
        Reasoning text content.
        
        String text
        
        The reasoning text from the model.
        
        JsonValue; type "reasoning_text"constant
        
        The type of the reasoning text. Always reasoning_text.
        
        REASONING_TEXT("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.
        
        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.
        
        JsonValue; type "compaction"constant
        
        The type of the item. Always compaction.
        
        COMPACTION("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        GENERATING("generating")
        
        FAILED("failed")
        
        JsonValue; type "image_generation_call"constant
        
        The type of the image generation call. Always image_generation_call.
        
        IMAGE_GENERATION_CALL("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.
        
        class Logs:
        
        The logs output from the code interpreter.
        
        String logs
        
        The logs output from the code interpreter.
        
        JsonValue; type "logs"constant
        
        The type of the output. Always logs.
        
        LOGS("logs")
        
        class Image:
        
        The image output from the code interpreter.
        
        JsonValue; type "image"constant
        
        The type of the output. Always image.
        
        IMAGE("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        INTERPRETING("interpreting")
        
        FAILED("failed")
        
        JsonValue; type "code_interpreter_call"constant
        
        The type of the code interpreter tool call. Always code_interpreter_call.
        
        CODE_INTERPRETER_CALL("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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        JsonValue; type "local_shell_call"constant
        
        The type of the local shell call. Always local_shell_call.
        
        LOCAL_SHELL_CALL("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
        
        The type of the local shell tool call output. Always local_shell_call_output.
        
        LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
        
        Optional<Status> status
        
        The status of the item. One of in_progress, completed, or incomplete.
        
        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.
        
        JsonValue; type "shell_call"constant
        
        The type of the item. Always shell_call.
        
        SHELL_CALL("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.
        
        class LocalEnvironment:
        
        class ContainerReference:
        
        Optional<Status> status
        
        The status of the shell call. One of in_progress, completed, or incomplete.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - ShellCallOutput
        
        String callId
        
        The unique ID of the shell tool call generated by the model.
        
        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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("exit")
        
        String stderr
        
        Captured stderr output for the shell call.
        
        String stdout
        
        Captured stdout output for the shell call.
        
        JsonValue; type "shell_call_output"constant
        
        The type of the item. Always shell_call_output.
        
        SHELL_CALL_OUTPUT("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - ApplyPatchCall
        
        String callId
        
        The unique ID of the apply patch tool call generated by the model.
        
        Operation operation
        
        The specific create, delete, or update instruction for the apply_patch tool call.
        
        class CreateFile:
        
        Instruction for creating a new file via the apply_patch tool.
        
        String diff
        
        Unified diff content to apply when creating the file.
        
        String path
        
        Path of the file to create relative to the workspace root.
        
        JsonValue; type "create_file"constant
        
        The operation type. Always create_file.
        
        CREATE_FILE("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.
        
        JsonValue; type "delete_file"constant
        
        The operation type. Always delete_file.
        
        DELETE_FILE("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.
        
        String path
        
        Path of the file to update relative to the workspace root.
        
        JsonValue; type "update_file"constant
        
        The operation type. Always update_file.
        
        UPDATE_FILE("update_file")
        
        Status status
        
        The status of the apply patch tool call. One of in_progress or completed.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        JsonValue; type "apply_patch_call"constant
        
        The type of the item. Always apply_patch_call.
        
        APPLY_PATCH_CALL("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.
        
        Status status
        
        The status of the apply patch tool call output. One of completed or failed.
        
        COMPLETED("completed")
        
        FAILED("failed")
        
        JsonValue; type "apply_patch_call_output"constant
        
        The type of the item. Always apply_patch_call_output.
        
        APPLY_PATCH_CALL_OUTPUT("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).
      - 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
        
        The type of the item. Always mcp_list_tools.
        
        MCP_LIST_TOOLS("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
        
        The type of the item. Always mcp_approval_request.
        
        MCP_APPROVAL_REQUEST("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
        
        The type of the item. Always mcp_approval_response.
        
        MCP_APPROVAL_RESPONSE("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
        
        The type of the item. Always mcp_call.
        
        MCP_CALL("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.
        
        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.
        
        String
        
        List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
        
        JsonValue; type "custom_tool_call_output"constant
        
        The type of the custom tool call output. Always custom_tool_call_output.
        
        CUSTOM_TOOL_CALL_OUTPUT("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
        
        The type of the custom tool call. Always custom_tool_call.
        
        CUSTOM_TOOL_CALL("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.
      - JsonValue;
        
        JsonValue; type "compaction_trigger"constant
        
        The type of the item. Always compaction_trigger.
        
        COMPACTION_TRIGGER("compaction_trigger")
      - ItemReference
        
        String id
        
        The ID of the item to reference.
        
        Optional<Type> type
        
        The type of item to reference. Always item_reference.
        
        ITEM_REFERENCE("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.
    - String
    - enum ChatModel:
      - GPT_5_4("gpt-5.4")
      - GPT_5_4_MINI("gpt-5.4-mini")
      - GPT_5_4_NANO("gpt-5.4-nano")
      - GPT_5_4_MINI_2026_03_17("gpt-5.4-mini-2026-03-17")
      - GPT_5_4_NANO_2026_03_17("gpt-5.4-nano-2026-03-17")
      - GPT_5_3_CHAT_LATEST("gpt-5.3-chat-latest")
      - GPT_5_2("gpt-5.2")
      - GPT_5_2_2025_12_11("gpt-5.2-2025-12-11")
      - GPT_5_2_CHAT_LATEST("gpt-5.2-chat-latest")
      - GPT_5_2_PRO("gpt-5.2-pro")
      - GPT_5_2_PRO_2025_12_11("gpt-5.2-pro-2025-12-11")
      - GPT_5_1("gpt-5.1")
      - GPT_5_1_2025_11_13("gpt-5.1-2025-11-13")
      - GPT_5_1_CODEX("gpt-5.1-codex")
      - GPT_5_1_MINI("gpt-5.1-mini")
      - GPT_5_1_CHAT_LATEST("gpt-5.1-chat-latest")
      - GPT_5("gpt-5")
      - GPT_5_MINI("gpt-5-mini")
      - GPT_5_NANO("gpt-5-nano")
      - GPT_5_2025_08_07("gpt-5-2025-08-07")
      - GPT_5_MINI_2025_08_07("gpt-5-mini-2025-08-07")
      - GPT_5_NANO_2025_08_07("gpt-5-nano-2025-08-07")
      - GPT_5_CHAT_LATEST("gpt-5-chat-latest")
      - GPT_4_1("gpt-4.1")
      - GPT_4_1_MINI("gpt-4.1-mini")
      - GPT_4_1_NANO("gpt-4.1-nano")
      - GPT_4_1_2025_04_14("gpt-4.1-2025-04-14")
      - GPT_4_1_MINI_2025_04_14("gpt-4.1-mini-2025-04-14")
      - GPT_4_1_NANO_2025_04_14("gpt-4.1-nano-2025-04-14")
      - O4_MINI("o4-mini")
      - O4_MINI_2025_04_16("o4-mini-2025-04-16")
      - O3("o3")
      - O3_2025_04_16("o3-2025-04-16")
      - O3_MINI("o3-mini")
      - O3_MINI_2025_01_31("o3-mini-2025-01-31")
      - O1("o1")
      - O1_2024_12_17("o1-2024-12-17")
      - O1_PREVIEW("o1-preview")
      - O1_PREVIEW_2024_09_12("o1-preview-2024-09-12")
      - O1_MINI("o1-mini")
      - O1_MINI_2024_09_12("o1-mini-2024-09-12")
      - GPT_4O("gpt-4o")
      - GPT_4O_2024_11_20("gpt-4o-2024-11-20")
      - GPT_4O_2024_08_06("gpt-4o-2024-08-06")
      - GPT_4O_2024_05_13("gpt-4o-2024-05-13")
      - GPT_4O_AUDIO_PREVIEW("gpt-4o-audio-preview")
      - GPT_4O_AUDIO_PREVIEW_2024_10_01("gpt-4o-audio-preview-2024-10-01")
      - GPT_4O_AUDIO_PREVIEW_2024_12_17("gpt-4o-audio-preview-2024-12-17")
      - GPT_4O_AUDIO_PREVIEW_2025_06_03("gpt-4o-audio-preview-2025-06-03")
      - GPT_4O_MINI_AUDIO_PREVIEW("gpt-4o-mini-audio-preview")
      - GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17("gpt-4o-mini-audio-preview-2024-12-17")
      - GPT_4O_SEARCH_PREVIEW("gpt-4o-search-preview")
      - GPT_4O_MINI_SEARCH_PREVIEW("gpt-4o-mini-search-preview")
      - GPT_4O_SEARCH_PREVIEW_2025_03_11("gpt-4o-search-preview-2025-03-11")
      - GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11("gpt-4o-mini-search-preview-2025-03-11")
      - CHATGPT_4O_LATEST("chatgpt-4o-latest")
      - CODEX_MINI_LATEST("codex-mini-latest")
      - GPT_4O_MINI("gpt-4o-mini")
      - GPT_4O_MINI_2024_07_18("gpt-4o-mini-2024-07-18")
      - GPT_4_TURBO("gpt-4-turbo")
      - GPT_4_TURBO_2024_04_09("gpt-4-turbo-2024-04-09")
      - GPT_4_0125_PREVIEW("gpt-4-0125-preview")
      - GPT_4_TURBO_PREVIEW("gpt-4-turbo-preview")
      - GPT_4_1106_PREVIEW("gpt-4-1106-preview")
      - GPT_4_VISION_PREVIEW("gpt-4-vision-preview")
      - GPT_4("gpt-4")
      - GPT_4_0314("gpt-4-0314")
      - GPT_4_0613("gpt-4-0613")
      - GPT_4_32K("gpt-4-32k")
      - GPT_4_32K_0314("gpt-4-32k-0314")
      - GPT_4_32K_0613("gpt-4-32k-0613")
      - GPT_3_5_TURBO("gpt-3.5-turbo")
      - GPT_3_5_TURBO_16K("gpt-3.5-turbo-16k")
      - GPT_3_5_TURBO_0301("gpt-3.5-turbo-0301")
      - GPT_3_5_TURBO_0613("gpt-3.5-turbo-0613")
      - GPT_3_5_TURBO_1106("gpt-3.5-turbo-1106")
      - GPT_3_5_TURBO_0125("gpt-3.5-turbo-0125")
      - GPT_3_5_TURBO_16K_0613("gpt-3.5-turbo-16k-0613")
    - ResponsesOnlyModel
      - O1_PRO("o1-pro")
      - O1_PRO_2025_03_19("o1-pro-2025-03-19")
      - O3_PRO("o3-pro")
      - O3_PRO_2025_06_10("o3-pro-2025-06-10")
      - O3_DEEP_RESEARCH("o3-deep-research")
      - O3_DEEP_RESEARCH_2025_06_26("o3-deep-research-2025-06-26")
      - O4_MINI_DEEP_RESEARCH("o4-mini-deep-research")
      - O4_MINI_DEEP_RESEARCH_2025_06_26("o4-mini-deep-research-2025-06-26")
      - COMPUTER_USE_PREVIEW("computer-use-preview")
      - COMPUTER_USE_PREVIEW_2025_03_11("computer-use-preview-2025-03-11")
      - GPT_5_CODEX("gpt-5-codex")
      - GPT_5_PRO("gpt-5-pro")
      - GPT_5_PRO_2025_10_06("gpt-5-pro-2025-10-06")
      - GPT_5_1_CODEX_MAX("gpt-5.1-codex-max")
  - JsonValue; object_ "response"constant
    
    The object type of this resource - always set to response.
    - RESPONSE("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.
    - class ResponseOutputMessage:
      
      An output message from the model.
    - class ResponseFileSearchToolCall:
      
      The results of a file search tool call. See the file search guide for more information.
    - class ResponseFunctionToolCall:
      
      A tool call to run a function. See the function calling guide for more information.
    - 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.
        
        String
        
        List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
      - Status status
        
        The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "function_call_output"constant
        
        The type of the function tool call output. Always function_call_output.
        
        FUNCTION_CALL_OUTPUT("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.
    - class ResponseComputerToolCall:
      
      A tool call to a computer use tool. See the computer use guide for more information.
    - 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.
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        FAILED("failed")
        
        IN_PROGRESS("in_progress")
      - JsonValue; type "computer_call_output"constant
        
        The type of the computer tool call output. Always computer_call_output.
        
        COMPUTER_CALL_OUTPUT("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.
    - 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.
        
        SERVER("server")
        
        CLIENT("client")
      - Status status
        
        The status of the tool search call item that was recorded.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "tool_search_call"constant
        
        The type of the item. Always tool_search_call.
        
        TOOL_SEARCH_CALL("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.
        
        SERVER("server")
        
        CLIENT("client")
      - Status status
        
        The status of the tool search output item that was recorded.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - List<Tool> tools
        
        The loaded tool definitions returned by tool search.
        
        class FunctionTool:
        
        Defines a function in your own code the model can choose to call. Learn more about function calling.
        
        class FileSearchTool:
        
        A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
        
        class ComputerTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
        
        class ComputerUsePreviewTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
        
        class WebSearchTool:
        
        Search the Internet for sources related to the prompt. Learn more about the web search tool.
        
        Mcp
        
        CodeInterpreter
        
        ImageGeneration
        
        JsonValue;
        
        class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        class CustomTool:
        
        A custom tool that processes input using a specified format. Learn more about custom tools
        
        class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        class WebSearchPreviewTool:
        
        This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
        
        class ApplyPatchTool:
        
        Allows the assistant to create, delete, or update files using unified diffs.
      - JsonValue; type "tool_search_output"constant
        
        The type of the item. Always tool_search_output.
        
        TOOL_SEARCH_OUTPUT("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
        
        The type of the item. Always compaction.
        
        COMPACTION("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        GENERATING("generating")
        
        FAILED("failed")
      - JsonValue; type "image_generation_call"constant
        
        The type of the image generation call. Always image_generation_call.
        
        IMAGE_GENERATION_CALL("image_generation_call")
    - class ResponseCodeInterpreterToolCall:
      
      A tool call to run code.
    - 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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "local_shell_call"constant
        
        The type of the local shell call. Always local_shell_call.
        
        LOCAL_SHELL_CALL("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
        
        The type of the local shell tool call output. Always local_shell_call_output.
        
        LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
      - Optional<Status> status
        
        The status of the item. One of in_progress, completed, or incomplete.
        
        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.
        
        class ResponseLocalEnvironment:
        
        Represents the use of a local environment to perform shell actions.
        
        JsonValue; type "local"constant
        
        The environment type. Always local.
        
        LOCAL("local")
        
        class ResponseContainerReference:
        
        Represents a container created with /v1/containers.
        
        String containerId
        
        JsonValue; type "container_reference"constant
        
        The environment type. Always container_reference.
        
        CONTAINER_REFERENCE("container_reference")
      - Status status
        
        The status of the shell call. One of in_progress, completed, or incomplete.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "shell_call"constant
        
        The type of the item. Always shell_call.
        
        SHELL_CALL("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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "shell_call_output"constant
        
        The type of the shell call output. Always shell_call_output.
        
        SHELL_CALL_OUTPUT("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.
        
        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 a new file with the provided diff.
        
        CREATE_FILE("create_file")
        
        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 the specified file.
        
        DELETE_FILE("delete_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 an existing file with the provided diff.
        
        UPDATE_FILE("update_file")
      - Status status
        
        The status of the apply patch tool call. One of in_progress or completed.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
      - JsonValue; type "apply_patch_call"constant
        
        The type of the item. Always apply_patch_call.
        
        APPLY_PATCH_CALL("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.
        
        COMPLETED("completed")
        
        FAILED("failed")
      - JsonValue; type "apply_patch_call_output"constant
        
        The type of the item. Always apply_patch_call_output.
        
        APPLY_PATCH_CALL_OUTPUT("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
        
        The type of the item. Always mcp_call.
        
        MCP_CALL("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.
        
        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
        
        The type of the item. Always mcp_list_tools.
        
        MCP_LIST_TOOLS("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
        
        The type of the item. Always mcp_approval_request.
        
        MCP_APPROVAL_REQUEST("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
        
        The type of the item. Always mcp_approval_response.
        
        MCP_APPROVAL_RESPONSE("mcp_approval_response")
      - Optional<String> reason
        
        Optional reason for the decision.
    - class ResponseCustomToolCall:
      
      A call to a custom tool created by the model.
    - 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.
        
        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.
  - 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.
    - 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.
        
        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 tool configuration type. Always allowed_tools.
        
        ALLOWED_TOOLS("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
        
        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
        
        For function calling, the type is always function.
        
        FUNCTION("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
        
        For MCP tools, the type is always mcp.
        
        MCP("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
        
        For custom tool calling, the type is always custom.
        
        CUSTOM("custom")
    - class ToolChoiceApplyPatch:
      
      Forces the model to call the apply_patch tool when executing a tool call.
      - JsonValue; type "apply_patch"constant
        
        The tool to call. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
    - class ToolChoiceShell:
      
      Forces the model to call the shell tool when a tool call is required.
      - JsonValue; type "shell"constant
        
        The tool to call. Always shell.
        
        SHELL("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.
    - class FunctionTool:
      
      Defines a function in your own code the model can choose to call. Learn more about function calling.
    - class FileSearchTool:
      
      A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
    - class ComputerTool:
      
      A tool that controls a virtual computer. Learn more about the computer tool.
    - class ComputerUsePreviewTool:
      
      A tool that controls a virtual computer. Learn more about the computer tool.
    - class WebSearchTool:
      
      Search the Internet for sources related to the prompt. Learn more about the web search tool.
    - Mcp
    - CodeInterpreter
    - ImageGeneration
    - JsonValue;
    - class FunctionShellTool:
      
      A tool that allows the model to execute shell commands.
    - class CustomTool:
      
      A custom tool that processes input using a specified format. Learn more about custom tools
    - class NamespaceTool:
      
      Groups function/custom tools under a shared namespace.
    - class ToolSearchTool:
      
      Hosted or BYOT tool search configuration for deferred tools.
    - class WebSearchPreviewTool:
      
      This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
    - class ApplyPatchTool:
      
      Allows the assistant to create, delete, or update files using unified diffs.
  - 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.
  - 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.
    - 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.
      - String
      - class ResponseInputText:
        
        A text input to the model.
      - class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
      - class ResponseInputFile:
        
        A file input to the model.
    - Optional<String> version
      
      Optional version of the prompt template.
  - 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.
    - IN_MEMORY("in_memory")
    - _24H("24h")
  - Optional<Reasoning> reasoning
    
    gpt-5 and o-series models only
    
    Configuration options for reasoning models.
    - Optional<ReasoningEffort> effort
      
      Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
      - gpt-5.1 defaults to none, which does not perform reasoning. The supported reasoning values for gpt-5.1 are none, low, medium, and high. Tool calls are supported for all reasoning values in gpt-5.1.
      - All models before gpt-5.1 default to medium reasoning effort, and do not support none.
      - The gpt-5-pro model defaults to (and only supports) high reasoning effort.
      - xhigh is supported for all models after gpt-5.1-codex-max.
      - NONE("none")
      - MINIMAL("minimal")
      - LOW("low")
      - MEDIUM("medium")
      - HIGH("high")
      - XHIGH("xhigh")
    - Optional<GenerateSummary> generateSummary
      
      Deprecated: use summary instead.
      
      A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
      - AUTO("auto")
      - CONCISE("concise")
      - DETAILED("detailed")
    - Optional<Summary> summary
      
      A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
      
      concise is supported for computer-use-preview models and all reasoning models after gpt-5.
      - AUTO("auto")
      - CONCISE("concise")
      - DETAILED("detailed")
  - 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.
  - 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.
    - 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.
    - COMPLETED("completed")
    - FAILED("failed")
    - IN_PROGRESS("in_progress")
    - CANCELLED("cancelled")
    - QUEUED("queued")
    - INCOMPLETE("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<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.
      - class ResponseFormatText:
        
        Default response format. Used to generate text responses.
        
        JsonValue; type "text"constant
        
        The type of response format being defined. Always text.
        
        TEXT("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
        
        The type of response format being defined. Always json_schema.
        
        JSON_SCHEMA("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
        
        The type of response format being defined. Always json_object.
        
        JSON_OBJECT("json_object")
    - 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.
      - LOW("low")
      - MEDIUM("medium")
      - HIGH("high")
  - Optional<Long> topLogprobs
    
    An integer between 0 and 20 specifying the maximum number of most likely tokens to return at each token position, each with an associated log probability. In some cases, the number of returned tokens may be fewer than requested.
  - 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.
    - 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.
    - 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.
  - Optional<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.
- long sequenceNumber
  
  The sequence number for this event.
- JsonValue; type "response.queued"constant
  
  The type of the event. Always 'response.queued'.
  - RESPONSE_QUEUED("response.queued")

Response Reasoning 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
    
    The type of the object. Always summary_text.
    - SUMMARY_TEXT("summary_text")
- JsonValue; type "reasoning"constant
  
  The type of the object. Always reasoning.
  - REASONING("reasoning")
- Optional<List<Content>> content
  
  Reasoning text content.
  - String text
    
    The reasoning text from the model.
  - JsonValue; type "reasoning_text"constant
    
    The type of the reasoning text. Always reasoning_text.
    - REASONING_TEXT("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.
  - IN_PROGRESS("in_progress")
  - COMPLETED("completed")
  - INCOMPLETE("incomplete")

Response Reasoning Summary Part Added Event

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
    
    The type of the summary part. Always summary_text.
    - SUMMARY_TEXT("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
  
  The type of the event. Always response.reasoning_summary_part.added.
  - RESPONSE_REASONING_SUMMARY_PART_ADDED("response.reasoning_summary_part.added")

Response Reasoning Summary Part Done Event

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
    
    The type of the summary part. Always summary_text.
    - SUMMARY_TEXT("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
  
  The type of the event. Always response.reasoning_summary_part.done.
  - RESPONSE_REASONING_SUMMARY_PART_DONE("response.reasoning_summary_part.done")

Response Reasoning Summary Text Delta Event

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
  
  The type of the event. Always response.reasoning_summary_text.delta.
  - RESPONSE_REASONING_SUMMARY_TEXT_DELTA("response.reasoning_summary_text.delta")

Response Reasoning Summary Text Done Event

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
  
  The type of the event. Always response.reasoning_summary_text.done.
  - RESPONSE_REASONING_SUMMARY_TEXT_DONE("response.reasoning_summary_text.done")

Response Reasoning Text Delta Event

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
  
  The type of the event. Always response.reasoning_text.delta.
  - RESPONSE_REASONING_TEXT_DELTA("response.reasoning_text.delta")

Response Reasoning Text Done Event

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
  
  The type of the event. Always response.reasoning_text.done.
  - RESPONSE_REASONING_TEXT_DONE("response.reasoning_text.done")

Response Refusal Delta Event

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
  
  The type of the event. Always response.refusal.delta.
  - RESPONSE_REFUSAL_DELTA("response.refusal.delta")

Response Refusal Done Event

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
  
  The type of the event. Always response.refusal.done.
  - RESPONSE_REFUSAL_DONE("response.refusal.done")

Response Status

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

Response Stream Event

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
    
    The type of the event. Always response.audio.delta.
    - RESPONSE_AUDIO_DELTA("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
    
    The type of the event. Always response.audio.done.
    - RESPONSE_AUDIO_DONE("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
    
    The type of the event. Always response.audio.transcript.delta.
    - RESPONSE_AUDIO_TRANSCRIPT_DELTA("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
    
    The type of the event. Always response.audio.transcript.done.
    - RESPONSE_AUDIO_TRANSCRIPT_DONE("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
    
    The type of the event. Always response.code_interpreter_call_code.delta.
    - RESPONSE_CODE_INTERPRETER_CALL_CODE_DELTA("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
    
    The type of the event. Always response.code_interpreter_call_code.done.
    - RESPONSE_CODE_INTERPRETER_CALL_CODE_DONE("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
    
    The type of the event. Always response.code_interpreter_call.completed.
    - RESPONSE_CODE_INTERPRETER_CALL_COMPLETED("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
    
    The type of the event. Always response.code_interpreter_call.in_progress.
    - RESPONSE_CODE_INTERPRETER_CALL_IN_PROGRESS("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
    
    The type of the event. Always response.code_interpreter_call.interpreting.
    - RESPONSE_CODE_INTERPRETER_CALL_INTERPRETING("response.code_interpreter_call.interpreting")
- class ResponseCompletedEvent:
  
  Emitted when the model response is complete.
  - Response response
    
    Properties of the completed 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.
      - Code code
        
        The error code for the response.
        
        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.
    - Optional<IncompleteDetails> incompleteDetails
      
      Details about why the response is incomplete.
      - Optional<Reason> reason
        
        The reason why the response is incomplete.
        
        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.
      - String
      - List<ResponseInputItem>
        
        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.
        
        String
        
        List<ResponseInputContent>
        
        class ResponseInputText:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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.
        
        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.
        
        COMMENTARY("commentary")
        
        FINAL_ANSWER("final_answer")
        
        Optional<Type> type
        
        The type of the message input. Always message.
        
        MESSAGE("message")
        
        Message
        
        List<ResponseInputContent> content
        
        A list of one or many input items to the model, containing different content types.
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
        
        Role role
        
        The role of the message input. One of user, system, or developer.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        Optional<Type> type
        
        The type of the message input. Always set to message.
        
        MESSAGE("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.
        
        class ResponseOutputText:
        
        A text output from the model.
        
        List<Annotation> annotations
        
        The annotations of the text output.
        
        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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
        
        String text
        
        The text output from the model.
        
        JsonValue; type "output_text"constant
        
        The type of the output text. Always output_text.
        
        OUTPUT_TEXT("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
        
        The type of the refusal. Always refusal.
        
        REFUSAL("refusal")
        
        JsonValue; role "assistant"constant
        
        The role of the output message. Always assistant.
        
        ASSISTANT("assistant")
        
        Status status
        
        The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        JsonValue; type "message"constant
        
        The type of the output message. Always message.
        
        MESSAGE("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.
        
        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,
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        FAILED("failed")
        
        JsonValue; type "file_search_call"constant
        
        The type of the file search tool call. Always file_search_call.
        
        FILE_SEARCH_CALL("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.
        
        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.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        Type type
        
        The type of the computer call. Always computer_call.
        
        COMPUTER_CALL("computer_call")
        
        Optional<Action> action
        
        A click action.
        
        class Click:
        
        A click action.
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        class Move:
        
        A mouse move action.
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        class Scroll:
        
        A scroll action.
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
        
        Optional<List<ComputerAction>> actions
        
        Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.
        
        Click
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        Move
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        Scroll
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
        
        ComputerCallOutput
        
        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.
        
        JsonValue; type "computer_screenshot"constant
        
        Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
        
        COMPUTER_SCREENSHOT("computer_screenshot")
        
        Optional<String> fileId
        
        The identifier of an uploaded file that contains the screenshot.
        
        Optional<String> imageUrl
        
        The URL of the screenshot image.
        
        JsonValue; type "computer_call_output"constant
        
        The type of the computer tool call output. Always computer_call_output.
        
        COMPUTER_CALL_OUTPUT("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.
        
        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).
        
        class Search:
        
        Action type "search" - Performs a web search query.
        
        String query
        
        [DEPRECATED] The search query.
        
        JsonValue; type "search"constant
        
        The action type.
        
        SEARCH("search")
        
        Optional<List<String>> queries
        
        The search queries.
        
        Optional<List<Source>> sources
        
        The sources used in the search.
        
        JsonValue; type "url"constant
        
        The type of source. Always url.
        
        URL("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
        
        The action type.
        
        OPEN_PAGE("open_page")
        
        Optional<String> url
        
        The URL opened by the model.
        
        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
        
        The action type.
        
        FIND_IN_PAGE("find_in_page")
        
        String url
        
        The URL of the page searched for the pattern.
        
        Status status
        
        The status of the web search tool call.
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        FAILED("failed")
        
        JsonValue; type "web_search_call"constant
        
        The type of the web search tool call. Always web_search_call.
        
        WEB_SEARCH_CALL("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
        
        The type of the function tool call. Always function_call.
        
        FUNCTION_CALL("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        FunctionCallOutput
        
        String callId
        
        The unique ID of the function tool call generated by the model.
        
        Output output
        
        Text, image, or file output of the function tool call.
        
        String
        
        List<ResponseFunctionCallOutputItem>
        
        class ResponseInputTextContent:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("input_text")
        
        class ResponseInputImageContent:
        
        An image input to the model. Learn about image inputs
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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.
        
        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.
        
        class ResponseInputFileContent:
        
        A file input to the model.
        
        JsonValue; type "input_file"constant
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        LOW("low")
        
        HIGH("high")
        
        Optional<String> fileData
        
        The base64-encoded data 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 "function_call_output"constant
        
        The type of the function tool call output. Always function_call_output.
        
        FUNCTION_CALL_OUTPUT("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.
        
        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
        
        The item type. Always tool_search_call.
        
        TOOL_SEARCH_CALL("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.
        
        Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
        
        Optional<Status> status
        
        The status of the tool search call.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        class ResponseToolSearchOutputItemParam:
        
        List<Tool> tools
        
        The loaded tool definitions returned by the tool search output.
        
        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
        
        The type of the function tool. Always function.
        
        FUNCTION("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
        
        The type of the file search tool. Always file_search.
        
        FILE_SEARCH("file_search")
        
        List<String> vectorStoreIds
        
        The IDs of the vector stores to search.
        
        Optional<Filters> filters
        
        A filter to apply.
        
        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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
        
        Type type
        
        Type of operation: and or or.
        
        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.
        
        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
        
        The type of the computer tool. Always computer.
        
        COMPUTER("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.
        
        WINDOWS("windows")
        
        MAC("mac")
        
        LINUX("linux")
        
        UBUNTU("ubuntu")
        
        BROWSER("browser")
        
        JsonValue; type "computer_use_preview"constant
        
        The type of the computer use tool. Always computer_use_preview.
        
        COMPUTER_USE_PREVIEW("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.
        
        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.
        
        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.
        
        APPROXIMATE("approximate")
        
        Mcp
        
        String serverLabel
        
        A label for this MCP server, used to identify it in tool calls.
        
        JsonValue; type "mcp"constant
        
        The type of the MCP tool. Always mcp.
        
        MCP("mcp")
        
        Optional<AllowedTools> allowedTools
        
        List of allowed tool names or a filter object.
        
        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
        
        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.
        
        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.
        
        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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
        
        JsonValue; type "code_interpreter"constant
        
        The type of the code interpreter tool. Always code_interpreter.
        
        CODE_INTERPRETER("code_interpreter")
        
        ImageGeneration
        
        JsonValue; type "image_generation"constant
        
        The type of the image generation tool. Always image_generation.
        
        IMAGE_GENERATION("image_generation")
        
        Optional<Action> action
        
        Whether to generate a new image or edit an existing image. Default: auto.
        
        GENERATE("generate")
        
        EDIT("edit")
        
        AUTO("auto")
        
        Optional<Background> background
        
        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.
        
        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.
        
        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.
        
        GPT_IMAGE_1("gpt-image-1")
        
        GPT_IMAGE_1_MINI("gpt-image-1-mini")
        
        GPT_IMAGE_2("gpt-image-2")
        
        GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
        
        GPT_IMAGE_1_5("gpt-image-1.5")
        
        CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
        
        Optional<Moderation> moderation
        
        Moderation level for the generated image. Default: auto.
        
        AUTO("auto")
        
        LOW("low")
        
        Optional<Long> outputCompression
        
        Compression level for the output image. Default: 100.
        
        Optional<OutputFormat> outputFormat
        
        The output format of the generated image. One of png, webp, or jpeg. Default: png.
        
        PNG("png")
        
        WEBP("webp")
        
        JPEG("jpeg")
        
        Optional<Long> partialImages
        
        Number of partial images to generate in streaming mode, from 0 (default value) to 3.
        
        Optional<Quality> quality
        
        The quality of the generated image. One of low, medium, high, or auto. Default: auto.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        AUTO("auto")
        
        Optional<Size> size
        
        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.
        
        _1024X1024("1024x1024")
        
        _1024X1536("1024x1536")
        
        _1536X1024("1536x1024")
        
        AUTO("auto")
        
        JsonValue;
        
        JsonValue; type "local_shell"constant
        
        The type of the local shell tool. Always local_shell.
        
        LOCAL_SHELL("local_shell")
        
        class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        JsonValue; type "shell"constant
        
        The type of the shell tool. Always shell.
        
        SHELL("shell")
        
        Optional<Environment> environment
        
        class ContainerAuto:
        
        JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
        
        Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
        
        class LocalEnvironment:
        
        JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
        
        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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
        
        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
        
        The type of the custom tool. Always custom.
        
        CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
        
        Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
        
        class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        String description
        
        A description of the namespace shown to the model.
        
        String name
        
        The namespace name used in tool calls (for example, crm).
        
        List<Tool> tools
        
        The function/custom tools available inside this namespace.
        
        class Function:
        
        String name
        
        JsonValue; type "function"constant
        
        FUNCTION("function")
        
        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
        
        JsonValue; type "namespace"constant
        
        The type of the tool. Always namespace.
        
        NAMESPACE("namespace")
        
        class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        JsonValue; type "tool_search"constant
        
        The type of the tool. Always tool_search.
        
        TOOL_SEARCH("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.
        
        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.
        
        WEB_SEARCH_PREVIEW("web_search_preview")
        
        WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
        
        Optional<List<SearchContentType>> searchContentTypes
        
        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.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        Optional<UserLocation> userLocation
        
        The user's location.
        
        JsonValue; type "approximate"constant
        
        The type of location approximation. Always approximate.
        
        APPROXIMATE("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
        
        The type of the tool. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
        
        JsonValue; type "tool_search_output"constant
        
        The item type. Always tool_search_output.
        
        TOOL_SEARCH_OUTPUT("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.
        
        Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
        
        Optional<Status> status
        
        The status of the tool search output.
        
        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
        
        The type of the object. Always summary_text.
        
        SUMMARY_TEXT("summary_text")
        
        JsonValue; type "reasoning"constant
        
        The type of the object. Always reasoning.
        
        REASONING("reasoning")
        
        Optional<List<Content>> content
        
        Reasoning text content.
        
        String text
        
        The reasoning text from the model.
        
        JsonValue; type "reasoning_text"constant
        
        The type of the reasoning text. Always reasoning_text.
        
        REASONING_TEXT("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.
        
        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.
        
        JsonValue; type "compaction"constant
        
        The type of the item. Always compaction.
        
        COMPACTION("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        GENERATING("generating")
        
        FAILED("failed")
        
        JsonValue; type "image_generation_call"constant
        
        The type of the image generation call. Always image_generation_call.
        
        IMAGE_GENERATION_CALL("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.
        
        class Logs:
        
        The logs output from the code interpreter.
        
        String logs
        
        The logs output from the code interpreter.
        
        JsonValue; type "logs"constant
        
        The type of the output. Always logs.
        
        LOGS("logs")
        
        class Image:
        
        The image output from the code interpreter.
        
        JsonValue; type "image"constant
        
        The type of the output. Always image.
        
        IMAGE("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        INTERPRETING("interpreting")
        
        FAILED("failed")
        
        JsonValue; type "code_interpreter_call"constant
        
        The type of the code interpreter tool call. Always code_interpreter_call.
        
        CODE_INTERPRETER_CALL("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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        JsonValue; type "local_shell_call"constant
        
        The type of the local shell call. Always local_shell_call.
        
        LOCAL_SHELL_CALL("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
        
        The type of the local shell tool call output. Always local_shell_call_output.
        
        LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
        
        Optional<Status> status
        
        The status of the item. One of in_progress, completed, or incomplete.
        
        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.
        
        JsonValue; type "shell_call"constant
        
        The type of the item. Always shell_call.
        
        SHELL_CALL("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.
        
        class LocalEnvironment:
        
        class ContainerReference:
        
        Optional<Status> status
        
        The status of the shell call. One of in_progress, completed, or incomplete.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        ShellCallOutput
        
        String callId
        
        The unique ID of the shell tool call generated by the model.
        
        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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("exit")
        
        String stderr
        
        Captured stderr output for the shell call.
        
        String stdout
        
        Captured stdout output for the shell call.
        
        JsonValue; type "shell_call_output"constant
        
        The type of the item. Always shell_call_output.
        
        SHELL_CALL_OUTPUT("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        ApplyPatchCall
        
        String callId
        
        The unique ID of the apply patch tool call generated by the model.
        
        Operation operation
        
        The specific create, delete, or update instruction for the apply_patch tool call.
        
        class CreateFile:
        
        Instruction for creating a new file via the apply_patch tool.
        
        String diff
        
        Unified diff content to apply when creating the file.
        
        String path
        
        Path of the file to create relative to the workspace root.
        
        JsonValue; type "create_file"constant
        
        The operation type. Always create_file.
        
        CREATE_FILE("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.
        
        JsonValue; type "delete_file"constant
        
        The operation type. Always delete_file.
        
        DELETE_FILE("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.
        
        String path
        
        Path of the file to update relative to the workspace root.
        
        JsonValue; type "update_file"constant
        
        The operation type. Always update_file.
        
        UPDATE_FILE("update_file")
        
        Status status
        
        The status of the apply patch tool call. One of in_progress or completed.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        JsonValue; type "apply_patch_call"constant
        
        The type of the item. Always apply_patch_call.
        
        APPLY_PATCH_CALL("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.
        
        Status status
        
        The status of the apply patch tool call output. One of completed or failed.
        
        COMPLETED("completed")
        
        FAILED("failed")
        
        JsonValue; type "apply_patch_call_output"constant
        
        The type of the item. Always apply_patch_call_output.
        
        APPLY_PATCH_CALL_OUTPUT("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).
        
        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
        
        The type of the item. Always mcp_list_tools.
        
        MCP_LIST_TOOLS("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
        
        The type of the item. Always mcp_approval_request.
        
        MCP_APPROVAL_REQUEST("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
        
        The type of the item. Always mcp_approval_response.
        
        MCP_APPROVAL_RESPONSE("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
        
        The type of the item. Always mcp_call.
        
        MCP_CALL("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.
        
        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.
        
        String
        
        List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
        
        JsonValue; type "custom_tool_call_output"constant
        
        The type of the custom tool call output. Always custom_tool_call_output.
        
        CUSTOM_TOOL_CALL_OUTPUT("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
        
        The type of the custom tool call. Always custom_tool_call.
        
        CUSTOM_TOOL_CALL("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.
        
        JsonValue;
        
        JsonValue; type "compaction_trigger"constant
        
        The type of the item. Always compaction_trigger.
        
        COMPACTION_TRIGGER("compaction_trigger")
        
        ItemReference
        
        String id
        
        The ID of the item to reference.
        
        Optional<Type> type
        
        The type of item to reference. Always item_reference.
        
        ITEM_REFERENCE("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.
      - String
      - enum ChatModel:
        
        GPT_5_4("gpt-5.4")
        
        GPT_5_4_MINI("gpt-5.4-mini")
        
        GPT_5_4_NANO("gpt-5.4-nano")
        
        GPT_5_4_MINI_2026_03_17("gpt-5.4-mini-2026-03-17")
        
        GPT_5_4_NANO_2026_03_17("gpt-5.4-nano-2026-03-17")
        
        GPT_5_3_CHAT_LATEST("gpt-5.3-chat-latest")
        
        GPT_5_2("gpt-5.2")
        
        GPT_5_2_2025_12_11("gpt-5.2-2025-12-11")
        
        GPT_5_2_CHAT_LATEST("gpt-5.2-chat-latest")
        
        GPT_5_2_PRO("gpt-5.2-pro")
        
        GPT_5_2_PRO_2025_12_11("gpt-5.2-pro-2025-12-11")
        
        GPT_5_1("gpt-5.1")
        
        GPT_5_1_2025_11_13("gpt-5.1-2025-11-13")
        
        GPT_5_1_CODEX("gpt-5.1-codex")
        
        GPT_5_1_MINI("gpt-5.1-mini")
        
        GPT_5_1_CHAT_LATEST("gpt-5.1-chat-latest")
        
        GPT_5("gpt-5")
        
        GPT_5_MINI("gpt-5-mini")
        
        GPT_5_NANO("gpt-5-nano")
        
        GPT_5_2025_08_07("gpt-5-2025-08-07")
        
        GPT_5_MINI_2025_08_07("gpt-5-mini-2025-08-07")
        
        GPT_5_NANO_2025_08_07("gpt-5-nano-2025-08-07")
        
        GPT_5_CHAT_LATEST("gpt-5-chat-latest")
        
        GPT_4_1("gpt-4.1")
        
        GPT_4_1_MINI("gpt-4.1-mini")
        
        GPT_4_1_NANO("gpt-4.1-nano")
        
        GPT_4_1_2025_04_14("gpt-4.1-2025-04-14")
        
        GPT_4_1_MINI_2025_04_14("gpt-4.1-mini-2025-04-14")
        
        GPT_4_1_NANO_2025_04_14("gpt-4.1-nano-2025-04-14")
        
        O4_MINI("o4-mini")
        
        O4_MINI_2025_04_16("o4-mini-2025-04-16")
        
        O3("o3")
        
        O3_2025_04_16("o3-2025-04-16")
        
        O3_MINI("o3-mini")
        
        O3_MINI_2025_01_31("o3-mini-2025-01-31")
        
        O1("o1")
        
        O1_2024_12_17("o1-2024-12-17")
        
        O1_PREVIEW("o1-preview")
        
        O1_PREVIEW_2024_09_12("o1-preview-2024-09-12")
        
        O1_MINI("o1-mini")
        
        O1_MINI_2024_09_12("o1-mini-2024-09-12")
        
        GPT_4O("gpt-4o")
        
        GPT_4O_2024_11_20("gpt-4o-2024-11-20")
        
        GPT_4O_2024_08_06("gpt-4o-2024-08-06")
        
        GPT_4O_2024_05_13("gpt-4o-2024-05-13")
        
        GPT_4O_AUDIO_PREVIEW("gpt-4o-audio-preview")
        
        GPT_4O_AUDIO_PREVIEW_2024_10_01("gpt-4o-audio-preview-2024-10-01")
        
        GPT_4O_AUDIO_PREVIEW_2024_12_17("gpt-4o-audio-preview-2024-12-17")
        
        GPT_4O_AUDIO_PREVIEW_2025_06_03("gpt-4o-audio-preview-2025-06-03")
        
        GPT_4O_MINI_AUDIO_PREVIEW("gpt-4o-mini-audio-preview")
        
        GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17("gpt-4o-mini-audio-preview-2024-12-17")
        
        GPT_4O_SEARCH_PREVIEW("gpt-4o-search-preview")
        
        GPT_4O_MINI_SEARCH_PREVIEW("gpt-4o-mini-search-preview")
        
        GPT_4O_SEARCH_PREVIEW_2025_03_11("gpt-4o-search-preview-2025-03-11")
        
        GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11("gpt-4o-mini-search-preview-2025-03-11")
        
        CHATGPT_4O_LATEST("chatgpt-4o-latest")
        
        CODEX_MINI_LATEST("codex-mini-latest")
        
        GPT_4O_MINI("gpt-4o-mini")
        
        GPT_4O_MINI_2024_07_18("gpt-4o-mini-2024-07-18")
        
        GPT_4_TURBO("gpt-4-turbo")
        
        GPT_4_TURBO_2024_04_09("gpt-4-turbo-2024-04-09")
        
        GPT_4_0125_PREVIEW("gpt-4-0125-preview")
        
        GPT_4_TURBO_PREVIEW("gpt-4-turbo-preview")
        
        GPT_4_1106_PREVIEW("gpt-4-1106-preview")
        
        GPT_4_VISION_PREVIEW("gpt-4-vision-preview")
        
        GPT_4("gpt-4")
        
        GPT_4_0314("gpt-4-0314")
        
        GPT_4_0613("gpt-4-0613")
        
        GPT_4_32K("gpt-4-32k")
        
        GPT_4_32K_0314("gpt-4-32k-0314")
        
        GPT_4_32K_0613("gpt-4-32k-0613")
        
        GPT_3_5_TURBO("gpt-3.5-turbo")
        
        GPT_3_5_TURBO_16K("gpt-3.5-turbo-16k")
        
        GPT_3_5_TURBO_0301("gpt-3.5-turbo-0301")
        
        GPT_3_5_TURBO_0613("gpt-3.5-turbo-0613")
        
        GPT_3_5_TURBO_1106("gpt-3.5-turbo-1106")
        
        GPT_3_5_TURBO_0125("gpt-3.5-turbo-0125")
        
        GPT_3_5_TURBO_16K_0613("gpt-3.5-turbo-16k-0613")
      - ResponsesOnlyModel
        
        O1_PRO("o1-pro")
        
        O1_PRO_2025_03_19("o1-pro-2025-03-19")
        
        O3_PRO("o3-pro")
        
        O3_PRO_2025_06_10("o3-pro-2025-06-10")
        
        O3_DEEP_RESEARCH("o3-deep-research")
        
        O3_DEEP_RESEARCH_2025_06_26("o3-deep-research-2025-06-26")
        
        O4_MINI_DEEP_RESEARCH("o4-mini-deep-research")
        
        O4_MINI_DEEP_RESEARCH_2025_06_26("o4-mini-deep-research-2025-06-26")
        
        COMPUTER_USE_PREVIEW("computer-use-preview")
        
        COMPUTER_USE_PREVIEW_2025_03_11("computer-use-preview-2025-03-11")
        
        GPT_5_CODEX("gpt-5-codex")
        
        GPT_5_PRO("gpt-5-pro")
        
        GPT_5_PRO_2025_10_06("gpt-5-pro-2025-10-06")
        
        GPT_5_1_CODEX_MAX("gpt-5.1-codex-max")
    - JsonValue; object_ "response"constant
      
      The object type of this resource - always set to response.
      - RESPONSE("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.
      - class ResponseOutputMessage:
        
        An output message from the model.
      - class ResponseFileSearchToolCall:
        
        The results of a file search tool call. See the file search guide for more information.
      - class ResponseFunctionToolCall:
        
        A tool call to run a function. See the function calling guide for more information.
      - 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.
        
        String
        
        List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
        
        Status status
        
        The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        JsonValue; type "function_call_output"constant
        
        The type of the function tool call output. Always function_call_output.
        
        FUNCTION_CALL_OUTPUT("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.
      - class ResponseComputerToolCall:
        
        A tool call to a computer use tool. See the computer use guide for more information.
      - 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.
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        FAILED("failed")
        
        IN_PROGRESS("in_progress")
        
        JsonValue; type "computer_call_output"constant
        
        The type of the computer tool call output. Always computer_call_output.
        
        COMPUTER_CALL_OUTPUT("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.
      - 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.
        
        SERVER("server")
        
        CLIENT("client")
        
        Status status
        
        The status of the tool search call item that was recorded.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        JsonValue; type "tool_search_call"constant
        
        The type of the item. Always tool_search_call.
        
        TOOL_SEARCH_CALL("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.
        
        SERVER("server")
        
        CLIENT("client")
        
        Status status
        
        The status of the tool search output item that was recorded.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        List<Tool> tools
        
        The loaded tool definitions returned by tool search.
        
        class FunctionTool:
        
        Defines a function in your own code the model can choose to call. Learn more about function calling.
        
        class FileSearchTool:
        
        A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
        
        class ComputerTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
        
        class ComputerUsePreviewTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
        
        class WebSearchTool:
        
        Search the Internet for sources related to the prompt. Learn more about the web search tool.
        
        Mcp
        
        CodeInterpreter
        
        ImageGeneration
        
        JsonValue;
        
        class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        class CustomTool:
        
        A custom tool that processes input using a specified format. Learn more about custom tools
        
        class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        class WebSearchPreviewTool:
        
        This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
        
        class ApplyPatchTool:
        
        Allows the assistant to create, delete, or update files using unified diffs.
        
        JsonValue; type "tool_search_output"constant
        
        The type of the item. Always tool_search_output.
        
        TOOL_SEARCH_OUTPUT("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
        
        The type of the item. Always compaction.
        
        COMPACTION("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        GENERATING("generating")
        
        FAILED("failed")
        
        JsonValue; type "image_generation_call"constant
        
        The type of the image generation call. Always image_generation_call.
        
        IMAGE_GENERATION_CALL("image_generation_call")
      - class ResponseCodeInterpreterToolCall:
        
        A tool call to run code.
      - 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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        JsonValue; type "local_shell_call"constant
        
        The type of the local shell call. Always local_shell_call.
        
        LOCAL_SHELL_CALL("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
        
        The type of the local shell tool call output. Always local_shell_call_output.
        
        LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
        
        Optional<Status> status
        
        The status of the item. One of in_progress, completed, or incomplete.
        
        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.
        
        class ResponseLocalEnvironment:
        
        Represents the use of a local environment to perform shell actions.
        
        JsonValue; type "local"constant
        
        The environment type. Always local.
        
        LOCAL("local")
        
        class ResponseContainerReference:
        
        Represents a container created with /v1/containers.
        
        String containerId
        
        JsonValue; type "container_reference"constant
        
        The environment type. Always container_reference.
        
        CONTAINER_REFERENCE("container_reference")
        
        Status status
        
        The status of the shell call. One of in_progress, completed, or incomplete.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        JsonValue; type "shell_call"constant
        
        The type of the item. Always shell_call.
        
        SHELL_CALL("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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        JsonValue; type "shell_call_output"constant
        
        The type of the shell call output. Always shell_call_output.
        
        SHELL_CALL_OUTPUT("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.
        
        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 a new file with the provided diff.
        
        CREATE_FILE("create_file")
        
        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 the specified file.
        
        DELETE_FILE("delete_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 an existing file with the provided diff.
        
        UPDATE_FILE("update_file")
        
        Status status
        
        The status of the apply patch tool call. One of in_progress or completed.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        JsonValue; type "apply_patch_call"constant
        
        The type of the item. Always apply_patch_call.
        
        APPLY_PATCH_CALL("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.
        
        COMPLETED("completed")
        
        FAILED("failed")
        
        JsonValue; type "apply_patch_call_output"constant
        
        The type of the item. Always apply_patch_call_output.
        
        APPLY_PATCH_CALL_OUTPUT("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
        
        The type of the item. Always mcp_call.
        
        MCP_CALL("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.
        
        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
        
        The type of the item. Always mcp_list_tools.
        
        MCP_LIST_TOOLS("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
        
        The type of the item. Always mcp_approval_request.
        
        MCP_APPROVAL_REQUEST("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
        
        The type of the item. Always mcp_approval_response.
        
        MCP_APPROVAL_RESPONSE("mcp_approval_response")
        
        Optional<String> reason
        
        Optional reason for the decision.
      - class ResponseCustomToolCall:
        
        A call to a custom tool created by the model.
      - 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.
        
        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.
    - 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.
      - 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.
        
        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 tool configuration type. Always allowed_tools.
        
        ALLOWED_TOOLS("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
        
        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
        
        For function calling, the type is always function.
        
        FUNCTION("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
        
        For MCP tools, the type is always mcp.
        
        MCP("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
        
        For custom tool calling, the type is always custom.
        
        CUSTOM("custom")
      - class ToolChoiceApplyPatch:
        
        Forces the model to call the apply_patch tool when executing a tool call.
        
        JsonValue; type "apply_patch"constant
        
        The tool to call. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
      - class ToolChoiceShell:
        
        Forces the model to call the shell tool when a tool call is required.
        
        JsonValue; type "shell"constant
        
        The tool to call. Always shell.
        
        SHELL("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.
      - class FunctionTool:
        
        Defines a function in your own code the model can choose to call. Learn more about function calling.
      - class FileSearchTool:
        
        A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
      - class ComputerTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
      - class ComputerUsePreviewTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
      - class WebSearchTool:
        
        Search the Internet for sources related to the prompt. Learn more about the web search tool.
      - Mcp
      - CodeInterpreter
      - ImageGeneration
      - JsonValue;
      - class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
      - class CustomTool:
        
        A custom tool that processes input using a specified format. Learn more about custom tools
      - class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
      - class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
      - class WebSearchPreviewTool:
        
        This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
      - class ApplyPatchTool:
        
        Allows the assistant to create, delete, or update files using unified diffs.
    - 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.
    - 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.
      - 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.
        
        String
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
      - Optional<String> version
        
        Optional version of the prompt template.
    - 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.
      - IN_MEMORY("in_memory")
      - _24H("24h")
    - Optional<Reasoning> reasoning
      
      gpt-5 and o-series models only
      
      Configuration options for reasoning models.
      - Optional<ReasoningEffort> effort
        
        Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
        
        gpt-5.1 defaults to none, which does not perform reasoning. The supported reasoning values for gpt-5.1 are none, low, medium, and high. Tool calls are supported for all reasoning values in gpt-5.1.
        
        All models before gpt-5.1 default to medium reasoning effort, and do not support none.
        
        The gpt-5-pro model defaults to (and only supports) high reasoning effort.
        
        xhigh is supported for all models after gpt-5.1-codex-max.
        
        NONE("none")
        
        MINIMAL("minimal")
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        XHIGH("xhigh")
      - Optional<GenerateSummary> generateSummary
        
        Deprecated: use summary instead.
        
        A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
        
        AUTO("auto")
        
        CONCISE("concise")
        
        DETAILED("detailed")
      - Optional<Summary> summary
        
        A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
        
        concise is supported for computer-use-preview models and all reasoning models after gpt-5.
        
        AUTO("auto")
        
        CONCISE("concise")
        
        DETAILED("detailed")
    - 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.
    - 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.
      - 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.
      - COMPLETED("completed")
      - FAILED("failed")
      - IN_PROGRESS("in_progress")
      - CANCELLED("cancelled")
      - QUEUED("queued")
      - INCOMPLETE("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<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.
        
        class ResponseFormatText:
        
        Default response format. Used to generate text responses.
        
        JsonValue; type "text"constant
        
        The type of response format being defined. Always text.
        
        TEXT("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
        
        The type of response format being defined. Always json_schema.
        
        JSON_SCHEMA("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
        
        The type of response format being defined. Always json_object.
        
        JSON_OBJECT("json_object")
      - 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.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
    - Optional<Long> topLogprobs
      
      An integer between 0 and 20 specifying the maximum number of most likely tokens to return at each token position, each with an associated log probability. In some cases, the number of returned tokens may be fewer than requested.
    - 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.
      - 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.
      - 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.
    - Optional<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.
  - long sequenceNumber
    
    The sequence number for this event.
  - JsonValue; type "response.completed"constant
    
    The type of the event. Always response.completed.
    - RESPONSE_COMPLETED("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.
    - class ResponseOutputText:
      
      A text output from the model.
    - class ResponseOutputRefusal:
      
      A refusal from the model.
    - class ReasoningText:
      
      Reasoning text from the model.
      - String text
        
        The reasoning text from the model.
      - JsonValue; type "reasoning_text"constant
        
        The type of the reasoning text. Always reasoning_text.
        
        REASONING_TEXT("reasoning_text")
  - long sequenceNumber
    
    The sequence number of this event.
  - JsonValue; type "response.content_part.added"constant
    
    The type of the event. Always response.content_part.added.
    - RESPONSE_CONTENT_PART_ADDED("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.
    - class ResponseOutputText:
      
      A text output from the model.
    - class ResponseOutputRefusal:
      
      A refusal from the model.
    - class ReasoningText:
      
      Reasoning text from the model.
      - String text
        
        The reasoning text from the model.
      - JsonValue; type "reasoning_text"constant
        
        The type of the reasoning text. Always reasoning_text.
        
        REASONING_TEXT("reasoning_text")
  - long sequenceNumber
    
    The sequence number of this event.
  - JsonValue; type "response.content_part.done"constant
    
    The type of the event. Always response.content_part.done.
    - RESPONSE_CONTENT_PART_DONE("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
    
    The type of the event. Always response.created.
    - RESPONSE_CREATED("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
    
    The type of the event. Always error.
    - ERROR("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
    
    The type of the event. Always response.file_search_call.completed.
    - RESPONSE_FILE_SEARCH_CALL_COMPLETED("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
    
    The type of the event. Always response.file_search_call.in_progress.
    - RESPONSE_FILE_SEARCH_CALL_IN_PROGRESS("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
    
    The type of the event. Always response.file_search_call.searching.
    - RESPONSE_FILE_SEARCH_CALL_SEARCHING("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
    
    The type of the event. Always response.function_call_arguments.delta.
    - RESPONSE_FUNCTION_CALL_ARGUMENTS_DELTA("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("response.function_call_arguments.done")
- 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
    
    The type of the event. Always response.in_progress.
    - RESPONSE_IN_PROGRESS("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
    
    The type of the event. Always response.failed.
    - RESPONSE_FAILED("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
    
    The type of the event. Always response.incomplete.
    - RESPONSE_INCOMPLETE("response.incomplete")
- class ResponseOutputItemAddedEvent:
  
  Emitted when a new output item is added.
  - ResponseOutputItem item
    
    The output item that was added.
    - class ResponseOutputMessage:
      
      An output message from the model.
    - class ResponseFileSearchToolCall:
      
      The results of a file search tool call. See the file search guide for more information.
    - class ResponseFunctionToolCall:
      
      A tool call to run a function. See the function calling guide for more information.
    - class ResponseFunctionToolCallOutputItem:
    - class ResponseFunctionWebSearch:
      
      The results of a web search tool call. See the web search guide for more information.
    - class ResponseComputerToolCall:
      
      A tool call to a computer use tool. See the computer use guide for more information.
    - class ResponseComputerToolCallOutputItem:
    - 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.
    - class ResponseToolSearchCall:
    - class ResponseToolSearchOutputItem:
    - class ResponseCompactionItem:
      
      A compaction item generated by the v1/responses/compact API.
    - ImageGenerationCall
    - class ResponseCodeInterpreterToolCall:
      
      A tool call to run code.
    - LocalShellCall
    - LocalShellCallOutput
    - class ResponseFunctionShellToolCall:
      
      A tool call that executes one or more shell commands in a managed environment.
    - class ResponseFunctionShellToolCallOutput:
      
      The output of a shell tool call that was emitted.
    - class ResponseApplyPatchToolCall:
      
      A tool call that applies file diffs by creating, deleting, or updating files.
    - class ResponseApplyPatchToolCallOutput:
      
      The output emitted by an apply patch tool call.
    - McpCall
    - McpListTools
    - McpApprovalRequest
    - McpApprovalResponse
    - class ResponseCustomToolCall:
      
      A call to a custom tool created by the model.
    - class ResponseCustomToolCallOutputItem:
      
      The output of a custom tool call from your code, being sent back to the model.
  - 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
    
    The type of the event. Always response.output_item.added.
    - RESPONSE_OUTPUT_ITEM_ADDED("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
    
    The type of the event. Always response.output_item.done.
    - RESPONSE_OUTPUT_ITEM_DONE("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
      
      The type of the summary part. Always summary_text.
      - SUMMARY_TEXT("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
    
    The type of the event. Always response.reasoning_summary_part.added.
    - RESPONSE_REASONING_SUMMARY_PART_ADDED("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
      
      The type of the summary part. Always summary_text.
      - SUMMARY_TEXT("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
    
    The type of the event. Always response.reasoning_summary_part.done.
    - RESPONSE_REASONING_SUMMARY_PART_DONE("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
    
    The type of the event. Always response.reasoning_summary_text.delta.
    - RESPONSE_REASONING_SUMMARY_TEXT_DELTA("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
    
    The type of the event. Always response.reasoning_summary_text.done.
    - RESPONSE_REASONING_SUMMARY_TEXT_DONE("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
    
    The type of the event. Always response.reasoning_text.delta.
    - RESPONSE_REASONING_TEXT_DELTA("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
    
    The type of the event. Always response.reasoning_text.done.
    - RESPONSE_REASONING_TEXT_DONE("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
    
    The type of the event. Always response.refusal.delta.
    - RESPONSE_REFUSAL_DELTA("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
    
    The type of the event. Always response.refusal.done.
    - RESPONSE_REFUSAL_DONE("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 probabilities of up to 20 of the 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
    
    The type of the event. Always response.output_text.delta.
    - RESPONSE_OUTPUT_TEXT_DELTA("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 probabilities of up to 20 of the 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
    
    The type of the event. Always response.output_text.done.
    - RESPONSE_OUTPUT_TEXT_DONE("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
    
    The type of the event. Always response.web_search_call.completed.
    - RESPONSE_WEB_SEARCH_CALL_COMPLETED("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
    
    The type of the event. Always response.web_search_call.in_progress.
    - RESPONSE_WEB_SEARCH_CALL_IN_PROGRESS("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
    
    The type of the event. Always response.web_search_call.searching.
    - RESPONSE_WEB_SEARCH_CALL_SEARCHING("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
    
    The type of the event. Always 'response.image_generation_call.completed'.
    - RESPONSE_IMAGE_GENERATION_CALL_COMPLETED("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
    
    The type of the event. Always 'response.image_generation_call.generating'.
    - RESPONSE_IMAGE_GENERATION_CALL_GENERATING("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
    
    The type of the event. Always 'response.image_generation_call.in_progress'.
    - RESPONSE_IMAGE_GENERATION_CALL_IN_PROGRESS("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
    
    The type of the event. Always 'response.image_generation_call.partial_image'.
    - RESPONSE_IMAGE_GENERATION_CALL_PARTIAL_IMAGE("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
    
    The type of the event. Always 'response.mcp_call_arguments.delta'.
    - RESPONSE_MCP_CALL_ARGUMENTS_DELTA("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
    
    The type of the event. Always 'response.mcp_call_arguments.done'.
    - RESPONSE_MCP_CALL_ARGUMENTS_DONE("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
    
    The type of the event. Always 'response.mcp_call.completed'.
    - RESPONSE_MCP_CALL_COMPLETED("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
    
    The type of the event. Always 'response.mcp_call.failed'.
    - RESPONSE_MCP_CALL_FAILED("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
    
    The type of the event. Always 'response.mcp_call.in_progress'.
    - RESPONSE_MCP_CALL_IN_PROGRESS("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
    
    The type of the event. Always 'response.mcp_list_tools.completed'.
    - RESPONSE_MCP_LIST_TOOLS_COMPLETED("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
    
    The type of the event. Always 'response.mcp_list_tools.failed'.
    - RESPONSE_MCP_LIST_TOOLS_FAILED("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
    
    The type of the event. Always 'response.mcp_list_tools.in_progress'.
    - RESPONSE_MCP_LIST_TOOLS_IN_PROGRESS("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
    
    The type of the event. Always 'response.output_text.annotation.added'.
    - RESPONSE_OUTPUT_TEXT_ANNOTATION_ADDED("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
    
    The type of the event. Always 'response.queued'.
    - RESPONSE_QUEUED("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
    
    The event type identifier.
    - RESPONSE_CUSTOM_TOOL_CALL_INPUT_DELTA("response.custom_tool_call_input.delta")
- 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
    
    The event type identifier.
    - RESPONSE_CUSTOM_TOOL_CALL_INPUT_DONE("response.custom_tool_call_input.done")

Response Text Config

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.
  - class ResponseFormatText:
    
    Default response format. Used to generate text responses.
    - JsonValue; type "text"constant
      
      The type of response format being defined. Always text.
      - TEXT("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
      
      The type of response format being defined. Always json_schema.
      - JSON_SCHEMA("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
      
      The type of response format being defined. Always json_object.
      - JSON_OBJECT("json_object")
- 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.
  - LOW("low")
  - MEDIUM("medium")
  - HIGH("high")

Response Text Delta Event

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 probabilities of up to 20 of the 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
  
  The type of the event. Always response.output_text.delta.
  - RESPONSE_OUTPUT_TEXT_DELTA("response.output_text.delta")

Response Text Done Event

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 probabilities of up to 20 of the 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
  
  The type of the event. Always response.output_text.done.
  - RESPONSE_OUTPUT_TEXT_DONE("response.output_text.done")

Response Tool Search Call

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.
  - SERVER("server")
  - CLIENT("client")
- Status status
  
  The status of the tool search call item that was recorded.
  - IN_PROGRESS("in_progress")
  - COMPLETED("completed")
  - INCOMPLETE("incomplete")
- JsonValue; type "tool_search_call"constant
  
  The type of the item. Always tool_search_call.
  - TOOL_SEARCH_CALL("tool_search_call")
- Optional<String> createdBy
  
  The identifier of the actor that created the item.

Response Tool Search Output 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.
  - SERVER("server")
  - CLIENT("client")
- Status status
  
  The status of the tool search output item that was recorded.
  - IN_PROGRESS("in_progress")
  - COMPLETED("completed")
  - INCOMPLETE("incomplete")
- List<Tool> tools
  
  The loaded tool definitions returned by tool search.
  - 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
      
      The type of the function tool. Always function.
      - FUNCTION("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
      
      The type of the file search tool. Always file_search.
      - FILE_SEARCH("file_search")
    - List<String> vectorStoreIds
      
      The IDs of the vector stores to search.
    - Optional<Filters> filters
      
      A filter to apply.
      - 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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
        
        Type type
        
        Type of operation: and or or.
        
        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.
        
        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
      
      The type of the computer tool. Always computer.
      - COMPUTER("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.
      - WINDOWS("windows")
      - MAC("mac")
      - LINUX("linux")
      - UBUNTU("ubuntu")
      - BROWSER("browser")
    - JsonValue; type "computer_use_preview"constant
      
      The type of the computer use tool. Always computer_use_preview.
      - COMPUTER_USE_PREVIEW("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.
      - 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.
      - 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.
        
        APPROXIMATE("approximate")
  - Mcp
    - String serverLabel
      
      A label for this MCP server, used to identify it in tool calls.
    - JsonValue; type "mcp"constant
      
      The type of the MCP tool. Always mcp.
      - MCP("mcp")
    - Optional<AllowedTools> allowedTools
      
      List of allowed tool names or a filter object.
      - 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
      - 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.
      - 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.
      - 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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
    - JsonValue; type "code_interpreter"constant
      
      The type of the code interpreter tool. Always code_interpreter.
      - CODE_INTERPRETER("code_interpreter")
  - ImageGeneration
    - JsonValue; type "image_generation"constant
      
      The type of the image generation tool. Always image_generation.
      - IMAGE_GENERATION("image_generation")
    - Optional<Action> action
      
      Whether to generate a new image or edit an existing image. Default: auto.
      - GENERATE("generate")
      - EDIT("edit")
      - AUTO("auto")
    - Optional<Background> background
      
      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.
      - 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.
      - 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.
      - GPT_IMAGE_1("gpt-image-1")
      - GPT_IMAGE_1_MINI("gpt-image-1-mini")
      - GPT_IMAGE_2("gpt-image-2")
      - GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
      - GPT_IMAGE_1_5("gpt-image-1.5")
      - CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
    - Optional<Moderation> moderation
      
      Moderation level for the generated image. Default: auto.
      - AUTO("auto")
      - LOW("low")
    - Optional<Long> outputCompression
      
      Compression level for the output image. Default: 100.
    - Optional<OutputFormat> outputFormat
      
      The output format of the generated image. One of png, webp, or jpeg. Default: png.
      - PNG("png")
      - WEBP("webp")
      - JPEG("jpeg")
    - Optional<Long> partialImages
      
      Number of partial images to generate in streaming mode, from 0 (default value) to 3.
    - Optional<Quality> quality
      
      The quality of the generated image. One of low, medium, high, or auto. Default: auto.
      - LOW("low")
      - MEDIUM("medium")
      - HIGH("high")
      - AUTO("auto")
    - Optional<Size> size
      
      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.
      - _1024X1024("1024x1024")
      - _1024X1536("1024x1536")
      - _1536X1024("1536x1024")
      - AUTO("auto")
  - JsonValue;
    - JsonValue; type "local_shell"constant
      
      The type of the local shell tool. Always local_shell.
      - LOCAL_SHELL("local_shell")
  - class FunctionShellTool:
    
    A tool that allows the model to execute shell commands.
    - JsonValue; type "shell"constant
      
      The type of the shell tool. Always shell.
      - SHELL("shell")
    - Optional<Environment> environment
      - class ContainerAuto:
        
        JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
        
        Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
      - class LocalEnvironment:
        
        JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
        
        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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
  - 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
      
      The type of the custom tool. Always custom.
      - CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
      - Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
  - class NamespaceTool:
    
    Groups function/custom tools under a shared namespace.
    - String description
      
      A description of the namespace shown to the model.
    - String name
      
      The namespace name used in tool calls (for example, crm).
    - List<Tool> tools
      
      The function/custom tools available inside this namespace.
      - class Function:
        
        String name
        
        JsonValue; type "function"constant
        
        FUNCTION("function")
        
        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
    - JsonValue; type "namespace"constant
      
      The type of the tool. Always namespace.
      - NAMESPACE("namespace")
  - class ToolSearchTool:
    
    Hosted or BYOT tool search configuration for deferred tools.
    - JsonValue; type "tool_search"constant
      
      The type of the tool. Always tool_search.
      - TOOL_SEARCH("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.
      - 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.
      - WEB_SEARCH_PREVIEW("web_search_preview")
      - WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
    - Optional<List<SearchContentType>> searchContentTypes
      - 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.
      - LOW("low")
      - MEDIUM("medium")
      - HIGH("high")
    - Optional<UserLocation> userLocation
      
      The user's location.
      - JsonValue; type "approximate"constant
        
        The type of location approximation. Always approximate.
        
        APPROXIMATE("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
      
      The type of the tool. Always apply_patch.
      - APPLY_PATCH("apply_patch")
- JsonValue; type "tool_search_output"constant
  
  The type of the item. Always tool_search_output.
  - TOOL_SEARCH_OUTPUT("tool_search_output")
- Optional<String> createdBy
  
  The identifier of the actor that created the item.

Response Tool Search Output Item Param

class ResponseToolSearchOutputItemParam:
- List<Tool> tools
  
  The loaded tool definitions returned by the tool search output.
  - 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
      
      The type of the function tool. Always function.
      - FUNCTION("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
      
      The type of the file search tool. Always file_search.
      - FILE_SEARCH("file_search")
    - List<String> vectorStoreIds
      
      The IDs of the vector stores to search.
    - Optional<Filters> filters
      
      A filter to apply.
      - 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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
        
        Type type
        
        Type of operation: and or or.
        
        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.
        
        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
      
      The type of the computer tool. Always computer.
      - COMPUTER("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.
      - WINDOWS("windows")
      - MAC("mac")
      - LINUX("linux")
      - UBUNTU("ubuntu")
      - BROWSER("browser")
    - JsonValue; type "computer_use_preview"constant
      
      The type of the computer use tool. Always computer_use_preview.
      - COMPUTER_USE_PREVIEW("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.
      - 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.
      - 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.
        
        APPROXIMATE("approximate")
  - Mcp
    - String serverLabel
      
      A label for this MCP server, used to identify it in tool calls.
    - JsonValue; type "mcp"constant
      
      The type of the MCP tool. Always mcp.
      - MCP("mcp")
    - Optional<AllowedTools> allowedTools
      
      List of allowed tool names or a filter object.
      - 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
      - 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.
      - 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.
      - 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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
    - JsonValue; type "code_interpreter"constant
      
      The type of the code interpreter tool. Always code_interpreter.
      - CODE_INTERPRETER("code_interpreter")
  - ImageGeneration
    - JsonValue; type "image_generation"constant
      
      The type of the image generation tool. Always image_generation.
      - IMAGE_GENERATION("image_generation")
    - Optional<Action> action
      
      Whether to generate a new image or edit an existing image. Default: auto.
      - GENERATE("generate")
      - EDIT("edit")
      - AUTO("auto")
    - Optional<Background> background
      
      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.
      - 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.
      - 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.
      - GPT_IMAGE_1("gpt-image-1")
      - GPT_IMAGE_1_MINI("gpt-image-1-mini")
      - GPT_IMAGE_2("gpt-image-2")
      - GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
      - GPT_IMAGE_1_5("gpt-image-1.5")
      - CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
    - Optional<Moderation> moderation
      
      Moderation level for the generated image. Default: auto.
      - AUTO("auto")
      - LOW("low")
    - Optional<Long> outputCompression
      
      Compression level for the output image. Default: 100.
    - Optional<OutputFormat> outputFormat
      
      The output format of the generated image. One of png, webp, or jpeg. Default: png.
      - PNG("png")
      - WEBP("webp")
      - JPEG("jpeg")
    - Optional<Long> partialImages
      
      Number of partial images to generate in streaming mode, from 0 (default value) to 3.
    - Optional<Quality> quality
      
      The quality of the generated image. One of low, medium, high, or auto. Default: auto.
      - LOW("low")
      - MEDIUM("medium")
      - HIGH("high")
      - AUTO("auto")
    - Optional<Size> size
      
      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.
      - _1024X1024("1024x1024")
      - _1024X1536("1024x1536")
      - _1536X1024("1536x1024")
      - AUTO("auto")
  - JsonValue;
    - JsonValue; type "local_shell"constant
      
      The type of the local shell tool. Always local_shell.
      - LOCAL_SHELL("local_shell")
  - class FunctionShellTool:
    
    A tool that allows the model to execute shell commands.
    - JsonValue; type "shell"constant
      
      The type of the shell tool. Always shell.
      - SHELL("shell")
    - Optional<Environment> environment
      - class ContainerAuto:
        
        JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
        
        Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
      - class LocalEnvironment:
        
        JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
        
        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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
  - 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
      
      The type of the custom tool. Always custom.
      - CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
      - Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
  - class NamespaceTool:
    
    Groups function/custom tools under a shared namespace.
    - String description
      
      A description of the namespace shown to the model.
    - String name
      
      The namespace name used in tool calls (for example, crm).
    - List<Tool> tools
      
      The function/custom tools available inside this namespace.
      - class Function:
        
        String name
        
        JsonValue; type "function"constant
        
        FUNCTION("function")
        
        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
    - JsonValue; type "namespace"constant
      
      The type of the tool. Always namespace.
      - NAMESPACE("namespace")
  - class ToolSearchTool:
    
    Hosted or BYOT tool search configuration for deferred tools.
    - JsonValue; type "tool_search"constant
      
      The type of the tool. Always tool_search.
      - TOOL_SEARCH("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.
      - 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.
      - WEB_SEARCH_PREVIEW("web_search_preview")
      - WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
    - Optional<List<SearchContentType>> searchContentTypes
      - 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.
      - LOW("low")
      - MEDIUM("medium")
      - HIGH("high")
    - Optional<UserLocation> userLocation
      
      The user's location.
      - JsonValue; type "approximate"constant
        
        The type of location approximation. Always approximate.
        
        APPROXIMATE("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
      
      The type of the tool. Always apply_patch.
      - APPLY_PATCH("apply_patch")
- JsonValue; type "tool_search_output"constant
  
  The item type. Always tool_search_output.
  - TOOL_SEARCH_OUTPUT("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.
- Optional<Execution> execution
  
  Whether tool search was executed by the server or by the client.
  - SERVER("server")
  - CLIENT("client")
- Optional<Status> status
  
  The status of the tool search output.
  - IN_PROGRESS("in_progress")
  - COMPLETED("completed")
  - INCOMPLETE("incomplete")

Response Usage

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.

Response Web Search Call Completed Event

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
  
  The type of the event. Always response.web_search_call.completed.
  - RESPONSE_WEB_SEARCH_CALL_COMPLETED("response.web_search_call.completed")

Response Web Search Call In Progress Event

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
  
  The type of the event. Always response.web_search_call.in_progress.
  - RESPONSE_WEB_SEARCH_CALL_IN_PROGRESS("response.web_search_call.in_progress")

Response Web Search Call Searching Event

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
  
  The type of the event. Always response.web_search_call.searching.
  - RESPONSE_WEB_SEARCH_CALL_SEARCHING("response.web_search_call.searching")

Responses Client Event

class ResponsesClientEvent:
- JsonValue; type "response.create"constant
  
  The type of the client event. Always response.create.
  - RESPONSE_CREATE("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.
- 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.
  - 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).
  - 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
  - String
  - List<ResponseInputItem>
    - 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.
        
        String
        
        List<ResponseInputContent>
        
        class ResponseInputText:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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.
        
        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.
        
        COMMENTARY("commentary")
        
        FINAL_ANSWER("final_answer")
      - Optional<Type> type
        
        The type of the message input. Always message.
        
        MESSAGE("message")
    - Message
      - List<ResponseInputContent> content
        
        A list of one or many input items to the model, containing different content types.
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
      - Role role
        
        The role of the message input. One of user, system, or developer.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - Optional<Type> type
        
        The type of the message input. Always set to message.
        
        MESSAGE("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.
        
        class ResponseOutputText:
        
        A text output from the model.
        
        List<Annotation> annotations
        
        The annotations of the text output.
        
        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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
        
        String text
        
        The text output from the model.
        
        JsonValue; type "output_text"constant
        
        The type of the output text. Always output_text.
        
        OUTPUT_TEXT("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
        
        The type of the refusal. Always refusal.
        
        REFUSAL("refusal")
      - JsonValue; role "assistant"constant
        
        The role of the output message. Always assistant.
        
        ASSISTANT("assistant")
      - Status status
        
        The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "message"constant
        
        The type of the output message. Always message.
        
        MESSAGE("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.
        
        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,
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        FAILED("failed")
      - JsonValue; type "file_search_call"constant
        
        The type of the file search tool call. Always file_search_call.
        
        FILE_SEARCH_CALL("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.
        
        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.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - Type type
        
        The type of the computer call. Always computer_call.
        
        COMPUTER_CALL("computer_call")
      - Optional<Action> action
        
        A click action.
        
        class Click:
        
        A click action.
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        class Move:
        
        A mouse move action.
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        class Scroll:
        
        A scroll action.
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
      - Optional<List<ComputerAction>> actions
        
        Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.
        
        Click
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        Move
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        Scroll
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
    - ComputerCallOutput
      - 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.
        
        JsonValue; type "computer_screenshot"constant
        
        Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
        
        COMPUTER_SCREENSHOT("computer_screenshot")
        
        Optional<String> fileId
        
        The identifier of an uploaded file that contains the screenshot.
        
        Optional<String> imageUrl
        
        The URL of the screenshot image.
      - JsonValue; type "computer_call_output"constant
        
        The type of the computer tool call output. Always computer_call_output.
        
        COMPUTER_CALL_OUTPUT("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.
        
        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).
        
        class Search:
        
        Action type "search" - Performs a web search query.
        
        String query
        
        [DEPRECATED] The search query.
        
        JsonValue; type "search"constant
        
        The action type.
        
        SEARCH("search")
        
        Optional<List<String>> queries
        
        The search queries.
        
        Optional<List<Source>> sources
        
        The sources used in the search.
        
        JsonValue; type "url"constant
        
        The type of source. Always url.
        
        URL("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
        
        The action type.
        
        OPEN_PAGE("open_page")
        
        Optional<String> url
        
        The URL opened by the model.
        
        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
        
        The action type.
        
        FIND_IN_PAGE("find_in_page")
        
        String url
        
        The URL of the page searched for the pattern.
      - Status status
        
        The status of the web search tool call.
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        FAILED("failed")
      - JsonValue; type "web_search_call"constant
        
        The type of the web search tool call. Always web_search_call.
        
        WEB_SEARCH_CALL("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
        
        The type of the function tool call. Always function_call.
        
        FUNCTION_CALL("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - FunctionCallOutput
      - String callId
        
        The unique ID of the function tool call generated by the model.
      - Output output
        
        Text, image, or file output of the function tool call.
        
        String
        
        List<ResponseFunctionCallOutputItem>
        
        class ResponseInputTextContent:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("input_text")
        
        class ResponseInputImageContent:
        
        An image input to the model. Learn about image inputs
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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.
        
        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.
        
        class ResponseInputFileContent:
        
        A file input to the model.
        
        JsonValue; type "input_file"constant
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        LOW("low")
        
        HIGH("high")
        
        Optional<String> fileData
        
        The base64-encoded data 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 "function_call_output"constant
        
        The type of the function tool call output. Always function_call_output.
        
        FUNCTION_CALL_OUTPUT("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.
        
        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
        
        The item type. Always tool_search_call.
        
        TOOL_SEARCH_CALL("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.
      - Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
      - Optional<Status> status
        
        The status of the tool search call.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - class ResponseToolSearchOutputItemParam:
      - List<Tool> tools
        
        The loaded tool definitions returned by the tool search output.
        
        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
        
        The type of the function tool. Always function.
        
        FUNCTION("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
        
        The type of the file search tool. Always file_search.
        
        FILE_SEARCH("file_search")
        
        List<String> vectorStoreIds
        
        The IDs of the vector stores to search.
        
        Optional<Filters> filters
        
        A filter to apply.
        
        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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
        
        Type type
        
        Type of operation: and or or.
        
        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.
        
        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
        
        The type of the computer tool. Always computer.
        
        COMPUTER("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.
        
        WINDOWS("windows")
        
        MAC("mac")
        
        LINUX("linux")
        
        UBUNTU("ubuntu")
        
        BROWSER("browser")
        
        JsonValue; type "computer_use_preview"constant
        
        The type of the computer use tool. Always computer_use_preview.
        
        COMPUTER_USE_PREVIEW("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.
        
        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.
        
        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.
        
        APPROXIMATE("approximate")
        
        Mcp
        
        String serverLabel
        
        A label for this MCP server, used to identify it in tool calls.
        
        JsonValue; type "mcp"constant
        
        The type of the MCP tool. Always mcp.
        
        MCP("mcp")
        
        Optional<AllowedTools> allowedTools
        
        List of allowed tool names or a filter object.
        
        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
        
        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.
        
        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.
        
        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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
        
        JsonValue; type "code_interpreter"constant
        
        The type of the code interpreter tool. Always code_interpreter.
        
        CODE_INTERPRETER("code_interpreter")
        
        ImageGeneration
        
        JsonValue; type "image_generation"constant
        
        The type of the image generation tool. Always image_generation.
        
        IMAGE_GENERATION("image_generation")
        
        Optional<Action> action
        
        Whether to generate a new image or edit an existing image. Default: auto.
        
        GENERATE("generate")
        
        EDIT("edit")
        
        AUTO("auto")
        
        Optional<Background> background
        
        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.
        
        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.
        
        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.
        
        GPT_IMAGE_1("gpt-image-1")
        
        GPT_IMAGE_1_MINI("gpt-image-1-mini")
        
        GPT_IMAGE_2("gpt-image-2")
        
        GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
        
        GPT_IMAGE_1_5("gpt-image-1.5")
        
        CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
        
        Optional<Moderation> moderation
        
        Moderation level for the generated image. Default: auto.
        
        AUTO("auto")
        
        LOW("low")
        
        Optional<Long> outputCompression
        
        Compression level for the output image. Default: 100.
        
        Optional<OutputFormat> outputFormat
        
        The output format of the generated image. One of png, webp, or jpeg. Default: png.
        
        PNG("png")
        
        WEBP("webp")
        
        JPEG("jpeg")
        
        Optional<Long> partialImages
        
        Number of partial images to generate in streaming mode, from 0 (default value) to 3.
        
        Optional<Quality> quality
        
        The quality of the generated image. One of low, medium, high, or auto. Default: auto.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        AUTO("auto")
        
        Optional<Size> size
        
        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.
        
        _1024X1024("1024x1024")
        
        _1024X1536("1024x1536")
        
        _1536X1024("1536x1024")
        
        AUTO("auto")
        
        JsonValue;
        
        JsonValue; type "local_shell"constant
        
        The type of the local shell tool. Always local_shell.
        
        LOCAL_SHELL("local_shell")
        
        class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        JsonValue; type "shell"constant
        
        The type of the shell tool. Always shell.
        
        SHELL("shell")
        
        Optional<Environment> environment
        
        class ContainerAuto:
        
        JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
        
        Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
        
        class LocalEnvironment:
        
        JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
        
        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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
        
        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
        
        The type of the custom tool. Always custom.
        
        CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
        
        Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
        
        class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        String description
        
        A description of the namespace shown to the model.
        
        String name
        
        The namespace name used in tool calls (for example, crm).
        
        List<Tool> tools
        
        The function/custom tools available inside this namespace.
        
        class Function:
        
        String name
        
        JsonValue; type "function"constant
        
        FUNCTION("function")
        
        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
        
        JsonValue; type "namespace"constant
        
        The type of the tool. Always namespace.
        
        NAMESPACE("namespace")
        
        class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        JsonValue; type "tool_search"constant
        
        The type of the tool. Always tool_search.
        
        TOOL_SEARCH("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.
        
        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.
        
        WEB_SEARCH_PREVIEW("web_search_preview")
        
        WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
        
        Optional<List<SearchContentType>> searchContentTypes
        
        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.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        Optional<UserLocation> userLocation
        
        The user's location.
        
        JsonValue; type "approximate"constant
        
        The type of location approximation. Always approximate.
        
        APPROXIMATE("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
        
        The type of the tool. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
      - JsonValue; type "tool_search_output"constant
        
        The item type. Always tool_search_output.
        
        TOOL_SEARCH_OUTPUT("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.
      - Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
      - Optional<Status> status
        
        The status of the tool search output.
        
        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
        
        The type of the object. Always summary_text.
        
        SUMMARY_TEXT("summary_text")
      - JsonValue; type "reasoning"constant
        
        The type of the object. Always reasoning.
        
        REASONING("reasoning")
      - Optional<List<Content>> content
        
        Reasoning text content.
        
        String text
        
        The reasoning text from the model.
        
        JsonValue; type "reasoning_text"constant
        
        The type of the reasoning text. Always reasoning_text.
        
        REASONING_TEXT("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.
        
        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.
      - JsonValue; type "compaction"constant
        
        The type of the item. Always compaction.
        
        COMPACTION("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        GENERATING("generating")
        
        FAILED("failed")
      - JsonValue; type "image_generation_call"constant
        
        The type of the image generation call. Always image_generation_call.
        
        IMAGE_GENERATION_CALL("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.
        
        class Logs:
        
        The logs output from the code interpreter.
        
        String logs
        
        The logs output from the code interpreter.
        
        JsonValue; type "logs"constant
        
        The type of the output. Always logs.
        
        LOGS("logs")
        
        class Image:
        
        The image output from the code interpreter.
        
        JsonValue; type "image"constant
        
        The type of the output. Always image.
        
        IMAGE("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        INTERPRETING("interpreting")
        
        FAILED("failed")
      - JsonValue; type "code_interpreter_call"constant
        
        The type of the code interpreter tool call. Always code_interpreter_call.
        
        CODE_INTERPRETER_CALL("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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "local_shell_call"constant
        
        The type of the local shell call. Always local_shell_call.
        
        LOCAL_SHELL_CALL("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
        
        The type of the local shell tool call output. Always local_shell_call_output.
        
        LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
      - Optional<Status> status
        
        The status of the item. One of in_progress, completed, or incomplete.
        
        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.
      - JsonValue; type "shell_call"constant
        
        The type of the item. Always shell_call.
        
        SHELL_CALL("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.
        
        class LocalEnvironment:
        
        class ContainerReference:
      - Optional<Status> status
        
        The status of the shell call. One of in_progress, completed, or incomplete.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - ShellCallOutput
      - String callId
        
        The unique ID of the shell tool call generated by the model.
      - 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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("exit")
        
        String stderr
        
        Captured stderr output for the shell call.
        
        String stdout
        
        Captured stdout output for the shell call.
      - JsonValue; type "shell_call_output"constant
        
        The type of the item. Always shell_call_output.
        
        SHELL_CALL_OUTPUT("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - ApplyPatchCall
      - String callId
        
        The unique ID of the apply patch tool call generated by the model.
      - Operation operation
        
        The specific create, delete, or update instruction for the apply_patch tool call.
        
        class CreateFile:
        
        Instruction for creating a new file via the apply_patch tool.
        
        String diff
        
        Unified diff content to apply when creating the file.
        
        String path
        
        Path of the file to create relative to the workspace root.
        
        JsonValue; type "create_file"constant
        
        The operation type. Always create_file.
        
        CREATE_FILE("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.
        
        JsonValue; type "delete_file"constant
        
        The operation type. Always delete_file.
        
        DELETE_FILE("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.
        
        String path
        
        Path of the file to update relative to the workspace root.
        
        JsonValue; type "update_file"constant
        
        The operation type. Always update_file.
        
        UPDATE_FILE("update_file")
      - Status status
        
        The status of the apply patch tool call. One of in_progress or completed.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
      - JsonValue; type "apply_patch_call"constant
        
        The type of the item. Always apply_patch_call.
        
        APPLY_PATCH_CALL("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.
      - Status status
        
        The status of the apply patch tool call output. One of completed or failed.
        
        COMPLETED("completed")
        
        FAILED("failed")
      - JsonValue; type "apply_patch_call_output"constant
        
        The type of the item. Always apply_patch_call_output.
        
        APPLY_PATCH_CALL_OUTPUT("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).
    - 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
        
        The type of the item. Always mcp_list_tools.
        
        MCP_LIST_TOOLS("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
        
        The type of the item. Always mcp_approval_request.
        
        MCP_APPROVAL_REQUEST("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
        
        The type of the item. Always mcp_approval_response.
        
        MCP_APPROVAL_RESPONSE("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
        
        The type of the item. Always mcp_call.
        
        MCP_CALL("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.
        
        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.
        
        String
        
        List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
      - JsonValue; type "custom_tool_call_output"constant
        
        The type of the custom tool call output. Always custom_tool_call_output.
        
        CUSTOM_TOOL_CALL_OUTPUT("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
        
        The type of the custom tool call. Always custom_tool_call.
        
        CUSTOM_TOOL_CALL("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.
    - JsonValue;
      - JsonValue; type "compaction_trigger"constant
        
        The type of the item. Always compaction_trigger.
        
        COMPACTION_TRIGGER("compaction_trigger")
    - ItemReference
      - String id
        
        The ID of the item to reference.
      - Optional<Type> type
        
        The type of item to reference. Always item_reference.
        
        ITEM_REFERENCE("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.
- 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.
  - String
  - enum ChatModel:
    - GPT_5_4("gpt-5.4")
    - GPT_5_4_MINI("gpt-5.4-mini")
    - GPT_5_4_NANO("gpt-5.4-nano")
    - GPT_5_4_MINI_2026_03_17("gpt-5.4-mini-2026-03-17")
    - GPT_5_4_NANO_2026_03_17("gpt-5.4-nano-2026-03-17")
    - GPT_5_3_CHAT_LATEST("gpt-5.3-chat-latest")
    - GPT_5_2("gpt-5.2")
    - GPT_5_2_2025_12_11("gpt-5.2-2025-12-11")
    - GPT_5_2_CHAT_LATEST("gpt-5.2-chat-latest")
    - GPT_5_2_PRO("gpt-5.2-pro")
    - GPT_5_2_PRO_2025_12_11("gpt-5.2-pro-2025-12-11")
    - GPT_5_1("gpt-5.1")
    - GPT_5_1_2025_11_13("gpt-5.1-2025-11-13")
    - GPT_5_1_CODEX("gpt-5.1-codex")
    - GPT_5_1_MINI("gpt-5.1-mini")
    - GPT_5_1_CHAT_LATEST("gpt-5.1-chat-latest")
    - GPT_5("gpt-5")
    - GPT_5_MINI("gpt-5-mini")
    - GPT_5_NANO("gpt-5-nano")
    - GPT_5_2025_08_07("gpt-5-2025-08-07")
    - GPT_5_MINI_2025_08_07("gpt-5-mini-2025-08-07")
    - GPT_5_NANO_2025_08_07("gpt-5-nano-2025-08-07")
    - GPT_5_CHAT_LATEST("gpt-5-chat-latest")
    - GPT_4_1("gpt-4.1")
    - GPT_4_1_MINI("gpt-4.1-mini")
    - GPT_4_1_NANO("gpt-4.1-nano")
    - GPT_4_1_2025_04_14("gpt-4.1-2025-04-14")
    - GPT_4_1_MINI_2025_04_14("gpt-4.1-mini-2025-04-14")
    - GPT_4_1_NANO_2025_04_14("gpt-4.1-nano-2025-04-14")
    - O4_MINI("o4-mini")
    - O4_MINI_2025_04_16("o4-mini-2025-04-16")
    - O3("o3")
    - O3_2025_04_16("o3-2025-04-16")
    - O3_MINI("o3-mini")
    - O3_MINI_2025_01_31("o3-mini-2025-01-31")
    - O1("o1")
    - O1_2024_12_17("o1-2024-12-17")
    - O1_PREVIEW("o1-preview")
    - O1_PREVIEW_2024_09_12("o1-preview-2024-09-12")
    - O1_MINI("o1-mini")
    - O1_MINI_2024_09_12("o1-mini-2024-09-12")
    - GPT_4O("gpt-4o")
    - GPT_4O_2024_11_20("gpt-4o-2024-11-20")
    - GPT_4O_2024_08_06("gpt-4o-2024-08-06")
    - GPT_4O_2024_05_13("gpt-4o-2024-05-13")
    - GPT_4O_AUDIO_PREVIEW("gpt-4o-audio-preview")
    - GPT_4O_AUDIO_PREVIEW_2024_10_01("gpt-4o-audio-preview-2024-10-01")
    - GPT_4O_AUDIO_PREVIEW_2024_12_17("gpt-4o-audio-preview-2024-12-17")
    - GPT_4O_AUDIO_PREVIEW_2025_06_03("gpt-4o-audio-preview-2025-06-03")
    - GPT_4O_MINI_AUDIO_PREVIEW("gpt-4o-mini-audio-preview")
    - GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17("gpt-4o-mini-audio-preview-2024-12-17")
    - GPT_4O_SEARCH_PREVIEW("gpt-4o-search-preview")
    - GPT_4O_MINI_SEARCH_PREVIEW("gpt-4o-mini-search-preview")
    - GPT_4O_SEARCH_PREVIEW_2025_03_11("gpt-4o-search-preview-2025-03-11")
    - GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11("gpt-4o-mini-search-preview-2025-03-11")
    - CHATGPT_4O_LATEST("chatgpt-4o-latest")
    - CODEX_MINI_LATEST("codex-mini-latest")
    - GPT_4O_MINI("gpt-4o-mini")
    - GPT_4O_MINI_2024_07_18("gpt-4o-mini-2024-07-18")
    - GPT_4_TURBO("gpt-4-turbo")
    - GPT_4_TURBO_2024_04_09("gpt-4-turbo-2024-04-09")
    - GPT_4_0125_PREVIEW("gpt-4-0125-preview")
    - GPT_4_TURBO_PREVIEW("gpt-4-turbo-preview")
    - GPT_4_1106_PREVIEW("gpt-4-1106-preview")
    - GPT_4_VISION_PREVIEW("gpt-4-vision-preview")
    - GPT_4("gpt-4")
    - GPT_4_0314("gpt-4-0314")
    - GPT_4_0613("gpt-4-0613")
    - GPT_4_32K("gpt-4-32k")
    - GPT_4_32K_0314("gpt-4-32k-0314")
    - GPT_4_32K_0613("gpt-4-32k-0613")
    - GPT_3_5_TURBO("gpt-3.5-turbo")
    - GPT_3_5_TURBO_16K("gpt-3.5-turbo-16k")
    - GPT_3_5_TURBO_0301("gpt-3.5-turbo-0301")
    - GPT_3_5_TURBO_0613("gpt-3.5-turbo-0613")
    - GPT_3_5_TURBO_1106("gpt-3.5-turbo-1106")
    - GPT_3_5_TURBO_0125("gpt-3.5-turbo-0125")
    - GPT_3_5_TURBO_16K_0613("gpt-3.5-turbo-16k-0613")
  - ResponsesOnlyModel
    - O1_PRO("o1-pro")
    - O1_PRO_2025_03_19("o1-pro-2025-03-19")
    - O3_PRO("o3-pro")
    - O3_PRO_2025_06_10("o3-pro-2025-06-10")
    - O3_DEEP_RESEARCH("o3-deep-research")
    - O3_DEEP_RESEARCH_2025_06_26("o3-deep-research-2025-06-26")
    - O4_MINI_DEEP_RESEARCH("o4-mini-deep-research")
    - O4_MINI_DEEP_RESEARCH_2025_06_26("o4-mini-deep-research-2025-06-26")
    - COMPUTER_USE_PREVIEW("computer-use-preview")
    - COMPUTER_USE_PREVIEW_2025_03_11("computer-use-preview-2025-03-11")
    - GPT_5_CODEX("gpt-5-codex")
    - GPT_5_PRO("gpt-5-pro")
    - GPT_5_PRO_2025_10_06("gpt-5-pro-2025-10-06")
    - GPT_5_1_CODEX_MAX("gpt-5.1-codex-max")
- 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.
  - 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.
    - String
    - class ResponseInputText:
      
      A text input to the model.
    - class ResponseInputImage:
      
      An image input to the model. Learn about image inputs.
    - class ResponseInputFile:
      
      A file input to the model.
  - Optional<String> version
    
    Optional version of the prompt template.
- 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.
  - IN_MEMORY("in_memory")
  - _24H("24h")
- Optional<Reasoning> reasoning
  
  gpt-5 and o-series models only
  
  Configuration options for reasoning models.
  - Optional<ReasoningEffort> effort
    
    Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
    - gpt-5.1 defaults to none, which does not perform reasoning. The supported reasoning values for gpt-5.1 are none, low, medium, and high. Tool calls are supported for all reasoning values in gpt-5.1.
    - All models before gpt-5.1 default to medium reasoning effort, and do not support none.
    - The gpt-5-pro model defaults to (and only supports) high reasoning effort.
    - xhigh is supported for all models after gpt-5.1-codex-max.
    - NONE("none")
    - MINIMAL("minimal")
    - LOW("low")
    - MEDIUM("medium")
    - HIGH("high")
    - XHIGH("xhigh")
  - Optional<GenerateSummary> generateSummary
    
    Deprecated: use summary instead.
    
    A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
    - AUTO("auto")
    - CONCISE("concise")
    - DETAILED("detailed")
  - Optional<Summary> summary
    
    A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
    
    concise is supported for computer-use-preview models and all reasoning models after gpt-5.
    - AUTO("auto")
    - CONCISE("concise")
    - DETAILED("detailed")
- 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.
- 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.
  - 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.
- 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<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.
    - class ResponseFormatText:
      
      Default response format. Used to generate text responses.
      - JsonValue; type "text"constant
        
        The type of response format being defined. Always text.
        
        TEXT("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
        
        The type of response format being defined. Always json_schema.
        
        JSON_SCHEMA("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
        
        The type of response format being defined. Always json_object.
        
        JSON_OBJECT("json_object")
  - 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.
    - LOW("low")
    - MEDIUM("medium")
    - HIGH("high")
- 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.
  - 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.
      - 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 tool configuration type. Always allowed_tools.
      - ALLOWED_TOOLS("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
      - 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
      
      For function calling, the type is always function.
      - FUNCTION("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
      
      For MCP tools, the type is always mcp.
      - MCP("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
      
      For custom tool calling, the type is always custom.
      - CUSTOM("custom")
  - class ToolChoiceApplyPatch:
    
    Forces the model to call the apply_patch tool when executing a tool call.
    - JsonValue; type "apply_patch"constant
      
      The tool to call. Always apply_patch.
      - APPLY_PATCH("apply_patch")
  - class ToolChoiceShell:
    
    Forces the model to call the shell tool when a tool call is required.
    - JsonValue; type "shell"constant
      
      The tool to call. Always shell.
      - SHELL("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.
  - class FunctionTool:
    
    Defines a function in your own code the model can choose to call. Learn more about function calling.
  - class FileSearchTool:
    
    A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
  - class ComputerTool:
    
    A tool that controls a virtual computer. Learn more about the computer tool.
  - class ComputerUsePreviewTool:
    
    A tool that controls a virtual computer. Learn more about the computer tool.
  - class WebSearchTool:
    
    Search the Internet for sources related to the prompt. Learn more about the web search tool.
  - Mcp
  - CodeInterpreter
  - ImageGeneration
  - JsonValue;
  - class FunctionShellTool:
    
    A tool that allows the model to execute shell commands.
  - class CustomTool:
    
    A custom tool that processes input using a specified format. Learn more about custom tools
  - class NamespaceTool:
    
    Groups function/custom tools under a shared namespace.
  - class ToolSearchTool:
    
    Hosted or BYOT tool search configuration for deferred tools.
  - class WebSearchPreviewTool:
    
    This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
  - class ApplyPatchTool:
    
    Allows the assistant to create, delete, or update files using unified diffs.
- Optional<Long> topLogprobs
  
  An integer between 0 and 20 specifying the maximum number of most likely tokens to return at each token position, each with an associated log probability. In some cases, the number of returned tokens may be fewer than requested.
- 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.
- 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.
  - AUTO("auto")
  - DISABLED("disabled")
- Optional<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.

Responses Server Event

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
    
    The type of the event. Always response.audio.delta.
    - RESPONSE_AUDIO_DELTA("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
    
    The type of the event. Always response.audio.done.
    - RESPONSE_AUDIO_DONE("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
    
    The type of the event. Always response.audio.transcript.delta.
    - RESPONSE_AUDIO_TRANSCRIPT_DELTA("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
    
    The type of the event. Always response.audio.transcript.done.
    - RESPONSE_AUDIO_TRANSCRIPT_DONE("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
    
    The type of the event. Always response.code_interpreter_call_code.delta.
    - RESPONSE_CODE_INTERPRETER_CALL_CODE_DELTA("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
    
    The type of the event. Always response.code_interpreter_call_code.done.
    - RESPONSE_CODE_INTERPRETER_CALL_CODE_DONE("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
    
    The type of the event. Always response.code_interpreter_call.completed.
    - RESPONSE_CODE_INTERPRETER_CALL_COMPLETED("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
    
    The type of the event. Always response.code_interpreter_call.in_progress.
    - RESPONSE_CODE_INTERPRETER_CALL_IN_PROGRESS("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
    
    The type of the event. Always response.code_interpreter_call.interpreting.
    - RESPONSE_CODE_INTERPRETER_CALL_INTERPRETING("response.code_interpreter_call.interpreting")
- class ResponseCompletedEvent:
  
  Emitted when the model response is complete.
  - Response response
    
    Properties of the completed 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.
      - Code code
        
        The error code for the response.
        
        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.
    - Optional<IncompleteDetails> incompleteDetails
      
      Details about why the response is incomplete.
      - Optional<Reason> reason
        
        The reason why the response is incomplete.
        
        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.
      - String
      - List<ResponseInputItem>
        
        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.
        
        String
        
        List<ResponseInputContent>
        
        class ResponseInputText:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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.
        
        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.
        
        COMMENTARY("commentary")
        
        FINAL_ANSWER("final_answer")
        
        Optional<Type> type
        
        The type of the message input. Always message.
        
        MESSAGE("message")
        
        Message
        
        List<ResponseInputContent> content
        
        A list of one or many input items to the model, containing different content types.
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
        
        Role role
        
        The role of the message input. One of user, system, or developer.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        Optional<Type> type
        
        The type of the message input. Always set to message.
        
        MESSAGE("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.
        
        class ResponseOutputText:
        
        A text output from the model.
        
        List<Annotation> annotations
        
        The annotations of the text output.
        
        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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
        
        String text
        
        The text output from the model.
        
        JsonValue; type "output_text"constant
        
        The type of the output text. Always output_text.
        
        OUTPUT_TEXT("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
        
        The type of the refusal. Always refusal.
        
        REFUSAL("refusal")
        
        JsonValue; role "assistant"constant
        
        The role of the output message. Always assistant.
        
        ASSISTANT("assistant")
        
        Status status
        
        The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        JsonValue; type "message"constant
        
        The type of the output message. Always message.
        
        MESSAGE("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.
        
        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,
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        FAILED("failed")
        
        JsonValue; type "file_search_call"constant
        
        The type of the file search tool call. Always file_search_call.
        
        FILE_SEARCH_CALL("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.
        
        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.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        Type type
        
        The type of the computer call. Always computer_call.
        
        COMPUTER_CALL("computer_call")
        
        Optional<Action> action
        
        A click action.
        
        class Click:
        
        A click action.
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        class Move:
        
        A mouse move action.
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        class Scroll:
        
        A scroll action.
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
        
        Optional<List<ComputerAction>> actions
        
        Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.
        
        Click
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        Move
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        Scroll
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
        
        ComputerCallOutput
        
        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.
        
        JsonValue; type "computer_screenshot"constant
        
        Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
        
        COMPUTER_SCREENSHOT("computer_screenshot")
        
        Optional<String> fileId
        
        The identifier of an uploaded file that contains the screenshot.
        
        Optional<String> imageUrl
        
        The URL of the screenshot image.
        
        JsonValue; type "computer_call_output"constant
        
        The type of the computer tool call output. Always computer_call_output.
        
        COMPUTER_CALL_OUTPUT("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.
        
        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).
        
        class Search:
        
        Action type "search" - Performs a web search query.
        
        String query
        
        [DEPRECATED] The search query.
        
        JsonValue; type "search"constant
        
        The action type.
        
        SEARCH("search")
        
        Optional<List<String>> queries
        
        The search queries.
        
        Optional<List<Source>> sources
        
        The sources used in the search.
        
        JsonValue; type "url"constant
        
        The type of source. Always url.
        
        URL("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
        
        The action type.
        
        OPEN_PAGE("open_page")
        
        Optional<String> url
        
        The URL opened by the model.
        
        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
        
        The action type.
        
        FIND_IN_PAGE("find_in_page")
        
        String url
        
        The URL of the page searched for the pattern.
        
        Status status
        
        The status of the web search tool call.
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        FAILED("failed")
        
        JsonValue; type "web_search_call"constant
        
        The type of the web search tool call. Always web_search_call.
        
        WEB_SEARCH_CALL("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
        
        The type of the function tool call. Always function_call.
        
        FUNCTION_CALL("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        FunctionCallOutput
        
        String callId
        
        The unique ID of the function tool call generated by the model.
        
        Output output
        
        Text, image, or file output of the function tool call.
        
        String
        
        List<ResponseFunctionCallOutputItem>
        
        class ResponseInputTextContent:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("input_text")
        
        class ResponseInputImageContent:
        
        An image input to the model. Learn about image inputs
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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.
        
        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.
        
        class ResponseInputFileContent:
        
        A file input to the model.
        
        JsonValue; type "input_file"constant
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        LOW("low")
        
        HIGH("high")
        
        Optional<String> fileData
        
        The base64-encoded data 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 "function_call_output"constant
        
        The type of the function tool call output. Always function_call_output.
        
        FUNCTION_CALL_OUTPUT("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.
        
        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
        
        The item type. Always tool_search_call.
        
        TOOL_SEARCH_CALL("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.
        
        Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
        
        Optional<Status> status
        
        The status of the tool search call.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        class ResponseToolSearchOutputItemParam:
        
        List<Tool> tools
        
        The loaded tool definitions returned by the tool search output.
        
        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
        
        The type of the function tool. Always function.
        
        FUNCTION("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
        
        The type of the file search tool. Always file_search.
        
        FILE_SEARCH("file_search")
        
        List<String> vectorStoreIds
        
        The IDs of the vector stores to search.
        
        Optional<Filters> filters
        
        A filter to apply.
        
        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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
        
        Type type
        
        Type of operation: and or or.
        
        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.
        
        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
        
        The type of the computer tool. Always computer.
        
        COMPUTER("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.
        
        WINDOWS("windows")
        
        MAC("mac")
        
        LINUX("linux")
        
        UBUNTU("ubuntu")
        
        BROWSER("browser")
        
        JsonValue; type "computer_use_preview"constant
        
        The type of the computer use tool. Always computer_use_preview.
        
        COMPUTER_USE_PREVIEW("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.
        
        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.
        
        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.
        
        APPROXIMATE("approximate")
        
        Mcp
        
        String serverLabel
        
        A label for this MCP server, used to identify it in tool calls.
        
        JsonValue; type "mcp"constant
        
        The type of the MCP tool. Always mcp.
        
        MCP("mcp")
        
        Optional<AllowedTools> allowedTools
        
        List of allowed tool names or a filter object.
        
        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
        
        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.
        
        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.
        
        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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
        
        JsonValue; type "code_interpreter"constant
        
        The type of the code interpreter tool. Always code_interpreter.
        
        CODE_INTERPRETER("code_interpreter")
        
        ImageGeneration
        
        JsonValue; type "image_generation"constant
        
        The type of the image generation tool. Always image_generation.
        
        IMAGE_GENERATION("image_generation")
        
        Optional<Action> action
        
        Whether to generate a new image or edit an existing image. Default: auto.
        
        GENERATE("generate")
        
        EDIT("edit")
        
        AUTO("auto")
        
        Optional<Background> background
        
        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.
        
        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.
        
        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.
        
        GPT_IMAGE_1("gpt-image-1")
        
        GPT_IMAGE_1_MINI("gpt-image-1-mini")
        
        GPT_IMAGE_2("gpt-image-2")
        
        GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
        
        GPT_IMAGE_1_5("gpt-image-1.5")
        
        CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
        
        Optional<Moderation> moderation
        
        Moderation level for the generated image. Default: auto.
        
        AUTO("auto")
        
        LOW("low")
        
        Optional<Long> outputCompression
        
        Compression level for the output image. Default: 100.
        
        Optional<OutputFormat> outputFormat
        
        The output format of the generated image. One of png, webp, or jpeg. Default: png.
        
        PNG("png")
        
        WEBP("webp")
        
        JPEG("jpeg")
        
        Optional<Long> partialImages
        
        Number of partial images to generate in streaming mode, from 0 (default value) to 3.
        
        Optional<Quality> quality
        
        The quality of the generated image. One of low, medium, high, or auto. Default: auto.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        AUTO("auto")
        
        Optional<Size> size
        
        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.
        
        _1024X1024("1024x1024")
        
        _1024X1536("1024x1536")
        
        _1536X1024("1536x1024")
        
        AUTO("auto")
        
        JsonValue;
        
        JsonValue; type "local_shell"constant
        
        The type of the local shell tool. Always local_shell.
        
        LOCAL_SHELL("local_shell")
        
        class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        JsonValue; type "shell"constant
        
        The type of the shell tool. Always shell.
        
        SHELL("shell")
        
        Optional<Environment> environment
        
        class ContainerAuto:
        
        JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
        
        Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
        
        class LocalEnvironment:
        
        JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
        
        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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
        
        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
        
        The type of the custom tool. Always custom.
        
        CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
        
        Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
        
        class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        String description
        
        A description of the namespace shown to the model.
        
        String name
        
        The namespace name used in tool calls (for example, crm).
        
        List<Tool> tools
        
        The function/custom tools available inside this namespace.
        
        class Function:
        
        String name
        
        JsonValue; type "function"constant
        
        FUNCTION("function")
        
        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
        
        JsonValue; type "namespace"constant
        
        The type of the tool. Always namespace.
        
        NAMESPACE("namespace")
        
        class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        JsonValue; type "tool_search"constant
        
        The type of the tool. Always tool_search.
        
        TOOL_SEARCH("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.
        
        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.
        
        WEB_SEARCH_PREVIEW("web_search_preview")
        
        WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
        
        Optional<List<SearchContentType>> searchContentTypes
        
        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.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        Optional<UserLocation> userLocation
        
        The user's location.
        
        JsonValue; type "approximate"constant
        
        The type of location approximation. Always approximate.
        
        APPROXIMATE("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
        
        The type of the tool. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
        
        JsonValue; type "tool_search_output"constant
        
        The item type. Always tool_search_output.
        
        TOOL_SEARCH_OUTPUT("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.
        
        Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
        
        Optional<Status> status
        
        The status of the tool search output.
        
        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
        
        The type of the object. Always summary_text.
        
        SUMMARY_TEXT("summary_text")
        
        JsonValue; type "reasoning"constant
        
        The type of the object. Always reasoning.
        
        REASONING("reasoning")
        
        Optional<List<Content>> content
        
        Reasoning text content.
        
        String text
        
        The reasoning text from the model.
        
        JsonValue; type "reasoning_text"constant
        
        The type of the reasoning text. Always reasoning_text.
        
        REASONING_TEXT("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.
        
        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.
        
        JsonValue; type "compaction"constant
        
        The type of the item. Always compaction.
        
        COMPACTION("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        GENERATING("generating")
        
        FAILED("failed")
        
        JsonValue; type "image_generation_call"constant
        
        The type of the image generation call. Always image_generation_call.
        
        IMAGE_GENERATION_CALL("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.
        
        class Logs:
        
        The logs output from the code interpreter.
        
        String logs
        
        The logs output from the code interpreter.
        
        JsonValue; type "logs"constant
        
        The type of the output. Always logs.
        
        LOGS("logs")
        
        class Image:
        
        The image output from the code interpreter.
        
        JsonValue; type "image"constant
        
        The type of the output. Always image.
        
        IMAGE("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        INTERPRETING("interpreting")
        
        FAILED("failed")
        
        JsonValue; type "code_interpreter_call"constant
        
        The type of the code interpreter tool call. Always code_interpreter_call.
        
        CODE_INTERPRETER_CALL("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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        JsonValue; type "local_shell_call"constant
        
        The type of the local shell call. Always local_shell_call.
        
        LOCAL_SHELL_CALL("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
        
        The type of the local shell tool call output. Always local_shell_call_output.
        
        LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
        
        Optional<Status> status
        
        The status of the item. One of in_progress, completed, or incomplete.
        
        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.
        
        JsonValue; type "shell_call"constant
        
        The type of the item. Always shell_call.
        
        SHELL_CALL("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.
        
        class LocalEnvironment:
        
        class ContainerReference:
        
        Optional<Status> status
        
        The status of the shell call. One of in_progress, completed, or incomplete.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        ShellCallOutput
        
        String callId
        
        The unique ID of the shell tool call generated by the model.
        
        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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("exit")
        
        String stderr
        
        Captured stderr output for the shell call.
        
        String stdout
        
        Captured stdout output for the shell call.
        
        JsonValue; type "shell_call_output"constant
        
        The type of the item. Always shell_call_output.
        
        SHELL_CALL_OUTPUT("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        ApplyPatchCall
        
        String callId
        
        The unique ID of the apply patch tool call generated by the model.
        
        Operation operation
        
        The specific create, delete, or update instruction for the apply_patch tool call.
        
        class CreateFile:
        
        Instruction for creating a new file via the apply_patch tool.
        
        String diff
        
        Unified diff content to apply when creating the file.
        
        String path
        
        Path of the file to create relative to the workspace root.
        
        JsonValue; type "create_file"constant
        
        The operation type. Always create_file.
        
        CREATE_FILE("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.
        
        JsonValue; type "delete_file"constant
        
        The operation type. Always delete_file.
        
        DELETE_FILE("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.
        
        String path
        
        Path of the file to update relative to the workspace root.
        
        JsonValue; type "update_file"constant
        
        The operation type. Always update_file.
        
        UPDATE_FILE("update_file")
        
        Status status
        
        The status of the apply patch tool call. One of in_progress or completed.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        JsonValue; type "apply_patch_call"constant
        
        The type of the item. Always apply_patch_call.
        
        APPLY_PATCH_CALL("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.
        
        Status status
        
        The status of the apply patch tool call output. One of completed or failed.
        
        COMPLETED("completed")
        
        FAILED("failed")
        
        JsonValue; type "apply_patch_call_output"constant
        
        The type of the item. Always apply_patch_call_output.
        
        APPLY_PATCH_CALL_OUTPUT("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).
        
        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
        
        The type of the item. Always mcp_list_tools.
        
        MCP_LIST_TOOLS("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
        
        The type of the item. Always mcp_approval_request.
        
        MCP_APPROVAL_REQUEST("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
        
        The type of the item. Always mcp_approval_response.
        
        MCP_APPROVAL_RESPONSE("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
        
        The type of the item. Always mcp_call.
        
        MCP_CALL("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.
        
        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.
        
        String
        
        List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
        
        JsonValue; type "custom_tool_call_output"constant
        
        The type of the custom tool call output. Always custom_tool_call_output.
        
        CUSTOM_TOOL_CALL_OUTPUT("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
        
        The type of the custom tool call. Always custom_tool_call.
        
        CUSTOM_TOOL_CALL("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.
        
        JsonValue;
        
        JsonValue; type "compaction_trigger"constant
        
        The type of the item. Always compaction_trigger.
        
        COMPACTION_TRIGGER("compaction_trigger")
        
        ItemReference
        
        String id
        
        The ID of the item to reference.
        
        Optional<Type> type
        
        The type of item to reference. Always item_reference.
        
        ITEM_REFERENCE("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.
      - String
      - enum ChatModel:
        
        GPT_5_4("gpt-5.4")
        
        GPT_5_4_MINI("gpt-5.4-mini")
        
        GPT_5_4_NANO("gpt-5.4-nano")
        
        GPT_5_4_MINI_2026_03_17("gpt-5.4-mini-2026-03-17")
        
        GPT_5_4_NANO_2026_03_17("gpt-5.4-nano-2026-03-17")
        
        GPT_5_3_CHAT_LATEST("gpt-5.3-chat-latest")
        
        GPT_5_2("gpt-5.2")
        
        GPT_5_2_2025_12_11("gpt-5.2-2025-12-11")
        
        GPT_5_2_CHAT_LATEST("gpt-5.2-chat-latest")
        
        GPT_5_2_PRO("gpt-5.2-pro")
        
        GPT_5_2_PRO_2025_12_11("gpt-5.2-pro-2025-12-11")
        
        GPT_5_1("gpt-5.1")
        
        GPT_5_1_2025_11_13("gpt-5.1-2025-11-13")
        
        GPT_5_1_CODEX("gpt-5.1-codex")
        
        GPT_5_1_MINI("gpt-5.1-mini")
        
        GPT_5_1_CHAT_LATEST("gpt-5.1-chat-latest")
        
        GPT_5("gpt-5")
        
        GPT_5_MINI("gpt-5-mini")
        
        GPT_5_NANO("gpt-5-nano")
        
        GPT_5_2025_08_07("gpt-5-2025-08-07")
        
        GPT_5_MINI_2025_08_07("gpt-5-mini-2025-08-07")
        
        GPT_5_NANO_2025_08_07("gpt-5-nano-2025-08-07")
        
        GPT_5_CHAT_LATEST("gpt-5-chat-latest")
        
        GPT_4_1("gpt-4.1")
        
        GPT_4_1_MINI("gpt-4.1-mini")
        
        GPT_4_1_NANO("gpt-4.1-nano")
        
        GPT_4_1_2025_04_14("gpt-4.1-2025-04-14")
        
        GPT_4_1_MINI_2025_04_14("gpt-4.1-mini-2025-04-14")
        
        GPT_4_1_NANO_2025_04_14("gpt-4.1-nano-2025-04-14")
        
        O4_MINI("o4-mini")
        
        O4_MINI_2025_04_16("o4-mini-2025-04-16")
        
        O3("o3")
        
        O3_2025_04_16("o3-2025-04-16")
        
        O3_MINI("o3-mini")
        
        O3_MINI_2025_01_31("o3-mini-2025-01-31")
        
        O1("o1")
        
        O1_2024_12_17("o1-2024-12-17")
        
        O1_PREVIEW("o1-preview")
        
        O1_PREVIEW_2024_09_12("o1-preview-2024-09-12")
        
        O1_MINI("o1-mini")
        
        O1_MINI_2024_09_12("o1-mini-2024-09-12")
        
        GPT_4O("gpt-4o")
        
        GPT_4O_2024_11_20("gpt-4o-2024-11-20")
        
        GPT_4O_2024_08_06("gpt-4o-2024-08-06")
        
        GPT_4O_2024_05_13("gpt-4o-2024-05-13")
        
        GPT_4O_AUDIO_PREVIEW("gpt-4o-audio-preview")
        
        GPT_4O_AUDIO_PREVIEW_2024_10_01("gpt-4o-audio-preview-2024-10-01")
        
        GPT_4O_AUDIO_PREVIEW_2024_12_17("gpt-4o-audio-preview-2024-12-17")
        
        GPT_4O_AUDIO_PREVIEW_2025_06_03("gpt-4o-audio-preview-2025-06-03")
        
        GPT_4O_MINI_AUDIO_PREVIEW("gpt-4o-mini-audio-preview")
        
        GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17("gpt-4o-mini-audio-preview-2024-12-17")
        
        GPT_4O_SEARCH_PREVIEW("gpt-4o-search-preview")
        
        GPT_4O_MINI_SEARCH_PREVIEW("gpt-4o-mini-search-preview")
        
        GPT_4O_SEARCH_PREVIEW_2025_03_11("gpt-4o-search-preview-2025-03-11")
        
        GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11("gpt-4o-mini-search-preview-2025-03-11")
        
        CHATGPT_4O_LATEST("chatgpt-4o-latest")
        
        CODEX_MINI_LATEST("codex-mini-latest")
        
        GPT_4O_MINI("gpt-4o-mini")
        
        GPT_4O_MINI_2024_07_18("gpt-4o-mini-2024-07-18")
        
        GPT_4_TURBO("gpt-4-turbo")
        
        GPT_4_TURBO_2024_04_09("gpt-4-turbo-2024-04-09")
        
        GPT_4_0125_PREVIEW("gpt-4-0125-preview")
        
        GPT_4_TURBO_PREVIEW("gpt-4-turbo-preview")
        
        GPT_4_1106_PREVIEW("gpt-4-1106-preview")
        
        GPT_4_VISION_PREVIEW("gpt-4-vision-preview")
        
        GPT_4("gpt-4")
        
        GPT_4_0314("gpt-4-0314")
        
        GPT_4_0613("gpt-4-0613")
        
        GPT_4_32K("gpt-4-32k")
        
        GPT_4_32K_0314("gpt-4-32k-0314")
        
        GPT_4_32K_0613("gpt-4-32k-0613")
        
        GPT_3_5_TURBO("gpt-3.5-turbo")
        
        GPT_3_5_TURBO_16K("gpt-3.5-turbo-16k")
        
        GPT_3_5_TURBO_0301("gpt-3.5-turbo-0301")
        
        GPT_3_5_TURBO_0613("gpt-3.5-turbo-0613")
        
        GPT_3_5_TURBO_1106("gpt-3.5-turbo-1106")
        
        GPT_3_5_TURBO_0125("gpt-3.5-turbo-0125")
        
        GPT_3_5_TURBO_16K_0613("gpt-3.5-turbo-16k-0613")
      - ResponsesOnlyModel
        
        O1_PRO("o1-pro")
        
        O1_PRO_2025_03_19("o1-pro-2025-03-19")
        
        O3_PRO("o3-pro")
        
        O3_PRO_2025_06_10("o3-pro-2025-06-10")
        
        O3_DEEP_RESEARCH("o3-deep-research")
        
        O3_DEEP_RESEARCH_2025_06_26("o3-deep-research-2025-06-26")
        
        O4_MINI_DEEP_RESEARCH("o4-mini-deep-research")
        
        O4_MINI_DEEP_RESEARCH_2025_06_26("o4-mini-deep-research-2025-06-26")
        
        COMPUTER_USE_PREVIEW("computer-use-preview")
        
        COMPUTER_USE_PREVIEW_2025_03_11("computer-use-preview-2025-03-11")
        
        GPT_5_CODEX("gpt-5-codex")
        
        GPT_5_PRO("gpt-5-pro")
        
        GPT_5_PRO_2025_10_06("gpt-5-pro-2025-10-06")
        
        GPT_5_1_CODEX_MAX("gpt-5.1-codex-max")
    - JsonValue; object_ "response"constant
      
      The object type of this resource - always set to response.
      - RESPONSE("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.
      - class ResponseOutputMessage:
        
        An output message from the model.
      - class ResponseFileSearchToolCall:
        
        The results of a file search tool call. See the file search guide for more information.
      - class ResponseFunctionToolCall:
        
        A tool call to run a function. See the function calling guide for more information.
      - 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.
        
        String
        
        List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
        
        Status status
        
        The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        JsonValue; type "function_call_output"constant
        
        The type of the function tool call output. Always function_call_output.
        
        FUNCTION_CALL_OUTPUT("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.
      - class ResponseComputerToolCall:
        
        A tool call to a computer use tool. See the computer use guide for more information.
      - 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.
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        FAILED("failed")
        
        IN_PROGRESS("in_progress")
        
        JsonValue; type "computer_call_output"constant
        
        The type of the computer tool call output. Always computer_call_output.
        
        COMPUTER_CALL_OUTPUT("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.
      - 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.
        
        SERVER("server")
        
        CLIENT("client")
        
        Status status
        
        The status of the tool search call item that was recorded.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        JsonValue; type "tool_search_call"constant
        
        The type of the item. Always tool_search_call.
        
        TOOL_SEARCH_CALL("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.
        
        SERVER("server")
        
        CLIENT("client")
        
        Status status
        
        The status of the tool search output item that was recorded.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        List<Tool> tools
        
        The loaded tool definitions returned by tool search.
        
        class FunctionTool:
        
        Defines a function in your own code the model can choose to call. Learn more about function calling.
        
        class FileSearchTool:
        
        A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
        
        class ComputerTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
        
        class ComputerUsePreviewTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
        
        class WebSearchTool:
        
        Search the Internet for sources related to the prompt. Learn more about the web search tool.
        
        Mcp
        
        CodeInterpreter
        
        ImageGeneration
        
        JsonValue;
        
        class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        class CustomTool:
        
        A custom tool that processes input using a specified format. Learn more about custom tools
        
        class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        class WebSearchPreviewTool:
        
        This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
        
        class ApplyPatchTool:
        
        Allows the assistant to create, delete, or update files using unified diffs.
        
        JsonValue; type "tool_search_output"constant
        
        The type of the item. Always tool_search_output.
        
        TOOL_SEARCH_OUTPUT("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
        
        The type of the item. Always compaction.
        
        COMPACTION("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        GENERATING("generating")
        
        FAILED("failed")
        
        JsonValue; type "image_generation_call"constant
        
        The type of the image generation call. Always image_generation_call.
        
        IMAGE_GENERATION_CALL("image_generation_call")
      - class ResponseCodeInterpreterToolCall:
        
        A tool call to run code.
      - 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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        JsonValue; type "local_shell_call"constant
        
        The type of the local shell call. Always local_shell_call.
        
        LOCAL_SHELL_CALL("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
        
        The type of the local shell tool call output. Always local_shell_call_output.
        
        LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
        
        Optional<Status> status
        
        The status of the item. One of in_progress, completed, or incomplete.
        
        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.
        
        class ResponseLocalEnvironment:
        
        Represents the use of a local environment to perform shell actions.
        
        JsonValue; type "local"constant
        
        The environment type. Always local.
        
        LOCAL("local")
        
        class ResponseContainerReference:
        
        Represents a container created with /v1/containers.
        
        String containerId
        
        JsonValue; type "container_reference"constant
        
        The environment type. Always container_reference.
        
        CONTAINER_REFERENCE("container_reference")
        
        Status status
        
        The status of the shell call. One of in_progress, completed, or incomplete.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        JsonValue; type "shell_call"constant
        
        The type of the item. Always shell_call.
        
        SHELL_CALL("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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        JsonValue; type "shell_call_output"constant
        
        The type of the shell call output. Always shell_call_output.
        
        SHELL_CALL_OUTPUT("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.
        
        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 a new file with the provided diff.
        
        CREATE_FILE("create_file")
        
        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 the specified file.
        
        DELETE_FILE("delete_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 an existing file with the provided diff.
        
        UPDATE_FILE("update_file")
        
        Status status
        
        The status of the apply patch tool call. One of in_progress or completed.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        JsonValue; type "apply_patch_call"constant
        
        The type of the item. Always apply_patch_call.
        
        APPLY_PATCH_CALL("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.
        
        COMPLETED("completed")
        
        FAILED("failed")
        
        JsonValue; type "apply_patch_call_output"constant
        
        The type of the item. Always apply_patch_call_output.
        
        APPLY_PATCH_CALL_OUTPUT("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
        
        The type of the item. Always mcp_call.
        
        MCP_CALL("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.
        
        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
        
        The type of the item. Always mcp_list_tools.
        
        MCP_LIST_TOOLS("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
        
        The type of the item. Always mcp_approval_request.
        
        MCP_APPROVAL_REQUEST("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
        
        The type of the item. Always mcp_approval_response.
        
        MCP_APPROVAL_RESPONSE("mcp_approval_response")
        
        Optional<String> reason
        
        Optional reason for the decision.
      - class ResponseCustomToolCall:
        
        A call to a custom tool created by the model.
      - 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.
        
        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.
    - 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.
      - 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.
        
        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 tool configuration type. Always allowed_tools.
        
        ALLOWED_TOOLS("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
        
        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
        
        For function calling, the type is always function.
        
        FUNCTION("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
        
        For MCP tools, the type is always mcp.
        
        MCP("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
        
        For custom tool calling, the type is always custom.
        
        CUSTOM("custom")
      - class ToolChoiceApplyPatch:
        
        Forces the model to call the apply_patch tool when executing a tool call.
        
        JsonValue; type "apply_patch"constant
        
        The tool to call. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
      - class ToolChoiceShell:
        
        Forces the model to call the shell tool when a tool call is required.
        
        JsonValue; type "shell"constant
        
        The tool to call. Always shell.
        
        SHELL("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.
      - class FunctionTool:
        
        Defines a function in your own code the model can choose to call. Learn more about function calling.
      - class FileSearchTool:
        
        A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
      - class ComputerTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
      - class ComputerUsePreviewTool:
        
        A tool that controls a virtual computer. Learn more about the computer tool.
      - class WebSearchTool:
        
        Search the Internet for sources related to the prompt. Learn more about the web search tool.
      - Mcp
      - CodeInterpreter
      - ImageGeneration
      - JsonValue;
      - class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
      - class CustomTool:
        
        A custom tool that processes input using a specified format. Learn more about custom tools
      - class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
      - class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
      - class WebSearchPreviewTool:
        
        This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
      - class ApplyPatchTool:
        
        Allows the assistant to create, delete, or update files using unified diffs.
    - 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.
    - 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.
      - 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.
        
        String
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
      - Optional<String> version
        
        Optional version of the prompt template.
    - 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.
      - IN_MEMORY("in_memory")
      - _24H("24h")
    - Optional<Reasoning> reasoning
      
      gpt-5 and o-series models only
      
      Configuration options for reasoning models.
      - Optional<ReasoningEffort> effort
        
        Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
        
        gpt-5.1 defaults to none, which does not perform reasoning. The supported reasoning values for gpt-5.1 are none, low, medium, and high. Tool calls are supported for all reasoning values in gpt-5.1.
        
        All models before gpt-5.1 default to medium reasoning effort, and do not support none.
        
        The gpt-5-pro model defaults to (and only supports) high reasoning effort.
        
        xhigh is supported for all models after gpt-5.1-codex-max.
        
        NONE("none")
        
        MINIMAL("minimal")
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        XHIGH("xhigh")
      - Optional<GenerateSummary> generateSummary
        
        Deprecated: use summary instead.
        
        A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
        
        AUTO("auto")
        
        CONCISE("concise")
        
        DETAILED("detailed")
      - Optional<Summary> summary
        
        A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
        
        concise is supported for computer-use-preview models and all reasoning models after gpt-5.
        
        AUTO("auto")
        
        CONCISE("concise")
        
        DETAILED("detailed")
    - 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.
    - 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.
      - 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.
      - COMPLETED("completed")
      - FAILED("failed")
      - IN_PROGRESS("in_progress")
      - CANCELLED("cancelled")
      - QUEUED("queued")
      - INCOMPLETE("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<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.
        
        class ResponseFormatText:
        
        Default response format. Used to generate text responses.
        
        JsonValue; type "text"constant
        
        The type of response format being defined. Always text.
        
        TEXT("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
        
        The type of response format being defined. Always json_schema.
        
        JSON_SCHEMA("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
        
        The type of response format being defined. Always json_object.
        
        JSON_OBJECT("json_object")
      - 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.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
    - Optional<Long> topLogprobs
      
      An integer between 0 and 20 specifying the maximum number of most likely tokens to return at each token position, each with an associated log probability. In some cases, the number of returned tokens may be fewer than requested.
    - 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.
      - 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.
      - 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.
    - Optional<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.
  - long sequenceNumber
    
    The sequence number for this event.
  - JsonValue; type "response.completed"constant
    
    The type of the event. Always response.completed.
    - RESPONSE_COMPLETED("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.
    - class ResponseOutputText:
      
      A text output from the model.
    - class ResponseOutputRefusal:
      
      A refusal from the model.
    - class ReasoningText:
      
      Reasoning text from the model.
      - String text
        
        The reasoning text from the model.
      - JsonValue; type "reasoning_text"constant
        
        The type of the reasoning text. Always reasoning_text.
        
        REASONING_TEXT("reasoning_text")
  - long sequenceNumber
    
    The sequence number of this event.
  - JsonValue; type "response.content_part.added"constant
    
    The type of the event. Always response.content_part.added.
    - RESPONSE_CONTENT_PART_ADDED("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.
    - class ResponseOutputText:
      
      A text output from the model.
    - class ResponseOutputRefusal:
      
      A refusal from the model.
    - class ReasoningText:
      
      Reasoning text from the model.
      - String text
        
        The reasoning text from the model.
      - JsonValue; type "reasoning_text"constant
        
        The type of the reasoning text. Always reasoning_text.
        
        REASONING_TEXT("reasoning_text")
  - long sequenceNumber
    
    The sequence number of this event.
  - JsonValue; type "response.content_part.done"constant
    
    The type of the event. Always response.content_part.done.
    - RESPONSE_CONTENT_PART_DONE("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
    
    The type of the event. Always response.created.
    - RESPONSE_CREATED("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
    
    The type of the event. Always error.
    - ERROR("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
    
    The type of the event. Always response.file_search_call.completed.
    - RESPONSE_FILE_SEARCH_CALL_COMPLETED("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
    
    The type of the event. Always response.file_search_call.in_progress.
    - RESPONSE_FILE_SEARCH_CALL_IN_PROGRESS("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
    
    The type of the event. Always response.file_search_call.searching.
    - RESPONSE_FILE_SEARCH_CALL_SEARCHING("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
    
    The type of the event. Always response.function_call_arguments.delta.
    - RESPONSE_FUNCTION_CALL_ARGUMENTS_DELTA("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("response.function_call_arguments.done")
- 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
    
    The type of the event. Always response.in_progress.
    - RESPONSE_IN_PROGRESS("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
    
    The type of the event. Always response.failed.
    - RESPONSE_FAILED("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
    
    The type of the event. Always response.incomplete.
    - RESPONSE_INCOMPLETE("response.incomplete")
- class ResponseOutputItemAddedEvent:
  
  Emitted when a new output item is added.
  - ResponseOutputItem item
    
    The output item that was added.
    - class ResponseOutputMessage:
      
      An output message from the model.
    - class ResponseFileSearchToolCall:
      
      The results of a file search tool call. See the file search guide for more information.
    - class ResponseFunctionToolCall:
      
      A tool call to run a function. See the function calling guide for more information.
    - class ResponseFunctionToolCallOutputItem:
    - class ResponseFunctionWebSearch:
      
      The results of a web search tool call. See the web search guide for more information.
    - class ResponseComputerToolCall:
      
      A tool call to a computer use tool. See the computer use guide for more information.
    - class ResponseComputerToolCallOutputItem:
    - 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.
    - class ResponseToolSearchCall:
    - class ResponseToolSearchOutputItem:
    - class ResponseCompactionItem:
      
      A compaction item generated by the v1/responses/compact API.
    - ImageGenerationCall
    - class ResponseCodeInterpreterToolCall:
      
      A tool call to run code.
    - LocalShellCall
    - LocalShellCallOutput
    - class ResponseFunctionShellToolCall:
      
      A tool call that executes one or more shell commands in a managed environment.
    - class ResponseFunctionShellToolCallOutput:
      
      The output of a shell tool call that was emitted.
    - class ResponseApplyPatchToolCall:
      
      A tool call that applies file diffs by creating, deleting, or updating files.
    - class ResponseApplyPatchToolCallOutput:
      
      The output emitted by an apply patch tool call.
    - McpCall
    - McpListTools
    - McpApprovalRequest
    - McpApprovalResponse
    - class ResponseCustomToolCall:
      
      A call to a custom tool created by the model.
    - class ResponseCustomToolCallOutputItem:
      
      The output of a custom tool call from your code, being sent back to the model.
  - 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
    
    The type of the event. Always response.output_item.added.
    - RESPONSE_OUTPUT_ITEM_ADDED("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
    
    The type of the event. Always response.output_item.done.
    - RESPONSE_OUTPUT_ITEM_DONE("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
      
      The type of the summary part. Always summary_text.
      - SUMMARY_TEXT("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
    
    The type of the event. Always response.reasoning_summary_part.added.
    - RESPONSE_REASONING_SUMMARY_PART_ADDED("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
      
      The type of the summary part. Always summary_text.
      - SUMMARY_TEXT("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
    
    The type of the event. Always response.reasoning_summary_part.done.
    - RESPONSE_REASONING_SUMMARY_PART_DONE("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
    
    The type of the event. Always response.reasoning_summary_text.delta.
    - RESPONSE_REASONING_SUMMARY_TEXT_DELTA("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
    
    The type of the event. Always response.reasoning_summary_text.done.
    - RESPONSE_REASONING_SUMMARY_TEXT_DONE("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
    
    The type of the event. Always response.reasoning_text.delta.
    - RESPONSE_REASONING_TEXT_DELTA("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
    
    The type of the event. Always response.reasoning_text.done.
    - RESPONSE_REASONING_TEXT_DONE("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
    
    The type of the event. Always response.refusal.delta.
    - RESPONSE_REFUSAL_DELTA("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
    
    The type of the event. Always response.refusal.done.
    - RESPONSE_REFUSAL_DONE("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 probabilities of up to 20 of the 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
    
    The type of the event. Always response.output_text.delta.
    - RESPONSE_OUTPUT_TEXT_DELTA("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 probabilities of up to 20 of the 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
    
    The type of the event. Always response.output_text.done.
    - RESPONSE_OUTPUT_TEXT_DONE("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
    
    The type of the event. Always response.web_search_call.completed.
    - RESPONSE_WEB_SEARCH_CALL_COMPLETED("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
    
    The type of the event. Always response.web_search_call.in_progress.
    - RESPONSE_WEB_SEARCH_CALL_IN_PROGRESS("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
    
    The type of the event. Always response.web_search_call.searching.
    - RESPONSE_WEB_SEARCH_CALL_SEARCHING("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
    
    The type of the event. Always 'response.image_generation_call.completed'.
    - RESPONSE_IMAGE_GENERATION_CALL_COMPLETED("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
    
    The type of the event. Always 'response.image_generation_call.generating'.
    - RESPONSE_IMAGE_GENERATION_CALL_GENERATING("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
    
    The type of the event. Always 'response.image_generation_call.in_progress'.
    - RESPONSE_IMAGE_GENERATION_CALL_IN_PROGRESS("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
    
    The type of the event. Always 'response.image_generation_call.partial_image'.
    - RESPONSE_IMAGE_GENERATION_CALL_PARTIAL_IMAGE("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
    
    The type of the event. Always 'response.mcp_call_arguments.delta'.
    - RESPONSE_MCP_CALL_ARGUMENTS_DELTA("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
    
    The type of the event. Always 'response.mcp_call_arguments.done'.
    - RESPONSE_MCP_CALL_ARGUMENTS_DONE("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
    
    The type of the event. Always 'response.mcp_call.completed'.
    - RESPONSE_MCP_CALL_COMPLETED("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
    
    The type of the event. Always 'response.mcp_call.failed'.
    - RESPONSE_MCP_CALL_FAILED("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
    
    The type of the event. Always 'response.mcp_call.in_progress'.
    - RESPONSE_MCP_CALL_IN_PROGRESS("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
    
    The type of the event. Always 'response.mcp_list_tools.completed'.
    - RESPONSE_MCP_LIST_TOOLS_COMPLETED("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
    
    The type of the event. Always 'response.mcp_list_tools.failed'.
    - RESPONSE_MCP_LIST_TOOLS_FAILED("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
    
    The type of the event. Always 'response.mcp_list_tools.in_progress'.
    - RESPONSE_MCP_LIST_TOOLS_IN_PROGRESS("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
    
    The type of the event. Always 'response.output_text.annotation.added'.
    - RESPONSE_OUTPUT_TEXT_ANNOTATION_ADDED("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
    
    The type of the event. Always 'response.queued'.
    - RESPONSE_QUEUED("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
    
    The event type identifier.
    - RESPONSE_CUSTOM_TOOL_CALL_INPUT_DELTA("response.custom_tool_call_input.delta")
- 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
    
    The event type identifier.
    - RESPONSE_CUSTOM_TOOL_CALL_INPUT_DONE("response.custom_tool_call_input.done")

Skill Reference

class SkillReference:
- String skillId
  
  The ID of the referenced skill.
- JsonValue; type "skill_reference"constant
  
  References a skill created with the /v1/skills endpoint.
  - SKILL_REFERENCE("skill_reference")
- Optional<String> version
  
  Optional skill version. Use a positive integer or 'latest'. Omit for default.

Tool

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
    
    The type of the function tool. Always function.
    - FUNCTION("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
    
    The type of the file search tool. Always file_search.
    - FILE_SEARCH("file_search")
  - List<String> vectorStoreIds
    
    The IDs of the vector stores to search.
  - Optional<Filters> filters
    
    A filter to apply.
    - 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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
      - Type type
        
        Type of operation: and or or.
        
        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.
      - 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
    
    The type of the computer tool. Always computer.
    - COMPUTER("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.
    - WINDOWS("windows")
    - MAC("mac")
    - LINUX("linux")
    - UBUNTU("ubuntu")
    - BROWSER("browser")
  - JsonValue; type "computer_use_preview"constant
    
    The type of the computer use tool. Always computer_use_preview.
    - COMPUTER_USE_PREVIEW("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.
    - 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.
    - 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.
      - APPROXIMATE("approximate")
- Mcp
  - String serverLabel
    
    A label for this MCP server, used to identify it in tool calls.
  - JsonValue; type "mcp"constant
    
    The type of the MCP tool. Always mcp.
    - MCP("mcp")
  - Optional<AllowedTools> allowedTools
    
    List of allowed tool names or a filter object.
    - 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
    - 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.
    - 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.
    - 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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
      - Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
  - JsonValue; type "code_interpreter"constant
    
    The type of the code interpreter tool. Always code_interpreter.
    - CODE_INTERPRETER("code_interpreter")
- ImageGeneration
  - JsonValue; type "image_generation"constant
    
    The type of the image generation tool. Always image_generation.
    - IMAGE_GENERATION("image_generation")
  - Optional<Action> action
    
    Whether to generate a new image or edit an existing image. Default: auto.
    - GENERATE("generate")
    - EDIT("edit")
    - AUTO("auto")
  - Optional<Background> background
    
    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.
    - 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.
    - 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.
    - GPT_IMAGE_1("gpt-image-1")
    - GPT_IMAGE_1_MINI("gpt-image-1-mini")
    - GPT_IMAGE_2("gpt-image-2")
    - GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
    - GPT_IMAGE_1_5("gpt-image-1.5")
    - CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
  - Optional<Moderation> moderation
    
    Moderation level for the generated image. Default: auto.
    - AUTO("auto")
    - LOW("low")
  - Optional<Long> outputCompression
    
    Compression level for the output image. Default: 100.
  - Optional<OutputFormat> outputFormat
    
    The output format of the generated image. One of png, webp, or jpeg. Default: png.
    - PNG("png")
    - WEBP("webp")
    - JPEG("jpeg")
  - Optional<Long> partialImages
    
    Number of partial images to generate in streaming mode, from 0 (default value) to 3.
  - Optional<Quality> quality
    
    The quality of the generated image. One of low, medium, high, or auto. Default: auto.
    - LOW("low")
    - MEDIUM("medium")
    - HIGH("high")
    - AUTO("auto")
  - Optional<Size> size
    
    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.
    - _1024X1024("1024x1024")
    - _1024X1536("1024x1536")
    - _1536X1024("1536x1024")
    - AUTO("auto")
- JsonValue;
  - JsonValue; type "local_shell"constant
    
    The type of the local shell tool. Always local_shell.
    - LOCAL_SHELL("local_shell")
- class FunctionShellTool:
  
  A tool that allows the model to execute shell commands.
  - JsonValue; type "shell"constant
    
    The type of the shell tool. Always shell.
    - SHELL("shell")
  - Optional<Environment> environment
    - class ContainerAuto:
      - JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
      - Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
      - Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
    - class LocalEnvironment:
      - JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
      - 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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
- 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
    
    The type of the custom tool. Always custom.
    - CUSTOM("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;
      - JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
    - Grammar
      - String definition
        
        The grammar definition.
      - Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
      - JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
- class NamespaceTool:
  
  Groups function/custom tools under a shared namespace.
  - String description
    
    A description of the namespace shown to the model.
  - String name
    
    The namespace name used in tool calls (for example, crm).
  - List<Tool> tools
    
    The function/custom tools available inside this namespace.
    - class Function:
      - String name
      - JsonValue; type "function"constant
        
        FUNCTION("function")
      - 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
  - JsonValue; type "namespace"constant
    
    The type of the tool. Always namespace.
    - NAMESPACE("namespace")
- class ToolSearchTool:
  
  Hosted or BYOT tool search configuration for deferred tools.
  - JsonValue; type "tool_search"constant
    
    The type of the tool. Always tool_search.
    - TOOL_SEARCH("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.
    - 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.
    - WEB_SEARCH_PREVIEW("web_search_preview")
    - WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
  - Optional<List<SearchContentType>> searchContentTypes
    - 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.
    - LOW("low")
    - MEDIUM("medium")
    - HIGH("high")
  - Optional<UserLocation> userLocation
    
    The user's location.
    - JsonValue; type "approximate"constant
      
      The type of location approximation. Always approximate.
      - APPROXIMATE("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
    
    The type of the tool. Always apply_patch.
    - APPLY_PATCH("apply_patch")

Tool Choice Allowed

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.
  - 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 tool configuration type. Always allowed_tools.
  - ALLOWED_TOOLS("allowed_tools")

Tool Choice Apply Patch

class ToolChoiceApplyPatch:

Forces the model to call the apply_patch tool when executing a tool call.
- JsonValue; type "apply_patch"constant
  
  The tool to call. Always apply_patch.
  - APPLY_PATCH("apply_patch")

Tool Choice Custom

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
  
  For custom tool calling, the type is always custom.
  - CUSTOM("custom")

Tool Choice Function

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
  
  For function calling, the type is always function.
  - FUNCTION("function")

Tool Choice Mcp

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
  
  For MCP tools, the type is always mcp.
  - MCP("mcp")
- Optional<String> name
  
  The name of the tool to call on the server.

Tool Choice Options

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

Tool Choice Shell

class ToolChoiceShell:

Forces the model to call the shell tool when a tool call is required.
- JsonValue; type "shell"constant
  
  The tool to call. Always shell.
  - SHELL("shell")

Tool Choice Types

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

Tool Search Tool

class ToolSearchTool:

Hosted or BYOT tool search configuration for deferred tools.
- JsonValue; type "tool_search"constant
  
  The type of the tool. Always tool_search.
  - TOOL_SEARCH("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.
  - SERVER("server")
  - CLIENT("client")
- Optional<JsonValue> parameters
  
  Parameter schema for a client-executed tool search tool.

Web Search Preview 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.
  - WEB_SEARCH_PREVIEW("web_search_preview")
  - WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
- Optional<List<SearchContentType>> searchContentTypes
  - 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.
  - LOW("low")
  - MEDIUM("medium")
  - HIGH("high")
- Optional<UserLocation> userLocation
  
  The user's location.
  - JsonValue; type "approximate"constant
    
    The type of location approximation. Always approximate.
    - APPROXIMATE("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.

Web Search Tool

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.
  - 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.
  - 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.
    - APPROXIMATE("approximate")

Input Items

List input items

InputItemListPage responses().inputItems().list(InputItemListParamsparams = InputItemListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

get /responses/{response_id}/input_items

Returns a list of input items for a given response.

Parameters

InputItemListParams params
- Optional<String> responseId
- Optional<String> after
  
  An item ID to list items after, used in pagination.
- Optional<List<ResponseIncludable>> include
  
  Additional fields to include in the response. See the include parameter for Response creation above for more information.
  - 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<Long> limit
  
  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
- Optional<Order> order
  
  The order to return the input items in. Default is desc.
  - asc: Return the input items in ascending order.
  - desc: Return the input items in descending order.
  - ASC("asc")
  - DESC("desc")

Returns

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.
    - class ResponseInputText:
      
      A text input to the model.
      - String text
        
        The text input to the model.
      - JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
      - JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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, system, or developer.
    - USER("user")
    - SYSTEM("system")
    - DEVELOPER("developer")
  - JsonValue; type "message"constant
    
    The type of the message input. Always set to message.
    - MESSAGE("message")
  - Optional<Status> status
    
    The status of item. One of in_progress, completed, or incomplete. Populated when items are returned via API.
    - 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.
    - class ResponseOutputText:
      
      A text output from the model.
      - List<Annotation> annotations
        
        The annotations of the text output.
        
        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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
      - String text
        
        The text output from the model.
      - JsonValue; type "output_text"constant
        
        The type of the output text. Always output_text.
        
        OUTPUT_TEXT("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
        
        The type of the refusal. Always refusal.
        
        REFUSAL("refusal")
  - JsonValue; role "assistant"constant
    
    The role of the output message. Always assistant.
    - ASSISTANT("assistant")
  - Status status
    
    The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - JsonValue; type "message"constant
    
    The type of the output message. Always message.
    - MESSAGE("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.
    - 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,
    - IN_PROGRESS("in_progress")
    - SEARCHING("searching")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
    - FAILED("failed")
  - JsonValue; type "file_search_call"constant
    
    The type of the file search tool call. Always file_search_call.
    - FILE_SEARCH_CALL("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.
      - 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.
    - 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.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - Type type
    
    The type of the computer call. Always computer_call.
    - COMPUTER_CALL("computer_call")
  - Optional<Action> action
    
    A click action.
    - class Click:
      
      A click action.
      - Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
      - JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
    - class Move:
      
      A mouse move action.
      - JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
    - class Scroll:
      
      A scroll action.
      - long scrollX
        
        The horizontal scroll distance.
      - long scrollY
        
        The vertical scroll distance.
      - JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
    - JsonValue;
      - JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
  - Optional<List<ComputerAction>> actions
    
    Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.
    - Click
      - Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
      - JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
    - Move
      - JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
    - Scroll
      - long scrollX
        
        The horizontal scroll distance.
      - long scrollY
        
        The vertical scroll distance.
      - JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
    - JsonValue;
      - JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
- 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.
    - JsonValue; type "computer_screenshot"constant
      
      Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
      - COMPUTER_SCREENSHOT("computer_screenshot")
    - Optional<String> fileId
      
      The identifier of an uploaded file that contains the screenshot.
    - Optional<String> imageUrl
      
      The URL of the screenshot image.
  - Status status
    
    The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
    - FAILED("failed")
    - IN_PROGRESS("in_progress")
  - JsonValue; type "computer_call_output"constant
    
    The type of the computer tool call output. Always computer_call_output.
    - COMPUTER_CALL_OUTPUT("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).
    - class Search:
      
      Action type "search" - Performs a web search query.
      - String query
        
        [DEPRECATED] The search query.
      - JsonValue; type "search"constant
        
        The action type.
        
        SEARCH("search")
      - Optional<List<String>> queries
        
        The search queries.
      - Optional<List<Source>> sources
        
        The sources used in the search.
        
        JsonValue; type "url"constant
        
        The type of source. Always url.
        
        URL("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
        
        The action type.
        
        OPEN_PAGE("open_page")
      - Optional<String> url
        
        The URL opened by the model.
    - 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
        
        The action type.
        
        FIND_IN_PAGE("find_in_page")
      - String url
        
        The URL of the page searched for the pattern.
  - Status status
    
    The status of the web search tool call.
    - IN_PROGRESS("in_progress")
    - SEARCHING("searching")
    - COMPLETED("completed")
    - FAILED("failed")
  - JsonValue; type "web_search_call"constant
    
    The type of the web search tool call. Always web_search_call.
    - WEB_SEARCH_CALL("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.
    - 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.
    - String
    - List<FunctionAndCustomToolCallOutput>
      - class ResponseInputText:
        
        A text input to the model.
      - class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
      - class ResponseInputFile:
        
        A file input to the model.
  - Status status
    
    The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - JsonValue; type "function_call_output"constant
    
    The type of the function tool call output. Always function_call_output.
    - FUNCTION_CALL_OUTPUT("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.
    - SERVER("server")
    - CLIENT("client")
  - Status status
    
    The status of the tool search call item that was recorded.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - JsonValue; type "tool_search_call"constant
    
    The type of the item. Always tool_search_call.
    - TOOL_SEARCH_CALL("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.
    - SERVER("server")
    - CLIENT("client")
  - Status status
    
    The status of the tool search output item that was recorded.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - List<Tool> tools
    
    The loaded tool definitions returned by tool search.
    - 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
        
        The type of the function tool. Always function.
        
        FUNCTION("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
        
        The type of the file search tool. Always file_search.
        
        FILE_SEARCH("file_search")
      - List<String> vectorStoreIds
        
        The IDs of the vector stores to search.
      - Optional<Filters> filters
        
        A filter to apply.
        
        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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
        
        Type type
        
        Type of operation: and or or.
        
        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.
        
        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
        
        The type of the computer tool. Always computer.
        
        COMPUTER("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.
        
        WINDOWS("windows")
        
        MAC("mac")
        
        LINUX("linux")
        
        UBUNTU("ubuntu")
        
        BROWSER("browser")
      - JsonValue; type "computer_use_preview"constant
        
        The type of the computer use tool. Always computer_use_preview.
        
        COMPUTER_USE_PREVIEW("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.
        
        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.
        
        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.
        
        APPROXIMATE("approximate")
    - Mcp
      - String serverLabel
        
        A label for this MCP server, used to identify it in tool calls.
      - JsonValue; type "mcp"constant
        
        The type of the MCP tool. Always mcp.
        
        MCP("mcp")
      - Optional<AllowedTools> allowedTools
        
        List of allowed tool names or a filter object.
        
        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
        
        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.
        
        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.
        
        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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
      - JsonValue; type "code_interpreter"constant
        
        The type of the code interpreter tool. Always code_interpreter.
        
        CODE_INTERPRETER("code_interpreter")
    - ImageGeneration
      - JsonValue; type "image_generation"constant
        
        The type of the image generation tool. Always image_generation.
        
        IMAGE_GENERATION("image_generation")
      - Optional<Action> action
        
        Whether to generate a new image or edit an existing image. Default: auto.
        
        GENERATE("generate")
        
        EDIT("edit")
        
        AUTO("auto")
      - Optional<Background> background
        
        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.
        
        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.
        
        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.
        
        GPT_IMAGE_1("gpt-image-1")
        
        GPT_IMAGE_1_MINI("gpt-image-1-mini")
        
        GPT_IMAGE_2("gpt-image-2")
        
        GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
        
        GPT_IMAGE_1_5("gpt-image-1.5")
        
        CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
      - Optional<Moderation> moderation
        
        Moderation level for the generated image. Default: auto.
        
        AUTO("auto")
        
        LOW("low")
      - Optional<Long> outputCompression
        
        Compression level for the output image. Default: 100.
      - Optional<OutputFormat> outputFormat
        
        The output format of the generated image. One of png, webp, or jpeg. Default: png.
        
        PNG("png")
        
        WEBP("webp")
        
        JPEG("jpeg")
      - Optional<Long> partialImages
        
        Number of partial images to generate in streaming mode, from 0 (default value) to 3.
      - Optional<Quality> quality
        
        The quality of the generated image. One of low, medium, high, or auto. Default: auto.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        AUTO("auto")
      - Optional<Size> size
        
        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.
        
        _1024X1024("1024x1024")
        
        _1024X1536("1024x1536")
        
        _1536X1024("1536x1024")
        
        AUTO("auto")
    - JsonValue;
      - JsonValue; type "local_shell"constant
        
        The type of the local shell tool. Always local_shell.
        
        LOCAL_SHELL("local_shell")
    - class FunctionShellTool:
      
      A tool that allows the model to execute shell commands.
      - JsonValue; type "shell"constant
        
        The type of the shell tool. Always shell.
        
        SHELL("shell")
      - Optional<Environment> environment
        
        class ContainerAuto:
        
        JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
        
        Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
        
        class LocalEnvironment:
        
        JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
        
        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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
    - 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
        
        The type of the custom tool. Always custom.
        
        CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
        
        Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
    - class NamespaceTool:
      
      Groups function/custom tools under a shared namespace.
      - String description
        
        A description of the namespace shown to the model.
      - String name
        
        The namespace name used in tool calls (for example, crm).
      - List<Tool> tools
        
        The function/custom tools available inside this namespace.
        
        class Function:
        
        String name
        
        JsonValue; type "function"constant
        
        FUNCTION("function")
        
        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
      - JsonValue; type "namespace"constant
        
        The type of the tool. Always namespace.
        
        NAMESPACE("namespace")
    - class ToolSearchTool:
      
      Hosted or BYOT tool search configuration for deferred tools.
      - JsonValue; type "tool_search"constant
        
        The type of the tool. Always tool_search.
        
        TOOL_SEARCH("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.
        
        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.
        
        WEB_SEARCH_PREVIEW("web_search_preview")
        
        WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
      - Optional<List<SearchContentType>> searchContentTypes
        
        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.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
      - Optional<UserLocation> userLocation
        
        The user's location.
        
        JsonValue; type "approximate"constant
        
        The type of location approximation. Always approximate.
        
        APPROXIMATE("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
        
        The type of the tool. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
  - JsonValue; type "tool_search_output"constant
    
    The type of the item. Always tool_search_output.
    - TOOL_SEARCH_OUTPUT("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
      
      The type of the object. Always summary_text.
      - SUMMARY_TEXT("summary_text")
  - JsonValue; type "reasoning"constant
    
    The type of the object. Always reasoning.
    - REASONING("reasoning")
  - Optional<List<Content>> content
    
    Reasoning text content.
    - String text
      
      The reasoning text from the model.
    - JsonValue; type "reasoning_text"constant
      
      The type of the reasoning text. Always reasoning_text.
      - REASONING_TEXT("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.
    - 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
    
    The type of the item. Always compaction.
    - COMPACTION("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.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - GENERATING("generating")
    - FAILED("failed")
  - JsonValue; type "image_generation_call"constant
    
    The type of the image generation call. Always image_generation_call.
    - IMAGE_GENERATION_CALL("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.
    - class Logs:
      
      The logs output from the code interpreter.
      - String logs
        
        The logs output from the code interpreter.
      - JsonValue; type "logs"constant
        
        The type of the output. Always logs.
        
        LOGS("logs")
    - class Image:
      
      The image output from the code interpreter.
      - JsonValue; type "image"constant
        
        The type of the output. Always image.
        
        IMAGE("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.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
    - INTERPRETING("interpreting")
    - FAILED("failed")
  - JsonValue; type "code_interpreter_call"constant
    
    The type of the code interpreter tool call. Always code_interpreter_call.
    - CODE_INTERPRETER_CALL("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
      
      The type of the local shell action. Always exec.
      - EXEC("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.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - JsonValue; type "local_shell_call"constant
    
    The type of the local shell call. Always local_shell_call.
    - LOCAL_SHELL_CALL("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
    
    The type of the local shell tool call output. Always local_shell_call_output.
    - LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
  - Optional<Status> status
    
    The status of the item. One of in_progress, completed, or incomplete.
    - 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.
    - class ResponseLocalEnvironment:
      
      Represents the use of a local environment to perform shell actions.
      - JsonValue; type "local"constant
        
        The environment type. Always local.
        
        LOCAL("local")
    - class ResponseContainerReference:
      
      Represents a container created with /v1/containers.
      - String containerId
      - JsonValue; type "container_reference"constant
        
        The environment type. Always container_reference.
        
        CONTAINER_REFERENCE("container_reference")
  - Status status
    
    The status of the shell call. One of in_progress, completed, or incomplete.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - JsonValue; type "shell_call"constant
    
    The type of the item. Always shell_call.
    - SHELL_CALL("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.
      - JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("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.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - JsonValue; type "shell_call_output"constant
    
    The type of the shell call output. Always shell_call_output.
    - SHELL_CALL_OUTPUT("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.
    - 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 a new file with the provided diff.
        
        CREATE_FILE("create_file")
    - 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 the specified file.
        
        DELETE_FILE("delete_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 an existing file with the provided diff.
        
        UPDATE_FILE("update_file")
  - Status status
    
    The status of the apply patch tool call. One of in_progress or completed.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
  - JsonValue; type "apply_patch_call"constant
    
    The type of the item. Always apply_patch_call.
    - APPLY_PATCH_CALL("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.
    - COMPLETED("completed")
    - FAILED("failed")
  - JsonValue; type "apply_patch_call_output"constant
    
    The type of the item. Always apply_patch_call_output.
    - APPLY_PATCH_CALL_OUTPUT("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
    
    The type of the item. Always mcp_list_tools.
    - MCP_LIST_TOOLS("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
    
    The type of the item. Always mcp_approval_request.
    - MCP_APPROVAL_REQUEST("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
    
    The type of the item. Always mcp_approval_response.
    - MCP_APPROVAL_RESPONSE("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
    
    The type of the item. Always mcp_call.
    - MCP_CALL("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.
    - 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.
    - 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.
    - IN_PROGRESS("in_progress")
    - COMPLETED("completed")
    - INCOMPLETE("incomplete")
  - Optional<String> createdBy
    
    The identifier of the actor that created the item.

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.responses.inputitems.InputItemListPage;
import com.openai.models.responses.inputitems.InputItemListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        InputItemListPage page = client.responses().inputItems().list("response_id");
    }
}

Response

{
  "data": [
    {
      "id": "id",
      "content": [
        {
          "text": "text",
          "type": "input_text"
        }
      ],
      "role": "user",
      "type": "message",
      "status": "in_progress"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id",
  "object": "list"
}

Domain Types

Response Item List

class ResponseItemList:

A list of Response items.
- List<ResponseItem> data
  
  A list of items used to generate this 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.
      - class ResponseInputText:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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, system, or developer.
      - USER("user")
      - SYSTEM("system")
      - DEVELOPER("developer")
    - JsonValue; type "message"constant
      
      The type of the message input. Always set to message.
      - MESSAGE("message")
    - Optional<Status> status
      
      The status of item. One of in_progress, completed, or incomplete. Populated when items are returned via API.
      - 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.
      - class ResponseOutputText:
        
        A text output from the model.
        
        List<Annotation> annotations
        
        The annotations of the text output.
        
        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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
        
        String text
        
        The text output from the model.
        
        JsonValue; type "output_text"constant
        
        The type of the output text. Always output_text.
        
        OUTPUT_TEXT("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
        
        The type of the refusal. Always refusal.
        
        REFUSAL("refusal")
    - JsonValue; role "assistant"constant
      
      The role of the output message. Always assistant.
      - ASSISTANT("assistant")
    - Status status
      
      The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "message"constant
      
      The type of the output message. Always message.
      - MESSAGE("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.
      - 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,
      - IN_PROGRESS("in_progress")
      - SEARCHING("searching")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
      - FAILED("failed")
    - JsonValue; type "file_search_call"constant
      
      The type of the file search tool call. Always file_search_call.
      - FILE_SEARCH_CALL("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.
        
        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.
      - 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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - Type type
      
      The type of the computer call. Always computer_call.
      - COMPUTER_CALL("computer_call")
    - Optional<Action> action
      
      A click action.
      - class Click:
        
        A click action.
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
      - class Move:
        
        A mouse move action.
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
      - class Scroll:
        
        A scroll action.
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
      - JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
    - Optional<List<ComputerAction>> actions
      
      Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.
      - Click
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
      - Move
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
      - Scroll
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
      - JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
  - 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.
      - JsonValue; type "computer_screenshot"constant
        
        Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
        
        COMPUTER_SCREENSHOT("computer_screenshot")
      - Optional<String> fileId
        
        The identifier of an uploaded file that contains the screenshot.
      - Optional<String> imageUrl
        
        The URL of the screenshot image.
    - Status status
      
      The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
      - FAILED("failed")
      - IN_PROGRESS("in_progress")
    - JsonValue; type "computer_call_output"constant
      
      The type of the computer tool call output. Always computer_call_output.
      - COMPUTER_CALL_OUTPUT("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).
      - class Search:
        
        Action type "search" - Performs a web search query.
        
        String query
        
        [DEPRECATED] The search query.
        
        JsonValue; type "search"constant
        
        The action type.
        
        SEARCH("search")
        
        Optional<List<String>> queries
        
        The search queries.
        
        Optional<List<Source>> sources
        
        The sources used in the search.
        
        JsonValue; type "url"constant
        
        The type of source. Always url.
        
        URL("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
        
        The action type.
        
        OPEN_PAGE("open_page")
        
        Optional<String> url
        
        The URL opened by the model.
      - 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
        
        The action type.
        
        FIND_IN_PAGE("find_in_page")
        
        String url
        
        The URL of the page searched for the pattern.
    - Status status
      
      The status of the web search tool call.
      - IN_PROGRESS("in_progress")
      - SEARCHING("searching")
      - COMPLETED("completed")
      - FAILED("failed")
    - JsonValue; type "web_search_call"constant
      
      The type of the web search tool call. Always web_search_call.
      - WEB_SEARCH_CALL("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.
      - 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.
      - String
      - List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
    - Status status
      
      The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "function_call_output"constant
      
      The type of the function tool call output. Always function_call_output.
      - FUNCTION_CALL_OUTPUT("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.
      - SERVER("server")
      - CLIENT("client")
    - Status status
      
      The status of the tool search call item that was recorded.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "tool_search_call"constant
      
      The type of the item. Always tool_search_call.
      - TOOL_SEARCH_CALL("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.
      - SERVER("server")
      - CLIENT("client")
    - Status status
      
      The status of the tool search output item that was recorded.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - List<Tool> tools
      
      The loaded tool definitions returned by tool search.
      - 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
        
        The type of the function tool. Always function.
        
        FUNCTION("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
        
        The type of the file search tool. Always file_search.
        
        FILE_SEARCH("file_search")
        
        List<String> vectorStoreIds
        
        The IDs of the vector stores to search.
        
        Optional<Filters> filters
        
        A filter to apply.
        
        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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
        
        Type type
        
        Type of operation: and or or.
        
        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.
        
        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
        
        The type of the computer tool. Always computer.
        
        COMPUTER("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.
        
        WINDOWS("windows")
        
        MAC("mac")
        
        LINUX("linux")
        
        UBUNTU("ubuntu")
        
        BROWSER("browser")
        
        JsonValue; type "computer_use_preview"constant
        
        The type of the computer use tool. Always computer_use_preview.
        
        COMPUTER_USE_PREVIEW("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.
        
        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.
        
        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.
        
        APPROXIMATE("approximate")
      - Mcp
        
        String serverLabel
        
        A label for this MCP server, used to identify it in tool calls.
        
        JsonValue; type "mcp"constant
        
        The type of the MCP tool. Always mcp.
        
        MCP("mcp")
        
        Optional<AllowedTools> allowedTools
        
        List of allowed tool names or a filter object.
        
        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
        
        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.
        
        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.
        
        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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
        
        JsonValue; type "code_interpreter"constant
        
        The type of the code interpreter tool. Always code_interpreter.
        
        CODE_INTERPRETER("code_interpreter")
      - ImageGeneration
        
        JsonValue; type "image_generation"constant
        
        The type of the image generation tool. Always image_generation.
        
        IMAGE_GENERATION("image_generation")
        
        Optional<Action> action
        
        Whether to generate a new image or edit an existing image. Default: auto.
        
        GENERATE("generate")
        
        EDIT("edit")
        
        AUTO("auto")
        
        Optional<Background> background
        
        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.
        
        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.
        
        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.
        
        GPT_IMAGE_1("gpt-image-1")
        
        GPT_IMAGE_1_MINI("gpt-image-1-mini")
        
        GPT_IMAGE_2("gpt-image-2")
        
        GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
        
        GPT_IMAGE_1_5("gpt-image-1.5")
        
        CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
        
        Optional<Moderation> moderation
        
        Moderation level for the generated image. Default: auto.
        
        AUTO("auto")
        
        LOW("low")
        
        Optional<Long> outputCompression
        
        Compression level for the output image. Default: 100.
        
        Optional<OutputFormat> outputFormat
        
        The output format of the generated image. One of png, webp, or jpeg. Default: png.
        
        PNG("png")
        
        WEBP("webp")
        
        JPEG("jpeg")
        
        Optional<Long> partialImages
        
        Number of partial images to generate in streaming mode, from 0 (default value) to 3.
        
        Optional<Quality> quality
        
        The quality of the generated image. One of low, medium, high, or auto. Default: auto.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        AUTO("auto")
        
        Optional<Size> size
        
        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.
        
        _1024X1024("1024x1024")
        
        _1024X1536("1024x1536")
        
        _1536X1024("1536x1024")
        
        AUTO("auto")
      - JsonValue;
        
        JsonValue; type "local_shell"constant
        
        The type of the local shell tool. Always local_shell.
        
        LOCAL_SHELL("local_shell")
      - class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        JsonValue; type "shell"constant
        
        The type of the shell tool. Always shell.
        
        SHELL("shell")
        
        Optional<Environment> environment
        
        class ContainerAuto:
        
        JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
        
        Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
        
        class LocalEnvironment:
        
        JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
        
        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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
      - 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
        
        The type of the custom tool. Always custom.
        
        CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
        
        Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
      - class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        String description
        
        A description of the namespace shown to the model.
        
        String name
        
        The namespace name used in tool calls (for example, crm).
        
        List<Tool> tools
        
        The function/custom tools available inside this namespace.
        
        class Function:
        
        String name
        
        JsonValue; type "function"constant
        
        FUNCTION("function")
        
        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
        
        JsonValue; type "namespace"constant
        
        The type of the tool. Always namespace.
        
        NAMESPACE("namespace")
      - class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        JsonValue; type "tool_search"constant
        
        The type of the tool. Always tool_search.
        
        TOOL_SEARCH("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.
        
        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.
        
        WEB_SEARCH_PREVIEW("web_search_preview")
        
        WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
        
        Optional<List<SearchContentType>> searchContentTypes
        
        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.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        Optional<UserLocation> userLocation
        
        The user's location.
        
        JsonValue; type "approximate"constant
        
        The type of location approximation. Always approximate.
        
        APPROXIMATE("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
        
        The type of the tool. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
    - JsonValue; type "tool_search_output"constant
      
      The type of the item. Always tool_search_output.
      - TOOL_SEARCH_OUTPUT("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
        
        The type of the object. Always summary_text.
        
        SUMMARY_TEXT("summary_text")
    - JsonValue; type "reasoning"constant
      
      The type of the object. Always reasoning.
      - REASONING("reasoning")
    - Optional<List<Content>> content
      
      Reasoning text content.
      - String text
        
        The reasoning text from the model.
      - JsonValue; type "reasoning_text"constant
        
        The type of the reasoning text. Always reasoning_text.
        
        REASONING_TEXT("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.
      - 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
      
      The type of the item. Always compaction.
      - COMPACTION("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - GENERATING("generating")
      - FAILED("failed")
    - JsonValue; type "image_generation_call"constant
      
      The type of the image generation call. Always image_generation_call.
      - IMAGE_GENERATION_CALL("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.
      - class Logs:
        
        The logs output from the code interpreter.
        
        String logs
        
        The logs output from the code interpreter.
        
        JsonValue; type "logs"constant
        
        The type of the output. Always logs.
        
        LOGS("logs")
      - class Image:
        
        The image output from the code interpreter.
        
        JsonValue; type "image"constant
        
        The type of the output. Always image.
        
        IMAGE("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
      - INTERPRETING("interpreting")
      - FAILED("failed")
    - JsonValue; type "code_interpreter_call"constant
      
      The type of the code interpreter tool call. Always code_interpreter_call.
      - CODE_INTERPRETER_CALL("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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "local_shell_call"constant
      
      The type of the local shell call. Always local_shell_call.
      - LOCAL_SHELL_CALL("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
      
      The type of the local shell tool call output. Always local_shell_call_output.
      - LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
    - Optional<Status> status
      
      The status of the item. One of in_progress, completed, or incomplete.
      - 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.
      - class ResponseLocalEnvironment:
        
        Represents the use of a local environment to perform shell actions.
        
        JsonValue; type "local"constant
        
        The environment type. Always local.
        
        LOCAL("local")
      - class ResponseContainerReference:
        
        Represents a container created with /v1/containers.
        
        String containerId
        
        JsonValue; type "container_reference"constant
        
        The environment type. Always container_reference.
        
        CONTAINER_REFERENCE("container_reference")
    - Status status
      
      The status of the shell call. One of in_progress, completed, or incomplete.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "shell_call"constant
      
      The type of the item. Always shell_call.
      - SHELL_CALL("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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("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.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
      - INCOMPLETE("incomplete")
    - JsonValue; type "shell_call_output"constant
      
      The type of the shell call output. Always shell_call_output.
      - SHELL_CALL_OUTPUT("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.
      - 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 a new file with the provided diff.
        
        CREATE_FILE("create_file")
      - 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 the specified file.
        
        DELETE_FILE("delete_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 an existing file with the provided diff.
        
        UPDATE_FILE("update_file")
    - Status status
      
      The status of the apply patch tool call. One of in_progress or completed.
      - IN_PROGRESS("in_progress")
      - COMPLETED("completed")
    - JsonValue; type "apply_patch_call"constant
      
      The type of the item. Always apply_patch_call.
      - APPLY_PATCH_CALL("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.
      - COMPLETED("completed")
      - FAILED("failed")
    - JsonValue; type "apply_patch_call_output"constant
      
      The type of the item. Always apply_patch_call_output.
      - APPLY_PATCH_CALL_OUTPUT("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
      
      The type of the item. Always mcp_list_tools.
      - MCP_LIST_TOOLS("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
      
      The type of the item. Always mcp_approval_request.
      - MCP_APPROVAL_REQUEST("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
      
      The type of the item. Always mcp_approval_response.
      - MCP_APPROVAL_RESPONSE("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
      
      The type of the item. Always mcp_call.
      - MCP_CALL("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.
      - 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.
      - 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.
      - 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
  
  The type of object returned, must be list.
  - LIST("list")

Input Tokens

Get input token counts

InputTokenCountResponse responses().inputTokens().count(InputTokenCountParamsparams = InputTokenCountParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

post /responses/input_tokens

Returns input token counts of the request.

Returns an object with object set to response.input_tokens and an input_tokens count.

Parameters

InputTokenCountParams params
- 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.
  - String
  - class ResponseConversationParam:
    
    The conversation that this response belongs to.
    - String id
      
      The unique ID of the conversation.
- Optional<Input> input
  
  Text, image, or file inputs to the model, used to generate a response
  - String
  - List<ResponseInputItem>
    - 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.
        
        String
        
        List<ResponseInputContent>
        
        class ResponseInputText:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("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.
        
        LOW("low")
        
        HIGH("high")
        
        AUTO("auto")
        
        ORIGINAL("original")
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        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.
        
        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.
        
        COMMENTARY("commentary")
        
        FINAL_ANSWER("final_answer")
      - Optional<Type> type
        
        The type of the message input. Always message.
        
        MESSAGE("message")
    - Message
      - List<ResponseInputContent> content
        
        A list of one or many input items to the model, containing different content types.
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
      - Role role
        
        The role of the message input. One of user, system, or developer.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - Optional<Type> type
        
        The type of the message input. Always set to message.
        
        MESSAGE("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.
        
        class ResponseOutputText:
        
        A text output from the model.
        
        List<Annotation> annotations
        
        The annotations of the text output.
        
        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
        
        The type of the file citation. Always file_citation.
        
        FILE_CITATION("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
        
        The type of the URL citation. Always url_citation.
        
        URL_CITATION("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
        
        The type of the container file citation. Always container_file_citation.
        
        CONTAINER_FILE_CITATION("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
        
        The type of the file path. Always file_path.
        
        FILE_PATH("file_path")
        
        String text
        
        The text output from the model.
        
        JsonValue; type "output_text"constant
        
        The type of the output text. Always output_text.
        
        OUTPUT_TEXT("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
        
        The type of the refusal. Always refusal.
        
        REFUSAL("refusal")
      - JsonValue; role "assistant"constant
        
        The role of the output message. Always assistant.
        
        ASSISTANT("assistant")
      - Status status
        
        The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "message"constant
        
        The type of the output message. Always message.
        
        MESSAGE("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.
        
        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,
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        FAILED("failed")
      - JsonValue; type "file_search_call"constant
        
        The type of the file search tool call. Always file_search_call.
        
        FILE_SEARCH_CALL("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.
        
        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.
        
        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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - Type type
        
        The type of the computer call. Always computer_call.
        
        COMPUTER_CALL("computer_call")
      - Optional<Action> action
        
        A click action.
        
        class Click:
        
        A click action.
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        class Move:
        
        A mouse move action.
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        class Scroll:
        
        A scroll action.
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
      - Optional<List<ComputerAction>> actions
        
        Flattened batched actions for computer_use. Each action includes an type discriminator and action-specific fields.
        
        Click
        
        Button button
        
        Indicates which mouse button was pressed during the click. One of left, right, wheel, back, or forward.
        
        LEFT("left")
        
        RIGHT("right")
        
        WHEEL("wheel")
        
        BACK("back")
        
        FORWARD("forward")
        
        JsonValue; type "click"constant
        
        Specifies the event type. For a click action, this property is always click.
        
        CLICK("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
        
        Specifies the event type. For a double click action, this property is always set to double_click.
        
        DOUBLE_CLICK("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
        
        Specifies the event type. For a drag action, this property is always set to drag.
        
        DRAG("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
        
        Specifies the event type. For a keypress action, this property is always set to keypress.
        
        KEYPRESS("keypress")
        
        Move
        
        JsonValue; type "move"constant
        
        Specifies the event type. For a move action, this property is always set to move.
        
        MOVE("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
        
        Specifies the event type. For a screenshot action, this property is always set to screenshot.
        
        SCREENSHOT("screenshot")
        
        Scroll
        
        long scrollX
        
        The horizontal scroll distance.
        
        long scrollY
        
        The vertical scroll distance.
        
        JsonValue; type "scroll"constant
        
        Specifies the event type. For a scroll action, this property is always set to scroll.
        
        SCROLL("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
        
        Specifies the event type. For a type action, this property is always set to type.
        
        TYPE("type")
        
        JsonValue;
        
        JsonValue; type "wait"constant
        
        Specifies the event type. For a wait action, this property is always set to wait.
        
        WAIT("wait")
    - ComputerCallOutput
      - 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.
        
        JsonValue; type "computer_screenshot"constant
        
        Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot.
        
        COMPUTER_SCREENSHOT("computer_screenshot")
        
        Optional<String> fileId
        
        The identifier of an uploaded file that contains the screenshot.
        
        Optional<String> imageUrl
        
        The URL of the screenshot image.
      - JsonValue; type "computer_call_output"constant
        
        The type of the computer tool call output. Always computer_call_output.
        
        COMPUTER_CALL_OUTPUT("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.
        
        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).
        
        class Search:
        
        Action type "search" - Performs a web search query.
        
        String query
        
        [DEPRECATED] The search query.
        
        JsonValue; type "search"constant
        
        The action type.
        
        SEARCH("search")
        
        Optional<List<String>> queries
        
        The search queries.
        
        Optional<List<Source>> sources
        
        The sources used in the search.
        
        JsonValue; type "url"constant
        
        The type of source. Always url.
        
        URL("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
        
        The action type.
        
        OPEN_PAGE("open_page")
        
        Optional<String> url
        
        The URL opened by the model.
        
        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
        
        The action type.
        
        FIND_IN_PAGE("find_in_page")
        
        String url
        
        The URL of the page searched for the pattern.
      - Status status
        
        The status of the web search tool call.
        
        IN_PROGRESS("in_progress")
        
        SEARCHING("searching")
        
        COMPLETED("completed")
        
        FAILED("failed")
      - JsonValue; type "web_search_call"constant
        
        The type of the web search tool call. Always web_search_call.
        
        WEB_SEARCH_CALL("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
        
        The type of the function tool call. Always function_call.
        
        FUNCTION_CALL("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - FunctionCallOutput
      - String callId
        
        The unique ID of the function tool call generated by the model.
      - Output output
        
        Text, image, or file output of the function tool call.
        
        String
        
        List<ResponseFunctionCallOutputItem>
        
        class ResponseInputTextContent:
        
        A text input to the model.
        
        String text
        
        The text input to the model.
        
        JsonValue; type "input_text"constant
        
        The type of the input item. Always input_text.
        
        INPUT_TEXT("input_text")
        
        class ResponseInputImageContent:
        
        An image input to the model. Learn about image inputs
        
        JsonValue; type "input_image"constant
        
        The type of the input item. Always input_image.
        
        INPUT_IMAGE("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.
        
        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.
        
        class ResponseInputFileContent:
        
        A file input to the model.
        
        JsonValue; type "input_file"constant
        
        The type of the input item. Always input_file.
        
        INPUT_FILE("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.
        
        LOW("low")
        
        HIGH("high")
        
        Optional<String> fileData
        
        The base64-encoded data 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 "function_call_output"constant
        
        The type of the function tool call output. Always function_call_output.
        
        FUNCTION_CALL_OUTPUT("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.
        
        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
        
        The item type. Always tool_search_call.
        
        TOOL_SEARCH_CALL("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.
      - Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
      - Optional<Status> status
        
        The status of the tool search call.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - class ResponseToolSearchOutputItemParam:
      - List<Tool> tools
        
        The loaded tool definitions returned by the tool search output.
        
        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
        
        The type of the function tool. Always function.
        
        FUNCTION("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
        
        The type of the file search tool. Always file_search.
        
        FILE_SEARCH("file_search")
        
        List<String> vectorStoreIds
        
        The IDs of the vector stores to search.
        
        Optional<Filters> filters
        
        A filter to apply.
        
        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
        
        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.
        
        String
        
        double
        
        boolean
        
        List<ComparisonFilterValueItem>
        
        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.
        
        class ComparisonFilter:
        
        A filter used to compare a specified attribute key to a given value using a defined comparison operation.
        
        JsonValue
        
        Type type
        
        Type of operation: and or or.
        
        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.
        
        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
        
        The type of the computer tool. Always computer.
        
        COMPUTER("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.
        
        WINDOWS("windows")
        
        MAC("mac")
        
        LINUX("linux")
        
        UBUNTU("ubuntu")
        
        BROWSER("browser")
        
        JsonValue; type "computer_use_preview"constant
        
        The type of the computer use tool. Always computer_use_preview.
        
        COMPUTER_USE_PREVIEW("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.
        
        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.
        
        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.
        
        APPROXIMATE("approximate")
        
        Mcp
        
        String serverLabel
        
        A label for this MCP server, used to identify it in tool calls.
        
        JsonValue; type "mcp"constant
        
        The type of the MCP tool. Always mcp.
        
        MCP("mcp")
        
        Optional<AllowedTools> allowedTools
        
        List of allowed tool names or a filter object.
        
        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
        
        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.
        
        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.
        
        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
        
        Always auto.
        
        AUTO("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.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        JsonValue; type "disabled"constant
        
        Disable outbound network access. Always disabled.
        
        DISABLED("disabled")
        
        class ContainerNetworkPolicyAllowlist:
        
        List<String> allowedDomains
        
        A list of allowed domains when type is allowlist.
        
        JsonValue; type "allowlist"constant
        
        Allow outbound network access only to specified domains. Always allowlist.
        
        ALLOWLIST("allowlist")
        
        Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
        
        Optional domain-scoped secrets for allowlisted domains.
        
        String domain
        
        The domain associated with the secret.
        
        String name
        
        The name of the secret to inject for the domain.
        
        String value
        
        The secret value to inject for the domain.
        
        JsonValue; type "code_interpreter"constant
        
        The type of the code interpreter tool. Always code_interpreter.
        
        CODE_INTERPRETER("code_interpreter")
        
        ImageGeneration
        
        JsonValue; type "image_generation"constant
        
        The type of the image generation tool. Always image_generation.
        
        IMAGE_GENERATION("image_generation")
        
        Optional<Action> action
        
        Whether to generate a new image or edit an existing image. Default: auto.
        
        GENERATE("generate")
        
        EDIT("edit")
        
        AUTO("auto")
        
        Optional<Background> background
        
        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.
        
        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.
        
        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.
        
        GPT_IMAGE_1("gpt-image-1")
        
        GPT_IMAGE_1_MINI("gpt-image-1-mini")
        
        GPT_IMAGE_2("gpt-image-2")
        
        GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
        
        GPT_IMAGE_1_5("gpt-image-1.5")
        
        CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
        
        Optional<Moderation> moderation
        
        Moderation level for the generated image. Default: auto.
        
        AUTO("auto")
        
        LOW("low")
        
        Optional<Long> outputCompression
        
        Compression level for the output image. Default: 100.
        
        Optional<OutputFormat> outputFormat
        
        The output format of the generated image. One of png, webp, or jpeg. Default: png.
        
        PNG("png")
        
        WEBP("webp")
        
        JPEG("jpeg")
        
        Optional<Long> partialImages
        
        Number of partial images to generate in streaming mode, from 0 (default value) to 3.
        
        Optional<Quality> quality
        
        The quality of the generated image. One of low, medium, high, or auto. Default: auto.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        AUTO("auto")
        
        Optional<Size> size
        
        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.
        
        _1024X1024("1024x1024")
        
        _1024X1536("1024x1536")
        
        _1536X1024("1536x1024")
        
        AUTO("auto")
        
        JsonValue;
        
        JsonValue; type "local_shell"constant
        
        The type of the local shell tool. Always local_shell.
        
        LOCAL_SHELL("local_shell")
        
        class FunctionShellTool:
        
        A tool that allows the model to execute shell commands.
        
        JsonValue; type "shell"constant
        
        The type of the shell tool. Always shell.
        
        SHELL("shell")
        
        Optional<Environment> environment
        
        class ContainerAuto:
        
        JsonValue; type "container_auto"constant
        
        Automatically creates a container for this request
        
        CONTAINER_AUTO("container_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 container.
        
        _1G("1g")
        
        _4G("4g")
        
        _16G("16g")
        
        _64G("64g")
        
        Optional<NetworkPolicy> networkPolicy
        
        Network access policy for the container.
        
        class ContainerNetworkPolicyDisabled:
        
        class ContainerNetworkPolicyAllowlist:
        
        Optional<List<Skill>> skills
        
        An optional list of skills referenced by id or inline data.
        
        class SkillReference:
        
        String skillId
        
        The ID of the referenced skill.
        
        JsonValue; type "skill_reference"constant
        
        References a skill created with the /v1/skills endpoint.
        
        SKILL_REFERENCE("skill_reference")
        
        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
        
        String data
        
        Base64-encoded skill zip bundle.
        
        JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
        
        JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
        
        JsonValue; type "inline"constant
        
        Defines an inline skill for this request.
        
        INLINE("inline")
        
        class LocalEnvironment:
        
        JsonValue; type "local"constant
        
        Use a local computer environment.
        
        LOCAL("local")
        
        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
        
        References a container created with the /v1/containers endpoint
        
        CONTAINER_REFERENCE("container_reference")
        
        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
        
        The type of the custom tool. Always custom.
        
        CUSTOM("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;
        
        JsonValue; type "text"constant
        
        Unconstrained text format. Always text.
        
        TEXT("text")
        
        Grammar
        
        String definition
        
        The grammar definition.
        
        Syntax syntax
        
        The syntax of the grammar definition. One of lark or regex.
        
        LARK("lark")
        
        REGEX("regex")
        
        JsonValue; type "grammar"constant
        
        Grammar format. Always grammar.
        
        GRAMMAR("grammar")
        
        class NamespaceTool:
        
        Groups function/custom tools under a shared namespace.
        
        String description
        
        A description of the namespace shown to the model.
        
        String name
        
        The namespace name used in tool calls (for example, crm).
        
        List<Tool> tools
        
        The function/custom tools available inside this namespace.
        
        class Function:
        
        String name
        
        JsonValue; type "function"constant
        
        FUNCTION("function")
        
        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
        
        JsonValue; type "namespace"constant
        
        The type of the tool. Always namespace.
        
        NAMESPACE("namespace")
        
        class ToolSearchTool:
        
        Hosted or BYOT tool search configuration for deferred tools.
        
        JsonValue; type "tool_search"constant
        
        The type of the tool. Always tool_search.
        
        TOOL_SEARCH("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.
        
        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.
        
        WEB_SEARCH_PREVIEW("web_search_preview")
        
        WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")
        
        Optional<List<SearchContentType>> searchContentTypes
        
        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.
        
        LOW("low")
        
        MEDIUM("medium")
        
        HIGH("high")
        
        Optional<UserLocation> userLocation
        
        The user's location.
        
        JsonValue; type "approximate"constant
        
        The type of location approximation. Always approximate.
        
        APPROXIMATE("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
        
        The type of the tool. Always apply_patch.
        
        APPLY_PATCH("apply_patch")
      - JsonValue; type "tool_search_output"constant
        
        The item type. Always tool_search_output.
        
        TOOL_SEARCH_OUTPUT("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.
      - Optional<Execution> execution
        
        Whether tool search was executed by the server or by the client.
        
        SERVER("server")
        
        CLIENT("client")
      - Optional<Status> status
        
        The status of the tool search output.
        
        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
        
        The type of the object. Always summary_text.
        
        SUMMARY_TEXT("summary_text")
      - JsonValue; type "reasoning"constant
        
        The type of the object. Always reasoning.
        
        REASONING("reasoning")
      - Optional<List<Content>> content
        
        Reasoning text content.
        
        String text
        
        The reasoning text from the model.
        
        JsonValue; type "reasoning_text"constant
        
        The type of the reasoning text. Always reasoning_text.
        
        REASONING_TEXT("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.
        
        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.
      - JsonValue; type "compaction"constant
        
        The type of the item. Always compaction.
        
        COMPACTION("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        GENERATING("generating")
        
        FAILED("failed")
      - JsonValue; type "image_generation_call"constant
        
        The type of the image generation call. Always image_generation_call.
        
        IMAGE_GENERATION_CALL("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.
        
        class Logs:
        
        The logs output from the code interpreter.
        
        String logs
        
        The logs output from the code interpreter.
        
        JsonValue; type "logs"constant
        
        The type of the output. Always logs.
        
        LOGS("logs")
        
        class Image:
        
        The image output from the code interpreter.
        
        JsonValue; type "image"constant
        
        The type of the output. Always image.
        
        IMAGE("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
        
        INTERPRETING("interpreting")
        
        FAILED("failed")
      - JsonValue; type "code_interpreter_call"constant
        
        The type of the code interpreter tool call. Always code_interpreter_call.
        
        CODE_INTERPRETER_CALL("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
        
        The type of the local shell action. Always exec.
        
        EXEC("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
      - JsonValue; type "local_shell_call"constant
        
        The type of the local shell call. Always local_shell_call.
        
        LOCAL_SHELL_CALL("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
        
        The type of the local shell tool call output. Always local_shell_call_output.
        
        LOCAL_SHELL_CALL_OUTPUT("local_shell_call_output")
      - Optional<Status> status
        
        The status of the item. One of in_progress, completed, or incomplete.
        
        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.
      - JsonValue; type "shell_call"constant
        
        The type of the item. Always shell_call.
        
        SHELL_CALL("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.
        
        class LocalEnvironment:
        
        class ContainerReference:
      - Optional<Status> status
        
        The status of the shell call. One of in_progress, completed, or incomplete.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - ShellCallOutput
      - String callId
        
        The unique ID of the shell tool call generated by the model.
      - 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.
        
        JsonValue;
        
        JsonValue; type "timeout"constant
        
        The outcome type. Always timeout.
        
        TIMEOUT("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
        
        The outcome type. Always exit.
        
        EXIT("exit")
        
        String stderr
        
        Captured stderr output for the shell call.
        
        String stdout
        
        Captured stdout output for the shell call.
      - JsonValue; type "shell_call_output"constant
        
        The type of the item. Always shell_call_output.
        
        SHELL_CALL_OUTPUT("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.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
        
        INCOMPLETE("incomplete")
    - ApplyPatchCall
      - String callId
        
        The unique ID of the apply patch tool call generated by the model.
      - Operation operation
        
        The specific create, delete, or update instruction for the apply_patch tool call.
        
        class CreateFile:
        
        Instruction for creating a new file via the apply_patch tool.
        
        String diff
        
        Unified diff content to apply when creating the file.
        
        String path
        
        Path of the file to create relative to the workspace root.
        
        JsonValue; type "create_file"constant
        
        The operation type. Always create_file.
        
        CREATE_FILE("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.
        
        JsonValue; type "delete_file"constant
        
        The operation type. Always delete_file.
        
        DELETE_FILE("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.
        
        String path
        
        Path of the file to update relative to the workspace root.
        
        JsonValue; type "update_file"constant
        
        The operation type. Always update_file.
        
        UPDATE_FILE("update_file")
      - Status status
        
        The status of the apply patch tool call. One of in_progress or completed.
        
        IN_PROGRESS("in_progress")
        
        COMPLETED("completed")
      - JsonValue; type "apply_patch_call"constant
        
        The type of the item. Always apply_patch_call.
        
        APPLY_PATCH_CALL("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.
      - Status status
        
        The status of the apply patch tool call output. One of completed or failed.
        
        COMPLETED("completed")
        
        FAILED("failed")
      - JsonValue; type "apply_patch_call_output"constant
        
        The type of the item. Always apply_patch_call_output.
        
        APPLY_PATCH_CALL_OUTPUT("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).
    - 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
        
        The type of the item. Always mcp_list_tools.
        
        MCP_LIST_TOOLS("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
        
        The type of the item. Always mcp_approval_request.
        
        MCP_APPROVAL_REQUEST("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
        
        The type of the item. Always mcp_approval_response.
        
        MCP_APPROVAL_RESPONSE("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
        
        The type of the item. Always mcp_call.
        
        MCP_CALL("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.
        
        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.
        
        String
        
        List<FunctionAndCustomToolCallOutput>
        
        class ResponseInputText:
        
        A text input to the model.
        
        class ResponseInputImage:
        
        An image input to the model. Learn about image inputs.
        
        class ResponseInputFile:
        
        A file input to the model.
      - JsonValue; type "custom_tool_call_output"constant
        
        The type of the custom tool call output. Always custom_tool_call_output.
        
        CUSTOM_TOOL_CALL_OUTPUT("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
        
        The type of the custom tool call. Always custom_tool_call.
        
        CUSTOM_TOOL_CALL("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.
    - JsonValue;
      - JsonValue; type "compaction_trigger"constant
        
        The type of the item. Always compaction_trigger.
        
        COMPACTION_TRIGGER("compaction_trigger")
    - ItemReference
      - String id
        
        The ID of the item to reference.
      - Optional<Type> type
        
        The type of item to reference. Always item_reference.
        
        ITEM_REFERENCE("item_reference")
- Optional<String> instructions
  
  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.
- Optional<String> 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<Reasoning> reasoning
  
  gpt-5 and o-series models only Configuration options for reasoning models.
- Optional<Text> 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<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.
    - class ResponseFormatText:
      
      Default response format. Used to generate text responses.
      - JsonValue; type "text"constant
        
        The type of response format being defined. Always text.
        
        TEXT("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
        
        The type of response format being defined. Always json_schema.
        
        JSON_SCHEMA("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
        
        The type of response format being defined. Always json_object.
        
        JSON_OBJECT("json_object")
  - 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.
    - LOW("low")
    - MEDIUM("medium")
    - HIGH("high")
- Optional<ToolChoice> toolChoice
  
  Controls which tool the model should use, if any.
  - 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.
      - 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 tool configuration type. Always allowed_tools.
      - ALLOWED_TOOLS("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
      - 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
      
      For function calling, the type is always function.
      - FUNCTION("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
      
      For MCP tools, the type is always mcp.
      - MCP("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
      
      For custom tool calling, the type is always custom.
      - CUSTOM("custom")
  - class ToolChoiceApplyPatch:
    
    Forces the model to call the apply_patch tool when executing a tool call.
    - JsonValue; type "apply_patch"constant
      
      The tool to call. Always apply_patch.
      - APPLY_PATCH("apply_patch")
  - class ToolChoiceShell:
    
    Forces the model to call the shell tool when a tool call is required.
    - JsonValue; type "shell"constant
      
      The tool to call. Always shell.
      - SHELL("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.
  - class FunctionTool:
    
    Defines a function in your own code the model can choose to call. Learn more about function calling.
  - class FileSearchTool:
    
    A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
  - class ComputerTool:
    
    A tool that controls a virtual computer. Learn more about the computer tool.
  - class ComputerUsePreviewTool:
    
    A tool that controls a virtual computer. Learn more about the computer tool.
  - class WebSearchTool:
    
    Search the Internet for sources related to the prompt. Learn more about the web search tool.
  - Mcp
  - CodeInterpreter
  - ImageGeneration
  - JsonValue;
  - class FunctionShellTool:
    
    A tool that allows the model to execute shell commands.
  - class CustomTool:
    
    A custom tool that processes input using a specified format. Learn more about custom tools
  - class NamespaceTool:
    
    Groups function/custom tools under a shared namespace.
  - class ToolSearchTool:
    
    Hosted or BYOT tool search configuration for deferred tools.
  - class WebSearchPreviewTool:
    
    This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
  - class ApplyPatchTool:
    
    Allows the assistant to create, delete, or update files using unified diffs.
- 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.
  - AUTO("auto")
  - DISABLED("disabled")

Returns

class InputTokenCountResponse:
- long inputTokens
- JsonValue; object_ "response.input_tokens"constant
  - RESPONSE_INPUT_TOKENS("response.input_tokens")

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.responses.inputtokens.InputTokenCountParams;
import com.openai.models.responses.inputtokens.InputTokenCountResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        InputTokenCountResponse response = client.responses().inputTokens().count();
    }
}

Response

{
  "input_tokens": 123,
  "object": "response.input_tokens"
}

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.responses.inputtokens.InputTokenCountParams;
import com.openai.models.responses.inputtokens.InputTokenCountResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        InputTokenCountParams params = InputTokenCountParams.builder()
            .model("gpt-5")
            .input("Tell me a joke.")
            .build();

        InputTokenCountResponse response = client.responses().inputTokens().count(params);
    }
}

Response

{
  "object": "response.input_tokens",
  "input_tokens": 11
}

java/resources/responses/index.md +136 −0

2950 2950

2951 The namespace of the custom tool being called.2951 The namespace of the custom tool being called.

2952 2952

2953 - `JsonValue;`

2954

2955 - `JsonValue; type "compaction_trigger"constant`

2956

2957 The type of the item. Always `compaction_trigger`.

2958

2959 - `COMPACTION_TRIGGER("compaction_trigger")`

2960

2953 - `ItemReference`2961 - `ItemReference`

2954 2962

2955 - `String id`2963 - `String id`

6297 6305

6298 The namespace of the custom tool being called.6306 The namespace of the custom tool being called.

6299 6307

6308 - `JsonValue;`

6309

6310 - `JsonValue; type "compaction_trigger"constant`

6311

6312 The type of the item. Always `compaction_trigger`.

6313

6314 - `COMPACTION_TRIGGER("compaction_trigger")`

6315

6300 - `ItemReference`6316 - `ItemReference`

6301 6317

6302 - `String id`6318 - `String id`

11098 11114

11099 The namespace of the custom tool being called.11115 The namespace of the custom tool being called.

11100 11116

11117 - `JsonValue;`

11118

11119 - `JsonValue; type "compaction_trigger"constant`

11120

11121 The type of the item. Always `compaction_trigger`.

11122

11123 - `COMPACTION_TRIGGER("compaction_trigger")`

11124

11101 - `ItemReference`11125 - `ItemReference`

11102 11126

11103 - `String id`11127 - `String id`

15900 15924

15901 The namespace of the custom tool being called.15925 The namespace of the custom tool being called.

15902 15926

15927 - `JsonValue;`

15928

15929 - `JsonValue; type "compaction_trigger"constant`

15930

15931 The type of the item. Always `compaction_trigger`.

15932

15933 - `COMPACTION_TRIGGER("compaction_trigger")`

15934

15903 - `ItemReference`15935 - `ItemReference`

15904 15936

15905 - `String id`15937 - `String id`

20778 20810

20779 The namespace of the custom tool being called.20811 The namespace of the custom tool being called.

20780 20812

20813 - `JsonValue;`

20814

20815 - `JsonValue; type "compaction_trigger"constant`

20816

20817 The type of the item. Always `compaction_trigger`.

20818

20819 - `COMPACTION_TRIGGER("compaction_trigger")`

20820

20781 - `ItemReference`20821 - `ItemReference`

20782 20822

20783 - `String id`20823 - `String id`

30579 30619

30580 The namespace of the custom tool being called.30620 The namespace of the custom tool being called.

30581 30621

30622 - `JsonValue;`

30623

30624 - `JsonValue; type "compaction_trigger"constant`

30625

30626 The type of the item. Always `compaction_trigger`.

30627

30628 - `COMPACTION_TRIGGER("compaction_trigger")`

30629

30582 - `ItemReference`30630 - `ItemReference`

30583 30631

30584 - `String id`30632 - `String id`

35628 35676

35629 The namespace of the custom tool being called.35677 The namespace of the custom tool being called.

35630 35678

35679 - `JsonValue;`

35680

35681 - `JsonValue; type "compaction_trigger"constant`

35682

35683 The type of the item. Always `compaction_trigger`.

35684

35685 - `COMPACTION_TRIGGER("compaction_trigger")`

35686

35631 - `ItemReference`35687 - `ItemReference`

35632 35688

35633 - `String id`35689 - `String id`

41403 41459

41404 The namespace of the custom tool being called.41460 The namespace of the custom tool being called.

41405 41461

41462 - `JsonValue;`

41463

41464 - `JsonValue; type "compaction_trigger"constant`

41465

41466 The type of the item. Always `compaction_trigger`.

41467

41468 - `COMPACTION_TRIGGER("compaction_trigger")`

41469

41406 - `ItemReference`41470 - `ItemReference`

41407 41471

41408 - `String id`41472 - `String id`

46348 46412

46349 The namespace of the custom tool being called.46413 The namespace of the custom tool being called.

46350 46414

46415 - `JsonValue;`

46416

46417 - `JsonValue; type "compaction_trigger"constant`

46418

46419 The type of the item. Always `compaction_trigger`.

46420

46421 - `COMPACTION_TRIGGER("compaction_trigger")`

46422

46351 - `ItemReference`46423 - `ItemReference`

46352 46424

46353 - `String id`46425 - `String id`

51951 52023

51952 The namespace of the custom tool being called.52024 The namespace of the custom tool being called.

51953 52025

52026 - `JsonValue;`

52027

52028 - `JsonValue; type "compaction_trigger"constant`

52029

52030 The type of the item. Always `compaction_trigger`.

52031

52032 - `COMPACTION_TRIGGER("compaction_trigger")`

52033

51954 - `ItemReference`52034 - `ItemReference`

51955 52035

51956 - `String id`52036 - `String id`

56604 56684

56605 The namespace of the custom tool being called.56685 The namespace of the custom tool being called.

56606 56686

56687 - `JsonValue;`

56688

56689 - `JsonValue; type "compaction_trigger"constant`

56690

56691 The type of the item. Always `compaction_trigger`.

56692

56693 - `COMPACTION_TRIGGER("compaction_trigger")`

56694

56607 - `ItemReference`56695 - `ItemReference`

56608 56696

56609 - `String id`56697 - `String id`

61393 61481

61394 The namespace of the custom tool being called.61482 The namespace of the custom tool being called.

61395 61483

61484 - `JsonValue;`

61485

61486 - `JsonValue; type "compaction_trigger"constant`

61487

61488 The type of the item. Always `compaction_trigger`.

61489

61490 - `COMPACTION_TRIGGER("compaction_trigger")`

61491

61396 - `ItemReference`61492 - `ItemReference`

61397 61493

61398 - `String id`61494 - `String id`

76254 76350

76255 The namespace of the custom tool being called.76351 The namespace of the custom tool being called.

76256 76352

76353 - `JsonValue;`

76354

76355 - `JsonValue; type "compaction_trigger"constant`

76356

76357 The type of the item. Always `compaction_trigger`.

76358

76359 - `COMPACTION_TRIGGER("compaction_trigger")`

76360

76257 - `ItemReference`76361 - `ItemReference`

76258 76362

76259 - `String id`76363 - `String id`

81420 81524

81421 The namespace of the custom tool being called.81525 The namespace of the custom tool being called.

81422 81526

81527 - `JsonValue;`

81528

81529 - `JsonValue; type "compaction_trigger"constant`

81530

81531 The type of the item. Always `compaction_trigger`.

81532

81533 - `COMPACTION_TRIGGER("compaction_trigger")`

81534

81423 - `ItemReference`81535 - `ItemReference`

81424 81536

81425 - `String id`81537 - `String id`

89624 89736

89625 The namespace of the custom tool being called.89737 The namespace of the custom tool being called.

89626 89738

89739 - `JsonValue;`

89740

89741 - `JsonValue; type "compaction_trigger"constant`

89742

89743 The type of the item. Always `compaction_trigger`.

89744

89745 - `COMPACTION_TRIGGER("compaction_trigger")`

89746

89627 - `ItemReference`89747 - `ItemReference`

89628 89748

89629 - `String id`89749 - `String id`

93526 93646

93527 The namespace of the custom tool being called.93647 The namespace of the custom tool being called.

93528 93648

93649 - `JsonValue;`

93650

93651 - `JsonValue; type "compaction_trigger"constant`

93652

93653 The type of the item. Always `compaction_trigger`.

93654

93655 - `COMPACTION_TRIGGER("compaction_trigger")`

93656

93529 - `ItemReference`93657 - `ItemReference`

93530 93658

93531 - `String id`93659 - `String id`

106314 106442

106315 The namespace of the custom tool being called.106443 The namespace of the custom tool being called.

106316 106444

106445 - `JsonValue;`

106446

106447 - `JsonValue; type "compaction_trigger"constant`

106448

106449 The type of the item. Always `compaction_trigger`.

106450

106451 - `COMPACTION_TRIGGER("compaction_trigger")`

106452

106317 - `ItemReference`106453 - `ItemReference`

106318 106454

106319 - `String id`106455 - `String id`

java/resources/responses/index.md 2026-05-11 18:00 UTC to 2026-05-18 22:01 UTC

Responses

Create a model response

Parameters

Returns

Example

Response

Get a model response

Parameters

Returns

Example

Response

Delete a model response

Parameters

Example

Cancel a response

Parameters

Returns

Example

Response

Compact a response

Parameters

Returns

Example

Response

Domain Types

Apply Patch Tool

Compacted Response

Computer Action

Computer Tool

Computer Use Preview Tool

Container Auto

Container Network Policy Allowlist

Container Network Policy Disabled

Container Network Policy Domain Secret

Container Reference

Custom Tool

Easy Input Message

File Search Tool

Function Shell Tool

Function Tool

Inline Skill

Inline Skill Source

Local Environment

Local Skill

Namespace Tool

Response

Response Apply Patch Tool Call

Response Apply Patch Tool Call Output

Response Audio Delta Event

Response Audio Done Event

Response Audio Transcript Delta Event

Response Audio Transcript Done Event

Response Code Interpreter Call Code Delta Event

Response Code Interpreter Call Code Done Event

Response Code Interpreter Call Completed Event

Response Code Interpreter Call In Progress Event

Response Code Interpreter Call Interpreting Event

Response Code Interpreter Tool Call

Response Compaction Item

Response Compaction Item Param

Response Completed Event

Response Computer Tool Call

Response Computer Tool Call Output Item

Response Computer Tool Call Output Screenshot

Response Container Reference

Response Content

Response Content Part Added Event

Response Content Part Done Event

Response Conversation Param

Response Created Event

Response Custom Tool Call

Response Custom Tool Call Input Delta Event

Response Custom Tool Call Input Done Event

Response Custom Tool Call Item

Response Custom Tool Call Output

Response Custom Tool Call Output Item

Response Error

Response Error Event

Response Failed Event