Rooms

Create a room

post/rooms

Request body

idstring required

Custom room ID (auto-generated UUID if omitted)

webhook_urlstring uri

Route all events for this room exclusively to this URL instead of global webhooks.

webhook_secretstring

HMAC-SHA256 signing secret for the per-room webhook.

app_idstring

Application identifier. Carried through to all events for this room. Use to filter the WebSocket event stream by app.

sample_rateinteger

Mixer sample rate in Hz. Allowed values: 8000, 16000, 48000. Default: 16000.

Response

Room created

instance_idstring

Instance identifier

idstring required

Room identifier

app_idstring

Application identifier for event stream filtering.

sample_rateinteger required

Mixer sample rate in Hz (8000, 16000, or 48000).

Changes

Changed in 11 of the 67 revisions of this API.81322

    • added the optional property participants/items/custom_data to the response with the 201 status

      response-optional-property-added

    • added the new livekit_participant enum value to the participants/items/type response property for the response status 201

      response-property-enum-value-added

    • added the new livekit_publish enum value to the participants/items/type response property for the response status 201

      response-property-enum-value-added

    • added the new moq_in enum value to the participants/items/type response property for the response status 201

      response-property-enum-value-added

    • added the optional property participants/items/role to the response with the 201 status

      response-optional-property-added

  • 97117ab6a5c421See the full diff
    • added the new websocket_in enum value to the participants/items/type response property for the response status 201

      response-property-enum-value-added

    • added the new websocket_out enum value to the participants/items/type response property for the response status 201

      response-property-enum-value-added

    • added the optional property participants/items/headers to the response with the 201 status

      response-optional-property-added

    • added the new whatsapp_in enum value to the participants/items/type response property for the response status 201

      response-property-enum-value-added

    • added the new whatsapp_out enum value to the participants/items/type response property for the response status 201

      response-property-enum-value-added

    • added the new optional request property sample_rate

      new-optional-request-property

    • added the required property sample_rate to the response with the 201 status

      response-required-property-added

    • added the new optional request property app_id

      new-optional-request-property

    • added the optional property app_id to the response with the 201 status

      response-optional-property-added

    • added the optional property participants/items/app_id to the response with the 201 status

      response-optional-property-added

    • added the required property participants/items/accept_dtmf to the response with the 201 status

      response-required-property-added

  • 6ad38ff56ac112See the full diff
    • removed the required property participants/items/leg_id from the response with the 201 status

      response-required-property-removed

    • added the required property participants/items/deaf to the response with the 201 status

      response-required-property-added

    • added the required property participants/items/id to the response with the 201 status

      response-required-property-added

  • d09c97c6ca8c669See the full diff
    • the response property participants/items/held became optional for the status 201

      response-property-became-optional

    • the response property participants/items/muted became optional for the status 201

      response-property-became-optional

    • removed the required property participants/items/accept_dtmf from the response with the 201 status

      response-required-property-removed

    • removed the required property participants/items/deaf from the response with the 201 status

      response-required-property-removed

    • removed the required property participants/items/id from the response with the 201 status

      response-required-property-removed

    • removed the required property sample_rate from the response with the 201 status

      response-required-property-removed

    • removed the request property app_id

      request-property-removed

    • removed the request property sample_rate

      request-property-removed

    • removed the optional property app_id from the response with the 201 status

      response-optional-property-removed

    • removed the optional property participants/items/app_id from the response with the 201 status

      response-optional-property-removed

    • removed the optional property participants/items/headers from the response with the 201 status

      response-optional-property-removed

    • removed the optional property participants/items/role from the response with the 201 status

      response-optional-property-removed

    • the request property id became optional

      request-property-became-optional

    • removed the livekit_participant enum value from the participants/items/type response property for the response status 201

      response-property-enum-value-removed

    • removed the livekit_publish enum value from the participants/items/type response property for the response status 201

      response-property-enum-value-removed

    • removed the moq_in enum value from the participants/items/type response property for the response status 201

      response-property-enum-value-removed

    • removed the websocket_in enum value from the participants/items/type response property for the response status 201

      response-property-enum-value-removed

    • removed the websocket_out enum value from the participants/items/type response property for the response status 201

      response-property-enum-value-removed

    • removed the whatsapp_in enum value from the participants/items/type response property for the response status 201

      response-property-enum-value-removed

    • removed the whatsapp_out enum value from the participants/items/type response property for the response status 201

      response-property-enum-value-removed

    • added the required property participants/items/leg_id to the response with the 201 status

      response-required-property-added

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog