API Reference

Detailed API documentation for REST endpoints, WebSocket events, and SDK methods.

1 min read

Work in Progress

The API reference is being expanded. Below is a summary of known endpoints and events.

REST Endpoints (Backend)

| Method | Path | Description | |--------|------|-------------| | POST | /api/recordings/convert-mp4 | Convert WebM recording to MP4 (H.264 + AAC) via ffmpeg | | GET | /api/recordings/list | List recordings for a room | | GET | /api/recordings/play | Stream or serve a recording for playback | | GET | /api/recordings/download | Download a recording file |

Socket.IO Events

Real-time collaboration uses these events (among others):

element updates — Sync canvas changes (create, update, delete elements)
cursor sync — Broadcast user cursor position and selection
room join/leave — User presence and room membership

AI Service Proxy Endpoints

The backend proxies requests to the Python FastAPI AI service (port 8652):

Streaming endpoints for AI Smart Drawing (skeleton generation)
Streaming endpoints for AI Teaching (step-by-step content)
Streaming endpoints for Board Agent (ExAgent) actions

Note: Full request/response schemas, authentication, and error handling will be documented in a future update. For now, inspect the source code or OpenAPI/Swagger output from the AI service for detailed specs.