API Reference
Base URL
- Development:
http://localhost:4020
- Production: Configurable via settings
Authentication
Token Generation
Session Management
Create Session
List Sessions
Get Session Details
Delete Session
Resize Terminal
WebSocket Connection
Connect to Session
Message Types
Terminal Output (Server → Client)
Binary format with magic byte:User Input (Client → Server)
Terminal Resize (Client → Server)
Keep-Alive Ping
Health Check
Server Status
Error Responses
Status | Error | Description |
---|---|---|
400 | Bad Request | Invalid parameters |
401 | Unauthorized | Missing/invalid token |
404 | Not Found | Session not found |
409 | Conflict | Session already exists |
500 | Server Error | Internal error |
Rate Limiting
- Session Creation: 10 per minute
- API Calls: 100 per minute
- WebSocket Messages: Unlimited