class EasyInputMessage:

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

Content content

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

One of the following:
String
One of the following:
class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type
constant
constant

The type of the input item. Always input_text.

Optional<PromptCacheBreakpoint> promptCacheBreakpoint

Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

JsonValue; mode
constant
constant

The breakpoint mode. Always explicit.

The minimum lifetime of this cache breakpoint. Defaults to the request TTL.

One of the following:
_30M("30m")
_12H("12h")
class ResponseInputImage:

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

Detail detail

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

One of the following:
LOW("low")
HIGH("high")
AUTO("auto")
ORIGINAL("original")
JsonValue; type
constant
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.

formaturi
Optional<PromptCacheBreakpoint> promptCacheBreakpoint

Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

JsonValue; mode
constant
constant

The breakpoint mode. Always explicit.

The minimum lifetime of this cache breakpoint. Defaults to the request TTL.

One of the following:
_30M("30m")
_12H("12h")
class ResponseInputFile:

A file input to the model.

JsonValue; type
constant
constant

The type of the input item. Always input_file.

Optional<Detail> detail

The detail level of the file to be sent to the model. Use auto to let the system select the detail level; for GPT-5.6 and later models, auto uses high-quality rendering, which may increase input token usage. Use low for lower-cost rendering, or high to render the file at higher quality. Defaults to auto.

One of the following:
AUTO("auto")
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.

formaturi
Optional<String> filename

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

Optional<PromptCacheBreakpoint> promptCacheBreakpoint

Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

JsonValue; mode
constant
constant

The breakpoint mode. Always explicit.

The minimum lifetime of this cache breakpoint. Defaults to the request TTL.

One of the following:
_30M("30m")
_12H("12h")
Role role

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

One of the following:
USER("user")
ASSISTANT("assistant")
SYSTEM("system")
DEVELOPER("developer")
Optional<Phase> phase

Labels an assistant message as intermediate commentary (commentary) or the final answer (final_answer). For models like gpt-5.3-codex and beyond, when sending follow-up requests, preserve and resend phase on all assistant messages — dropping it can degrade performance. Not used for user messages.

One of the following:
COMMENTARY("commentary")
FINAL_ANSWER("final_answer")
Optional<Type> type

The type of the message input. Always message.

Message
This type repeats the enclosing schema.
class ResponseOutputMessage:

An output message from the model.

String id

The unique ID of the output message.

List<Content> content

The content of the output message.

One of the following:
class ResponseOutputText:

A text output from the model.

List<Annotation> annotations

The annotations of the text output.

One of the following:
class FileCitation:

A citation to a file.

String fileId

The ID of the file.

String filename

The filename of the file cited.

long index

The index in the output text at which to insert the file citation.

JsonValue; type
constant
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
constant
constant

The type of the URL citation. Always url_citation.

String url

The URL of the web resource.

formaturi
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
constant
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
constant
constant

The type of the file path. Always file_path.

String text

The text output from the model.

JsonValue; type
constant
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
constant
constant

The type of the refusal. Always refusal.

JsonValue; role
constant
constant

The role of the output message. Always assistant.

Status status

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

One of the following:
IN_PROGRESS("in_progress")
COMPLETED("completed")
INCOMPLETE("incomplete")
JsonValue; type
constant
constant

The type of the output message. Always message.

Optional<Phase> phase

Labels an assistant message as intermediate commentary (commentary) or the final answer (final_answer). For models like gpt-5.3-codex and beyond, when sending follow-up requests, preserve and resend phase on all assistant messages — dropping it can degrade performance. Not used for user messages.

One of the following:
COMMENTARY("commentary")
FINAL_ANSWER("final_answer")
class ResponseFileSearchToolCall:

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

String id

The unique ID of the file search tool call.

List<String> queries

The queries used to search for files.

Status status

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

One of the following:
IN_PROGRESS("in_progress")
SEARCHING("searching")
COMPLETED("completed")
INCOMPLETE("incomplete")
FAILED("failed")
JsonValue; type
constant
constant

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

Optional<List<Result>> results

The results of the file search tool call.

Optional<Attributes> attributes

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

One of the following:
String
double
boolean
Optional<String> fileId

The unique ID of the file.

Optional<String> filename

The name of the file.

Optional<Double> score

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

formatfloat
Optional<String> text

The text that was retrieved from the file.

class ResponseComputerToolCall:

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

String id

The unique ID of the computer call.

String callId

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

List<PendingSafetyCheck> pendingSafetyChecks

The pending safety checks for the computer call.

String id

The ID of the pending safety check.

Optional<String> code

The type of the pending safety check.

Optional<String> message

Details about the pending safety check.

Status status

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

One of the following:
IN_PROGRESS("in_progress")
COMPLETED("completed")
INCOMPLETE("incomplete")
Type type

The type of the computer call. Always computer_call.

Optional<Action> action

A click action.

One of the following:
class Click:

A click action.

Button button

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

One of the following:
LEFT("left")
RIGHT("right")
WHEEL("wheel")
BACK("back")
FORWARD("forward")
JsonValue; type
constant
constant

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

long x

The x-coordinate where the click occurred.

long y

The y-coordinate where the click occurred.

Optional<List<String>> keys

The keys being held while clicking.

class DoubleClick:

A double click action.

Optional<List<String>> keys

The keys being held while double-clicking.

JsonValue; type
constant
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
constant
constant

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

Optional<List<String>> keys

The keys being held while dragging the mouse.

class Keypress:

A collection of keypresses the model would like to perform.

List<String> keys

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

JsonValue; type
constant
constant

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

class Move:

A mouse move action.

JsonValue; type
constant
constant

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

long x

The x-coordinate to move to.

long y

The y-coordinate to move to.

Optional<List<String>> keys

The keys being held while moving the mouse.

JsonValue;
JsonValue; type
constant
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
constant
constant

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

long x

The x-coordinate where the scroll occurred.

long y

The y-coordinate where the scroll occurred.

Optional<List<String>> keys

The keys being held while scrolling.

class Type:

An action to type in text.

String text

The text to type.

JsonValue; type
constant
constant

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

JsonValue;
JsonValue; type
constant
constant

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

Optional<List<ComputerAction>> actions

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

One of the following:
Click
This type repeats the enclosing schema.
DoubleClick
This type repeats the enclosing schema.
Drag
This type repeats the enclosing schema.
Keypress
This type repeats the enclosing schema.
Move
This type repeats the enclosing schema.
JsonValue;
JsonValue; type
constant
constant

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

Scroll
This type repeats the enclosing schema.
Type
This type repeats the enclosing schema.
JsonValue;
JsonValue; type
constant
constant

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

ComputerCallOutput
This type repeats the enclosing schema.
One of the following:
class ResponseFunctionToolCall:

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

FunctionCallOutput
ToolSearchCall
class ResponseToolSearchOutputItemParam:
AdditionalTools
class ResponseConfigurationUpdateItemParam:

An update to the conversation’s response configuration. Supply reasoning, text, or both. Each setting stays in effect until a later update replaces it.

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 ResponseCompactionItemParam:

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

ImageGenerationCall
class ResponseCodeInterpreterToolCall:

A tool call to run code.

LocalShellCall
LocalShellCallOutput
ShellCall
ShellCallOutput
ApplyPatchCall
ApplyPatchCallOutput
McpListTools
McpApprovalRequest
McpApprovalResponse
McpCall
class ResponseCustomToolCallOutput:

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

class ResponseCustomToolCall:

A call to a custom tool created by the model.

JsonValue;
ItemReference
Program
ProgramOutput