Responses
Create Responses
Retrieve Responses
ModelsExpand Collapse
class ActionClick: …A click action.
A click action.
button: Literal["left", "right", "wheel", 2 more]
class ActionDoubleClick: …A double click action.
A double click action.
class ActionDrag: …A drag action.
A drag action.
path: List[Path]
class ActionFind: …Action type "find": Searches for a pattern within a loaded page.
Action type "find": Searches for a pattern within a loaded page.
class ActionKeyDown: …Press and hold a key.
Press and hold a key.
class ActionKeyUp: …Release a held key.
Release a held key.
class ActionKeypress: …A collection of keypresses the model would like to perform.
A collection of keypresses the model would like to perform.
class ActionMouseDown: …Press and hold the left mouse button at a position.
Press and hold the left mouse button at a position.
class ActionMouseUp: …Release the left mouse button at a position.
Release the left mouse button at a position.
class ActionMove: …A mouse move action.
A mouse move action.
class ActionOpenPage: …Action type "open_page" - Opens a specific URL from search results.
Action type "open_page" - Opens a specific URL from search results.
class ActionPointAndType: …Click at a position then type text.
Click at a position then type text.
class ActionScreenshot: …A screenshot action.
A screenshot action.
class ActionScroll: …A scroll action.
A scroll action.
class ActionSearchSource: …A source used in the search.
A source used in the search.
class ActionType: …An action to type in text.
An action to type in text.
class ActionWait: …A wait action.
A wait action.
class AnnotationContainerFileCitation: …A citation for a container file used to generate a model response.
A citation for a container file used to generate a model response.
class AnnotationFileCitation: …A citation to a file.
A citation to a file.
class AnnotationFilePath: …A path to a file.
A path to a file.
class AnnotationURLCitation: …A citation for a web resource used to generate a model response.
A citation for a web resource used to generate a model response.
class Logprob: …The log probability of a token.
The log probability of a token.
top_logprobs: List[TopLogprob]
class McpApprovalRequest: …A request for human approval of a tool invocation.
A request for human approval of a tool invocation.
class OutputImage: …The image output from the code interpreter.
The image output from the code interpreter.
class OutputLogs: …The logs output from the code interpreter.
The logs output from the code interpreter.
class PendingSafetyCheck: …A pending safety check for the computer call.
A pending safety check for the computer call.
class ResponseComputerToolCall: …A tool call to a computer use tool.
See the
computer use guide for more information.
A tool call to a computer use tool.
See the computer use guide for more information.
action: ActionA click action.
A click action.
class ActionClick: …A click action.
A click action.
button: Literal["left", "right", "wheel", 2 more]
class ActionDoubleClick: …A double click action.
A double click action.
class ActionDrag: …A drag action.
A drag action.
path: List[Path]
class ActionKeypress: …A collection of keypresses the model would like to perform.
A collection of keypresses the model would like to perform.
class ActionMove: …A mouse move action.
A mouse move action.
class ActionScreenshot: …A screenshot action.
A screenshot action.
class ActionScroll: …A scroll action.
A scroll action.
class ActionType: …An action to type in text.
An action to type in text.
class ActionWait: …A wait action.
A wait action.
class ActionPointAndType: …Click at a position then type text.
Click at a position then type text.
class ActionMouseDown: …Press and hold the left mouse button at a position.
Press and hold the left mouse button at a position.
class ActionMouseUp: …Release the left mouse button at a position.
Release the left mouse button at a position.
class ActionKeyDown: …Press and hold a key.
Press and hold a key.
class ActionKeyUp: …Release a held key.
Release a held key.
status: Literal["in_progress", "completed", "incomplete"]
class ResponseFunctionToolCall: …A tool call to run a function.
See the
function calling guide for more information.
A tool call to run a function.
See the function calling guide for more information.
status: Optional[Literal["in_progress", "completed", "incomplete"]]
class ResponseInputFileParam: …A file input to the model.
A file input to the model.
class ResponseInputImageParam: …An image input to the model.
Learn about image inputs.
An image input to the model.
Learn about image inputs.
detail: Literal["low", "high", "auto"]
class ResponseInputTextParam: …A text input to the model.
A text input to the model.
class ResponseOutputMessage: …An output message from the model.
An output message from the model.
content: List[Content]
class ResponseOutputText: …A text output from the model.
A text output from the model.
annotations: List[Annotation]
class AnnotationFileCitation: …A citation to a file.
A citation to a file.
class AnnotationURLCitation: …A citation for a web resource used to generate a model response.
A citation for a web resource used to generate a model response.
class AnnotationContainerFileCitation: …A citation for a container file used to generate a model response.
A citation for a container file used to generate a model response.
class AnnotationFilePath: …A path to a file.
A path to a file.
top_logprobs: List[TopLogprob]
class ResponseOutputRefusal: …A refusal from the model.
A refusal from the model.
status: Literal["in_progress", "completed", "incomplete"]
class ResponseOutputRefusal: …A refusal from the model.
A refusal from the model.
class ResponseOutputText: …A text output from the model.
A text output from the model.
annotations: List[Annotation]
class AnnotationFileCitation: …A citation to a file.
A citation to a file.
class AnnotationURLCitation: …A citation for a web resource used to generate a model response.
A citation for a web resource used to generate a model response.
class AnnotationContainerFileCitation: …A citation for a container file used to generate a model response.
A citation for a container file used to generate a model response.
class AnnotationFilePath: …A path to a file.
A path to a file.
top_logprobs: List[TopLogprob]
class Summary: …A summary text from the model.
A summary text from the model.