Skip to main content
GET
Get a LiveKit room connection

Authorizations

Authorization
string
header
required

A Reactor API key (rk_...), sent as Authorization: Bearer rk_.... Keep it on a server.

Headers

Reactor-API-Version
string

The API protocol version the client speaks. Currently 1. Older versions than the server's minimum get 426.

Example:

"1"

Path Parameters

session_id
string<uuid>
required

The session's ID, as returned by POST /sessions.

connection_id
integer<int32>
required

The connection's ID, as returned when it was registered.

Required range: 1001 <= x <= 9999
Example:

4321

Response

The join has finished.

connection_id
integer<int32>
required
state
enum<string>
required

open: the session joined the room and publishes its tracks there. failed: the join failed; reason names why. closed: the room connection was open and has closed.

Available options:
open,
failed,
closed
reason
string

Why the join failed. Present for failed.