API Reference

Computers

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Execute debug command (deprecated — use /exec)

POST/computers/{id}/debug

Deprecated — prefer /exec (streaming NDJSON) or /exec/sync (buffered JSON). Executes a shell command inside the session and returns a buffered result with stdout, stderr, and exit_code. This endpoint always runs synchronously; for real-time output use /exec, which streams command output line by line.

tab_id is accepted for compatibility but is only meaningful on browser-session actions; debug commands run in desktop sessions. timeout_seconds defaults to 120; max_output_length defaults to 65536 bytes and truncates stdout / stderr.

Path ParametersExpand Collapse

id: string

Body ParametersJSONExpand Collapse

command: optional string

max_output_length: optional number

tab_id: optional string

timeout_seconds: optional number

ReturnsExpand Collapse

ActionResult = object { error_message, executed_tab_id, page_context, 4 more }

error_message: optional string

executed_tab_id: optional string

page_context: optional 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

request_id: optional string

result: optional map[unknown]

status: optional string

timestamp: optional string

Execute debug command (deprecated — use /exec)

HTTP

HTTP

TypeScript

Python

curl https://api.tzafon.ai/computers/$ID/debug \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $TZAFON_API_KEY" \
    -d '{}'

200 example

{
  "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

200 example

{
  "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"
}