utils

Daily REST Helpers.

Methods that wrap the Daily API to create rooms, check room URLs, and get meeting tokens.

class pipecat.transports.daily.utils.DailyRoomSipParams(*, display_name: str = 'sw-sip-dialin', video: bool = False, sip_mode: str = 'dial-in', num_endpoints: int = 1, codecs: dict[str, list[str]] | None = None, provider: str | None = None)[source]

Bases: BaseModel

SIP configuration parameters for Daily rooms.

Parameters:

  • display_name – Name shown for the SIP endpoint.

  • video – Whether video is enabled for SIP.

  • sip_mode – SIP connection mode, typically ‘dial-in’.

  • num_endpoints – Number of allowed SIP endpoints.

  • codecs – Codecs to support for audio and video. If None, uses Daily defaults. Example: {“audio”: [“OPUS”], “video”: [“H264”]}

  • provider – Optional SIP provider name (defaults to None). Example: “daily”

display_name: str
video: bool
sip_mode: str
num_endpoints: int
codecs: dict[str, list[str]] | None
provider: str | None
class pipecat.transports.daily.utils.RecordingsBucketConfig(*, bucket_name: str, bucket_region: str, assume_role_arn: str, allow_api_access: bool = False)[source]

Bases: BaseModel

Configuration for storing Daily recordings in a custom S3 bucket.

Refer to the Daily API documentation for more information: https://docs.daily.co/guides/products/live-streaming-recording/storing-recordings-in-a-custom-s3-bucket

Parameters:

  • bucket_name – Name of the S3 bucket for storing recordings.

  • bucket_region – AWS region where the S3 bucket is located.

  • assume_role_arn – ARN of the IAM role to assume for S3 access.

  • allow_api_access – Whether to allow API access to the recordings.

bucket_name: str
bucket_region: str
assume_role_arn: str
allow_api_access: bool
class pipecat.transports.daily.utils.TranscriptionBucketConfig(*, bucket_name: str, bucket_region: str, assume_role_arn: str, allow_api_access: bool = False)[source]

Bases: BaseModel

Configuration for storing Daily transcription in a custom S3 bucket.

Refer to the Daily API documentation for more information: https://docs.daily.co/guides/products/live-streaming-recording/storing-recordings-in-a-custom-s3-bucket

Parameters:

  • bucket_name – Name of the S3 bucket for storing transcription.

  • bucket_region – AWS region where the S3 bucket is located.

  • assume_role_arn – ARN of the IAM role to assume for S3 access.

  • allow_api_access – Whether to allow API access to the transcription.

bucket_name: str
bucket_region: str
assume_role_arn: str
allow_api_access: bool
class pipecat.transports.daily.utils.DailyRoomProperties(*, exp: float | None = None, enable_chat: bool = False, enable_prejoin_ui: bool = False, enable_emoji_reactions: bool = False, eject_at_room_exp: bool = False, enable_dialout: bool | None = None, enable_recording: Literal['cloud', 'cloud-audio-only', 'local', 'raw-tracks'] | None = None, enable_transcription_storage: bool | None = None, geo: str | None = None, max_participants: int | None = None, recordings_bucket: RecordingsBucketConfig | None = None, transcription_bucket: TranscriptionBucketConfig | None = None, sip: DailyRoomSipParams | None = None, sip_uri: dict[str, Any] | None = None, start_video_off: bool = False, **extra_data: Any)[source]

Bases: BaseModel

Properties for configuring a Daily room.

Reference: https://docs.daily.co/reference/rest-api/rooms/create-room#properties

Parameters:

  • exp – Optional Unix epoch timestamp for room expiration (e.g., time.time() + 300 for 5 minutes).

  • enable_chat – Whether chat is enabled in the room.

  • enable_prejoin_ui – Whether the pre-join UI is enabled.

  • enable_emoji_reactions – Whether emoji reactions are enabled.

  • eject_at_room_exp – Whether to remove participants when room expires.

  • enable_dialout – Whether SIP dial-out is enabled.

  • enable_recording – Recording settings (‘cloud’, ‘cloud-audio-only’, ‘local’, ‘raw-tracks’).

  • enable_transcription_storage – Whether transcription storage is enabled.

  • geo – Geographic region for room.

  • max_participants – Maximum number of participants allowed in the room.

  • recordings_bucket – Configuration for custom S3 bucket recordings.

  • transcription_bucket – Configuration for custom S3 bucket transcription.

  • sip – SIP configuration parameters.

  • sip_uri – SIP URI information returned by Daily.

  • start_video_off – Whether video is off by default.

exp: float | None
enable_chat: bool
enable_prejoin_ui: bool
enable_emoji_reactions: bool
eject_at_room_exp: bool
enable_dialout: bool | None
enable_recording: Literal['cloud', 'cloud-audio-only', 'local', 'raw-tracks'] | None
enable_transcription_storage: bool | None
geo: str | None
max_participants: int | None
recordings_bucket: RecordingsBucketConfig | None
transcription_bucket: TranscriptionBucketConfig | None
sip: DailyRoomSipParams | None
sip_uri: dict[str, Any] | None
start_video_off: bool
property sip_endpoint: str

Get the SIP endpoint URI if available.

Returns:

SIP endpoint URI or empty string if not available.

class pipecat.transports.daily.utils.DailyRoomParams(*, name: str | None = None, privacy: Literal['private', 'public']='public', properties: DailyRoomProperties = <factory>)[source]

Bases: BaseModel

Parameters for creating a Daily room.

Parameters:

  • name – Optional custom name for the room.

  • privacy – Room privacy setting (‘private’ or ‘public’).

  • properties – Room configuration properties.

name: str | None
privacy: Literal['private', 'public']
properties: DailyRoomProperties
class pipecat.transports.daily.utils.DailyRoomObject(*, id: str, name: str, api_created: bool, privacy: str, url: str, created_at: str, config: DailyRoomProperties)[source]

Bases: BaseModel

Represents a Daily room returned by the API.

Parameters:

  • id – Unique room identifier.

  • name – Room name.

  • api_created – Whether room was created via API.

  • privacy – Room privacy setting (‘private’ or ‘public’).

  • url – Full URL for joining the room.

  • created_at – Timestamp of room creation in ISO 8601 format (e.g., “2019-01-26T09:01:22.000Z”).

  • config – Room configuration properties.

id: str
name: str
api_created: bool
privacy: str
url: str
created_at: str
config: DailyRoomProperties
class pipecat.transports.daily.utils.DailyMeetingTokenProperties(*, room_name: str | None = None, eject_at_token_exp: bool | None = None, eject_after_elapsed: int | None = None, nbf: int | None = None, exp: int | None = None, is_owner: bool | None = None, user_name: str | None = None, user_id: str | None = None, enable_screenshare: bool | None = None, start_video_off: bool | None = None, start_audio_off: bool | None = None, enable_recording: Literal['cloud', 'cloud-audio-only', 'local', 'raw-tracks'] | None = None, enable_prejoin_ui: bool | None = None, start_cloud_recording: bool | None = None, permissions: dict[str, Any] | None = None)[source]

Bases: BaseModel

Properties for configuring a Daily meeting token.

Refer to the Daily API documentation for more information: https://docs.daily.co/reference/rest-api/meeting-tokens/create-meeting-token#properties

Parameters:

  • room_name – The room for which this token is valid. If not set, the token is valid for all rooms in your domain.

  • eject_at_token_exp – If True, the user will be ejected from the room when the token expires.

  • eject_after_elapsed – The number of seconds after which the user will be ejected from the room.

  • nbf – Not before timestamp - users cannot join with this token before this time.

  • exp – Expiration time (unix timestamp in seconds). Strongly recommended for security.

  • is_owner – If True, the token will grant owner privileges in the room.

  • user_name – The name of the user. This will be added to the token payload.

  • user_id – A unique identifier for the user. This will be added to the token payload.

  • enable_screenshare – If True, the user will be able to share their screen.

  • start_video_off – If True, the user’s video will be turned off when they join the room.

  • start_audio_off – If True, the user’s audio will be turned off when they join the room.

  • enable_recording – Recording settings for the token. Must be one of ‘cloud’, ‘cloud-audio-only’, ‘local’ or ‘raw-tracks’.

  • enable_prejoin_ui – If True, the user will see the prejoin UI before joining the room.

  • start_cloud_recording – Start cloud recording when the user joins the room.

  • permissions – Specifies the initial default permissions for a non-meeting-owner participant.

room_name: str | None
eject_at_token_exp: bool | None
eject_after_elapsed: int | None
nbf: int | None
exp: int | None
is_owner: bool | None
user_name: str | None
user_id: str | None
enable_screenshare: bool | None
start_video_off: bool | None
start_audio_off: bool | None
enable_recording: Literal['cloud', 'cloud-audio-only', 'local', 'raw-tracks'] | None
enable_prejoin_ui: bool | None
start_cloud_recording: bool | None
permissions: dict[str, Any] | None
class pipecat.transports.daily.utils.DailyMeetingTokenParams(*, properties: DailyMeetingTokenProperties = <factory>)[source]

Bases: BaseModel

Parameters for creating a Daily meeting token.

Refer to the Daily API documentation for more information: https://docs.daily.co/reference/rest-api/meeting-tokens/create-meeting-token#body-params

Parameters:

properties – Meeting token configuration properties.

properties: DailyMeetingTokenProperties
class pipecat.transports.daily.utils.DailyRESTHelper(*, daily_api_key: str, daily_api_url: str = 'https://api.daily.co/v1', aiohttp_session: ClientSession)[source]

Bases: object

Helper class for interacting with Daily’s REST API.

Provides methods for creating, managing, and accessing Daily rooms.

__init__(*, daily_api_key: str, daily_api_url: str = 'https://api.daily.co/v1', aiohttp_session: ClientSession)[source]

Initialize the Daily REST helper.

Parameters:

  • daily_api_key – Your Daily API key.

  • daily_api_url – Daily API base URL (e.g. “https://api.daily.co/v1”).

  • aiohttp_session – Async HTTP session for making requests.

get_name_from_url(room_url: str) → str[source]

Extract room name from a Daily room URL.

Parameters:

room_url – Full Daily room URL.

Returns:

Room name portion of the URL.

async get_room_from_url(room_url: str) → DailyRoomObject[source]

Get room details from a Daily room URL.

Parameters:

room_url – Full Daily room URL.

Returns:

DailyRoomObject instance for the room.

async create_room(params: DailyRoomParams) → DailyRoomObject[source]

Create a new Daily room.

Parameters:

params – Room configuration parameters.

Returns:

DailyRoomObject instance for the created room.

Raises:

Exception – If room creation fails or response is invalid.

async get_token(room_url: str, expiry_time: float = 3600, eject_at_token_exp: bool = False, owner: bool = True, params: DailyMeetingTokenParams | None = None) → str[source]

Generate a meeting token for user to join a Daily room.

Parameters:

  • room_url – Daily room URL.

  • expiry_time – Token validity duration in seconds (default: 1 hour).

  • eject_at_token_exp – Whether to eject user when token expires.

  • owner – Whether token has owner privileges.

  • params – Optional additional token properties. Note that room_name, exp, and is_owner will be set based on the other function parameters regardless of values in params.

Returns:

Meeting token.

Raises:

Exception – If token generation fails or room URL is missing.

async delete_room_by_url(room_url: str) → bool[source]

Delete a room using its URL.

Parameters:

room_url – Daily room URL.

Returns:

True if deletion was successful.

async delete_room_by_name(room_name: str) → bool[source]

Delete a room using its name.

Parameters:

room_name – Name of the room to delete.

Returns:

True if deletion was successful.

Raises:

Exception – If deletion fails (excluding 404 Not Found).