API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Responses

Create a new response

client.responses.create(ResponseCreateParams { input, instructions, max_output_tokens, 6 more } body, RequestOptionsoptions?): ResponsesResponse { id, computer_id, created_at, 9 more }

POST/v1/responses

Get a response

client.responses.retrieve(stringid, RequestOptionsoptions?): ResponsesResponse { id, computer_id, created_at, 9 more }

GET/v1/responses/{id}

Delete a response

client.responses.delete(stringid, RequestOptionsoptions?): ResponseDeleteResponse { id, deleted, object }

DELETE/v1/responses/{id}

Cancel a response

client.responses.cancel(stringid, RequestOptionsoptions?): ResponsesResponse { id, computer_id, created_at, 9 more }

POST/v1/responses/{id}/cancel

ModelsExpand Collapse

ContentBlock { image_url, text, type }

image_url?: string

text?: string

type?: "input_text" | "output_text" | "summary_text" | "input_image"

One of the following:

"input_text"

"output_text"

"summary_text"

"input_image"

ResponsesResponse { id, computer_id, created_at, 9 more }

id?: string

computer_id?: string

created_at?: string

max_output_tokens?: number

model?: string

object?: string

output?: Array<V2GoBackendInternalServiceOutputItem { id, action, call_id, 5 more } >

id?: string

action?: V2GoBackendInternalServiceAction { button, end_x, end_y, 10 more }

button?: string

end_x?: number

end_y?: number

keys?: Array<string>

result?: string

scroll_x?: number

scroll_y?: number

status?: string

text?: string

type?: "click" | "double_click" | "triple_click" | 14 more

One of the following:

"click"

"double_click"

"triple_click"

"right_click"

"type"

"key"

"keypress"

"key_down"

"key_up"

"scroll"

"hscroll"

"navigate"

"drag"

"wait"

"terminate"

"answer"

"done"

url?: string

x?: number

y?: number

call_id?: string

content?: Array<ContentBlock { image_url, text, type } >

image_url?: string

text?: string

type?: "input_text" | "output_text" | "summary_text" | "input_image"

One of the following:

"input_text"

"output_text"

"summary_text"

"input_image"

role?: string

status?: string

summary?: Array<ContentBlock { image_url, text, type } >

image_url?: string

text?: string

type?: "input_text" | "output_text" | "summary_text" | "input_image"

One of the following:

"input_text"

"output_text"

"summary_text"

"input_image"

type?: "reasoning" | "computer_call" | "computer_call_output" | "message"

One of the following:

"reasoning"

"computer_call"

"computer_call_output"

"message"

status?: string

temperature?: number

top_p?: number

usage?: V2GoBackendInternalServiceResponsesUsage { input_tokens, output_tokens, total_tokens }

input_tokens?: number

output_tokens?: number

total_tokens?: number

viewport?: V2GoBackendInternalServiceViewport { environment, height, width }

environment?: string

height?: number

width?: number

V2GoBackendInternalServiceAction { button, end_x, end_y, 10 more }

button?: string

end_x?: number

end_y?: number

keys?: Array<string>

result?: string

scroll_x?: number

scroll_y?: number

status?: string

text?: string

type?: "click" | "double_click" | "triple_click" | 14 more

One of the following:

"click"

"double_click"

"triple_click"

"right_click"

"type"

"key"

"keypress"

"key_down"

"key_up"

"scroll"

"hscroll"

"navigate"

"drag"

"wait"

"terminate"

"answer"

"done"

url?: string

x?: number

y?: number

V2GoBackendInternalServiceOutputItem { id, action, call_id, 5 more }

id?: string

action?: V2GoBackendInternalServiceAction { button, end_x, end_y, 10 more }

button?: string

end_x?: number

end_y?: number

keys?: Array<string>

result?: string

scroll_x?: number

scroll_y?: number

status?: string

text?: string

type?: "click" | "double_click" | "triple_click" | 14 more

One of the following:

"click"

"double_click"

"triple_click"

"right_click"

"type"

"key"

"keypress"

"key_down"

"key_up"

"scroll"

"hscroll"

"navigate"

"drag"

"wait"

"terminate"

"answer"

"done"

url?: string

x?: number

y?: number

call_id?: string

content?: Array<ContentBlock { image_url, text, type } >

image_url?: string

text?: string

type?: "input_text" | "output_text" | "summary_text" | "input_image"

One of the following:

"input_text"

"output_text"

"summary_text"

"input_image"

role?: string

status?: string

summary?: Array<ContentBlock { image_url, text, type } >

image_url?: string

text?: string

type?: "input_text" | "output_text" | "summary_text" | "input_image"

One of the following:

"input_text"

"output_text"

"summary_text"

"input_image"

type?: "reasoning" | "computer_call" | "computer_call_output" | "message"

One of the following:

"reasoning"

"computer_call"

"computer_call_output"

"message"

V2GoBackendInternalServiceResponsesUsage { input_tokens, output_tokens, total_tokens }

input_tokens?: number

output_tokens?: number

total_tokens?: number

V2GoBackendInternalServiceViewport { environment, height, width }

environment?: string

height?: number

width?: number