Skip to main content
GET
Returns one screen: its display, size, ports, and whether it is the screen the computer booted with.

​
Path parameters

​
string
required
Computer ID (UUID). The computer must be up. One that is still being created, or that has been frozen, returns 400.
​
string
required
Screen ID, or default for the boot screen.

​
Response

Returns the screen. A screen ID that does not exist returns 404. It is never resolved to the boot screen, because acting on the wrong screen puts a click on another agent’s screen.

​
Errors

Failures raised before the request reaches the computer carry error alone. Failures relayed back from the computer add request_id and upstream_status. Both a missing computer and a missing screen answer 404, and the body tells them apart.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Computer ID

​
screenId
string
required

Screen ID, or default for the boot screen.

Response

The screen. An ID that does not exist answers 404; it is never resolved to the boot screen, because acting on the wrong screen puts a click on another agent's screen.

​
id
string

Screen identifier. The boot screen is always default.

Example:

"screen-1"

​
display
string

X display this screen runs on.

Example:

":100"

​
width
integer

Width in pixels.

Example:

1920

​
height
integer

Height in pixels.

Example:

1080

​
vnc_port
integer

VNC port for this screen.

Example:

6000

​
ws_port
integer

WebSocket port for this screen.

Example:

6081

​
default
boolean

True for the screen the computer boots with. It cannot be destroyed.

Example:

false