This repository provides the official web client SDKs for Pipecat, an open-source Python framework for building real-time voice and multimodal AI applications. It targets frontend developers and researchers looking to integrate voice-based AI interactions into web applications, offering robust handling of media streams, bot configuration, and session management.

How It Works

The SDK is structured as a monorepo with two main packages: client-js for a core JavaScript/TypeScript client and client-react for React-specific components and hooks. It abstracts away the complexities of device and media stream management, bot communication, and session state. A key design principle is the separation of concerns, requiring an external "transport" package (e.g., @pipecat-ai/daily-transport for WebRTC via Daily) to handle the actual data transmission, allowing flexibility in choosing communication protocols.

Quick Start & Requirements

• Install core JS client: npm install @pipecat-ai/client-js
• Install React components: npm install @pipecat-ai/client-react
• Install a transport layer (e.g., Daily): npm install @pipecat-ai/daily-transport
• Requires a server-side endpoint for authentication and secret management.
• Documentation: https://docs.pipecat.ai/client/introduction

Highlighted Details

• Provides JavaScript/TypeScript SDK and React components/hooks.
• Handles device and media stream management.
• Manages bot configuration, actions, messages, and session state.
• Requires external transport packages for data transmission.

Maintenance & Community

• Community contributions are welcomed via issues, discussions, and pull requests.
• Support channels include Discord and X.

Licensing & Compatibility

• The repository does not explicitly state a license in the provided README.

Limitations & Caveats

The SDK does not include any transport capabilities out-of-the-box, necessitating the installation and configuration of separate transport packages. Server-side endpoints are recommended for secure handling of API keys and authentication.