Room Management¶
This section details the RPC-style endpoints used to manage LiveKit rooms (Create, Read, Update, Delete).
Base URL: /api/v1/livekit
Authentication: Required (Bearer Token / Session Cookie)
Create Room¶
Creates a new room configuration in the database.
- URL:
/room-create - Method:
POST - Permission: Authenticated User
Request Body¶
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | Yes | The display name of the room. |
description |
string | Yes | A description of the room. |
roomTypeId |
int64 | No | Optional ID for the room type configuration. |
Example Request:
{
"name": "General Chat",
"description": "A place for general discussion",
"roomTypeId": 1
}
Response¶
{
"code": 200
}
Update Room¶
Updates an existing room's details.
- URL:
/room-update - Method:
POST - Permission: Authenticated User (Owner/Admin)
Request Body¶
| Field | Type | Required | Description |
|---|---|---|---|
id |
int64 | Yes | The unique ID of the room to update. |
name |
string | Yes | The new name. |
description |
string | Yes | The new description. |
roomTypeId |
int64 | No | Optional new room type ID. |
Example Request:
{
"id": 155,
"name": "General Chat (Updated)",
"description": "Updated description",
"roomTypeId": 2
}
Response¶
{
"code": 200
}
Delete Room¶
Permanently removes a room.
- URL:
/room-delete - Method:
POST - Permission: Authenticated User (Owner/Admin)
Request Body¶
| Field | Type | Required | Description |
|---|---|---|---|
roomId |
int64 | Yes | The unique ID of the room to delete. |
Example Request:
{
"roomId": 155
}
Response¶
{
"code": 200
}
List Rooms¶
Retrieves a paginated list of rooms.
- URL:
/room-list - Method:
POST - Permission: Authenticated User
Request Body¶
| Field | Type | Required | Validation | Description |
|---|---|---|---|---|
limit |
int | Yes | min=1, max=100 |
Number of items to return. |
offset |
int | Yes | min=0 |
Number of items to skip. |
Example Request:
{
"limit": 10,
"offset": 0
}
Response¶
{
"code": 200
}