computers

A computer is a sandboxed machine a session works on. Nine methods; objects parse with the core ComputerSchema. API detail: Computers.

create

client.computers.create(body: ComputerCreate): Promise<Computer>

POST /v1/computers. Every field is optional — an empty body gets the defaults.

string

Display name.

integer

Virtual CPUs.

integer

Memory in MiB.

integer

Disk in GiB.

object

Browser policy, e.g. { allowed_domains: ["*.example.com"] }.

string

A snp_ snapshot to restore from.

list

client.computers.list(query?: ListQuery): Promise<Page<Computer>>

GET /v1/computers, cursor-paginated.

get

client.computers.get(id: string): Promise<Computer>

GET /v1/computers/{id}.

exec

client.computers.exec(id: string, command: string, timeoutMs?: number): Promise<ExecResult>

POST /v1/computers/{id}/exec. Runs a shell command and answers when it exits:

{ "stdout": "...", "stderr": "", "exit_code": 0, "duration_ms": 412 }

timeoutMs maps to the timeout_ms body field; the command is killed when it elapses.

pause / resume

client.computers.pause(id: string): Promise<Computer>
client.computers.resume(id: string): Promise<Computer>

POST /v1/computers/{id}/pause and POST /v1/computers/{id}/resume. Paused bills storage only — the first efficiency lever. Resume brings the same disk back.

snapshot

client.computers.snapshot(id: string): Promise<Snapshot>

POST /v1/computers/{id}/snapshot. Captures the filesystem for fast restore; pass the returned snapshot_id to create.

fs

client.computers.fs(id: string, op: FsOp, body: Record<string, string>): Promise<unknown>

One method parameterized over the five /v1/computers/{id}/fs/* routes — FsOp is "read" | "write" | "list" | "mkdir" | "remove". Splitting it would produce five near-identical methods with no added type safety. The reply differs per op ({content}, {entries}, {created}, …), so it comes back unparsed. Every op takes an absolute path. read and write also take encoding ("text" default, "base64" for binary) and write takes content:

await client.computers.fs(id, "write", { path: "/workspace/hello.txt", content: "hi\n" });
const file = await client.computers.fs(id, "read", { path: "/workspace/hello.txt" });
const dir = await client.computers.fs(id, "list", { path: "/workspace" });

Bodies and per-op replies are specified in the filesystem API reference.

delete

client.computers.delete(id: string): Promise<Deleted>

DELETE /v1/computers/{id}. Destroys the machine and its disk. Snapshots survive.

TypeScript

Control plane

Resources

Identity & access

Automation

Account

create

list

get

exec

pause / resume

snapshot

fs

delete

​create

​list

​get

​exec

​pause / resume

​snapshot

​fs

​delete

create

list

get

exec

pause / resume

snapshot

fs

delete