Skip to main content
POST
Starts a second desktop on a computer that is already running. Use one when two agents need to work at the same time: X11 has a single pointer per display, so two agents sharing a screen are two hands on one mouse.
A computer supports at most four screens. Each one is an X server plus a window manager plus whatever runs on it, so a computer runs out of memory long before it runs out of screens.

​
Path parameters

​
string
required
Computer ID (UUID).

​
Body parameters

​
integer
Width in pixels. Defaults to the boot screen’s width.
​
integer
Height in pixels. Defaults to the boot screen’s height.
Send an empty body to match the screen the computer booted with, which is almost always what a second screen is wanted at.

​
Response

Returns the new screen. Use its id as the screen parameter on any action to work on it.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Computer ID

Body

application/json
​
width
integer

Width in pixels. Defaults to the size of the boot screen.

Example:

1920

​
height
integer

Height in pixels. Defaults to the size of the boot screen.

Example:

1080

Response

Screen created

​
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