Skip to main content
This section provides comprehensive API documentation for all Scale Gymnasium environments using Mintlify’s interactive API components.
Contact Scale to receive Docker images for your environments. Images are distributed as tar files that can be loaded into your local Docker registry.

​
Environment APIs

MCP Environment

Tool-based agent interaction APIs

Website Environments

Synthetic website APIs for GUI agents

Desktop Environments

VM control APIs for CUA agents

​
MCP Environment Endpoints

EndpointMethodDescription
/list-toolsPOSTDiscover available tools
/call-toolsPOSTExecute a tool
/show-dataPOSTInspect server state
/healthGETHealth check

​
Website Environment Endpoints

EndpointMethodDescription
/resetPOSTInitialize session with data pack
/verifierPOSTRun verification checks
/taskPOSTConvert to variable dates (Calendr)
/promptPOSTConvert to absolute dates (Calendr)

​
Desktop Environment Endpoints

EndpointMethodDescription
/screenshotGETCapture current visual state
/executePOSTExecute shell command
/platformGETGet platform information
/accessibilityGETGet UI accessibility tree
/filePOSTDownload file from VM

​
Interactive API Documentation

Each endpoint page includes:
  • Parameter documentation with types and descriptions
  • Request examples in cURL format
  • Response examples showing success and error cases

​
Next Steps

MCP API

Full MCP endpoint documentation

Website API

Full Website endpoint documentation