API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Responses

Create Responses

POST/v1/responses

Retrieve Responses

GET/v1/responses/{response_id}

Cancel Responses

POST/v1/responses/{response_id}/cancel

ModelsExpand Collapse

ActionClick = object { button, type, x, y }

A click action.

button: "left" or "right" or "wheel" or 2 more

One of the following:

"left"

"right"

"wheel"

"back"

"forward"

type: "click"

x: number

y: number

ActionDoubleClick = object { type, x, y }

A double click action.

type: "double_click"

x: number

y: number

ActionDrag = object { path, type }

A drag action.

path: array of object { x, y }

x: number

y: number

type: "drag"

ActionFind = object { pattern, type, url }

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

pattern: string

type: "find"

url: string

ActionKeyDown = object { keys, type }

Press and hold a key.

keys: array of string

type: "key_down"

ActionKeyUp = object { keys, type }

Release a held key.

keys: array of string

type: "key_up"

ActionKeypress = object { keys, type }

A collection of keypresses the model would like to perform.

keys: array of string

type: "keypress"

ActionMouseDown = object { type, x, y }

Press and hold the left mouse button at a position.

type: "mouse_down"

x: number

y: number

ActionMouseUp = object { type, x, y }

Release the left mouse button at a position.

type: "mouse_up"

x: number

y: number

ActionMove = object { type, x, y }

A mouse move action.

type: "move"

x: number

y: number

ActionOpenPage = object { type, url }

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

type: "open_page"

url: string

ActionPointAndType = object { text, type, x, y }

Click at a position then type text.

text: string

type: "point_and_type"

x: number

y: number

ActionScreenshot = object { type }

A screenshot action.

type: "screenshot"

ActionScroll = object { scroll_x, scroll_y, type, 2 more }

A scroll action.

scroll_x: number

scroll_y: number

type: "scroll"

x: number

y: number

ActionSearchSource = object { type, url }

A source used in the search.

type: "url"

url: string

ActionType = object { text, type }

An action to type in text.

text: string

type: "type"

ActionWait = object { type }

A wait action.

type: "wait"

AnnotationContainerFileCitation = object { container_id, end_index, file_id, 3 more }

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

container_id: string

end_index: number

file_id: string

filename: string

start_index: number

type: "container_file_citation"

AnnotationFileCitation = object { file_id, filename, index, type }

A citation to a file.

file_id: string

filename: string

index: number

type: "file_citation"

AnnotationFilePath = object { file_id, index, type }

A path to a file.

file_id: string

index: number

type: "file_path"

AnnotationURLCitation = object { end_index, start_index, title, 2 more }

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

end_index: number

start_index: number

title: string

type: "url_citation"

url: string

Logprob = object { token, bytes, logprob, top_logprobs }

The log probability of a token.

token: string

bytes: array of number

logprob: number

top_logprobs: array of object { token, bytes, logprob }

token: string

bytes: array of number

logprob: number

McpApprovalRequest = object { id, arguments, name, 2 more }

A request for human approval of a tool invocation.

id: string

arguments: string

name: string

server_label: string

type: "mcp_approval_request"

OutputImage = object { type, url }

The image output from the code interpreter.

type: "image"

url: string

OutputLogs = object { logs, type }

The logs output from the code interpreter.

logs: string

type: "logs"

PendingSafetyCheck = object { id, code, message }

A pending safety check for the computer call.

id: string

code: optional string

message: optional string

ResponseComputerToolCall = object { id, action, call_id, 3 more }

A tool call to a computer use tool.

See the computer use guide for more information.

id: string

action: ActionClick { button, type, x, y } or ActionDoubleClick { type, x, y } or ActionDrag { path, type } or 11 more

A click action.

One of the following:

ActionClick = object { button, type, x, y }

A click action.

button: "left" or "right" or "wheel" or 2 more

One of the following:

"left"

"right"

"wheel"

"back"

"forward"

type: "click"

x: number

y: number

ActionDoubleClick = object { type, x, y }

A double click action.

type: "double_click"

x: number

y: number

ActionDrag = object { path, type }

A drag action.

path: array of object { x, y }

x: number

y: number

type: "drag"

ActionKeypress = object { keys, type }

A collection of keypresses the model would like to perform.

keys: array of string

type: "keypress"

ActionMove = object { type, x, y }

A mouse move action.

type: "move"

x: number

y: number

ActionScreenshot = object { type }

A screenshot action.

type: "screenshot"

ActionScroll = object { scroll_x, scroll_y, type, 2 more }

A scroll action.

scroll_x: number

scroll_y: number

type: "scroll"

x: number

y: number

ActionType = object { text, type }

An action to type in text.

text: string

type: "type"

ActionWait = object { type }

A wait action.

type: "wait"

ActionPointAndType = object { text, type, x, y }

Click at a position then type text.

text: string

type: "point_and_type"

x: number

y: number

ActionMouseDown = object { type, x, y }

Press and hold the left mouse button at a position.

type: "mouse_down"

x: number

y: number

ActionMouseUp = object { type, x, y }

Release the left mouse button at a position.

type: "mouse_up"

x: number

y: number

ActionKeyDown = object { keys, type }

Press and hold a key.

keys: array of string

type: "key_down"

ActionKeyUp = object { keys, type }

Release a held key.

keys: array of string

type: "key_up"

call_id: string

pending_safety_checks: array of PendingSafetyCheck { id, code, message }

id: string

code: optional string

message: optional string

status: "in_progress" or "completed" or "incomplete"

One of the following:

"in_progress"

"completed"

"incomplete"

type: "computer_call"

ResponseFunctionToolCall = object { arguments, call_id, name, 3 more }

A tool call to run a function.

See the function calling guide for more information.

arguments: string

call_id: string

name: string

type: "function_call"

id: optional string

status: optional "in_progress" or "completed" or "incomplete"

One of the following:

"in_progress"

"completed"

"incomplete"

ResponseInputFileParam = object { type, file_data, file_id, 2 more }

A file input to the model.

type: "input_file"

file_data: optional string

file_id: optional string

file_url: optional string

filename: optional string

ResponseInputImageParam = object { detail, type, file_id, image_url }

An image input to the model.

Learn about image inputs.

detail: "low" or "high" or "auto"

One of the following:

"low"

"high"

"auto"

type: "input_image"

file_id: optional string

image_url: optional string

ResponseInputTextParam = object { text, type }

A text input to the model.

text: string

type: "input_text"

ResponseOutputMessage = object { id, content, role, 2 more }

An output message from the model.

id: string

content: array of ResponseOutputText { annotations, text, type, logprobs } or ResponseOutputRefusal { refusal, type }

One of the following:

ResponseOutputText = object { annotations, text, type, logprobs }

A text output from the model.

annotations: array of AnnotationFileCitation { file_id, filename, index, type } or AnnotationURLCitation { end_index, start_index, title, 2 more } or AnnotationContainerFileCitation { container_id, end_index, file_id, 3 more } or AnnotationFilePath { file_id, index, type }

One of the following:

AnnotationFileCitation = object { file_id, filename, index, type }

A citation to a file.

file_id: string

filename: string

index: number

type: "file_citation"

AnnotationURLCitation = object { end_index, start_index, title, 2 more }

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

end_index: number

start_index: number

title: string

type: "url_citation"

url: string

AnnotationContainerFileCitation = object { container_id, end_index, file_id, 3 more }

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

container_id: string

end_index: number

file_id: string

filename: string

start_index: number

type: "container_file_citation"

AnnotationFilePath = object { file_id, index, type }

A path to a file.

file_id: string

index: number

type: "file_path"

text: string

type: "output_text"

logprobs: optional array of Logprob { token, bytes, logprob, top_logprobs }

token: string

bytes: array of number

logprob: number

top_logprobs: array of object { token, bytes, logprob }

token: string

bytes: array of number

logprob: number

ResponseOutputRefusal = object { refusal, type }

A refusal from the model.

refusal: string

type: "refusal"

role: "assistant"

status: "in_progress" or "completed" or "incomplete"

One of the following:

"in_progress"

"completed"

"incomplete"

type: "message"

ResponseOutputRefusal = object { refusal, type }

A refusal from the model.

refusal: string

type: "refusal"

ResponseOutputText = object { annotations, text, type, logprobs }

A text output from the model.

annotations: array of AnnotationFileCitation { file_id, filename, index, type } or AnnotationURLCitation { end_index, start_index, title, 2 more } or AnnotationContainerFileCitation { container_id, end_index, file_id, 3 more } or AnnotationFilePath { file_id, index, type }

One of the following:

AnnotationFileCitation = object { file_id, filename, index, type }

A citation to a file.

file_id: string

filename: string

index: number

type: "file_citation"

AnnotationURLCitation = object { end_index, start_index, title, 2 more }

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

end_index: number

start_index: number

title: string

type: "url_citation"

url: string

AnnotationContainerFileCitation = object { container_id, end_index, file_id, 3 more }

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

container_id: string

end_index: number

file_id: string

filename: string

start_index: number

type: "container_file_citation"

AnnotationFilePath = object { file_id, index, type }

A path to a file.

file_id: string

index: number

type: "file_path"

text: string

type: "output_text"

logprobs: optional array of Logprob { token, bytes, logprob, top_logprobs }

token: string

bytes: array of number

logprob: number

top_logprobs: array of object { token, bytes, logprob }

token: string

bytes: array of number

logprob: number

Summary = object { text, type }

A summary text from the model.

text: string

type: "summary_text"