> ## 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.

# Platform

> Retrieve information about the VM's operating system and platform

Retrieves high-level information about the VM's operating system and platform. Use this to determine the environment you're working with.

<Note>
  Replace `VM_API_IP:PORT` with the actual IP and port of the VM's Desktop Environment API server.
</Note>

## Response

<ResponseField name="os_type" type="string">
  Operating system type (e.g., `windows`, `linux`, `darwin`)
</ResponseField>

<ResponseField name="version" type="string">
  Operating system version
</ResponseField>

<ResponseField name="architecture" type="string">
  CPU architecture (e.g., `x86_64`, `arm64`)
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET "http://VM_API_IP:PORT/platform"
  ```
</RequestExample>

<ResponseExample>
  ```json Ubuntu Response theme={null}
  {
    "os_type": "linux",
    "version": "Ubuntu 22.04.3 LTS",
    "architecture": "x86_64"
  }
  ```

  ```json Windows Response theme={null}
  {
    "os_type": "windows",
    "version": "Windows 11 Pro",
    "architecture": "x86_64"
  }
  ```

  ```json macOS Response theme={null}
  {
    "os_type": "darwin",
    "version": "macOS 14.0 Sonoma",
    "architecture": "arm64"
  }
  ```
</ResponseExample>