Session
TheSession class is the primary way to start and interact with agent sessions.
Constructor Parameters
Methods
Starts a new session with the specified agent.ReturnsA dictionary containing session information. If
use_daily is True, includes dailyRoom URL and dailyToken.RaisesAgentStartError: If the session fails to start due to missing API key, agent not found, agent not ready, or capacity limits.SessionParams
TheSessionParams class allows you to configure a session.
Parameters
Optional dictionary of data to pass to the agent. Must be JSON-serializable.
If True, creates a Daily WebRTC room for the session, enabling voice
interaction.
Optional dictionary of properties to configure the Daily room. Only used when
use_daily=True.See Daily API
documentation for
available properties.SmallWebRTCSessionManager
Coordinates the wait between a Pipecat Cloud session starting and aSmallWebRTCTransport connection arriving. A room-less SmallWebRTC bot is
activated over HTTP before the WebRTC connection exists, so the entry point has
to wait for it rather than proceed immediately.
Constructor Parameters
Methods
Waits for the WebRTC connection.Raises
TimeoutError if no connection arrives within timeout_seconds.
RuntimeError if a wait is already in progress — one manager handles one wait at a time.Releases a pending wait, cancelling its timeout. Returns
True if there was a
wait to complete, False otherwise.