> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gym.scale.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference Overview

> API documentation for Scale Gymnasium environments

This section provides comprehensive API documentation for all Scale Gymnasium environments using Mintlify's interactive API components.

<Info>
  Contact Scale to receive Docker images for your environments. Images are distributed as tar files that can be loaded into your local Docker registry.
</Info>

## Environment APIs

<CardGroup cols={3}>
  <Card title="MCP Environment" icon="wrench" href="/api-reference/mcp/overview">
    Tool-based agent interaction APIs
  </Card>

  <Card title="Website Environments" icon="globe" href="/api-reference/websites/overview">
    Synthetic website APIs for GUI agents
  </Card>

  <Card title="Desktop Environments" icon="desktop" href="/api-reference/desktop/overview">
    VM control APIs for CUA agents
  </Card>
</CardGroup>

## MCP Environment Endpoints

| Endpoint                                       | Method | Description              |
| ---------------------------------------------- | ------ | ------------------------ |
| [`/list-tools`](/api-reference/mcp/list-tools) | POST   | Discover available tools |
| [`/call-tools`](/api-reference/mcp/call-tools) | POST   | Execute a tool           |
| [`/show-data`](/api-reference/mcp/show-data)   | POST   | Inspect server state     |
| [`/health`](/api-reference/mcp/health)         | GET    | Health check             |

## Website Environment Endpoints

| Endpoint                                        | Method | Description                         |
| ----------------------------------------------- | ------ | ----------------------------------- |
| [`/reset`](/api-reference/websites/reset)       | POST   | Initialize session with data pack   |
| [`/verifier`](/api-reference/websites/verifier) | POST   | Run verification checks             |
| [`/task`](/api-reference/websites/task)         | POST   | Convert to variable dates (Calendr) |
| [`/prompt`](/api-reference/websites/prompt)     | POST   | Convert to absolute dates (Calendr) |

## Desktop Environment Endpoints

| Endpoint                                                 | Method | Description                  |
| -------------------------------------------------------- | ------ | ---------------------------- |
| [`/screenshot`](/api-reference/desktop/screenshot)       | GET    | Capture current visual state |
| [`/execute`](/api-reference/desktop/execute)             | POST   | Execute shell command        |
| [`/platform`](/api-reference/desktop/platform)           | GET    | Get platform information     |
| [`/accessibility`](/api-reference/desktop/accessibility) | GET    | Get UI accessibility tree    |
| [`/file`](/api-reference/desktop/file)                   | POST   | Download 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

<CardGroup cols={2}>
  <Card title="MCP API" icon="wrench" href="/api-reference/mcp/overview">
    Full MCP endpoint documentation
  </Card>

  <Card title="Website API" icon="globe" href="/api-reference/websites/overview">
    Full Website endpoint documentation
  </Card>
</CardGroup>