From 222b2444435032b3a4c5eedd178ffcf6b2a58460 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Fri, 12 Jun 2026 13:28:51 +0000 Subject: [PATCH] docs: deprecate WebsocketServerTransport (pipecat PR #4716) - Add deprecation warning to WebsocketServerTransport configuration section - Update single-client limitation note to reference deprecation - Add deprecation note to transport params table - Recommend FastAPIWebsocketTransport as replacement --- .../services/transport/transport-params.mdx | 6 +++++- .../services/transport/websocket-server.mdx | 20 ++++++++++++++----- 2 files changed, 20 insertions(+), 6 deletions(-) diff --git a/api-reference/server/services/transport/transport-params.mdx b/api-reference/server/services/transport/transport-params.mdx index b43e9ca5..5f26fe43 100644 --- a/api-reference/server/services/transport/transport-params.mdx +++ b/api-reference/server/services/transport/transport-params.mdx @@ -168,5 +168,9 @@ Each transport extends `TransportParams` with provider-specific fields: | [DailyTransport](/api-reference/server/services/transport/daily) | `DailyParams` | `api_key`, `api_url`, `dialin_settings`, `transcription_enabled`, `transcription_settings` | | [LiveKitTransport](/api-reference/server/services/transport/livekit) | `LiveKitParams` | (no additional fields) | | [SmallWebRTCTransport](/api-reference/server/services/transport/small-webrtc) | `TransportParams` | Uses base class directly | -| [WebsocketServerTransport](/api-reference/server/services/transport/websocket-server) | `WebsocketServerParams` | `add_wav_header`, `serializer`, `session_timeout` | +| [WebsocketServerTransport](/api-reference/server/services/transport/websocket-server) | `WebsocketServerParams` | `add_wav_header`, `serializer`, `session_timeout` **(deprecated)** | | [FastAPIWebsocketTransport](/api-reference/server/services/transport/fastapi-websocket) | `FastAPIWebsocketParams` | `serializer`, `session_timeout` | + + +**WebsocketServerTransport** is deprecated as of version 1.4.0. Use [FastAPIWebsocketTransport](/api-reference/server/services/transport/fastapi-websocket) instead. + diff --git a/api-reference/server/services/transport/websocket-server.mdx b/api-reference/server/services/transport/websocket-server.mdx index 9edc4c43..649200da 100644 --- a/api-reference/server/services/transport/websocket-server.mdx +++ b/api-reference/server/services/transport/websocket-server.mdx @@ -82,6 +82,14 @@ Before using WebSocket transports, you need: ### WebsocketServerTransport + +**Deprecated in version 1.4.0** + +`WebsocketServerTransport` is deprecated and will be removed in a future version. It was intended for development and testing only and has a critical limitation: it only supports a single client at a time. + +Use [FastAPIWebsocketTransport](/api-reference/server/services/transport/fastapi-websocket) instead for production use. + + Transport configuration parameters. @@ -277,11 +285,13 @@ async def on_disconnected(transport, websocket): | `transport` | `WebsocketClientTransport` | The transport instance | | `websocket` | `WebSocketClientProtocol` | The WebSocket connection object | - - The WebSocket server only supports one client connection at a time. If a new - client connects while one is already connected, the existing connection will - be closed. - + +**Single Client Limitation** + +The WebSocket server only supports one client connection at a time. If a new client connects while one is already connected, the existing connection will be closed. + +This limitation is why `WebsocketServerTransport` is deprecated in favor of [FastAPIWebsocketTransport](/api-reference/server/services/transport/fastapi-websocket), which supports multiple concurrent clients. + ## Additional Resources