API Reference

Responses

Input Tokens

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get input token counts

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

POST/responses/input_tokens

Get input token counts

ParametersExpand Collapse

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>

Accepts one of the following:

class EasyInputMessage:

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

Content content

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

Accepts one of the following:

String

List<ResponseInputContent>

Accepts one of the following:

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputImage:

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

Detail detail

The detail level of the image to be sent to the model. One of high, low, or auto. Defaults to auto.

Accepts one of the following:

LOW("low")

HIGH("high")

AUTO("auto")

JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<String> fileId

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

Optional<String> imageUrl

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

class ResponseInputFile:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

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

Accepts one of the following:

USER("user")

ASSISTANT("assistant")

SYSTEM("system")

DEVELOPER("developer")

Optional<Type> type

The type of the message input. Always message.

Message

List<ResponseInputContent> content

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

Accepts one of the following:

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputImage:

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

Detail detail

The detail level of the image to be sent to the model. One of high, low, or auto. Defaults to auto.

Accepts one of the following:

LOW("low")

HIGH("high")

AUTO("auto")

JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<String> fileId

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

Optional<String> imageUrl

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

class ResponseInputFile:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

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

Accepts one of the following:

USER("user")

SYSTEM("system")

DEVELOPER("developer")

Optional<Status> status

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

Accepts one of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

Optional<Type> type

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

class ResponseOutputMessage:

An output message from the model.

String id

The unique ID of the output message.

List<Content> content

The content of the output message.

Accepts one of the following:

class ResponseOutputText:

A text output from the model.

List<Annotation> annotations

The annotations of the text output.

Accepts one of the following:

class FileCitation:

A citation to a file.

String fileId

The ID of the file.

String filename

The filename of the file cited.

long index

The index of the file in the list of files.

JsonValue; type "file_citation"constant"file_citation"constant

The type of the file citation. Always file_citation.

class UrlCitation:

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

long endIndex

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

long startIndex

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

String title

The title of the web resource.

JsonValue; type "url_citation"constant"url_citation"constant

The type of the URL citation. Always url_citation.

String url

The URL of the web resource.

class ContainerFileCitation:

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

String containerId

The ID of the container file.

long endIndex

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

String fileId

The ID of the file.

String filename

The filename of the container file cited.

long startIndex

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

JsonValue; type "container_file_citation"constant"container_file_citation"constant

The type of the container file citation. Always container_file_citation.

class FilePath:

A path to a file.

String fileId

The ID of the file.

long index

The index of the file in the list of files.

JsonValue; type "file_path"constant"file_path"constant

The type of the file path. Always file_path.

String text

The text output from the model.

JsonValue; type "output_text"constant"output_text"constant

The type of the output text. Always output_text.

Optional<List<Logprob>> logprobs

String token

List<long> bytes

double logprob

List<TopLogprob> topLogprobs

String token

List<long> bytes

double logprob

class ResponseOutputRefusal:

A refusal from the model.

String refusal

The refusal explanation from the model.

JsonValue; type "refusal"constant"refusal"constant

The type of the refusal. Always refusal.

JsonValue; role "assistant"constant"assistant"constant

The role of the output message. Always assistant.

Status status

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

Accepts one of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "message"constant"message"constant

The type of the output message. Always message.

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,

Accepts one of the following:

IN_PROGRESS("in_progress")

SEARCHING("searching")

COMPLETED("completed")

INCOMPLETE("incomplete")

FAILED("failed")

JsonValue; type "file_search_call"constant"file_search_call"constant

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

Optional<List<Result>> results

The results of the file search tool call.

Optional<Attributes> attributes

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters, booleans, or numbers.

Accepts one of the following:

String

double

boolean

Optional<String> fileId

The unique ID of the file.

Optional<String> filename

The name of the file.

Optional<Double> score

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

formatfloat

Optional<String> text

The text that was retrieved from the file.

class ResponseComputerToolCall:

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

String id

The unique ID of the computer call.

Action action

A click action.

Accepts one of the following:

class Click:

A click action.

Button button

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

Accepts one of the following:

LEFT("left")

RIGHT("right")

WHEEL("wheel")

BACK("back")

FORWARD("forward")

JsonValue; type "click"constant"click"constant

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

long x

The x-coordinate where the click occurred.

long y

The y-coordinate where the click occurred.

class DoubleClick:

A double click action.

JsonValue; type "double_click"constant"double_click"constant

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

long x

The x-coordinate where the double click occurred.

long y

The y-coordinate where the double click occurred.

class Drag:

A drag action.

List<Path> path

An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg

[
  { x: 100, y: 200 },
  { x: 200, y: 300 }
]

long x

The x-coordinate.

long y

The y-coordinate.

JsonValue; type "drag"constant"drag"constant

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

class Keypress:

A collection of keypresses the model would like to perform.

List<String> keys

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

JsonValue; type "keypress"constant"keypress"constant

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

class Move:

A mouse move action.

JsonValue; type "move"constant"move"constant

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

long x

The x-coordinate to move to.

long y

The y-coordinate to move to.

JsonValue;

JsonValue; type "screenshot"constant"screenshot"constant

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

class Scroll:

A scroll action.

long scrollX

The horizontal scroll distance.

long scrollY

The vertical scroll distance.

JsonValue; type "scroll"constant"scroll"constant

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

long x

The x-coordinate where the scroll occurred.

long y

The y-coordinate where the scroll occurred.

class Type:

An action to type in text.

String text

The text to type.

JsonValue; type "type"constant"type"constant

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

JsonValue;

JsonValue; type "wait"constant"wait"constant

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

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.

Accepts one of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

Type type

The type of the computer call. Always computer_call.

ComputerCallOutput

String callId

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

maxLength64

minLength1

ResponseComputerToolCallOutputScreenshot output

A computer screenshot image used with the computer use tool.

JsonValue; type "computer_screenshot"constant"computer_screenshot"constant

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

Optional<String> fileId

The identifier of an uploaded file that contains the screenshot.

Optional<String> imageUrl

The URL of the screenshot image.

JsonValue; type "computer_call_output"constant"computer_call_output"constant

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

Optional<String> id

The ID of the computer tool call output.

Optional<List<AcknowledgedSafetyCheck>> acknowledgedSafetyChecks

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

String id

The ID of the pending safety check.

Optional<String> code

The type of the pending safety check.

Optional<String> message

Details about the pending safety check.

Optional<Status> status

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

Accepts one of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseFunctionWebSearch:

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

String id

The unique ID of the web search tool call.

Action action

An object describing the specific action taken in this web search call. Includes details on how the model used the web (search, open_page, find_in_page).

Accepts one of the following:

class Search:

Action type "search" - Performs a web search query.

String query

[DEPRECATED] The search query.

JsonValue; type "search"constant"search"constant

The action type.

Optional<List<String>> queries

The search queries.

Optional<List<Source>> sources

The sources used in the search.

JsonValue; type "url"constant"url"constant

The type of source. Always url.

String url

The URL of the source.

class OpenPage:

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

JsonValue; type "open_page"constant"open_page"constant

The action type.

Optional<String> url

The URL opened by the model.

formaturi

class FindInPage:

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

String pattern

The pattern or text to search for within the page.

JsonValue; type "find_in_page"constant"find_in_page"constant

The action type.

String url

The URL of the page searched for the pattern.

formaturi

Status status

The status of the web search tool call.

Accepts one of the following:

IN_PROGRESS("in_progress")

SEARCHING("searching")

COMPLETED("completed")

FAILED("failed")

JsonValue; type "web_search_call"constant"web_search_call"constant

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

class ResponseFunctionToolCall:

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

String arguments

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

String callId

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

String name

The name of the function to run.

JsonValue; type "function_call"constant"function_call"constant

The type of the function tool call. Always function_call.

Optional<String> id

The unique ID of the function tool call.

Optional<Status> status

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

Accepts one of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

FunctionCallOutput

String callId

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

maxLength64

minLength1

Output output

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

Accepts one of the following:

String

List<ResponseFunctionCallOutputItem>

Accepts one of the following:

class ResponseInputTextContent:

A text input to the model.

String text

The text input to the model.

maxLength10485760

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputImageContent:

An image input to the model. Learn about image inputs

JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<Detail> detail

The detail level of the image to be sent to the model. One of high, low, or auto. Defaults to auto.

Accepts one of the following:

LOW("low")

HIGH("high")

AUTO("auto")

Optional<String> fileId

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

Optional<String> imageUrl

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

maxLength20971520

class ResponseInputFileContent:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

Optional<String> fileData

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

maxLength33554432

Optional<String> fileId

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

Optional<String> fileUrl

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

Optional<String> filename

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

JsonValue; type "function_call_output"constant"function_call_output"constant

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

Optional<String> id

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

Optional<Status> status

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

Accepts one of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseReasoningItem:

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

String id

The unique identifier of the reasoning content.

List<Summary> summary

Reasoning summary content.

String text

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

JsonValue; type "summary_text"constant"summary_text"constant

The type of the object. Always summary_text.

JsonValue; type "reasoning"constant"reasoning"constant

The type of the object. Always reasoning.

Optional<List<Content>> content

Reasoning text content.

String text

The reasoning text from the model.

JsonValue; type "reasoning_text"constant"reasoning_text"constant

The type of the reasoning text. Always reasoning_text.

Optional<String> encryptedContent

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

Optional<Status> status

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

Accepts one of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

class ResponseCompactionItemParam:

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

String encryptedContent

The encrypted content of the compaction summary.

maxLength10485760

JsonValue; type "compaction"constant"compaction"constant

The type of the item. Always compaction.

Optional<String> id

The ID of the compaction item.

ImageGenerationCall

String id

The unique ID of the image generation call.

Optional<String> result

The generated image encoded in base64.

Status status

The status of the image generation call.

Accepts one of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

GENERATING("generating")

FAILED("failed")

JsonValue; type "image_generation_call"constant"image_generation_call"constant

The type of the image generation call. Always image_generation_call.

class ResponseCodeInterpreterToolCall:

A tool call to run code.

String id

The unique ID of the code interpreter tool call.

Optional<String> code

The code to run, or null if not available.

String containerId

The ID of the container used to run the code.

Optional<List<Output>> outputs

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

Accepts one of the following:

class Logs:

The logs output from the code interpreter.

String logs

The logs output from the code interpreter.

JsonValue; type "logs"constant"logs"constant

The type of the output. Always logs.

class Image:

The image output from the code interpreter.

JsonValue; type "image"constant"image"constant

The type of the output. Always image.

String url

The URL of the image output from the code interpreter.

Status status

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

Accepts one of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

INTERPRETING("interpreting")

FAILED("failed")

JsonValue; type "code_interpreter_call"constant"code_interpreter_call"constant

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

LocalShellCall

String id

The unique ID of the local shell call.

Action action

Execute a shell command on the server.

List<String> command

The command to run.

Env env

Environment variables to set for the command.

JsonValue; type "exec"constant"exec"constant

The type of the local shell action. Always exec.

Optional<Long> timeoutMs

Optional timeout in milliseconds for the command.

Optional<String> user

Optional user to run the command as.

Optional<String> workingDirectory

Optional working directory to run the command in.

String callId

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

Status status

The status of the local shell call.

Accepts one of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

JsonValue; type "local_shell_call"constant"local_shell_call"constant

The type of the local shell call. Always local_shell_call.

LocalShellCallOutput

String id

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

String output

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

JsonValue; type "local_shell_call_output"constant"local_shell_call_output"constant

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

Optional<Status> status

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

Accepts one of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

ShellCall

Action action

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

List<String> commands

Ordered shell commands for the execution environment to run.

Optional<Long> maxOutputLength

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

Optional<Long> timeoutMs

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

String callId

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

maxLength64

minLength1

JsonValue; type "shell_call"constant"shell_call"constant

The type of the item. Always shell_call.

Optional<String> id

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

Optional<Status> status

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

Accepts one of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

ShellCallOutput

String callId

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

maxLength64

minLength1

List<ResponseFunctionShellCallOutputContent> output

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

Outcome outcome

The exit or timeout outcome associated with this shell call.

Accepts one of the following:

JsonValue;

JsonValue; type "timeout"constant"timeout"constant

The outcome type. Always timeout.

class Exit:

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

long exitCode

The exit code returned by the shell process.

JsonValue; type "exit"constant"exit"constant

The outcome type. Always exit.

String stderr

Captured stderr output for the shell call.

maxLength10485760

String stdout

Captured stdout output for the shell call.

maxLength10485760

JsonValue; type "shell_call_output"constant"shell_call_output"constant

The type of the item. Always shell_call_output.

Optional<String> id

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

Optional<Long> maxOutputLength

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

Optional<Status> status

The status of the shell call output.

Accepts one of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

ApplyPatchCall

String callId

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

maxLength64

minLength1

Operation operation

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

Accepts one of the following:

class CreateFile:

Instruction for creating a new file via the apply_patch tool.

String diff

Unified diff content to apply when creating the file.

maxLength10485760

String path

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

minLength1

JsonValue; type "create_file"constant"create_file"constant

The operation type. Always create_file.

class DeleteFile:

Instruction for deleting an existing file via the apply_patch tool.

String path

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

minLength1

JsonValue; type "delete_file"constant"delete_file"constant

The operation type. Always delete_file.

class UpdateFile:

Instruction for updating an existing file via the apply_patch tool.

String diff

Unified diff content to apply to the existing file.

maxLength10485760

String path

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

minLength1

JsonValue; type "update_file"constant"update_file"constant

The operation type. Always update_file.

Status status

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

Accepts one of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

JsonValue; type "apply_patch_call"constant"apply_patch_call"constant

The type of the item. Always apply_patch_call.

Optional<String> id

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

ApplyPatchCallOutput

String callId

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

maxLength64

minLength1

Status status

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

Accepts one of the following:

COMPLETED("completed")

FAILED("failed")

JsonValue; type "apply_patch_call_output"constant"apply_patch_call_output"constant

The type of the item. Always apply_patch_call_output.

Optional<String> id

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

Optional<String> output

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

maxLength10485760

McpListTools

String id

The unique ID of the list.

String serverLabel

The label of the MCP server.

List<Tool> tools

The tools available on the server.

JsonValue inputSchema

The JSON schema describing the tool's input.

String name

The name of the tool.

Optional<JsonValue> annotations

Additional annotations about the tool.

Optional<String> description

The description of the tool.

JsonValue; type "mcp_list_tools"constant"mcp_list_tools"constant

The type of the item. Always mcp_list_tools.

Optional<String> error

Error message if the server could not list tools.

McpApprovalRequest

String id

The unique ID of the approval request.

String arguments

A JSON string of arguments for the tool.

String name

The name of the tool to run.

String serverLabel

The label of the MCP server making the request.

JsonValue; type "mcp_approval_request"constant"mcp_approval_request"constant

The type of the item. Always mcp_approval_request.

McpApprovalResponse

String approvalRequestId

The ID of the approval request being answered.

boolean approve

Whether the request was approved.

JsonValue; type "mcp_approval_response"constant"mcp_approval_response"constant

The type of the item. Always mcp_approval_response.

Optional<String> id

The unique ID of the approval response

Optional<String> reason

Optional reason for the decision.

McpCall

String id

The unique ID of the tool call.

String arguments

A JSON string of the arguments passed to the tool.

String name

The name of the tool that was run.

String serverLabel

The label of the MCP server running the tool.

JsonValue; type "mcp_call"constant"mcp_call"constant

The type of the item. Always mcp_call.

Optional<String> approvalRequestId

Unique identifier for the MCP tool call approval request. Include this value in a subsequent mcp_approval_response input to approve or reject the corresponding tool call.

Optional<String> error

The error from the tool call, if any.

Optional<String> output

The output from the tool call.

Optional<Status> status

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

Accepts one of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

INCOMPLETE("incomplete")

CALLING("calling")

FAILED("failed")

class ResponseCustomToolCallOutput:

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

String callId

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

Output output

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

Accepts one of the following:

String

List<FunctionAndCustomToolCallOutput>

Accepts one of the following:

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputImage:

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

Detail detail

The detail level of the image to be sent to the model. One of high, low, or auto. Defaults to auto.

Accepts one of the following:

LOW("low")

HIGH("high")

AUTO("auto")

JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<String> fileId

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

Optional<String> imageUrl

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

class ResponseInputFile:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

Optional<String> fileData

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

Optional<String> fileId

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

Optional<String> fileUrl

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

Optional<String> filename

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

JsonValue; type "custom_tool_call_output"constant"custom_tool_call_output"constant

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

Optional<String> id

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

class ResponseCustomToolCall:

A call to a custom tool created by the model.

String callId

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

String input

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

String name

The name of the custom tool being called.

JsonValue; type "custom_tool_call"constant"custom_tool_call"constant

The type of the custom tool call. Always custom_tool_call.

Optional<String> id

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

ItemReference

String id

The ID of the item to reference.

Optional<Type> type

The type of item to reference. Always item_reference.

Optional<String> instructions

A system (or developer) message inserted into the model's context. When 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.

Accepts one of the following:

class ResponseFormatText:

Default response format. Used to generate text responses.

JsonValue; type "text"constant"text"constant

The type of response format being defined. Always text.

class ResponseFormatTextJsonSchemaConfig:

JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.

String name

The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

Schema schema

The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas here.

JsonValue; type "json_schema"constant"json_schema"constant

The type of response format being defined. Always json_schema.

Optional<String> description

A description of what the response format is for, used by the model to determine how to respond in the format.

Optional<Boolean> strict

Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true. To learn more, read the Structured Outputs guide.

class ResponseFormatJsonObject:

JSON object response format. An older method of generating JSON responses. Using json_schema is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so.

JsonValue; type "json_object"constant"json_object"constant

The type of response format being defined. Always json_object.

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.

Accepts one of the following:

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.

Accepts one of the following:

AUTO("auto")

REQUIRED("required")

List<Tool> tools

A list of tool definitions that the model should be allowed to call.

For the Responses API, the list of tool definitions might look like:

[
  { "type": "function", "name": "get_weather" },
  { "type": "mcp", "server_label": "deepwiki" },
  { "type": "image_generation" }
]

JsonValue; type "allowed_tools"constant"allowed_tools"constant

Allowed tool configuration type. Always allowed_tools.

class ToolChoiceTypes:

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

Type type

The type of hosted tool the model should to use. Learn more about built-in tools.

Allowed values are:

• file_search
• web_search_preview
• computer_use_preview
• code_interpreter
• image_generation

Accepts one of the following:

FILE_SEARCH("file_search")

WEB_SEARCH_PREVIEW("web_search_preview")

COMPUTER_USE_PREVIEW("computer_use_preview")

WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")

IMAGE_GENERATION("image_generation")

CODE_INTERPRETER("code_interpreter")

class ToolChoiceFunction:

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

String name

The name of the function to call.

JsonValue; type "function"constant"function"constant

For function calling, the type is always function.

class ToolChoiceMcp:

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

String serverLabel

The label of the MCP server to use.

JsonValue; type "mcp"constant"mcp"constant

For MCP tools, the type is always mcp.

Optional<String> name

The name of the tool to call on the server.

class ToolChoiceCustom:

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

String name

The name of the custom tool to call.

JsonValue; type "custom"constant"custom"constant

For custom tool calling, the type is always custom.

class ToolChoiceApplyPatch:

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

JsonValue; type "apply_patch"constant"apply_patch"constant

The tool to call. Always apply_patch.

class ToolChoiceShell:

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

JsonValue; type "shell"constant"shell"constant

The tool to call. Always shell.

Optional<List<Tool>> tools

An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter.

class FunctionTool:

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

String name

The name of the function to call.

Optional<Parameters> parameters

A JSON schema object describing the parameters of the function.

Optional<Boolean> strict

Whether to enforce strict parameter validation. Default true.

JsonValue; type "function"constant"function"constant

The type of the function tool. Always function.

Optional<String> description

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

class FileSearchTool:

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

JsonValue; type "file_search"constant"file_search"constant

The type of the file search tool. Always file_search.

List<String> vectorStoreIds

The IDs of the vector stores to search.

Optional<Filters> filters

A filter to apply.

Accepts one of the following:

class ComparisonFilter:

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

String key

The key to compare against the value.

Type type

Specifies the comparison operator: eq, ne, gt, gte, lt, lte, in, nin.

• eq: equals
• ne: not equal
• gt: greater than
• gte: greater than or equal
• lt: less than
• lte: less than or equal
• in: in
• nin: not in

Accepts one of the following:

EQ("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

Value value

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

Accepts one of the following:

String

double

boolean

List<ComparisonFilterValueItem>

Accepts one of the following:

String

double

class CompoundFilter:

Combine multiple filters using and or or.

List<Filter> filters

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

Accepts one of the following:

class ComparisonFilter:

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

String key

The key to compare against the value.

Type type

Specifies the comparison operator: eq, ne, gt, gte, lt, lte, in, nin.

• eq: equals
• ne: not equal
• gt: greater than
• gte: greater than or equal
• lt: less than
• lte: less than or equal
• in: in
• nin: not in

Accepts one of the following:

EQ("eq")

NE("ne")

GT("gt")

GTE("gte")

LT("lt")

LTE("lte")

Value value

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

Accepts one of the following:

String

double

boolean

List<ComparisonFilterValueItem>

Accepts one of the following:

String

double

JsonValue

Type type

Type of operation: and or or.

Accepts one of the following:

AND("and")

OR("or")

Optional<Long> maxNumResults

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

Optional<RankingOptions> rankingOptions

Ranking options for search.

Optional<HybridSearch> hybridSearch

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

double embeddingWeight

The weight of the embedding in the reciprocal ranking fusion.

double textWeight

The weight of the text in the reciprocal ranking fusion.

Optional<Ranker> ranker

The ranker to use for the file search.

Accepts one of the following:

AUTO("auto")

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

Optional<Double> scoreThreshold

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

class ComputerTool:

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

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.

Accepts one of the following:

WINDOWS("windows")

MAC("mac")

LINUX("linux")

UBUNTU("ubuntu")

BROWSER("browser")

JsonValue; type "computer_use_preview"constant"computer_use_preview"constant

The type of the computer use tool. Always computer_use_preview.

class WebSearchTool:

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

Type type

The type of the web search tool. One of web_search or web_search_2025_08_26.

Accepts one of the following:

WEB_SEARCH("web_search")

WEB_SEARCH_2025_08_26("web_search_2025_08_26")

Optional<Filters> filters

Filters for the search.

Optional<List<String>> allowedDomains

Allowed domains for the search. If not provided, all domains are allowed. Subdomains of the provided domains are allowed as well.

Example: ["pubmed.ncbi.nlm.nih.gov"]

Optional<SearchContextSize> searchContextSize

High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.

Accepts one of the following:

LOW("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The approximate location of the user.

Optional<String> city

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

Optional<String> country

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

Optional<String> region

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

Optional<String> timezone

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

Optional<Type> type

The type of location approximation. Always approximate.

Mcp

String serverLabel

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

JsonValue; type "mcp"constant"mcp"constant

The type of the MCP tool. Always mcp.

Optional<AllowedTools> allowedTools

List of allowed tool names or a filter object.

Accepts one of the following:

List<String>

class McpToolFilter:

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

Indicates whether or not a tool modifies data or is read-only. If an MCP server is annotated with readOnlyHint, it will match this filter.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<String> authorization

An OAuth access token that can be used with a remote MCP server, either with a custom MCP server URL or a service connector. Your application must handle the OAuth authorization flow and provide the token here.

Optional<ConnectorId> connectorId

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

Currently supported connector_id values are:

• Dropbox: connector_dropbox
• Gmail: connector_gmail
• Google Calendar: connector_googlecalendar
• Google Drive: connector_googledrive
• Microsoft Teams: connector_microsoftteams
• Outlook Calendar: connector_outlookcalendar
• Outlook Email: connector_outlookemail
• SharePoint: connector_sharepoint

Accepts one of the following:

CONNECTOR_DROPBOX("connector_dropbox")

CONNECTOR_GMAIL("connector_gmail")

CONNECTOR_GOOGLECALENDAR("connector_googlecalendar")

CONNECTOR_GOOGLEDRIVE("connector_googledrive")

CONNECTOR_MICROSOFTTEAMS("connector_microsoftteams")

CONNECTOR_OUTLOOKCALENDAR("connector_outlookcalendar")

CONNECTOR_OUTLOOKEMAIL("connector_outlookemail")

CONNECTOR_SHAREPOINT("connector_sharepoint")

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

Accepts one of the following:

class McpToolApprovalFilter:

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

Optional<Always> always

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

Indicates whether or not a tool modifies data or is read-only. If an MCP server is annotated with readOnlyHint, it will match this filter.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<Never> never

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

Indicates whether or not a tool modifies data or is read-only. If an MCP server is annotated with readOnlyHint, it will match this filter.

Optional<List<String>> toolNames

List of allowed tool names.

enum McpToolApprovalSetting:

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

ALWAYS("always")

NEVER("never")

Optional<String> serverDescription

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

Optional<String> serverUrl

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

CodeInterpreter

Container container

The code interpreter container. Can be a container ID or an object that specifies uploaded file IDs to make available to your code, along with an optional memory_limit setting.

Accepts one of the following:

String

class CodeInterpreterToolAuto:

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

JsonValue; type "auto"constant"auto"constant

Always auto.

Optional<List<String>> fileIds

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

Optional<MemoryLimit> memoryLimit

The memory limit for the code interpreter container.

Accepts one of the following:

_1G("1g")

_4G("4g")

_16G("16g")

_64G("64g")

JsonValue; type "code_interpreter"constant"code_interpreter"constant

The type of the code interpreter tool. Always code_interpreter.

ImageGeneration

JsonValue; type "image_generation"constant"image_generation"constant

The type of the image generation tool. Always image_generation.

Optional<Action> action

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

Accepts one of the following:

GENERATE("generate")

EDIT("edit")

AUTO("auto")

Optional<Background> background

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

Accepts one of the following:

TRANSPARENT("transparent")

OPAQUE("opaque")

AUTO("auto")

Optional<InputFidelity> inputFidelity

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

Accepts one of the following:

HIGH("high")

LOW("low")

Optional<InputImageMask> inputImageMask

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

Optional<String> fileId

File ID for the mask image.

Optional<String> imageUrl

Base64-encoded mask image.

Optional<Model> model

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

Accepts one of the following:

GPT_IMAGE_1("gpt-image-1")

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

GPT_IMAGE_1_5("gpt-image-1.5")

Optional<Moderation> moderation

Moderation level for the generated image. Default: auto.

Accepts one of the following:

AUTO("auto")

LOW("low")

Optional<Long> outputCompression

Compression level for the output image. Default: 100.

minimum0

maximum100

Optional<OutputFormat> outputFormat

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

Accepts one of the following:

PNG("png")

WEBP("webp")

JPEG("jpeg")

Optional<Long> partialImages

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

minimum0

maximum3

Optional<Quality> quality

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

Accepts one of the following:

LOW("low")

MEDIUM("medium")

HIGH("high")

AUTO("auto")

Optional<Size> size

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

Accepts one of the following:

_1024X1024("1024x1024")

_1024X1536("1024x1536")

_1536X1024("1536x1024")

AUTO("auto")

JsonValue;

JsonValue; type "local_shell"constant"local_shell"constant

The type of the local shell tool. Always local_shell.

class FunctionShellTool:

A tool that allows the model to execute shell commands.

JsonValue; type "shell"constant"shell"constant

The type of the shell tool. Always shell.

class CustomTool:

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

String name

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

JsonValue; type "custom"constant"custom"constant

The type of the custom tool. Always custom.

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

Accepts one of the following:

JsonValue;

JsonValue; type "text"constant"text"constant

Unconstrained text format. Always text.

Grammar

String definition

The grammar definition.

Syntax syntax

The syntax of the grammar definition. One of lark or regex.

Accepts one of the following:

LARK("lark")

REGEX("regex")

JsonValue; type "grammar"constant"grammar"constant

Grammar format. Always grammar.

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.

Accepts one of the following:

WEB_SEARCH_PREVIEW("web_search_preview")

WEB_SEARCH_PREVIEW_2025_03_11("web_search_preview_2025_03_11")

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.

Accepts one of the following:

LOW("low")

MEDIUM("medium")

HIGH("high")

Optional<UserLocation> userLocation

The user's location.

JsonValue; type "approximate"constant"approximate"constant

The type of location approximation. Always approximate.

Optional<String> city

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

Optional<String> country

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

Optional<String> region

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

Optional<String> timezone

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

class ApplyPatchTool:

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

JsonValue; type "apply_patch"constant"apply_patch"constant

The type of the tool. Always apply_patch.

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

ReturnsExpand Collapse

class InputTokenCountResponse:

long inputTokens

JsonValue; object_ "response.input_tokens"constant"response.input_tokens"constant

Get input token counts

Java

HTTP

TypeScript

Python

Java

Go

Ruby

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();
    }
}

200 example

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

Returns Examples

200 example

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