Skip to content
Lightcone Lightcone
Dashboard
API Reference
Computers

Execute single action

computers.execute(strid, ComputerExecuteParams**kwargs) -> ActionResult
POST/computers/{id}/execute

Execute a single action such as screenshot, click, type, navigate, scroll, debug, set_viewport, get_html_content or other computer use actions

ParametersExpand Collapse
id: str
action: Optional[ComputerActionParam]
auto_detect_encoding: Optional[bool]

For get_html_content

base64: Optional[bool]

For screenshot

button: Optional[str]
debug: Optional[Debug]
command: Optional[str]
cwd: Optional[str]
env: Optional[Dict[str, str]]
max_output_length: Optional[int]
request_id: Optional[str]
stream: Optional[bool]
timeout_seconds: Optional[int]
dx: Optional[float]

For scrolling

dy: Optional[float]
height: Optional[int]
include_context: Optional[bool]

Include page context in response

key: Optional[str]

For key_down/key_up

keys: Optional[List[str]]
ms: Optional[int]
proxy_url: Optional[str]
request_id: Optional[str]

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

scale_factor: Optional[float]
tab_id: Optional[str]

For tab management (browser sessions only)

text: Optional[str]
type: Optional[str]

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[str]
width: Optional[int]

For set_viewport

x: Optional[float]
x1: Optional[float]

For dragging/scrolling

x2: Optional[float]

For dragging

y: Optional[float]
y1: Optional[float]
y2: Optional[float]
ReturnsExpand Collapse
class ActionResult: …
error_message: Optional[str]
executed_tab_id: Optional[str]
page_context: Optional[V2GoBackendInternalTypesPageContext]
device_scale_factor: Optional[float]
is_main_tab: Optional[bool]
page_height: Optional[int]
page_width: Optional[int]
scroll_x: Optional[float]
scroll_y: Optional[float]
tab_id: Optional[str]
title: Optional[str]
url: Optional[str]
viewport_height: Optional[int]
viewport_width: Optional[int]
request_id: Optional[str]
result: Optional[Dict[str, object]]
status: Optional[str]
timestamp: Optional[str]

Execute single action

import os
from tzafon import Lightcone

client = Lightcone(
    api_key=os.environ.get("TZAFON_API_KEY"),  # This is the default and can be omitted
)
action_result = client.computers.execute(
    id="id",
)
print(action_result.executed_tab_id)
{
  "error_message": "error_message",
  "executed_tab_id": "executed_tab_id",
  "page_context": {
    "device_scale_factor": 0,
    "is_main_tab": true,
    "page_height": 0,
    "page_width": 0,
    "scroll_x": 0,
    "scroll_y": 0,
    "tab_id": "tab_id",
    "title": "title",
    "url": "url",
    "viewport_height": 0,
    "viewport_width": 0
  },
  "request_id": "request_id",
  "result": {
    "foo": "bar"
  },
  "status": "status",
  "timestamp": "timestamp"
}
Returns Examples
{
  "error_message": "error_message",
  "executed_tab_id": "executed_tab_id",
  "page_context": {
    "device_scale_factor": 0,
    "is_main_tab": true,
    "page_height": 0,
    "page_width": 0,
    "scroll_x": 0,
    "scroll_y": 0,
    "tab_id": "tab_id",
    "title": "title",
    "url": "url",
    "viewport_height": 0,
    "viewport_width": 0
  },
  "request_id": "request_id",
  "result": {
    "foo": "bar"
  },
  "status": "status",
  "timestamp": "timestamp"
}