Authentication
All API requests require an API key to be passed in the request header:
x-api-key: YOUR_API_KEY
Rooms
POST
/v1/rooms
Create a new video meeting room.
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| company_id required | string | Your company identifier |
| name required | string | Name of the room |
| description optional | string | Room description |
| room_code optional | string | Unique room code (auto-generated if not provided) |
| is_private optional | boolean | Whether the room is private (default: false) |
| default_virtual_bg optional | string | Default virtual background URL |
| show_prejoin_ui optional | boolean | Show pre-join UI screen (default: false) |
| auto_recording optional | boolean | Enable automatic recording (default: false) |
| transcription_enabled optional | boolean | Enable transcription (default: false) |
| recording_type optional | string | Recording type (default: "cloud") | boolean | Whether the room requires a token to join |
Test API
Response
Meeting Tokens
POST
/v1/meeting-tokens
Generate a token for accessing private rooms.
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| room_code required | string | Room code to generate token for |
| name optional | string | User's display name (defaults to "Guest") |
| theme optional | string | Initial theme (default, office, beach, space, blur, black, none) |
| minimal optional | boolean | Enable minimal UI mode (default: false) |
| autoJoin optional | boolean | Automatically join the room (default: false) |
| hideSelfview optional | boolean | Hide self video view (default: false) |
| hideStatus optional | boolean | Hide status indicators (default: false) |
| hideControls optional | boolean | Hide video controls (default: false) |
Test API
Response
Error Codes
| Error Code | Description | HTTP Status |
|---|---|---|
| INVALID_API_KEY | API key is missing or invalid | 401 |
| COMPANY_ID_REQUIRED | Company ID is required for room creation | 400 |
| ROOM_NAME_REQUIRED | Room name is required | 400 |
| ROOM_CODE_REQUIRED | Room code is required for token generation | 400 |
| ROOM_NOT_FOUND | The specified room does not exist | 404 |
| TOKEN_ERROR | Error generating meeting token | 500 |