API Endpoints
Room Management
| Description | Endpoint | Method | Documentation |
|---|---|---|---|
| start/join room | /rooms | POST | Link |
| get room detail | /rooms/<access_key> | GET | Link |
| stop room | /rooms/<access_key> | DELETE | Link |
| force stop room | /rooms/<room_id> | DELETE | Link |
| get list of running rooms | /rooms | GET | Link |
| lock room | /rooms/<access_key>/lock | POST | Link |
| send message | /rooms/<access_key>/messages | POST | Link |
| start playback | /rooms/<access_key>/playbacks | POST | Link |
| stop playback | /rooms/<access_key>/playbacks/<play_id> | DELETE | Link |
User Management
| Description | Endpoint | Method | Documentation |
|---|---|---|---|
| fetch user details | /rooms/<access_key>/users/<user_id> | GET | Link |
| register guest user | /guests/<guest_token> | POST | Link |
| kick user | /rooms/<access_key>/users/<user_id> | DELETE | Link |
| create permalink | /permalink | POST | Link |
| get list of permalinks | /permalink | GET | Link |
| get permalink by id | /permalink/<permalink_id> | GET | Link |
| update permalink | /permalink/<permalink_id> | PUT | Link |
| delete permalink | /permalink/<permalink_id> | DELETE | Link |
| register host user | /permalink/<permalink_id>/users | POST | Link |
| remove host user | /permalink/<permalink_id>/users/<user-token> | DELETE | Link |
| get meeting info | /permalink/<user_token | guest_token> | GET | Link |
| start meeting | /permalink/<user_token> | POST | Link |
| register guest user to permalink | /guests/<guest_token> | POST | Link |
Stream Forwarding Management - AI adapter
| Description | Endpoint | Method | Documentation |
|---|---|---|---|
| forward source | /forward/source | POST | Link |
| forward mcu | /forward/mcu | POST | Link |
| forward playback | /forward/playback | POST | Link |
| end forward | /forward/<forward_id> | DELETE | Link |
Layout and Layer Management
| Description | Endpoint | Method | Documentation |
|---|---|---|---|
| add content to layer | /rooms/<access_key>/layers | POST | Link |
| delete layer content | /rooms/<access_key>/layers/<layer_index> | DELETE | Link |
| set layout | /rooms/<access_key>/layout | POST | Link |
Recording and Snapshot Management
| Description | Endpoint | Method | Documentation |
|---|---|---|---|
| start recording | /rooms/<access_key>/recording | POST | Link |
| stop recording | /rooms/<access_key>/recording | DELETE | Link |
| get recording | /recordings/<recording_id> | GET | Link |
| get list of recordings | /rooms/<room_id>/recordings | GET | Link |
| delete recording | /recordings/<recording_id> | DELETE | Link |
| create snapshot | /rooms/<access_key>/snapshot | POST | Link |
| get snapshot | /rooms/<access_key>/snapshots/<snapshot_id> | GET | Link |
| get snapshot | /snapshots/<snapshot_id> | GET | Link |
| get list of snapshots | /rooms/<room_id>/snapshots | GET | Link |
| delete snapshot | /snapshots/<snapshot_id> | DELETE | Link |
Broadcast Management
| Description | Endpoint | Method | Documentation |
|---|---|---|---|
| start broadcast | /rooms/<access_key>/broadcasts | POST | Link |
| update player_url | /rooms/<access_key>/broadcasts/generic | PUT | Link |
| stop broadcast | /rooms/<access_key>/broadcasts | DELETE | Link |
Webhook Management
| Description | Endpoint | Method | Documentation |
|---|---|---|---|
| register webhook | /webhooks | POST | Link |
| get webhooks | /webhooks | GET | Link |
| remove webhook | /webhooks/<webhook_id> | DELETE | Link |
tip
Make sure to get acquainted with all parameters at endpoints.