Skip to content
Lightcone Lightcone
NorthstarPlatformPricingLogin
API Reference

Responses

Create Responses
client.responses.create(ResponseCreateParams { input, background, cache_salt, 31 more } body, RequestOptionsoptions?): ResponseCreateResponse { id, created_at, model, 6 more }
POST/v1/responses
Retrieve Responses
client.responses.retrieve(stringresponseID, ResponseRetrieveParams { starting_after, stream } query?, RequestOptionsoptions?): ResponseRetrieveResponse
GET/v1/responses/{response_id}
Cancel Responses
client.responses.cancel(stringresponseID, RequestOptionsoptions?): ResponseCancelResponse
POST/v1/responses/{response_id}/cancel
ModelsExpand Collapse
ActionClick { button, type, x, y }

A click action.

button: "left" | "right" | "wheel" | 2 more
One of the following:
"left"
"right"
"wheel"
"back"
"forward"
type: "click"
x: number
y: number
ActionDoubleClick { type, x, y }

A double click action.

type: "double_click"
x: number
y: number
ActionDrag { path, type }

A drag action.

path: Array<Path>
x: number
y: number
type: "drag"
ActionFind { pattern, type, url }

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

pattern: string
type: "find"
url: string
ActionKeypress { keys, type }

A collection of keypresses the model would like to perform.

keys: Array<string>
type: "keypress"
ActionMove { type, x, y }

A mouse move action.

type: "move"
x: number
y: number
ActionOpenPage { type, url }

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

type: "open_page"
url: string
ActionScreenshot { type }

A screenshot action.

type: "screenshot"
ActionScroll { scroll_x, scroll_y, type, 2 more }

A scroll action.

scroll_x: number
scroll_y: number
type: "scroll"
x: number
y: number
ActionSearchSource { type, url }

A source used in the search.

type: "url"
url: string
ActionType { text, type }

An action to type in text.

text: string
type: "type"
ActionWait { type }

A wait action.

type: "wait"
AnnotationContainerFileCitation { 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 { file_id, filename, index, type }

A citation to a file.

file_id: string
filename: string
index: number
type: "file_citation"
AnnotationFilePath { file_id, index, type }

A path to a file.

file_id: string
index: number
type: "file_path"
AnnotationURLCitation { 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 { token, bytes, logprob, top_logprobs }

The log probability of a token.

token: string
bytes: Array<number>
logprob: number
top_logprobs: Array<TopLogprob>
token: string
bytes: Array<number>
logprob: number
McpApprovalRequest { 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 { type, url }

The image output from the code interpreter.

type: "image"
url: string
OutputLogs { logs, type }

The logs output from the code interpreter.

logs: string
type: "logs"
ResponseInputFileParam { type, file_data, file_id, 2 more }

A file input to the model.

type: "input_file"
file_data?: string
file_id?: string | null
file_url?: string
filename?: string
ResponseInputImageParam { detail, type, file_id, image_url }

An image input to the model.

Learn about image inputs.

detail: "low" | "high" | "auto"
One of the following:
"low"
"high"
"auto"
type: "input_image"
file_id?: string | null
image_url?: string | null
ResponseInputTextParam { text, type }

A text input to the model.

text: string
type: "input_text"
Summary { text, type }

A summary text from the model.

text: string
type: "summary_text"