Skip to main content

API Reference

Base URL

  • Development: http://localhost:4020
  • Production: Configurable via settings

Authentication

Token Generation

Response

Session Management

Create Session

Response

List Sessions

Response

Get Session Details

Delete Session

Resize Terminal

WebSocket Connection

WebSocket v3 (/ws)

  • Endpoint: GET /ws (WebSocket upgrade)
  • Framing: binary v3 frames ("VT" magic, version 3, type, sessionId, payload)
  • Multiplexing: one socket carries multiple session subscriptions
Protocol details: docs/websocket.md.

Health Check

Server Status

Response

Error Responses

Error Format

Rate Limiting

  • Session Creation: 10 per minute
  • API Calls: 100 per minute
  • WebSocket Messages: Unlimited

Terminal Transport (WebSocket v3)

Terminal I/O uses a single /ws WebSocket with binary v3 framing and multiplexed sessions. Details: docs/websocket.md.

Session Recording

Sessions are recorded in asciinema v2 format:
Event format:

See Also