DOC-API-MODEL-schema-1kp6t31pq7#overview
DailyRoomProperties
Daily room configuration (subset of frequently used fields)
Meaning and usage
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-nbfnbf | string (int64) | Optional | Earliest time at which the Daily room can be joined, as Unix seconds. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-expexp | string (int64) | Optional | Expiration time of the Daily room, as Unix seconds. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-maxparticipantsmaxParticipants | string (int64) | Optional | Maximum number of participants allowed in the Daily room. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-enablepeopleuienablePeopleUi | boolean | Optional | Whether the Daily room exposes participant-list controls. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-enablepipuienablePipUi | boolean | Optional | Whether the Daily room enables picture-in-picture controls. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-enableemojireactionsenableEmojiReactions | boolean | Optional | Whether the Daily room enables emoji reactions. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-enablehandraisingenableHandRaising | boolean | Optional | Whether the Daily room enables hand-raising controls. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-enableprejoinuienablePrejoinUi | boolean | Optional | Whether the Daily room enables its prejoin screen. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-enablelivecaptionsuienableLiveCaptionsUi | boolean | Optional | Whether the Daily room exposes live-caption controls. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-enablenetworkuienableNetworkUi | boolean | Optional | Whether the Daily room exposes network-information controls. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-enablenoisecancellationuienableNoiseCancellationUi | boolean | Optional | Whether the Daily room exposes noise-cancellation controls. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-enablebreakoutroomsenableBreakoutRooms | boolean | Optional | Whether the Daily room enables breakout rooms. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-enableknockingenableKnocking | boolean | Optional | When true, requests Daily’s knocking feature for a private room, allowing a participant without a meeting token to ask a meeting owner for admission. It does not restrict a public room. The current room-property mapping forwards true only; false or omission does not explicitly disable a provider setting. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-owneronlybroadcastownerOnlyBroadcast | boolean | Optional | Whether broadcasting is restricted to Daily room owners. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-enforceuniqueuseridsenforceUniqueUserIds | boolean | Optional | Whether the Daily room requires participant user identifiers to be unique. |
enableScreenshare | boolean | Optional | Whether screen sharing is enabled in the Daily room. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-enablevideoprocessinguienableVideoProcessingUi | boolean | Optional | Whether the Daily room exposes video-processing controls. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-enablechatenableChat | boolean | Optional | Whether chat is enabled in the Daily room. |
enableSharedChatHistory | boolean | Optional | Whether the Daily room enables shared chat history. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-enableadvancedchatenableAdvancedChat | boolean | Optional | Whether the Daily room enables advanced chat features. |
enableHiddenParticipants | boolean | Optional | Whether the Daily room allows hidden participants. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-startvideooffstartVideoOff | boolean | Optional | Whether participants join the Daily room with video initially off. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-startaudiooffstartAudioOff | boolean | Optional | Whether participants join the Daily room with audio initially off. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-enablerecordingenableRecording | string (RECORDING_MODE_CLOUD, RECORDING_MODE_LOCAL, RECORDING_MODE_RAW_TRACKS, RECORDING_MODE_DISABLED) or integer (int32) | Optional; explicit presence | Recording mode configured for the Daily room. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-ejectatroomexpejectAtRoomExp | boolean | Optional | Whether participants are removed when the Daily room expires. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-ejectafterelapsedejectAfterElapsed | string (int64) | Optional | Elapsed session duration after which participants are removed, in seconds. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-enablemeshsfuenableMeshSfu | boolean | Optional | When true, forwards Daily’s enable_mesh_sfu room-topology option. Confirm provider support and its effect for your Daily account before relying on it. The current room-property mapping forwards true only; false or omission does not explicitly disable a provider setting. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-sfuswitchoversfuSwitchover | number (double) or string (NaN, Infinity, -Infinity) | Optional | Daily topology setting controlling the switch to SFU transport. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-enableadaptivesimulcastenableAdaptiveSimulcast | boolean | Optional | Whether adaptive simulcast is enabled for the Daily room. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-enablemultipartyadaptivesimulcastenableMultipartyAdaptiveSimulcast | boolean | Optional | Whether multiparty adaptive simulcast is enabled for the Daily room. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-experimentaloptimizelargecallsexperimentalOptimizeLargeCalls | boolean | Optional | Whether Daily’s experimental large-call optimization is requested. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-langlang | string | Optional | Language code configured for the Daily room interface, such as en, es, or pt-BR. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-meetingjoinhookmeetingJoinHook | string | Optional | Webhook URL invoked by the Daily meeting-join hook. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-geogeo | string | Optional | Region selected for the Daily room media infrastructure, such as eu-west-2. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-rtmpgeortmpGeo | string | Optional | Region selected for Daily RTMP streaming, such as us-west-2. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-disablertmpgeofallbackdisableRtmpGeoFallback | boolean | Optional | Whether automatic RTMP region fallback is disabled. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-recordingsbucketrecordingsBucket | RecordingBucketConfig | Optional | Storage destination configured for Daily recordings. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-transcriptionbuckettranscriptionBucket | TranscriptionBucketConfig | Optional | Storage destination configured for Daily transcriptions. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-recordingstemplaterecordingsTemplate | string | Optional | Template used for recording object names in storage. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-field-transcriptiontemplatetranscriptionTemplate | string | Optional | Template used for transcription object names in storage. |
Values of enableRecording
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#request-values-enablerecording
Recording mode requested when configuring a Daily room.
| Value | No. | Form | Meaning |
|---|---|---|---|
RECORDING_MODE_CLOUD | 0 | Canonical | See meaning below. |
RECORDING_MODE_LOCAL | 1 | Canonical | See meaning below. |
RECORDING_MODE_RAW_TRACKS | 2 | Canonical | See meaning below. |
RECORDING_MODE_DISABLED | 3 | Canonical | See meaning below. |
RECORDING_MODE_CLOUD
Request the provider's cloud recording mode.
"cloud"
RECORDING_MODE_LOCAL
Request the provider's local recording mode.
"local"
RECORDING_MODE_RAW_TRACKS
Request separate raw media tracks for recording.
"raw-tracks"
RECORDING_MODE_DISABLED
Explicitly disable room recording.
explicitly disabled
In responses
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-nbfSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-nbfnbf | string (int64) | Optional | Earliest time at which the Daily room can be joined, as Unix seconds. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-expSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-expexp | string (int64) | Optional | Expiration time of the Daily room, as Unix seconds. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-maxparticipantsSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-maxparticipantsmaxParticipants | string (int64) | Optional | Maximum number of participants allowed in the Daily room. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-enablepeopleuiSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-enablepeopleuienablePeopleUi | boolean | Optional | Whether the Daily room exposes participant-list controls. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-enablepipuiSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-enablepipuienablePipUi | boolean | Optional | Whether the Daily room enables picture-in-picture controls. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-enableemojireactionsSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-enableemojireactionsenableEmojiReactions | boolean | Optional | Whether the Daily room enables emoji reactions. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-enablehandraisingSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-enablehandraisingenableHandRaising | boolean | Optional | Whether the Daily room enables hand-raising controls. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-enableprejoinuiSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-enableprejoinuienablePrejoinUi | boolean | Optional | Whether the Daily room enables its prejoin screen. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-enablelivecaptionsuiSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-enablelivecaptionsuienableLiveCaptionsUi | boolean | Optional | Whether the Daily room exposes live-caption controls. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-enablenetworkuiSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-enablenetworkuienableNetworkUi | boolean | Optional | Whether the Daily room exposes network-information controls. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-enablenoisecancellationuiSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-enablenoisecancellationuienableNoiseCancellationUi | boolean | Optional | Whether the Daily room exposes noise-cancellation controls. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-enablebreakoutroomsSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-enablebreakoutroomsenableBreakoutRooms | boolean | Optional | Whether the Daily room enables breakout rooms. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-enableknockingSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-enableknockingenableKnocking | boolean | Optional | When true, requests Daily’s knocking feature for a private room, allowing a participant without a meeting token to ask a meeting owner for admission. It does not restrict a public room. The current room-property mapping forwards true only; false or omission does not explicitly disable a provider setting. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-owneronlybroadcastSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-owneronlybroadcastownerOnlyBroadcast | boolean | Optional | Whether broadcasting is restricted to Daily room owners. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-enforceuniqueuseridsSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-enforceuniqueuseridsenforceUniqueUserIds | boolean | Optional | Whether the Daily room requires participant user identifiers to be unique. |
enableScreenshare | boolean | Optional | Whether screen sharing is enabled in the Daily room. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-enablevideoprocessinguiSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-enablevideoprocessinguienableVideoProcessingUi | boolean | Optional | Whether the Daily room exposes video-processing controls. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-enablechatSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-enablechatenableChat | boolean | Optional | Whether chat is enabled in the Daily room. |
enableSharedChatHistory | boolean | Optional | Whether the Daily room enables shared chat history. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-enableadvancedchatSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-enableadvancedchatenableAdvancedChat | boolean | Optional | Whether the Daily room enables advanced chat features. |
enableHiddenParticipants | boolean | Optional | Whether the Daily room allows hidden participants. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-startvideooffSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-startvideooffstartVideoOff | boolean | Optional | Whether participants join the Daily room with video initially off. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-startaudiooffSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-startaudiooffstartAudioOff | boolean | Optional | Whether participants join the Daily room with audio initially off. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-enablerecordingSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-enablerecordingenableRecording | string (RECORDING_MODE_CLOUD, RECORDING_MODE_LOCAL, RECORDING_MODE_RAW_TRACKS, RECORDING_MODE_DISABLED) or integer (int32) | Optional; explicit presence | Recording mode configured for the Daily room. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-ejectatroomexpSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-ejectatroomexpejectAtRoomExp | boolean | Optional | Whether participants are removed when the Daily room expires. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-ejectafterelapsedSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-ejectafterelapsedejectAfterElapsed | string (int64) | Optional | Elapsed session duration after which participants are removed, in seconds. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-enablemeshsfuSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-enablemeshsfuenableMeshSfu | boolean | Optional | When true, forwards Daily’s enable_mesh_sfu room-topology option. Confirm provider support and its effect for your Daily account before relying on it. The current room-property mapping forwards true only; false or omission does not explicitly disable a provider setting. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-sfuswitchoverSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-sfuswitchoversfuSwitchover | number (double) or string (NaN, Infinity, -Infinity) | Optional | Daily topology setting controlling the switch to SFU transport. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-enableadaptivesimulcastSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-enableadaptivesimulcastenableAdaptiveSimulcast | boolean | Optional | Whether adaptive simulcast is enabled for the Daily room. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-enablemultipartyadaptivesimulcastSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-enablemultipartyadaptivesimulcastenableMultipartyAdaptiveSimulcast | boolean | Optional | Whether multiparty adaptive simulcast is enabled for the Daily room. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-experimentaloptimizelargecallsSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-experimentaloptimizelargecallsexperimentalOptimizeLargeCalls | boolean | Optional | Whether Daily’s experimental large-call optimization is requested. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-langSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-langlang | string | Optional | Language code configured for the Daily room interface, such as en, es, or pt-BR. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-meetingjoinhookSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-meetingjoinhookmeetingJoinHook | string | Optional | Webhook URL invoked by the Daily meeting-join hook. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-geoSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-geogeo | string | Optional | Region selected for the Daily room media infrastructure, such as eu-west-2. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-rtmpgeoSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-rtmpgeortmpGeo | string | Optional | Region selected for Daily RTMP streaming, such as us-west-2. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-disablertmpgeofallbackSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-disablertmpgeofallbackdisableRtmpGeoFallback | boolean | Optional | Whether automatic RTMP region fallback is disabled. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-recordingsbucketSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-recordingsbucketrecordingsBucket | RecordingBucketConfig | Optional | Storage destination configured for Daily recordings. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-transcriptionbucketSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-transcriptionbuckettranscriptionBucket | TranscriptionBucketConfig | Optional | Storage destination configured for Daily transcriptions. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-recordingstemplateSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-recordingstemplaterecordingsTemplate | string | Optional | Template used for recording object names in storage. |
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#field-transcriptiontemplateSection ID: DOC-API-MODEL-schema-1kp6t31pq7#response-field-transcriptiontemplatetranscriptionTemplate | string | Optional | Template used for transcription object names in storage. |
Values of enableRecording
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#response-values-enablerecording
Recording mode requested when configuring a Daily room.
| Value | No. | Form | Meaning |
|---|---|---|---|
RECORDING_MODE_CLOUD | 0 | Canonical | See meaning below. |
RECORDING_MODE_LOCAL | 1 | Canonical | See meaning below. |
RECORDING_MODE_RAW_TRACKS | 2 | Canonical | See meaning below. |
RECORDING_MODE_DISABLED | 3 | Canonical | See meaning below. |
RECORDING_MODE_CLOUD
Request the provider's cloud recording mode.
"cloud"
RECORDING_MODE_LOCAL
Request the provider's local recording mode.
"local"
RECORDING_MODE_RAW_TRACKS
Request separate raw media tracks for recording.
"raw-tracks"
RECORDING_MODE_DISABLED
Explicitly disable room recording.
explicitly disabled
Where used
Section ID: DOC-API-MODEL-schema-1kp6t31pq7#where-used
| Reference | Relationship |
|---|---|
| Create a voice session (in progress) | POST /api/v1/llm/create-daily-session |
Models containing this value
| Model | Relationship |
|---|---|
| DailySession | Nested in model |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1kp6t31pq7