Skip to content
Dashboard

Responses

Create a new response
responses.create(ResponseCreateParams**kwargs) -> ResponsesResponse
POST/v1/responses
Get a response
responses.retrieve(strid) -> ResponsesResponse
GET/v1/responses/{id}
Delete a response
responses.delete(strid) -> ResponseDeleteResponse
DELETE/v1/responses/{id}
Cancel a response
responses.cancel(strid) -> ResponsesResponse
POST/v1/responses/{id}/cancel
ModelsExpand Collapse
class ContentBlock:
image_url: Optional[str]
text: Optional[str]
type: Optional[Literal["input_text", "output_text", "summary_text", "input_image"]]
One of the following:
"input_text"
"output_text"
"summary_text"
"input_image"
class ResponsesResponse:
id: Optional[str]
computer_id: Optional[str]
created_at: Optional[str]
max_output_tokens: Optional[int]
model: Optional[str]
object: Optional[str]
output: Optional[List[V2GoBackendInternalServiceOutputItem]]
id: Optional[str]
action: Optional[V2GoBackendInternalServiceAction]
button: Optional[str]
end_x: Optional[int]
end_y: Optional[int]
keys: Optional[List[str]]
result: Optional[str]
scroll_x: Optional[int]
scroll_y: Optional[int]
status: Optional[str]
text: Optional[str]
type: Optional[Literal["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: Optional[str]
x: Optional[int]
y: Optional[int]
call_id: Optional[str]
content: Optional[List[ContentBlock]]
image_url: Optional[str]
text: Optional[str]
type: Optional[Literal["input_text", "output_text", "summary_text", "input_image"]]
One of the following:
"input_text"
"output_text"
"summary_text"
"input_image"
role: Optional[str]
status: Optional[str]
summary: Optional[List[ContentBlock]]
image_url: Optional[str]
text: Optional[str]
type: Optional[Literal["input_text", "output_text", "summary_text", "input_image"]]
One of the following:
"input_text"
"output_text"
"summary_text"
"input_image"
type: Optional[Literal["reasoning", "computer_call", "computer_call_output", "message"]]
One of the following:
"reasoning"
"computer_call"
"computer_call_output"
"message"
status: Optional[str]
temperature: Optional[float]
top_p: Optional[float]
usage: Optional[V2GoBackendInternalServiceResponsesUsage]
input_tokens: Optional[int]
output_tokens: Optional[int]
total_tokens: Optional[int]
viewport: Optional[V2GoBackendInternalServiceViewport]
environment: Optional[str]
height: Optional[int]
width: Optional[int]
class V2GoBackendInternalServiceAction:
button: Optional[str]
end_x: Optional[int]
end_y: Optional[int]
keys: Optional[List[str]]
result: Optional[str]
scroll_x: Optional[int]
scroll_y: Optional[int]
status: Optional[str]
text: Optional[str]
type: Optional[Literal["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: Optional[str]
x: Optional[int]
y: Optional[int]
class V2GoBackendInternalServiceOutputItem:
id: Optional[str]
action: Optional[V2GoBackendInternalServiceAction]
button: Optional[str]
end_x: Optional[int]
end_y: Optional[int]
keys: Optional[List[str]]
result: Optional[str]
scroll_x: Optional[int]
scroll_y: Optional[int]
status: Optional[str]
text: Optional[str]
type: Optional[Literal["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: Optional[str]
x: Optional[int]
y: Optional[int]
call_id: Optional[str]
content: Optional[List[ContentBlock]]
image_url: Optional[str]
text: Optional[str]
type: Optional[Literal["input_text", "output_text", "summary_text", "input_image"]]
One of the following:
"input_text"
"output_text"
"summary_text"
"input_image"
role: Optional[str]
status: Optional[str]
summary: Optional[List[ContentBlock]]
image_url: Optional[str]
text: Optional[str]
type: Optional[Literal["input_text", "output_text", "summary_text", "input_image"]]
One of the following:
"input_text"
"output_text"
"summary_text"
"input_image"
type: Optional[Literal["reasoning", "computer_call", "computer_call_output", "message"]]
One of the following:
"reasoning"
"computer_call"
"computer_call_output"
"message"
class V2GoBackendInternalServiceResponsesUsage:
input_tokens: Optional[int]
output_tokens: Optional[int]
total_tokens: Optional[int]
class V2GoBackendInternalServiceViewport:
environment: Optional[str]
height: Optional[int]
width: Optional[int]