REST endpoints

LiveKit room details

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}

Handler for GET /livekit/rooms/{room_name} endpoint

curl --request GET \
  --url https://api.sayna.ai/livekit/rooms/{room_name} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.sayna.ai/livekit/rooms/{room_name}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sayna.ai/livekit/rooms/{room_name}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sayna.ai/livekit/rooms/{room_name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sayna.ai/livekit/rooms/{room_name}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sayna.ai/livekit/rooms/{room_name}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sayna.ai/livekit/rooms/{room_name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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

Mode	Behavior
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

Status	Condition
`404 Not Found`	Room not found or access denied (masked for security).
`500 Internal Server Error`	LiveKit 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

Show child attributes

sid

string

required

Unique session ID for the room (generated by LiveKit)

Example:

"RM_xyz789"

Remove LiveKit participantRemoves a participant from a LiveKit room, forcibly disconnecting them. Access is authorized via `metadata.auth_id` check. Note: This does not invalidate the participant's token. To prevent rejoining, use short-lived tokens and avoid issuing new tokens to removed participants. # Arguments * `state` - Shared application state containing LiveKit configuration * `auth` - Authentication context from middleware * `request` - Request with room name and participant identity # Returns * `Response` - JSON response with removal status or error # 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 * 400 Bad Request - Empty room name or participant identity * 404 Not Found - Room/participant not found or access denied (masked) * 500 Internal Server Error - LiveKit not configured or removal failed # Flow 1. Validate request fields are not empty 2. Check room access via metadata.auth_id 3. Verify participant exists in the room 4. Remove the participant 5. Return success or appropriate error

Handler for GET /livekit/rooms/{room_name} endpoint

curl --request GET \
  --url https://api.sayna.ai/livekit/rooms/{room_name} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.sayna.ai/livekit/rooms/{room_name}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sayna.ai/livekit/rooms/{room_name}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sayna.ai/livekit/rooms/{room_name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sayna.ai/livekit/rooms/{room_name}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sayna.ai/livekit/rooms/{room_name}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sayna.ai/livekit/rooms/{room_name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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"
}

​Authorization

​Response

​Error responses

Authorizations

Path Parameters

Response

Example

Authorization

Response

Error responses