Sign in

v4

latestOpenAPI 3.1.02026-08-08221179273.1 KB
livekit

Create Room With Metadata

Create a new LiveKit room with the provided room_id and generate an access token.

This endpoint:

  1. Creates a new LiveKit room using the provided room_id as the room name
  2. Generates an access token for the participant
  3. Returns room details and the access token
post/api/livekit/create

Headers

x-user-idstring nullable

Request body

room_idstring required

Room ID to create the LiveKit room

opening_messagestring nullable

Optional text the voice agent should speak verbatim as its first utterance.

supports_voice_idle_checkboolean

True when the client supports the voice_control idle-check flow (receives 'idle_check' and replies 'idle_active'). Older builds omit it.

Response

Successful Response

roomobject required
access_tokenstring required
urlstring required