Skip to content
Lightcone Lightcone
Dashboard
API Reference

Computers

List computers
GET/computers
Create a new computer instance
POST/computers
Get computer status
GET/computers/{id}
Terminate computer
DELETE/computers/{id}
Execute multiple actions
POST/computers/{id}/batch
Change proxy settings
POST/computers/{id}/change-proxy
Click at coordinates
POST/computers/{id}/click
Execute debug command
POST/computers/{id}/debug
Double-click at coordinates
POST/computers/{id}/double-click
Click and drag
POST/computers/{id}/drag
Stream events
GET/computers/{id}/events
Execute single action
POST/computers/{id}/execute
Press hotkey combination
POST/computers/{id}/hotkey
Get page HTML
POST/computers/{id}/html
Keep computer alive
POST/computers/{id}/keepalive
Press and hold key
POST/computers/{id}/key-down
Release held key
POST/computers/{id}/key-up
Press and hold mouse button
POST/computers/{id}/mouse-down
Release mouse button
POST/computers/{id}/mouse-up
Navigate to URL
POST/computers/{id}/navigate
Right-click at coordinates
POST/computers/{id}/right-click
Stream screencast frames
GET/computers/{id}/screencast
Capture screenshot
POST/computers/{id}/screenshot
Scroll viewport
POST/computers/{id}/scroll
Get computer status (TTL)
GET/computers/{id}/status
Type text
POST/computers/{id}/type
Set viewport size
POST/computers/{id}/viewport
WebSocket connection
GET/computers/{id}/ws
ModelsExpand Collapse
ActionResult = object { error_message, executed_tab_id, page_context, 4 more }
error_message: optional string
executed_tab_id: optional string
page_context: optional V2GoBackendInternalTypesPageContext { device_scale_factor, is_main_tab, page_height, 8 more }
device_scale_factor: optional number
is_main_tab: optional boolean
page_height: optional number
page_width: optional number
scroll_x: optional number
scroll_y: optional number
tab_id: optional string
title: optional string
url: optional string
viewport_height: optional number
viewport_width: optional number
request_id: optional string
result: optional map[unknown]
status: optional string
timestamp: optional string
ComputerAction = object { auto_detect_encoding, base64, button, 22 more }
auto_detect_encoding: optional boolean

For get_html_content

base64: optional boolean

For screenshot

button: optional string
debug: optional object { command, cwd, env, 4 more }
command: optional string
cwd: optional string
env: optional map[string]
max_output_length: optional number
request_id: optional string
stream: optional boolean
timeout_seconds: optional number
dx: optional number

For scrolling

dy: optional number
height: optional number
include_context: optional boolean

Include page context in response

key: optional string

For key_down/key_up

keys: optional array of string
ms: optional number
proxy_url: optional string
request_id: optional string

RequestId is used for correlating streaming output to the originating request. Set on ActionRequest, not individual action types.

scale_factor: optional number
tab_id: optional string

For tab management (browser sessions only)

text: optional string
type: optional string

click|double_click|right_click|drag|type|keypress|scroll|wait|screenshot|go_to_url|debug|get_html_content|set_viewport|list_tabs|new_tab|switch_tab|close_tab|key_down|key_up|mouse_down|mouse_up

url: optional string
width: optional number

For set_viewport

x: optional number
x1: optional number

For dragging/scrolling

x2: optional number

For dragging

y: optional number
y1: optional number
y2: optional number
ComputerResponse = object { id, auto_kill, created_at, 8 more }
id: optional string
auto_kill: optional boolean
created_at: optional string
endpoints: optional map[string]
expires_at: optional string
idle_expires_at: optional string
inactivity_timeout_seconds: optional number
kind: optional string
last_activity_at: optional string
max_lifetime_seconds: optional number
status: optional string
V2GoBackendInternalTypesPageContext = object { device_scale_factor, is_main_tab, page_height, 8 more }
device_scale_factor: optional number
is_main_tab: optional boolean
page_height: optional number
page_width: optional number
scroll_x: optional number
scroll_y: optional number
tab_id: optional string
title: optional string
url: optional string
viewport_height: optional number
viewport_width: optional number

ComputersExec

Execute command (streaming)
POST/computers/{id}/exec
Execute command (synchronous)
POST/computers/{id}/exec/sync

ComputersTabs

List all tabs
GET/computers/{id}/tabs
Create new tab
POST/computers/{id}/tabs
Close tab
DELETE/computers/{id}/tabs/{tab_id}
Switch to tab
POST/computers/{id}/tabs/{tab_id}/switch