Skip to content
NorthstarPlatformPricingLogin

API Reference

Libraries

npm install @tzafon/lightcone
pip install tzafon

API Overview

Agent

AgentTasks

Start task (async)
POST/agent/tasks
Start task (streaming)
POST/agent/tasks/stream
Get task status
GET/agent/tasks/{id}
Inject message into task
POST/agent/tasks/{id}/messages
Pause task
POST/agent/tasks/{id}/pause
Resume task
POST/agent/tasks/{id}/resume

Computers

List computers
GET/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
Double-click at coordinates
POST/computers/{id}/double-click
Click and drag
POST/computers/{id}/drag
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 video and cursor events
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

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

Chat

Create Chat Completion
POST/chat/completions

Models

Responses

Create Responses
POST/v1/responses
Retrieve Responses
GET/v1/responses/{response_id}
Cancel Responses
POST/v1/responses/{response_id}/cancel