Skip to content
Lightcone Lightcone
NorthstarPlatformPricingLogin
API Reference

Responses

Create Responses
responses.create(ResponseCreateParams**kwargs) -> ResponseCreateResponse
POST/v1/responses
Retrieve Responses
responses.retrieve(strresponse_id, ResponseRetrieveParams**kwargs) -> object
GET/v1/responses/{response_id}
Cancel Responses
responses.cancel(strresponse_id) -> object
POST/v1/responses/{response_id}/cancel
ModelsExpand Collapse
class ActionClick: …

A click action.

button: Literal["left", "right", "wheel", 2 more]
One of the following:
"left"
"right"
"wheel"
"back"
"forward"
type: Literal["click"]
x: int
y: int
class ActionDoubleClick: …

A double click action.

type: Literal["double_click"]
x: int
y: int
class ActionDrag: …

A drag action.

path: List[Path]
x: int
y: int
type: Literal["drag"]
class ActionFind: …

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

pattern: str
type: Literal["find"]
url: str
class ActionKeypress: …

A collection of keypresses the model would like to perform.

keys: List[str]
type: Literal["keypress"]
class ActionMove: …

A mouse move action.

type: Literal["move"]
x: int
y: int
class ActionOpenPage: …

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

type: Literal["open_page"]
url: str
class ActionScreenshot: …

A screenshot action.

type: Literal["screenshot"]
class ActionScroll: …

A scroll action.

scroll_x: int
scroll_y: int
type: Literal["scroll"]
x: int
y: int
class ActionSearchSource: …

A source used in the search.

type: Literal["url"]
url: str
class ActionType: …

An action to type in text.

text: str
type: Literal["type"]
class ActionWait: …

A wait action.

type: Literal["wait"]
class AnnotationContainerFileCitation: …

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

container_id: str
end_index: int
file_id: str
filename: str
start_index: int
type: Literal["container_file_citation"]
class AnnotationFileCitation: …

A citation to a file.

file_id: str
filename: str
index: int
type: Literal["file_citation"]
class AnnotationFilePath: …

A path to a file.

file_id: str
index: int
type: Literal["file_path"]
class AnnotationURLCitation: …

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

end_index: int
start_index: int
title: str
type: Literal["url_citation"]
url: str
class Logprob: …

The log probability of a token.

token: str
bytes: List[int]
logprob: float
top_logprobs: List[TopLogprob]
token: str
bytes: List[int]
logprob: float
class McpApprovalRequest: …

A request for human approval of a tool invocation.

id: str
arguments: str
name: str
server_label: str
type: Literal["mcp_approval_request"]
class OutputImage: …

The image output from the code interpreter.

type: Literal["image"]
url: str
class OutputLogs: …

The logs output from the code interpreter.

logs: str
type: Literal["logs"]
class ResponseInputFileParam: …

A file input to the model.

type: Literal["input_file"]
file_data: Optional[str]
file_id: Optional[str]
file_url: Optional[str]
filename: Optional[str]
class ResponseInputImageParam: …

An image input to the model.

Learn about image inputs.

detail: Literal["low", "high", "auto"]
One of the following:
"low"
"high"
"auto"
type: Literal["input_image"]
file_id: Optional[str]
image_url: Optional[str]
class ResponseInputTextParam: …

A text input to the model.

text: str
type: Literal["input_text"]
class Summary: …

A summary text from the model.

text: str
type: Literal["summary_text"]