Session Arguments

When creating agents with Pipecat Cloud, your bot() entry point function receives different types of arguments depending on the session type. These classes represent the structure of those arguments.

These types subclass pipecat-ai’s runner argument types, and pipecat-ai is an optional dependency of pipecatcloud. Importing anything from pipecatcloud.agent without it raises an ImportError. Install the extra:

uv add "pipecatcloud[pipecat]"

Agent images built on pipecat-base already have pipecat-ai; the extra matters when you install pipecatcloud yourself.

PipecatSessionArguments

Standard Pipecat Cloud agent session arguments, used for basic sessions.

from pipecatcloud.agent import PipecatSessionArguments

def bot(args: PipecatSessionArguments):
    print(f"Session ID: {args.session_id}")
    print(f"Custom data: {args.body}")

Properties

Optional[str]

The unique identifier for the current session.

Any

The custom data passed to the agent via the session parameters.

DailySessionArguments

Arguments for sessions that involve Daily WebRTC rooms for voice/video interaction.

from pipecat.runner.types import DailyRunnerArguments

def bot(args: DailyRunnerArguments):
    print(f"Session ID: {args.session_id}")
    print(f"Daily room URL: {args.room_url}")
    print(f"Daily token: {args.token}")
    print(f"Custom data: {args.body}")

Properties

Optional[str]

The unique identifier for the current session.

str

The URL for the Daily room.

str | None

The authentication token for the Daily room.

Any

The custom data passed to the agent via the session parameters.

WebSocketSessionArguments

Arguments for sessions that use WebSocket connections for real-time communication.

from pipecat.runner.types import WebSocketRunnerArguments

async def bot(args: WebSocketRunnerArguments):
    print(f"Session ID: {args.session_id}")
    await args.websocket.send_text("Hello from the agent!")

Properties

Optional[str]

The unique identifier for the current session.

WebSocket

The FastAPI WebSocket connection used to communicate with the client.

SmallWebRTCSessionArguments

Session arguments for an agent using SmallWebRTCTransport.

from pipecatcloud.agent import SmallWebRTCSessionArguments

async def bot(args: SmallWebRTCSessionArguments):
    print(f"Session ID: {args.session_id}")

Subclasses pipecat-ai’s SmallWebRTCRunnerArguments, so it carries that type’s fields alongside session_id.