Skip to main content

VNC

POST 
/workstations/:workstation_id/vnc

Connect to a Workstation's desktop using VNC (Virtual Network Computing). This endpoint returns a VNC URL that can be used to establish a remote desktop connection using a native VNC client.

Native VNC Client (TigerVNC)​

TigerVNC is a high-performance, platform-neutral implementation of VNC that works on Windows, macOS, and Linux.

Installation​

Windows:

  1. Download TigerVNC from the official website: https://sourceforge.net/projects/tigervnc/files/stable/
  2. Run the installer (.exe file)
  3. The vncviewer application will be available in the Start menu

macOS:

brew install tiger-vnc

Ubuntu/Debian:

sudo apt-get update
sudo apt-get install tigervnc-viewer

Fedora/RHEL:

sudo dnf install tigervnc

Connecting with TigerVNC​

  1. Get the VNC connection URL:
curl -X POST https://api.agentstation.ai/v1/workstations/HvcqZjmeoPtP/vnc \
  -H "Authorization: Bearer <your_token>"
  1. Connect using the command line:
# Using command line
vncviewer a2mdkyweatct.vnc.v1.connect.agentstation.ai:5900

Or using the GUI:

  1. Open TigerVNC Viewer
  2. Enter the VNC URL in the "VNC Server" field
  3. Click "Connect"
  4. The remote desktop should appear in a new window

Notes​

  • The VNC connection will be automatically closed after the Workstation is released
  • The URL contains a secure random token that authenticates the connection
  • Default VNC settings:
    • Resolution: 1280x720
    • Color depth: 24-bit
    • Framerate: 30 fps
    • Encoding: Tight with JPEG compression

Request​

Responses​

Remote connection successful