The Client SDKs are currently in transition to a new, simpler API design. The js and react libraries have already been deployed with these changes. Their corresponding documentation along with this top-level documentation has been updated to reflect the latest changes. For transitioning to the new API, please refer to the migration guide. Note that iOS and Android SDKs are still in the process of being updated and their documentation will be updated once the new versions are released. If you have any questions or need assistance, please reach out to us on Discord.
Javascript
Pipecat JS SDK
React
Pipecat React SDK
React Native
Pipecat React Native SDK
Swift
Pipecat iOS SDK
Kotlin
Pipecat Android SDK
C++
Pipecat C++ SDK
Core Functionality
All Pipecat client SDKs provide:Media Management
Handle device inputs and media streams for audio and video
Bot Integration
Configure and communicate with your Pipecat bot
Session Management
Manage connection state and error handling
Core Types
PipecatClient
The main class for interacting with Pipecat bots. It is the primary type you will interact with.Transport
ThePipecatClient
wraps a Transport, which defines and provides the underlying connection mechanism (e.g., WebSocket, WebRTC). Your Pipecat pipeline will contain a corresponding transport.
RTVIMessage
Represents a message sent to or received from a Pipecat bot.Simple Usage Examples
Establish ongoing connections via WebSocket or WebRTC for:
- Live voice conversations
- Real-time video processing
- Continuous interactions
About RTVI
Pipecat’s client SDKs implement the RTVI (Real-Time Voice and Video Inference) standard, an open specification for real-time AI inference. This means:- Your code can work with any RTVI-compatible inference service
- You get battle-tested tooling for real-time multimedia handling
- You can easily set up development and testing environments