Classes and methods for interacting with the Daily API to manage rooms and tokens
Daily REST API Documentation
For complete Daily REST API reference and additional details
Classes
DailyRoomSipParams
Configuration for SIP (Session Initiation Protocol) parameters.
string
default:"sw-sip-dialin"
Display name for the SIP endpoint
boolean
default:false
Whether video is enabled for SIP
string
default:"dial-in"
SIP connection mode
integer
default:1
Number of SIP endpoints
from pipecat.transports.daily.utils import DailyRoomSipParamssip_params = DailyRoomSipParams( display_name="conference-line", video=True, num_endpoints=2)
RecordingsBucketConfig
Configuration for storing Daily recordings in a custom S3 bucket.
string
required
Name of the S3 bucket for storing recordings
string
required
AWS region where the S3 bucket is located
string
required
ARN of the IAM role to assume for S3 access
boolean
default:false
Whether to allow API access to the recordings
from pipecat.transports.daily.utils import RecordingsBucketConfigbucket_config = RecordingsBucketConfig( bucket_name="my-recordings-bucket", bucket_region="us-west-2", assume_role_arn="arn:aws:iam::123456789012:role/DailyRecordingsRole", allow_api_access=True)
DailyRoomProperties
Properties that configure a Daily room’s behavior and features.
float
Room expiration time as Unix timestamp (e.g., time.time() + 300 for 5 minutes)
boolean
default:false
Whether chat is enabled in the room
boolean
default:false
Whether the prejoin lobby UI is enabled
boolean
default:false
Whether emoji reactions are enabled
boolean
default:false
Whether to eject participants when room expires
boolean
Whether dial-out is enabled
string
Recording settings (“cloud”, “cloud-audio-only”, “local”, or “raw-tracks”)
string
Geographic region for room
number
Maximum number of participants allowed in the room
RecordingsBucketConfig
Configuration for custom S3 bucket recordings
DailyRoomSipParams
SIP configuration parameters
dict
SIP URI configuration (returned by Daily)
boolean
default:false
Whether the camera video is turned off by default
The class also includes a sip_endpoint property that returns the SIP endpoint URI if available.enable_recording also supports cloud-audio-only, which records the call server-side and produces an audio-only MPEG-4 file with .m4a file extension and content type as audio/mp4. This recording setting behaves like cloud, except the layout options do not apply because there are no video tracks. Note: you can retrieve the resulting .m4a recordings via the Daily REST API, in the same way you fetch cloud recording assets.
If you’re already using enable_recording="cloud" and want to switch to
audio-only without changing your code, you can set
force_audio_only_recording: 1 on your Daily domain. This forces all cloud
recordings to be audio-only (.m4a instead of .mp4) and skips recording
video tracks even if they are present. This is useful when you want to
transition to audio-only recordings immediately while avoiding an application
redeploy. Switching force_audio_only_recording: 0 will allow recording video
tracks.
from pipecat.transports.daily.utils import ( DailyRoomObject, DailyRoomProperties,)# Example of what a DailyRoomObject looks like when receivedroom = DailyRoomObject( id="abc123", name="team-meeting", api_created=True, privacy="private", url="https://your-domain.daily.co/team-meeting", created_at="2024-01-20T10:00:00.000Z", config=DailyRoomProperties( enable_chat=True, exp=1705743600 ))
DailyMeetingTokenProperties
Properties for configuring a Daily meeting token.
string
The room this token is valid for. If not set, token is valid for all rooms.
boolean
Whether to eject user when token expires
integer
Eject user after this many seconds
integer
“Not before” timestamp - users cannot join before this time
integer
Expiration timestamp - users cannot join after this time
boolean
Whether token grants owner privileges
string
User’s display name in the meeting
string
Unique identifier for the user (36 char limit)
boolean
Whether user can share their screen
boolean
Whether to join with video off
boolean
Whether to join with audio off
string
Recording settings (“cloud”, “cloud-audio-only”, “local”, or “raw-tracks”)
boolean
Whether to show prejoin UI
boolean
Whether to start cloud recording when user joins
dict
Initial default permissions for a non-meeting-owner participant
Token expiration time in seconds. Ignored if params sets exp.
bool | None
default:"None"
Whether to eject the user when the token expires. If unset, the value in
params is kept; if that is unset too, the field is left out so the room’s
eject_at_room_exp setting applies. Setting it to True or False overrides
the room’s ejection settings for this token.
bool
default:"True"
Whether the token should have owner privileges. Ignored if params sets
is_owner.
DailyMeetingTokenParams
Additional token configuration. room_name is always taken from room_url.
exp and is_owner set in params are kept; otherwise expiry_time and
owner are used. The object you pass is not modified.