Skip to main content
The Desktop Environment API is organized into two layers:
  • Control Plane: VM lifecycle management (create, initialize, evaluate, close)
  • Data Plane: Direct VM interaction (screenshot, execute, accessibility)
Contact Scale to receive access to Desktop Environments. VMs are provisioned and managed through the Scale Gymnasium platform.

Control Plane (VM Lifecycle)

Endpoints for managing VM lifecycle and task execution.

Health

Check API server status

Create Desktop

Provision a new VM environment

Initialize Task

Set up a task in the VM

Run Evaluator

Evaluate task completion

Reset

Reset environment to initial state

Close

Terminate VM and clean up

List Environments

View all active VMs

Get VNC URL

Get VNC connection URL

Task Status

Check background task status

Run Agent Loop

Execute agent on a task

Data Plane (VM Interaction)

Endpoints for direct interaction with the running VM.

Screenshot

Capture current visual state

Execute

Run shell commands

Platform

Get OS information

Accessibility

Get UI accessibility tree

File

Download files from VM

Network Access

ComponentPortAccess Method
Control Plane API3000VM lifecycle management
Data Plane API (OSWorld)5000AI agent interaction
noVNC Web8006Browser-based access
VNC Server5900Direct VNC client

Next Steps

Desktop Guide

Explore desktop environments

Docker Quick Start

Self-host desktop environments