Skip to main content
GET
Get computer
Returns a computer’s details, including its current status and everything needed to connect to it. There is no endpoint that lists computers on their own. To list them, read desktops from List workspaces or Get workspace.

Path parameters

string
required
Computer UUID or instance_id. Both resolve to the same computer.

Response

string
Computer identifier (UUID).
string
Computer name.
string
ID of the parent workspace.
string
Name of the parent workspace.
object
What you can do in the computer’s workspace: canView, canWrite, canManageAccess, and canUseAgent, each a boolean.
object
The computer’s placement and connection record, with every field whose name contains password, secret, token, api_key, or authorized_keys removed.
string
Operating system: linux, windows, macos, android, or ios.
integer
RAM in GB.
number
vCPU. Fractional for 0.5 vCPU computers.
string
One of creating, running, restarting, updating, suspending, suspended, resuming, frozen, stopped, error, deleted. See Status values.
string
The computer’s API address on its fleet host, as http://{host}:{port}. This is an internal fleet address, not a dashboard link and not the endpoint you connect to. Use connection_url to connect. The value is rewritten whenever the computer restarts, is started again, or has its RAM resized. It still holds the last host’s address after the computer is stopped, so it is only meaningful while the computer is running.
string
Identifier of the computer’s current VM, the same value POST /computers returns as instance_id. It changes when the computer is started from its archive or wakes from storage, so keep id (the UUID) as your handle and read this fresh from this endpoint. null while the computer has no host (frozen, or asleep in storage). This endpoint returns the field under its legacy name only.
string
ISO 8601 timestamp.
string
Same-origin host for the computer’s connection endpoints: www.orgo.ai. Empty while the computer has no instance id, such as when it is frozen or asleep in storage.
string
Same-origin connection base (https://www.orgo.ai/desktops/{instance_id}). Append /ws/websockify, /ws/terminal, or /ws/audio for the WebSocket endpoints; HTTP Desktop API calls go to https://www.orgo.ai/api/desktops/{instance_id}/proxy/{endpoint}. Empty while the computer has no instance id, such as when it is frozen or asleep in storage.
string
Current VNC / WebSocket token. Rotates on restart, on start, and on a RAM resize. null when you have Can chat access to the workspace, when a restricted key lacks Control write, for an MCP sign-in or a computer’s identity token, while the computer is locked (see lock), while its password is being changed, or when the stored credential cannot be decrypted. A restricted or expiring key also gets null for a computer that holds its own Orgo key.
boolean
true when the computer’s workspace keeps screens private, so the Orgo dashboard keeps the screen covered until someone chooses to show it.
object | null
What the computer runs on, from its current VM’s launch record: host_cpu (family, name, and signature, or null), cpu_model, hypervisor, qemu, boot, fallback, and launched_at. null when the host has not reported a launch record for the computer’s current VM.
string | null
The Device ID Orgo prints on a physical device, or for a macOS computer on the Mac it runs on. Read-only. null for a computer on Orgo’s servers.
object | null
Where a suspended computer is. null for any other status. where is host (resumes on interaction) or storage (moved off its host; Start, Resume, or any action wakes it in about a minute). since is when it went to sleep. Both carry waking ({ since, expected_seconds } while a wake from storage runs, else null) and wake_error (why the last wake failed, else null). A computer in storage also carries reason (hours, idle, or null).
object | null
The computer’s current suspension while it is suspending, suspended, or resuming: state (capturing, uploading, stored, resuming, resumed, failed, or abandoned), where (host or storage), saving (true while its copy is still being saved; Resume and Delete still work meanwhile), and region (the storage region, or null). null for any other status or when nothing is recorded. Get suspension has the full record.
object | null
Set only on a Mac, iPhone, or Android phone that Orgo locked because its account is over its plan’s capacity. It carries reason (over_capacity), locked_at, and cap (how many computers the plan allows). The computer keeps running, but every way in is refused until the account has room. null otherwise.
string | null
When the computer ends, as an ISO 8601 time: Orgo deletes it then, running or stopped, with everything on it. null when it never ends. Set, move, or clear it with Update computer.
string | null
What happens at the end, read only. "delete": the computer is deleted at ends_at, which every end set now does. "stop": an end set before every end deleted the computer, which stops it at ends_at and deletes it 7 days later unless it is started. null when it has no end.
string | null
For an on_end "stop" computer: when Orgo stopped it because its time ran out, or marked it ended if it was already off. A computer that keeps this value keeps its ends_at beside it. null when it has not ended, and always for an on_end "delete" computer. Starting or resuming the computer clears it.
string | null
When Orgo deletes the computer. For on_end "delete" it is ends_at. For an on_end "stop" computer that has ended it is 7 days after ended_at: start it before then and it is kept, with no end or with the end the Start sends. Taking the end off with Update computer keeps either one. null otherwise.
string | null
For a computer that runs by the hour and is running out a prepaid end: when its prepaid run ends. This is ends_at, unless someone who may not prepay moved the end later; the time past prepaid_until is then billed by the hour. null for an hourly computer with no prepay, for a stopped one, and for any computer on a plan.
integer | null
What is held from your credits for the prepaid run, in cents, rounded to the nearest cent. The part the computer does not use comes back when it stops, is deleted, or reaches its end, or when its end is moved or taken off. null whenever prepaid_until is.
string | null
Where the computer runs: us, eu or apac. From the server it runs on, or from the region it was created with when that is not known. null before it is placed. See Choose where a computer runs.
string | null
The city it runs in, as a city code such as chi, lon or syd. null before it is placed, and for a computer in the US whose city Orgo does not record.
object | null
When the computer last ran out of memory and its system stopped a program: last_at (ISO 8601) and kills_24h (how many programs it stopped in the last 24 hours). null until that has happened.
A computer that runs by the hour has billing_mode: "hourly" in instance_details. What happens when a computer’s time runs out, and what an hourly computer prepays, is described in Computers with an end. A Mac computer that runs as a virtual machine also carries mac_features (which backups, snapshots, and restores its Backups tab offers) and mac_job (the restore it is part of now, or null). No other computer has these fields.

Status values

Example

Response

Errors

Rename a computer or change its end

PATCH /computers/{id} renames a computer, sets its mascot, and sets, moves, or clears when it ends. It is described in Update computer.

Authorizations

Authorization
string
header
required

API key authentication. Get your key at orgo.ai/workspaces

Path Parameters

id
string
required

Computer ID

Response

Computer details

A computer. No single response carries every field: POST /computers returns workspace_id, project_id, instance_id, fly_instance_id, and the connect fields, plus hardware and launch when the host reports them, and ends_at (with on_end when you sent ends_in_hours or on_end, and prepaid_until and prepaid_cents for an hourly create with an end); GET /computers/{id} returns project_id, project_name, permissions, fly_instance_id, the connect fields, private_screens, hardware, device_tag, asleep, suspension, lock, and the end and prepay fields (ends_at, on_end, ended_at, deletes_at, prepaid_until, prepaid_cents); a computer embedded in a workspace carries the stored row. Each operation's example shows what that operation returns.

id
string

Unique computer identifier

Example:

"a3bb189e-8bf9-3888-9912-ace4e6543002"

name
string

Computer name

Example:

"agent-1"

workspace_id
string

ID of the workspace the computer belongs to. Returned by POST /computers; GET /computers/{id} returns it as project_id.

Example:

"550e8400-e29b-41d4-a716-446655440000"

project_name
string

Name of the parent workspace

Example:

"production"

os
enum<string>

Operating system. ios is a physical handset rather than a virtual computer.

Available options:
linux,
windows,
macos,
android,
ios
Example:

"linux"

ram
enum<integer>

RAM in GB. 10 or 12 occurs only on macOS.

Available options:
4,
8,
10,
12,
16,
32,
64
Example:

4

cpu
enum<number>

vCPU cores.

Available options:
0.5,
1,
2,
4,
6,
8,
16
Example:

1

status
enum<string>

Current status. suspending while a suspend is being saved, resuming while a resume brings it back from storage.

Available options:
creating,
running,
restarting,
updating,
suspending,
suspended,
resuming,
frozen,
stopped,
error,
deleted
Example:

"running"

url
string

Base URL of the computer's own API on the host that runs it, as http://<host>:<port>. Plain HTTP, and reachable only from inside Orgo's network. It is not a dashboard link and not an endpoint you can call. Use connection_url from your own code.

Example:

"http://198.51.100.24:8081"

created_at
string<date-time>
region
enum<string> | null

Where the computer runs: us, eu or apac. From the server it runs on, or from the region it was created with when that is not known. null before it is placed. POST /computers and GET /computers/{id} return it.

Available options:
us,
eu,
apac,
null
location
enum<string> | null

The city the computer runs in, as a city code. null before it is placed, and for a computer in the US whose city Orgo does not record. POST /computers and GET /computers/{id} return it.

Available options:
nyc,
ash,
mia,
chi,
dal,
lax,
sjc,
lon,
syd,
null
instance_id
string | null

Identifier of the computer's current VM, returned by POST /computers. It changes when the computer is started from archive or woken from storage, so use id to refer to the computer. null while it has no host (frozen, or asleep in storage).

Example:

"a3881618"

hostname
string

Same-origin host for the computer's connection endpoints: www.orgo.ai. Empty while the computer has no instance id, such as when it is frozen or asleep in storage.

Example:

"www.orgo.ai"

connection_url
string

Same-origin connection base (https://www.orgo.ai/desktops/{instance_id}). Append /ws/websockify, /ws/terminal, or /ws/audio for WebSocket endpoints; HTTP Desktop API calls go to https://www.orgo.ai/api/desktops/{instance_id}/proxy/{endpoint}.

Example:

"https://www.orgo.ai/desktops/a3881618"

vnc_password
string | null

VNC / WebSocket Bearer token. Rotates on restart, on start, and on a RAM resize, so do not persist it. null when you have Can chat access to the workspace, when a restricted key lacks Control write, for an MCP sign-in or a computer's identity token, while the computer is locked, while its password is being changed, or when the stored credential cannot be decrypted.

Example:

"a06db12a8683df96"

project_id
string

ID of the parent workspace, under its older name. POST /computers returns it as a deprecated alias of workspace_id; GET /computers/{id} returns only this name.

Example:

"550e8400-e29b-41d4-a716-446655440000"

fly_instance_id
string | null

The instance id under its legacy name. The same value POST /computers returns as instance_id. GET /computers/{id} returns only this name. It changes when the computer is started from archive or woken from storage, so use id. null while it has no host (frozen, or asleep in storage).

Example:

"a3881618"

permissions
object

What your role in the workspace allows.

private_screens
boolean

Returned by GET /computers/{id}. true when the computer's workspace keeps screens private, so the Orgo dashboard keeps the screen covered until someone chooses to show it.

Example:

false

instance_details
object

The computer's placement and connection record: provider, id, name, webUrl, vncHost, vncPort, apiPort, serverAddress, resolution, and fromPool, plus hypervisor and templateTerminals when they apply. GET /computers/{id} and the workspace endpoints remove every field whose name contains password, secret, token, api_key, or authorized_keys, in any letter case and at any depth.

hardware
object | null

What the computer runs on, from its current VM's launch record. GET /computers/{id} always returns it, null when the host has not reported a launch record for the computer's current VM. POST /computers returns it, with launch, only when the host reports how it launched the computer.

device_tag
string | null

Returned by GET /computers/{id}. The Device ID Orgo prints on a physical device (or, for a macOS VM, on the Mac it runs on). null for a VM on Orgo's servers. Read-only.

asleep
object | null

Returned by GET /computers/{id}. Where a suspended computer is. null when it is not suspended.

suspension
object | null

Returned by GET /computers/{id}. The current suspension of a suspended, suspending or resuming computer. null otherwise, or when nothing is recorded.

launch
object

Returned by POST /computers alongside hardware, when the host reports how it launched the computer: the host's launch record for the new computer, without the host's name or the source its state was restored from.

resolution
string

Display resolution in WIDTHxHEIGHTxDEPTH format. Returned by POST /computers.

Example:

"1280x720x24"

gpu_downgraded
boolean

Returned by POST /computers only, present and true when you asked for a legacy gpu string (2q or 4q) and a CPU computer was created instead. A V710 or B50 is never swapped for a CPU computer.

warning
string

Present only alongside gpu_downgraded, explaining the downgrade.

gpu
object

Returned by POST /computers only, for a V710 or B50 computer.

price
object

Returned by POST /computers only, alongside gpu. What the computer costs: monthly_usd, yearly_usd, hourly_usd (running, by the hour), and lines, one per part (the GPU slice, vCPU, memory, disk, and the Windows license on Windows), each with label, monthly_usd and hourly_usd.

billing
object

Returned by POST /computers only, on a monthly V710 or B50 purchase: mode is "monthly", with what the first month charged.

lock
object | null

Returned by Get computer. Set only on a Mac, iPhone, or Android phone that Orgo locked because its account is over its plan's capacity: reason (over_capacity), locked_at, and cap (how many computers the plan allows). null otherwise.

ends_at
string<date-time> | null

When the computer ends: Orgo deletes it then, running or not, with everything on it (or, for on_end "stop", stops it). null when it never ends. POST /computers always returns it; GET /computers/{id} too. A computer an earlier end stopped keeps it beside ended_at.

on_end
enum<string> | null

Returned by GET /computers/{id}, and by POST /computers when you sent ends_in_hours or on_end. What happens at the end, read only: "delete" (deleted at ends_at, as every end set now is), "stop" (an end set before every end deleted the computer: stopped at ends_at, deleted 7 days later unless it is started), or null with no end.

Available options:
delete,
stop,
null
ended_at
string<date-time> | null

Returned by GET /computers/{id}. When Orgo stopped the computer because its time ran out, or marked it ended if it was already off. null when it has not ended. Starting or resuming the computer clears it.

deletes_at
string<date-time> | null

Returned by GET /computers/{id}. When Orgo deletes the computer: ends_at for on_end "delete", or 7 days after ended_at for an on_end "stop" computer that has ended. null otherwise.

prepaid_until
string<date-time> | null

A computer that runs by the hour and is running out a prepaid end: when its prepaid run ends. This is ends_at, unless someone who may not prepay moved the end later. null for an hourly computer with no prepay, a stopped one, and any computer on a plan. GET /computers/{id} always returns it; POST /computers only for an hourly create with ends_in_hours.

prepaid_cents
integer | null

Alongside prepaid_until: what is held from your credits for the prepaid run, in cents, rounded to the nearest cent. null when prepaid_until is.

ends_warning
string

Returned by POST /computers only, when you sent ends_in_hours and the computer was made without an end: This computer can’t have an end, so it keeps running until you stop it. or The computer was made, but its end could not be saved, so it keeps running until you stop it. Do not retry the create.

out_of_memory
object | null

Returned by GET /computers/{id}. When the computer last ran out of memory and its system stopped a program. null until that has happened.