API Reference

Computers

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get computer status

computers.retrieve(strid) -> ComputerResponse

GET/computers/{id}

Get the current status and metadata of a computer instance

ParametersExpand Collapse

id: str

ReturnsExpand Collapse

class ComputerResponse: …

id: Optional[str]

auto_kill: Optional[bool]

created_at: Optional[str]

endpoints: Optional[Dict[str, str]]

expires_at: Optional[str]

idle_expires_at: Optional[str]

inactivity_timeout_seconds: Optional[int]

kind: Optional[str]

last_activity_at: Optional[str]

max_lifetime_seconds: Optional[int]

status: Optional[str]

Get computer status

Python

HTTP

TypeScript

Python

import os
from tzafon import Lightcone

client = Lightcone(
    api_key=os.environ.get("TZAFON_API_KEY"),  # This is the default and can be omitted
)
computer_response = client.computers.retrieve(
    "id",
)
print(computer_response.id)

200 example

{
  "id": "id",
  "auto_kill": true,
  "created_at": "created_at",
  "endpoints": {
    "foo": "string"
  },
  "expires_at": "expires_at",
  "idle_expires_at": "idle_expires_at",
  "inactivity_timeout_seconds": 0,
  "kind": "kind",
  "last_activity_at": "last_activity_at",
  "max_lifetime_seconds": 0,
  "status": "status"
}

Returns Examples

200 example

{
  "id": "id",
  "auto_kill": true,
  "created_at": "created_at",
  "endpoints": {
    "foo": "string"
  },
  "expires_at": "expires_at",
  "idle_expires_at": "idle_expires_at",
  "inactivity_timeout_seconds": 0,
  "kind": "kind",
  "last_activity_at": "last_activity_at",
  "max_lifetime_seconds": 0,
  "status": "status"
}