Skip to main content

Pipecat AI Prebuilt

A simple, ready-to-use prebuilt client supporting all Pipecat transports.

This prebuilt client provides a lightweight UI to quickly test and verify transport behavior without needing a custom implementation.

Ideal for development, debugging, and quick prototyping.


📦 Installation & Usage

If you just want to use the prebuilt client in your own Python project:

✅ Install from PyPI

pip install pipecat-ai-prebuilt

🧰 Example Usage

from fastapi import FastAPI
from fastapi.responses import RedirectResponse
from pipecat_ai_prebuilt.frontend import PipecatPrebuiltUI

app = FastAPI()

# Mount the frontend at /client
app.mount("/client", PipecatPrebuiltUI)

@app.get("/", include_in_schema=False)
async def root_redirect():
    return RedirectResponse(url="/client/")

🧪 Try a Sample App

Want to see it in action? Check out our sample app demonstrating how to use this module:

⌨ Development Quick Start

If you want to work on the prebuilt client itself or use it locally in development:

📋 Prerequisites

  • Node.js (for building the client)
  • uv (recommended for Python dependency management)

🔧 Set Up the Environment

  1. Clone the Repository
git clone https://github.com/pipecat-ai/pipecat-prebuilt.git
cd pipecat-ai-prebuilt
  1. Build the Client

The Python package serves a built React client, so you need to build it first:

cd client
npm install
npm run build
cd ..

This creates the client/dist/ directory that the Python package will serve.

  1. Try the Sample App

Now you can test the local package with the sample app:

cd test
uv sync  # Installs dependencies and the local package in editable mode
uv run bot.py

Then open http://localhost:7860 in your browser.

🚀 Publishing

Publishing is automated via GitHub Actions using trusted publishing (no API tokens needed).

Prerequisites

  1. Update the version in pyproject.toml:

    version = "1.0.0"
    
  2. Create a git tag:

    git tag -m v1.0.0 v1.0.0
    git push --tags origin
    

Publishing Process

  1. Go to GitHub Actions in your repository
  2. Select the "publish" workflow
  3. Click "Run workflow"
  4. Enter the git tag (e.g., v1.0.0)
  5. Click "Run workflow"

The workflow will:

  • Build the client (React/Vite)
  • Bundle it into the Python package
  • Build the Python package with version from pyproject.toml
  • Publish to both Test PyPI and PyPI

Testing Before Production

To test publishing without creating a release:

  1. Use the publish-test workflow (publishes to Test PyPI only):

    • Go to GitHub Actions → "publish-test" workflow
    • Click "Run workflow"
    • No git tag needed!
  2. Install from Test PyPI:

    pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ pipecat-ai-prebuilt
    
  3. Test your changes, then use the regular publish workflow for production

Local Build Testing

To test the build locally before publishing, use the provided build script. It builds the React client, bundles it into the Python package, and produces the distribution artifacts in dist/.

Run from the repo root:

./scripts/local_build.sh

The script will:

  1. Clear any previous dist/ artifacts
  2. Install client npm dependencies
  3. Build the React client (client/dist/)
  4. Copy the built client into the Python package
  5. Build the Python package with uv build
  6. Clean up the temporary client copy

The resulting .whl and .tar.gz files will be in dist/. You can install the wheel directly to test it:

pip install dist/pipecat_ai_prebuilt-*.whl

Metadata

Release files for pipecat-ai-prebuilt 1.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pipecat-ai-prebuilt 1.4.0
File Size Uploaded Provenance Actions
pipecat_ai_prebuilt-1.4.0.tar.gz 997.6 kB With provenance Details for pipecat_ai_prebuilt-1.4.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pipecat-ai-prebuilt 1.4.0
File Interpreter ABI Platform Actions
pipecat_ai_prebuilt-1.4.0-py3-none-any.whl Python 3 none any Details for pipecat_ai_prebuilt-1.4.0-py3-none-any.whl

Total release size: 2.0 MB

Release files / pipecat_ai_prebuilt-1.4.0.tar.gz

Download URL pipecat_ai_prebuilt-1.4.0.tar.gz
Size 997.6 kB
Tags Source
SHA-256 checksum
How to use checksums
c1535e7585efda245b53573d0e13fdd16c47828ae991927d924cf08651c79397
BLAKE2b-256 checksum
How to use checksums
c807dc6ed6fb233411c912be32f8abb24336d6a455aa8fbbc5ff96e1ff86db4d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 9, 2026.

Transparency log

Release files / pipecat_ai_prebuilt-1.4.0-py3-none-any.whl

Download URL pipecat_ai_prebuilt-1.4.0-py3-none-any.whl
Size 1.0 MB
Tags Python 3
SHA-256 checksum
How to use checksums
8826315c6ec70cb355c24421faf9bc7de9843c2891174e3e949aa1aa59275bce
BLAKE2b-256 checksum
How to use checksums
ef02108601f64733024bb9f97c36e5958169170dd60f84291a28b53184acda08
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 9, 2026.

Transparency log

Security for pipecat-ai-prebuilt 1.4.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for pipecat_ai_prebuilt-1.4.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 9, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page