Skip to main content
GET
/
livekit
/
rooms
/
{room_name}
Handler for GET /livekit/rooms/{room_name} endpoint
curl --request GET \
  --url https://api.sayna.ai/livekit/rooms/{room_name} \
  --header 'Authorization: Bearer <token>'
{
  "active_recording": false,
  "creation_time": 1703123456,
  "max_participants": 10,
  "metadata": "",
  "name": "conversation-room-123",
  "num_participants": 2,
  "participants": [
    {
      "attributes": {},
      "identity": "user-alice-456",
      "is_publisher": true,
      "joined_at": 1703123456,
      "kind": "STANDARD",
      "metadata": {
        "role": "host"
      },
      "name": "Alice Smith",
      "sid": "PA_abc123",
      "state": "ACTIVE"
    }
  ],
  "sid": "RM_xyz789"
}
Returns detailed information about a specific LiveKit room including all current participants. Access is authorized via metadata.auth_id check.

​
Authorization

ModeBehavior
Authenticated (auth.id present)Requires room.metadata.auth_id == auth.id.
Unauthenticated (auth.id absent)Access is allowed (backward-compatible mode).
Room names are used exactly as provided. No prefixing or modification is applied.

​
Response

Returns room details including:
  • sid - Unique session ID (generated by LiveKit)
  • name - The room name
  • num_participants - Current participant count
  • max_participants - Maximum allowed (0 = no limit)
  • creation_time - Unix timestamp
  • metadata - Room metadata (treat as opaque JSON)
  • active_recording - Whether recording is active
  • participants - List of participants with identities, metadata, and state

​
Error responses

StatusCondition
404 Not FoundRoom not found or access denied (masked for security).
500 Internal Server ErrorLiveKit not configured or API call failed.

Authorizations

​
Authorization
string
header
required

Authentication token for protected endpoints. Can be provided as Authorization: Bearer <token> or ?api_key=<token>. Required when AUTH_REQUIRED is enabled.

Path Parameters

​
room_name
string
required

Name of the room to retrieve

Response

Room details retrieved successfully

Detailed information about a LiveKit room including participants

Example

{
  "sid": "RM_xyz789",
  "name": "conversation-room-123",
  "num_participants": 2,
  "max_participants": 10,
  "creation_time": 1703123456,
  "metadata": "{\"auth_id\": \"tenant-123\"}",
  "active_recording": false,
  "participants": [...]
}
​
active_recording
boolean
required

Whether a recording is currently active

Example:

false

​
creation_time
integer<int64>
required

Room creation time (Unix timestamp in seconds)

Example:

1703123456

​
max_participants
integer<int32>
required

Maximum allowed participants (0 = no limit)

Required range: x >= 0
Example:

10

​
metadata
string
required

User-specified metadata for the room

Example:

""

​
name
string
required

The room name

Example:

"conversation-room-123"

​
num_participants
integer<int32>
required

Number of current participants in the room

Required range: x >= 0
Example:

2

​
participants
object[]
required

List of participants currently in the room

​
sid
string
required

Unique session ID for the room (generated by LiveKit)

Example:

"RM_xyz789"