Skip to main content
The generic WebSocket endpoint is a protocol-agnostic way to connect a WebSocket client to your Pipecat Cloud agent. Unlike the provider-specific endpoints (/ws/twilio, /ws/plivo, etc.), it imposes no protocol requirements. Messages are relayed directly between the client and your bot without validation or transformation.

When to Use

  • Telephony providers: Connect any telephony provider that supports WebSocket audio streaming.
  • Server-to-server integrations: Connect your own backend or a third-party platform over WebSocket.
  • Custom WebSocket clients: Any client that can establish a WebSocket connection.
Web and mobile clients: Browsers and mobile apps can connect via WebSocket, but we recommend WebRTC instead. WebRTC handles varying network conditions, media quality, and reconnect behavior better than raw WebSocket. See the Daily WebRTC guide or the SmallWebRTC client SDKs for recommended web and mobile options.

Endpoint

wss://{region}.api.pipecat.daily.co/ws/generic/{agentName}.{organizationName}
The service host ({agentName}.{organizationName}) can also be provided as a query parameter:
wss://{region}.api.pipecat.daily.co/ws/generic?serviceHost={agentName}.{organizationName}

Authentication

The generic endpoint supports optional HMAC token authentication, controlled by the websocket_auth setting on your agent. See the WebSocket Authentication guide for details on how to configure and use token authentication. When websocket_auth is set to none, clients can connect directly without a token:
wscat -c "wss://us-west.api.pipecat.daily.co/ws/generic/my-agent.my-org"

Message Format

The generic endpoint supports both text and binary WebSocket frames. Your bot receives messages exactly as sent by the client — no protocol-specific parsing or transformation is applied. Your bot code is responsible for handling the client’s message format. Use the appropriate serializer for your client’s protocol, or implement custom message handling for non-standard clients.