v1
latestOpenAPI 3.1.0Apache-2.02026-07-17144068.3 KBlivekit
Handler for GET /livekit/rooms/{room_name} endpoint
Returns detailed information about a specific LiveKit room including all current participants. Access is authorized via metadata.auth_id check.
Arguments
- state - Shared application state containing LiveKit configuration
- auth - Authentication context from middleware
- room_name - Name of the room to retrieve (from path parameter)
Returns
- Response - JSON response with room details or error status
Authorization
- When auth.id is present: Requires room.metadata.auth_id == auth.id
- When auth.id is absent: Access is allowed (backward-compatible mode)
Errors
- 404 Not Found - Room not found or access denied (masked as not found)
- 500 Internal Server Error - LiveKit service not configured or API call failed
get/livekit/rooms/{room_name}
Path parameters
room_namestring required
Name of the room to retrieve
Response
Room details retrieved successfully
Example response
{
"creation_time": 1703123456,
"max_participants": 10,
"name": "conversation-room-123",
"num_participants": 2,
"participants": [
{
"identity": "user-alice-456",
"is_publisher": true,
"joined_at": 1703123456,
"kind": "STANDARD",
"name": "Alice Smith",
"sid": "PA_abc123",
"state": "ACTIVE"
}
],
"sid": "RM_xyz789"
}