POST
/rooms

A POST request to /rooms creates a new room.

If the room is created, a room object is returned. So you can, for example, create a room, then immediately grab the room url from the API response and use it in your user interface. If you don't set privacy configuration parameters when you create the room, you can always set/change them later.

The config part of the room object includes only configuration parameters that differ from room configuration defaults.

If the room is not created, you'll get back an HTTP error, with information about the error in the HTTP response body.

Body params

A POST request has three optional body parameters: name, privacy, and a properties object.

name

string

Defaults to a randomly generated string. A room name can include only the uppercase and lowercase ascii letters, numbers, dash and underscore. In other words, this regexp detects an invalid room name: /[^A-Za-z0-9_-]/.

Together, the domain name and the room name cannot exceed 41 characters. You'll get an error if you try to create a room with a name that's too long.

privacy

string
Determines who can access the room.
Options: "public","private"
Default: "public"

properties

integer

"Not before". This is a unix timestamp (seconds since the epoch.) Users cannot join a meeting in this room before this time.

integer

"Expires". This is a unix timestamp (seconds since the epoch.) Users cannot join a meeting in this room after this time.

More resources:

How many people are allowed in a room at the same time.

⚠️ Contact us if you need to set the limit above 200.

Default: 200

Determines if Daily Prebuilt displays the People UI. When set to true, a People button in the call tray reveals a People tab in the call sidebar. The tab lists all participants, and next to each name indicates audio status and an option to pin the participant. When enable_people_ui is set to false, the button and tab are hidden.

⚠️ Has no effect on custom calls built on the Daily call object.

Sets whether the room can use Daily Prebuilt's Picture in Picture controls. When set to true, an additional button will be available in Daily Prebuilt's UI to toggle the Picture in Picture feature.

⚠️ This flag only applies to Daily Prebuilt. It has no effect when building custom video applications with the Daily call object.

Determines if Daily Prebuilt displays the Emoji Reactions UI. When set to true, a Reactions button appears in the call tray. This button allows users to select and send a reaction into the call. When set to false, the Reactions button is hidden and the feature is disabled.

Usage: This feature is a good fit for meetings when a host or presenter would benefit from receiving nonverbal cues from the audience. It's also great to keep meetings fun.

⚠️ This flag only applies to Daily Prebuilt. It has no effect when building custom video applications with the Daily call object.

Sets whether the participants in the room can use Daily Prebuilt's hand raising controls. When set to true, an additional button will be available in Daily Prebuilt's UI to toggle a hand raise.

⚠️ This flag only applies to Daily Prebuilt. It has no effect when building custom video applications with the Daily call object.

Determines whether participants enter a waiting room with a camera, mic, and browser check before joining a call.

⚠️ You must be using Daily Prebuilt to use enable_prejoin_ui.

Sets whether participants in a room see a closed captions button in their Daily Prebuilt call tray. When the closed caption button is clicked, closed captions are displayed locally.

When set to true, a closed captions button appears in the call tray. When set to false, the closed captions button is hidden from the call tray.

Note: Transcription must be enabled for the room or users must have permission to start transcription for this feature to be enabled. View the transcription guide for more details.

⚠️ You must be using Daily Prebuilt to use enable_live_captions_ui.

Determines whether the network button, and the network panel it reveals on click, appears in this room.

⚠️ You must be using Daily Prebuilt to use enable_network_ui.

Determines whether Daily Prebuilt displays noise cancellation controls. When set to true, a participant can enable microphone noise cancellation during a Daily Prebuilt call. ⚠️ This flag only applies to Daily Prebuilt. It has no effect when building custom video applications with the Daily call object. To learn more about adding noise cancellation to a custom application, see the updateInputSettings() docs.

Sets whether Daily Prebuilt’s breakout rooms feature is enabled. When set to true, an owner in a Prebuilt call can create breakout rooms to divide participants into smaller, private groups.

⚠️ You must be using Daily Prebuilt to use enable_breakout_rooms.

⚠️ This property is in beta.

Turns on a lobby experience for private rooms. A participant without a corresponding meeting token can request to be admitted to the meeting with a "knock", and wait for the meeting owner to admit them.

Sets whether users in a room can screen share during a session. This property cannot be changed after a session starts. For dynamic control over permissions, use the updateParticipant() method to control user permissions.

Default: true

Determines whether Daily Prebuilt displays background blur controls. When set to true, a participant can enable blur during a Daily Prebuilt call.

⚠️ This flag only applies to Daily Prebuilt. It has no effect when building custom video applications with the Daily call object.

Default: true
Default: false

Disable the default behavior of automatically turning on a participant's camera on a direct join() (i.e. without startCamera() first).

Default: false

Disable the default behavior of automatically turning on a participant's microphone on a direct join() (i.e. without startCamera() first).

Default: false

In Daily Prebuilt, only the meeting owners will be able to turn on camera, unmute mic, and share screen.

See setting up calls.

Default: false
Options: "cloud","local","raw-tracks","<not set>"
Default: <not set>

If there's a meeting going on at room exp time, end the meeting by kicking everyone out. This behavior can be overridden by setting eject properties of a meeting token.

Default: false

Eject a meeting participant this many seconds after the participant joins the meeting. You can use this is a default length limit to prevent long meetings. This can be overridden by setting eject properties of a meeting token.

Property that gives end users a richer chat experience. This includes:

  • Emoji reactions to chat messages
  • Emoji picker in the chat input form
  • Ability to send a Giphy chat message

⚠️ This flag only applies to Daily Prebuilt. It has no effect when building custom video applications with the Daily call object.

Default: false

When enabled, non-owner users join a meeting with a hidden presence, meaning they won't appear as a named participant in the meeting and have no participant events associated to them. Additionally, these participants can only receive media tracks from owner participants.

Hidden participants can be tracked using the participantCounts() method. Hidden participants do not have entries in the participants() method return value.

When used with Daily Prebuilt, hidden participants are included in the participant count available in the UI; however, are not included in the People panel and can only read chat messages.

This property should be used to support hosting large meetings. See our guide on interactive live streaming for additional instruction.

Default: false

Configures a room to use multiple SFUs for a call's media. This feature enables calls to scale to large sizes and to reduce latency between participants. It is recommended specifically for interactive live streaming.

See our guide for interactive live streaming for additional instruction.

Dictates the participant count after which room topology automatically switches from Peer-to-Peer (P2P) to Selective Forwarding Unit (SFU) mode, or vice versa.

For example, if sfu_switchover is set to 2 and the current network topology is P2P, the topology will switch to SFU mode when the third participant joins the call. If the current topology is SFU, it will switch to P2P mode when the participant count decreases from 2 to 1.

We recommend specifying an integer value for this property except for cases where you would like the room to switch to SFU mode as soon as the first participant joins. In this case, set sfu_switchover to 0.5.

See our guide about video call architecture for additional information.

Default: 0.5

Configures a domain or room to use Daily Adaptive Bitrate. When enabled, along with configuring the client to allowAdaptiveLayers, the Daily client will continually adapt send settings to the current network conditions. allowAdaptiveLayers is true by default; if you haven't modified that setting, then setting enable_adaptive_simulcast to true will enable Daily Adaptive Bitrate.

Default: true

Configures a domain or room to disallow multiple participants from having the same user_id. This feature can be enabled to prevent users from "sharing" meeting tokens. When enabled, a participant joining or reconnecting to a meeting will cause existing participants with the same user_id to be ejected.

Default: false

Enables Daily Prebuilt to support group calls of up to 1,000 participants and owner only broadcast calls of up to 100K participants.

When set to true, Daily Prebuilt will:

  • Automatically mute the local user on joining
  • Update grid view to show a maximum of 12 users in the grid at a time
  • Allow only 16 users to be unmuted at the same time. When more than 16 users are unmuted, the oldest active speaker will be automatically muted.

See our guide on large real-time calls for additional instruction.

⚠️ This flag only applies to Daily Prebuilt. It has no effect when building custom video applications with the Daily call object.

string

The default language of the Daily prebuilt video call UI, for this room.

Setting the language at the room level will override any domain-level language settings you have.

Read more about changing prebuilt UI language settings.

* Norwegian "no" and Russian "ru" are only available in the new Daily Prebuilt.

Options: "de","en","es","fi","fr","it","jp","ka","nl","no","pt","pt-BR","pl","ru","sv","tr","user"
Default: en

Sets a URL that will receive a webhook when a user joins a room. Default is NULL. Character limit for webhook URL is 255.

More resources:

string

Daily uses signaling servers to manage all of the participants in a given call session. In an SFU/server mode call, the server will send and receive all audio and video from each participant. In a peer-to-peer call, each participant sends media directly to and from each other peer, but a signaling server still manages call state.

Daily runs servers in several different AWS regions to minimize latency for users around the world. The job of 'picking' a call server is handled when the first participant joins a room. The first participant's browser connects to a call server using Amazon's Route 53 DNS resolution, which chooses a server in the region closest to them.

This isn't always optimal. For example, if one person joins in London, and then ten more people join from Cape Town, the call will still be hosted out of eu-west-2 . The majority of the participants will have higher latency to the server than if one of them had joined first and the call was being hosted in af-south-1. In cases like this, you may want to configure your domain (or a specific room) to always choose a call server in a specific AWS region.

Available regions:

  • "af-south-1" (Cape Town)
  • "ap-northeast-2" (Seoul)
  • "ap-southeast-1" (Singapore)
  • "ap-southeast-2" (Sydney)
  • "ap-south-1" (Mumbai)
  • "eu-central-1" (Frankfurt)
  • "eu-west-2" (London)
  • "sa-east-1" (São Paulo)
  • "us-east-1" (N. Virginia)
  • "us-west-2" (Oregon)
Default: NULL
string

Used to select the region where an RTMP stream should originate. In cases where RTMP streaming services aren't available in the desired region, we'll attempt to fall back to the default region based on the SFU being used for the meeting.

Available regions:

  • "us-west-2" (Oregon)
  • "eu-central-1" (Frankfurt)
  • "ap-south-1" (Mumbai)

The default regions are grouped based on the SFU region like so:

  • RTMP region "us-west-2" includes SFU regions: "us-west-2", "us-east-1", "sa-east-1"
  • RTMP region "eu-central-1" includes SFU regions: "eu-central-1", "eu-west-2", "af-south-1"
  • RTMP region "ap-south-1" includes SFU regions: "ap-southeast-1", "ap-southeast-2", "ap-northeast-2", "ap-south-1"
Default: The closest available region to the SFU region used by the meeting.

Disable the fall back behavior of rtmp_geo. When rtmp_geo is set, we first try to connect to a media server in desired region. If a media server is not available in the desired region, we fall back to default region based on SFU's region. This property disables this automatic fall back. When this property is set, we will trigger a recording/streaming error event when media worker is unavailable. Also, the client should retry recording/streaming.

Default: false

Configures an S3 bucket in which to store recordings. See the S3 bucket guide for more information.

Properties:

The name of the Amazon S3 bucket to use for recording storage.

The region which the specified S3 bucket is located in.

The Amazon Resource Name (ARN) of the role Daily should assume when storing the recording in the specified bucket.

Controls whether the recording will be accessible using Daily's API.

Specifies which Content-Disposition response header the recording link retrieved from the access-link REST API endpoint will have. If allow_streaming_from_bucket is false, the header will be Content-Dispostion: attachment. If allow_streaming_from_bucket is true, the header will be Content-Disposition: inline. To play the recording link directly in the browser or embed it in a video player, set this property to true.

Default: false

Reduces the volume of log messages. This feature should be enabled when there are more than 200 participants in a meeting to help improve performance.

See our guides for supporting large experiences for additional instruction.

Default: false

Options to use when auto_start_transcription is true. See startTranscription() for available options.

Live transcriptions generated can be saved as WebVTT. This flag controls if transcription started with startTranscription() should be saved or not.

Default: false

Configures an S3 bucket in which to store transcriptions. See the S3 bucket guide for more information.

The name of the Amazon S3 bucket to use for transcription storage.

The region which the specified S3 bucket is located in.

The Amazon Resource Name (ARN) of the role Daily should assume when storing the transcription in the specified bucket.

Whether the transcription should be accessible using Daily's API.

Cloud recordings are stored in either Daily's S3 bucket or the customer's own S3 bucket. By default recordings are stored as {domain_name}/{room_name}/{epoch_time}. Sometimes, the use case may call for custom recording file names to be used (for example, if you'd like to enforce the presence of the .mp4 extension in the file name).

recordings_template is made up of a replacement string with prefixes, suffixes, or both. The currently supported replacements are:

  • epoch_time: The epoch time in seconds (mandatory)
  • domain_name: Your Daily domain (optional)
  • room_name: The name of the room which is getting recorded (optional)
  • mtg_session_id: The ID of the meeting session which is getting recorded (optional)
  • instance_id: The instance ID of the recording (optional)
  • recording_id: The recording ID of the recording (optional)

The restrictions for defining a recording template are as follows:

  • The epoch_time tag is mandatory to ensure the recording file name is unique under all conditions
  • The maximum size of the template is 1024 characters
  • Each replacement parameter should be placed within a curly bracket (e.g., {domain_name})
  • Only alphanumeric characters (0-9, A-Z, a-z) and ., /, -, _ are valid within the template
  • .mp4 is the only valid extension

Examples

  • Example domain: "myDomain"
  • Example room: "myRoom"

Example 1:

  • Template: myprefix-{domain_name}-{epoch_time}.mp4
  • Resulting file name: myprefix-myDomain-1675842936274.mp4

Example 2:

  • Template: {room_name}/{instance_id}/{epoch_time}
  • Resulting room name: myRoom/d529cd2f-fbcc-4fb7-b2c0-c4995b1162b6/1675842936274
Default: {domain_name}/{room_name}/{epoch_time}.

An array of stream endpoint configuration objects, which allows configurations to be pre-defined without having to pass them into startLiveStreaming() at runtime. For example, an RTMP endpoint can be set up for YouTube as a streaming_endpoints configuration along with another configuration for HLS storage.

HLS output can only be stored on a customer's S3, not in Daily's storage infrastructure. The stream configuration defines which S3 bucket to store the HLS output. (See the S3 bucket guide for more information.)

Example:

To reset the streaming_endpoints property, pass null instead of an array.

When calling startLiveStreaming(), the pre-defined streaming_endpoints name can be used:

Properties:

Specifies the initial default permissions for a non-meeting-owner participant joining a call.

Each permission (i.e. each of the properties listed below) can be configured in the meeting token, the room, and/or the domain, in decreasing order of precedence.

Participant admins (those with the 'participants' value in their canAdmin permission) can also change participants' permissions on the fly during a call using updateParticipant() or updateParticipants().

Whether the participant appears as "present" in the call, i.e. whether they appear in participants().

boolean | array

Which types of media a participant should be permitted to send.

Can be:

  • An Array containing any of 'video', 'audio', 'screenVideo', and 'screenAudio'
  • true (meaning "all")
  • false (meaning "none")
boolean | array

Which admin tasks a participant is permitted to do.

Can be:

  • An array containing any of 'participants', 'streaming', or 'transcription'
  • true (meaning "all")
  • false (meaning "none")
Default: <not set>

Example requests

Create a randomly named room that expires in an hour

Here's how you might create a room with an auto-generated name, set to expire in an hour. This is a pretty common use case. For example, maybe you're creating rooms on demand to use for customer support or account verification. You don't need to set the room's privacy, because you won't be sharing the room URL other than within your own UI, and you won't be re-using the room. It is worth setting the room exp, just so that the room is auto-deleted and you don't end up with a huge number of live rooms.

If you're writing API calls in JavaScript, note that exp and nbf are unix timestamps expressed in seconds, not in milliseconds. You will need to divide JavaScript timestamps by 1,000 to turn them into unix timestamps. For example, you probably want to use some variant of Math.floor(Date.now()/1000) as a base value when creating near-future expiration timestamps. Don't just use Date.now().

Create a private room with a human-readable name and devices turned off at start

Here's how you might create a room with a human-readable name, and privacy set to private, and with the default behavior of everyone's camera and mic turned off initially. You can create meeting tokens to allow access to this room (Learn more in our guide to room access control).

When a room object is returned by an API call, only configuration options that differ from the defaults are included in the config struct.*