bot() entry point function receives different types of arguments depending on the session type. These classes represent the structure of those arguments.
PipecatSessionArguments
Standard Pipecat Cloud agent session arguments, used for basic sessions.Properties
DailySessionArguments
Arguments for sessions that involve Daily WebRTC rooms for voice/video interaction.Properties
WebSocketSessionArguments
Arguments for sessions that use WebSocket connections for real-time communication.Properties
SmallWebRTCSessionArguments
Session arguments for an agent usingSmallWebRTCTransport.
pipecat-ai’s SmallWebRTCRunnerArguments, so it carries that
type’s fields alongside session_id.
MOQSessionArguments
Session arguments for a Media over QUIC session, which the agent’s transport uses to dial the relay in its region.pipecat-ai’s MOQRunnerArguments, so create_transport takes its
"moq" entry for it. MoQ on Pipecat Cloud needs pipecat-ai[moq] 1.13.0 or
newer. With a pipecat-ai older than 1.12.0, MOQSessionArguments doesn’t
exist and importing it raises ImportError.
Properties
The relay URL the bot dials, with the session’s credential in its query
string. It is kept out of the object’s
repr; keep it out of your logs too.Scopes the session: the bot publishes under
<namespace>/<participant_id>
and subscribes to <namespace>/<peer_id>.SessionArguments
The base type the others share. It contributessession_id and serves as a
marker, so you can annotate a handler that accepts any session type:
Every concrete type above lists its
pipecat-ai runner base first and
SessionArguments second. That ordering is what lets pipecat-ai’s own
session_id win once it defines one, so don’t reorder the bases if you
subclass these yourself.