Update python-compatibility workflow to include new user project check

Update README with local dev setup for contributors

.github/workflows/android.yaml

@@ -1,48 +0,0 @@
-name: android
-
-on:
-  push:
-    branches:
-      - main
-    paths:
-      - "examples/simple-chatbot/client/android/**"
-  pull_request:
-    branches:
-      - "**"
-    paths:
-      - "examples/simple-chatbot/client/android/**"
-  workflow_dispatch:
-    inputs:
-      sdk_git_ref:
-        type: string
-        description: "Which git ref of the app to build"
-
-concurrency:
-  group: build-android-${{ github.event.pull_request.number || github.ref }}
-  cancel-in-progress: true
-
-jobs:
-  sdk:
-    name: "Simple chatbot demo"
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repo
-        uses: actions/checkout@v4
-        with:
-          ref: ${{ github.event.inputs.sdk_git_ref || github.ref }}
-
-      - name: "Install Java"
-        uses: actions/setup-java@v4
-        with:
-          distribution: 'temurin'
-          java-version: '17'
-
-      - name: Build demo app
-        working-directory: examples/simple-chatbot/client/android
-        run: ./gradlew :simple-chatbot-client:assembleDebug
-
-      - name: Upload demo APK
-        uses: actions/upload-artifact@v4
-        with:
-          name: Simple Chatbot Android Client
-          path: examples/simple-chatbot/client/android/simple-chatbot-client/build/outputs/apk/debug/simple-chatbot-client-debug.apk

.github/workflows/build.yaml

@@ -21,24 +21,20 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: Set up Python
-        id: setup_python
-        uses: actions/setup-python@v4
+      
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
         with:
-          python-version: '3.10'
-      - name: Setup virtual environment
-        run: |
-          python -m venv .venv
-      - name: Install basic Python dependencies
-        run: |
-          source .venv/bin/activate
-          python -m pip install --upgrade pip
-          pip install -r dev-requirements.txt
+          version: "latest"
+      
+      - name: Set up Python
+        run: uv python install 3.10
+      
+      - name: Install development dependencies
+        run: uv sync --group dev
+      
       - name: Build project
-        run: |
-          source .venv/bin/activate
-          python -m build
-      - name: Install project and other Python dependencies
-        run: |
-          source .venv/bin/activate
-          pip install --editable .
+        run: uv build
+      
+      - name: Install project in editable mode
+        run: uv pip install --editable .

.github/workflows/coverage.yaml

@@ -18,35 +18,28 @@ jobs:
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: "latest"
+
       - name: Set up Python
-        id: setup_python
-        uses: actions/setup-python@v4
-        with:
-          python-version: "3.10"
-      - name: Cache virtual environment
-        uses: actions/cache@v3
-        with:
-          # We are hashing dev-requirements.txt and test-requirements.txt which
-          # contain all dependencies needed to run the tests.
-          key: venv-${{ runner.os }}-${{ steps.setup_python.outputs.python-version}}-${{ hashFiles('dev-requirements.txt') }}-${{ hashFiles('test-requirements.txt') }}
-          path: .venv
+        run: uv python install 3.10
+
       - name: Install system packages
-        id: install_system_packages
         run: |
           sudo apt-get install -y portaudio19-dev
-      - name: Setup virtual environment
+
+      - name: Install dependencies
         run: |
-          python -m venv .venv
-      - name: Install basic Python dependencies
-        run: |
-          source .venv/bin/activate
-          python -m pip install --upgrade pip
-          pip install -r dev-requirements.txt -r test-requirements.txt
+          uv sync --group dev --extra anthropic --extra aws --extra google --extra langchain
+
       - name: Run tests with coverage
         run: |
-          source .venv/bin/activate
-          coverage run
-          coverage xml
+          uv run coverage run
+          uv run coverage xml
+
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v5
         with:

.github/workflows/format.yaml

@@ -17,30 +17,27 @@ concurrency:
 
 jobs:
   ruff-format:
-    name: "Formatting checker"
+    name: "Code quality checks"
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
-      - name: Set up Python
-        uses: actions/setup-python@v4
+      
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
         with:
-          python-version: "3.10"
-      - name: Setup virtual environment
-        run: |
-          python -m venv .venv
-      - name: Install development Python dependencies
-        run: |
-          source .venv/bin/activate
-          python -m pip install --upgrade pip
-          pip install -r dev-requirements.txt
+          version: "latest"
+      
+      - name: Set up Python
+        run: uv python install 3.10
+      
+      - name: Install development dependencies
+        run: uv sync --group dev
+      
       - name: Ruff formatter
         id: ruff-format
-        run: |
-          source .venv/bin/activate
-          ruff format --diff
-      - name: Ruff import linter
+        run: uv run ruff format --diff
+      
+      - name: Ruff linter (all rules)
         id: ruff-check
-        run: |
-          source .venv/bin/activate
-          ruff check --select I
+        run: uv run ruff check

.github/workflows/publish.yaml

@@ -5,7 +5,7 @@ on:
     inputs:
       gitref:
         type: string
-        description: "what git ref to build"
+        description: "what git tag to build (e.g. v0.0.74)"
         required: true
 
 jobs:
@@ -17,23 +17,17 @@ jobs:
         uses: actions/checkout@v4
         with:
           ref: ${{ github.event.inputs.gitref }}
-      - name: Set up Python
-        id: setup_python
-        uses: actions/setup-python@v4
+      
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
         with:
-          python-version: '3.10'
-      - name: Setup virtual environment
-        run: |
-          python -m venv .venv
-      - name: Install basic Python dependencies
-        run: |
-          source .venv/bin/activate
-          python -m pip install --upgrade pip
-          pip install -r dev-requirements.txt
+          version: "latest"
+      - name: Set up Python
+        run: uv python install 3.10
+      - name: Install development dependencies
+        run: uv sync --group dev
       - name: Build project
-        run: |
-          source .venv/bin/activate
-          python -m build
+        run: uv build
       - name: Upload wheels
         uses: actions/upload-artifact@v4
         with:

.github/workflows/publish_test.yaml

@@ -12,23 +12,16 @@ jobs:
         with:
           fetch-tags: true
           fetch-depth: 100
-      - name: Set up Python
-        id: setup_python
-        uses: actions/setup-python@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
         with:
-          python-version: '3.10'
-      - name: Setup virtual environment
-        run: |
-          python -m venv .venv
-      - name: Install basic Python dependencies
-        run: |
-          source .venv/bin/activate
-          python -m pip install --upgrade pip
-          pip install -r dev-requirements.txt
+          version: "latest"
+      - name: Set up Python
+        run: uv python install 3.10
+      - name: Install development dependencies
+        run: uv sync --group dev
       - name: Build project
-        run: |
-          source .venv/bin/activate
-          python -m build
+        run: uv build
       - name: Upload wheels
         uses: actions/upload-artifact@v4
         with:
@@ -38,7 +31,7 @@ jobs:
   publish-to-test-pypi:
     name: "Publish to Test PyPI"
     runs-on: ubuntu-latest
-    needs: [ build ]
+    needs: [build]
     environment:
       name: testpypi
       url: https://pypi.org/p/pipecat-ai

.github/workflows/python-compatibility.yaml

@@ -0,0 +1,123 @@
+name: Python Compatibility Test
+
+on:
+  push:
+    branches: [main, develop]
+    paths: ['pyproject.toml']
+  pull_request:
+    branches: [main, develop]
+    paths: ['pyproject.toml']
+
+jobs:
+  test-dev-environment:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.10.18', '3.11.13', '3.12.11', '3.13.5']
+
+    name: Dev Environment - Python ${{ matrix.python-version }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y \
+            portaudio19-dev \
+            libcairo2-dev \
+            libgirepository1.0-dev \
+            pkg-config
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: 'latest'
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: |
+          uv python install ${{ matrix.python-version }}
+          uv python pin ${{ matrix.python-version }}
+
+      - name: Test uv sync with all extras (Python < 3.13)
+        if: "!startsWith(matrix.python-version, '3.13.')"
+        run: |
+          uv sync --group dev --all-extras --no-extra krisp
+
+      - name: Test uv sync without PyTorch extras (Python 3.13+)
+        if: startsWith(matrix.python-version, '3.13.')
+        run: |
+          uv sync --group dev --all-extras \
+            --no-extra krisp \
+            --no-extra ultravox \
+            --no-extra local-smart-turn \
+            --no-extra moondream \
+            --no-extra mlx-whisper
+
+      - name: Verify dev installation
+        run: |
+          uv run python --version
+          uv run python -c "import pipecat; print('✅ Dev environment - Pipecat imports successfully')"
+
+  test-user-experience:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.10.18', '3.11.13', '3.12.11', '3.13.5']
+
+    name: User Experience - Python ${{ matrix.python-version }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y \
+            portaudio19-dev \
+            libcairo2-dev \
+            libgirepository1.0-dev \
+            pkg-config
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: 'latest'
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: |
+          uv python install ${{ matrix.python-version }}
+
+      - name: Build local package
+        run: |
+          uv build
+
+      - name: Create test project
+        run: |
+          mkdir test-project
+          cd test-project
+          uv init --python ${{ matrix.python-version }}
+
+      - name: Test comprehensive extras with uv add (Python 3.10-3.12)
+        if: "!startsWith(matrix.python-version, '3.13.')"
+        run: |
+          cd test-project
+          # Use uv add with built wheel to leverage dependency management
+          uv add "../dist/pipecat_ai-"*".whl[anthropic,assemblyai,asyncai,aws,aws-nova-sonic,azure,cartesia,cerebras,deepseek,daily,deepgram,elevenlabs,fal,fireworks,fish,gladia,google,grok,groq,gstreamer,heygen,inworld,koala,langchain,livekit,lmnt,local,mcp,mem0,mlx-whisper,moondream,nim,neuphonic,noisereduce,openai,openpipe,openrouter,perplexity,playht,qwen,rime,riva,runner,sambanova,sentry,local-smart-turn,remote-smart-turn,silero,simli,soniox,soundfile,speechmatics,tavus,together,tracing,ultravox,webrtc,websocket,whisper]"
+
+      - name: Test Python 3.13 compatible extras with uv add
+        if: startsWith(matrix.python-version, '3.13.')
+        run: |
+          cd test-project
+          # Use uv add with built wheel and Python 3.13 compatible extras
+          uv add "../dist/pipecat_ai-"*".whl[anthropic,assemblyai,asyncai,aws,aws-nova-sonic,azure,cartesia,cerebras,deepseek,daily,deepgram,elevenlabs,fal,fireworks,fish,gladia,google,grok,groq,gstreamer,heygen,inworld,koala,langchain,livekit,lmnt,local,mcp,mem0,nim,neuphonic,noisereduce,openai,openpipe,openrouter,perplexity,playht,qwen,rime,riva,runner,sambanova,sentry,remote-smart-turn,silero,simli,soniox,soundfile,speechmatics,tavus,together,tracing,webrtc,websocket,whisper]"
+
+      - name: Verify user installation
+        run: |
+          cd test-project
+          uv run python --version
+          uv run python -c "import pipecat; print('✅ User experience - Pipecat imports successfully')"
+          # Test that basic functionality works
+          uv run python -c "from pipecat.pipeline.pipeline import Pipeline; print('✅ Pipeline import works')"

.github/workflows/sync-quickstart.yaml

@@ -0,0 +1,56 @@
+name: Sync Quickstart to pipecat-quickstart repo
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'examples/quickstart/**'
+  workflow_dispatch: # Manual trigger
+
+jobs:
+  sync-quickstart:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout main repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Checkout quickstart repo
+        uses: actions/checkout@v4
+        with:
+          repository: pipecat-ai/pipecat-quickstart
+          token: ${{ secrets.QUICKSTART_SYNC_TOKEN }}
+          path: quickstart-repo
+
+      - name: Sync files (excluding READMEs)
+        run: |
+          # Copy code files only, skip READMEs
+          cp examples/quickstart/bot.py quickstart-repo/
+          cp examples/quickstart/requirements.txt quickstart-repo/
+          cp examples/quickstart/env.example quickstart-repo/
+
+          # Copy any other files that aren't README.md
+          find examples/quickstart -type f \
+            -not -name "README.md" \
+            -not -name "*.md" \
+            -exec cp {} quickstart-repo/ \;
+
+      - name: Commit and push changes
+        run: |
+          cd quickstart-repo
+          git config user.name "GitHub Action"
+          git config user.email "action@github.com"
+          git add .
+
+          # Only commit if there are changes
+          if ! git diff --staged --quiet; then
+            git commit -m "Sync from pipecat main repo
+            
+            Updated files from examples/quickstart/
+            Commit: ${{ github.sha }}
+            "
+            git push
+          else
+            echo "No changes to sync"
+          fi

.github/workflows/tests.yaml

@@ -22,31 +22,23 @@ jobs:
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: "latest"
+
       - name: Set up Python
-        id: setup_python
-        uses: actions/setup-python@v4
-        with:
-          python-version: "3.10"
-      - name: Cache virtual environment
-        uses: actions/cache@v3
-        with:
-          # We are hashing dev-requirements.txt and test-requirements.txt which
-          # contain all dependencies needed to run the tests.
-          key: venv-${{ runner.os }}-${{ steps.setup_python.outputs.python-version}}-${{ hashFiles('dev-requirements.txt') }}-${{ hashFiles('test-requirements.txt') }}
-          path: .venv
+        run: uv python install 3.10
+
       - name: Install system packages
-        id: install_system_packages
         run: |
           sudo apt-get install -y portaudio19-dev
-      - name: Setup virtual environment
+
+      - name: Install dependencies
         run: |
-          python -m venv .venv
-      - name: Install basic Python dependencies
-        run: |
-          source .venv/bin/activate
-          python -m pip install --upgrade pip
-          pip install -r dev-requirements.txt -r test-requirements.txt
+          uv sync --group dev --extra anthropic --extra aws --extra google --extra langchain
+
       - name: Test with pytest
         run: |
-          source .venv/bin/activate
-          pytest
+          uv run pytest

.github/workflows/update-lockfile.yaml

@@ -0,0 +1,42 @@
+name: Update lockfile
+
+on:
+  push:
+    paths:
+      - 'pyproject.toml'
+    branches:
+      - main
+  workflow_dispatch: # Allows manual triggering from GitHub UI
+
+jobs:
+  update-lockfile:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # This gives the workflow permission to push back to the repo
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v1
+
+      - name: Update lockfile
+        run: uv lock
+
+      - name: Check for changes
+        id: verify-changed-files
+        run: |
+          if [ -n "$(git status --porcelain)" ]; then
+            echo "changed=true" >> $GITHUB_OUTPUT
+          else
+            echo "changed=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Commit lockfile
+        if: steps.verify-changed-files.outputs.changed == 'true'
+        run: |
+          git config --local user.email "action@github.com"  
+          git config --local user.name "GitHub Action"
+          git add uv.lock
+          git commit -m "chore: update uv.lock after dependency changes"
+          git push

.gitignore

@@ -31,8 +31,6 @@ MANIFEST
 fly.toml
 
 # Examples
-examples/telnyx-chatbot/templates/streams.xml
-examples/twilio-chatbot/templates/streams.xml
 examples/**/node_modules/
 examples/**/.expo/
 examples/**/dist/
@@ -50,4 +48,7 @@ examples/**/web-build/
 
 # Documentation
 docs/api/_build/
-docs/api/api
+docs/api/api
+
+# uv
+.python-version

.pre-commit-config.yaml

@@ -1,8 +1,8 @@
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.9.7
+    rev: v0.12.1
     hooks:
       - id: ruff
         language_version: python3
-        args: [ --select,  I, ]
+        args: [--fix]
       - id: ruff-format

.readthedocs.yaml

@@ -9,22 +9,14 @@ build:
     - python3-dev
     - libasound2-dev
   jobs:
-    pre_build:
-      - python -m pip install --upgrade pip
-      - pip install wheel setuptools
-    post_build:
-      - echo "Build completed"
+    post_install:
+      - pip install uv
+      - UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --group docs --all-extras --no-extra krisp --no-extra gstreamer --no-extra ultravox --no-extra local_smart_turn --no-extra moondream --no-extra riva --no-extra mlx-whisper
 
 sphinx:
   configuration: docs/api/conf.py
   fail_on_warning: false
 
-python:
-  install:
-    - requirements: docs/api/requirements.txt
-    - method: pip
-      path: .
-
 search:
   ranking:
     api/*: 5

CONTRIBUTING.md

@@ -41,36 +41,150 @@ We use Ruff for code linting and formatting. Please ensure your code passes all
 
 We follow Google-style docstrings with these specific conventions:
 
-- Class docstrings should fully document all parameters used in `__init__`
-- We don't require separate docstrings for `__init__` methods when parameters are documented in the class docstring
-- Property methods should have docstrings explaining their purpose and return value
+**Regular Classes:**
 
-Example of correctly documented class:
+- Class docstring describes the class purpose and key functionality
+- `__init__` method has its own docstring with complete `Args:` section documenting all parameters
+- All public methods must have docstrings with `Args:` and `Returns:` sections as appropriate
+
+**Dataclasses:**
+
+- Class docstring describes the purpose and documents all fields in a `Parameters:` section
+- No `__init__` docstring (auto-generated)
+
+**Properties:**
+
+- Must have docstrings with `Returns:` section
+
+**Abstract Methods:**
+
+- Must have docstrings explaining what subclasses should implement
+
+**`__init__.py` Files:**
+
+- **Skip docstrings** for pure import/re-export modules
+- **Add brief docstrings** for top-level packages or those with initialization logic
+
+**Enums:**
+
+- Class docstring describes the enumeration purpose
+- Use `Parameters:` section to document each enum value and its meaning
+- No `__init__` docstring (Enums don't have custom constructors)
+
+**Code Examples in Docstrings:**
+
+- Use `Examples:` as a section header for multiple examples
+- Use descriptive text followed by double colons (`::`) for each example
+- **Always include a blank line after the `::"`**
+- Indent all code consistently within each block
+- Separate multiple examples with blank lines for readability
+
+**Lists and Bullets in Docstrings:**
+
+- Use dashes (`-`) for bullet points, not asterisks (`*`)
+- **Add a blank line before bullet lists** when they follow a colon
+- Use section headers like "Supported features:" or "Behavior:" before lists
+- For complex nested information, consider using paragraph format instead
+
+**Deprecations:**
+
+- Use `warnings.warn()` in code for runtime deprecation warnings
+- Add `.. deprecated::` directive in docstrings for documentation visibility
+- Include version information and describe current status
+- Describe parameters in present tense, use directive to indicate deprecation status
+
+#### Examples:
 
 ```python
-class MyClass:
-    """Class description.
+# Regular class
+class MyService(BaseService):
+    """Description of what the service does.
 
-    Additional details about the class.
+    Provides detailed explanation of the service's functionality,
+    key features, and usage patterns.
 
-    Args:
-        param1: Description of first parameter.
-        param2: Description of second parameter.
+    Supported features:
+
+    - Feature one with detailed explanation
+    - Feature two with additional context
+    - Feature three for advanced use cases
     """
 
-    def __init__(self, param1, param2):
-        # No docstring required here as parameters are documented above
-        self.param1 = param1
-        self.param2 = param2
+    def __init__(self, param1: str, old_param: str = None, **kwargs):
+        """Initialize the service.
+
+        Args:
+            param1: Description of param1.
+            old_param: Controls legacy behavior.
+
+                .. deprecated:: 1.2.0
+                    This parameter no longer has any effect and will be removed in version 2.0.
+
+            **kwargs: Additional arguments passed to parent.
+        """
+        if old_param is not None:
+            import warnings
+            warnings.warn(
+                "Parameter 'old_param' is deprecated and will be removed in version 2.0.",
+                DeprecationWarning,
+            )
+        super().__init__(**kwargs)
 
     @property
-    def some_property(self) -> str:
-        """Get the formatted property value.
+    def sample_rate(self) -> int:
+        """Get the current sample rate.
 
         Returns:
-            A string representation of the property.
+            The sample rate in Hz.
         """
-        return f"Property: {self.param1}"
+        return self._sample_rate
+
+    async def process_data(self, data: str) -> bool:
+        """Process the provided data.
+
+        Args:
+            data: The data to process.
+
+        Returns:
+            True if processing succeeded.
+        """
+        pass
+
+# Dataclass with code examples
+@dataclass
+class MessageFrame:
+    """Frame containing messages in OpenAI format.
+
+    Supports both simple and content list message formats.
+
+    Example::
+
+        [
+            {"role": "user", "content": "Hello"},
+            {"role": "assistant", "content": "Hi there!"}
+        ]
+
+    Parameters:
+        messages: List of messages in OpenAI format.
+    """
+
+    messages: List[dict]
+
+# Enum class
+class Status(Enum):
+    """Status codes for processing operations.
+
+    Parameters:
+        PENDING: Operation is queued but not started.
+        RUNNING: Operation is currently in progress.
+        COMPLETED: Operation finished successfully.
+        FAILED: Operation encountered an error.
+    """
+
+    PENDING = "pending"
+    RUNNING = "running"
+    COMPLETED = "completed"
+    FAILED = "failed"
 ```
 
 # Contributor Covenant Code of Conduct

Dockerfile

@@ -1,40 +0,0 @@
-# setup
-FROM python:3.11.5
-
-WORKDIR /app
-COPY requirements.txt /app
-COPY *.py /app
-COPY pyproject.toml /app
-
-COPY src/ /app/src/
-COPY examples/ /app/examples/
-
-WORKDIR /app
-RUN ls --recursive /app/
-RUN pip3 install --upgrade -r requirements.txt
-RUN python -m build .
-RUN pip3 install .
-RUN pip3 install gunicorn
-# If running on Ubuntu, Azure TTS requires some extra config
-# https://learn.microsoft.com/en-us/azure/ai-services/speech-service/quickstarts/setup-platform?pivots=programming-language-python&tabs=linux%2Cubuntu%2Cdotnetcli%2Cdotnet%2Cjre%2Cmaven%2Cnodejs%2Cmac%2Cpypi
-
-RUN wget -O - https://www.openssl.org/source/openssl-1.1.1w.tar.gz | tar zxf -
-WORKDIR openssl-1.1.1w
-RUN ./config --prefix=/usr/local
-RUN make -j $(nproc)
-RUN make install_sw install_ssldirs
-RUN ldconfig -v
-ENV SSL_CERT_DIR=/etc/ssl/certs
-
-#ENV LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH
-RUN apt clean
-RUN apt-get update
-RUN apt-get -y install build-essential libssl-dev ca-certificates libasound2 wget
-
-ENV PYTHONUNBUFFERED=1
-
-WORKDIR /app
-
-EXPOSE 8000
-# run
-CMD ["gunicorn", "--workers=2", "--log-level", "debug", "--chdir", "examples/server", "--capture-output", "daily-bot-manager:app", "--bind=0.0.0.0:8000"]

MANIFEST.in

@@ -0,0 +1,4 @@
+prune docs
+prune examples
+prune scripts
+prune tests

README.md

@@ -8,6 +8,8 @@
 
 **Pipecat** is an open-source Python framework for building real-time voice and multimodal conversational agents. Orchestrate audio and video, AI services, different transports, and conversation pipelines effortlessly—so you can focus on what makes your agent unique.
 
+> Want to dive right in? Try the [quickstart](https://docs.pipecat.ai/getting-started/quickstart).
+
 ## 🚀 What You Can Build
 
 - **Voice Assistants** – natural, streaming conversations with AI
@@ -29,11 +31,11 @@
 ## 🎬 See it in action
 
 <p float="left">
-    <a href="https://github.com/pipecat-ai/pipecat/tree/main/examples/simple-chatbot"><img src="https://raw.githubusercontent.com/pipecat-ai/pipecat/main/examples/simple-chatbot/image.png" width="400" /></a>&nbsp;
-    <a href="https://github.com/pipecat-ai/pipecat/tree/main/examples/storytelling-chatbot"><img src="https://raw.githubusercontent.com/pipecat-ai/pipecat/main/examples/storytelling-chatbot/image.png" width="400" /></a>
+    <a href="https://github.com/pipecat-ai/pipecat-examples/tree/main/simple-chatbot"><img src="https://raw.githubusercontent.com/pipecat-ai/pipecat-examples/main/simple-chatbot/image.png" width="400" /></a>&nbsp;
+    <a href="https://github.com/pipecat-ai/pipecat-examples/tree/main/storytelling-chatbot"><img src="https://raw.githubusercontent.com/pipecat-ai/pipecat-examples/main/storytelling-chatbot/image.png" width="400" /></a>
     <br/>
-    <a href="https://github.com/pipecat-ai/pipecat/tree/main/examples/translation-chatbot"><img src="https://raw.githubusercontent.com/pipecat-ai/pipecat/main/examples/translation-chatbot/image.png" width="400" /></a>&nbsp;
-    <a href="https://github.com/pipecat-ai/pipecat/tree/main/examples/moondream-chatbot"><img src="https://raw.githubusercontent.com/pipecat-ai/pipecat/main/examples/moondream-chatbot/image.png" width="400" /></a>
+    <a href="https://github.com/pipecat-ai/pipecat-examples/tree/main/translation-chatbot"><img src="https://raw.githubusercontent.com/pipecat-ai/pipecat-examples/main/translation-chatbot/image.png" width="400" /></a>&nbsp;
+    <a href="https://github.com/pipecat-ai/pipecat-examples/tree/main/moondream-chatbot"><img src="https://raw.githubusercontent.com/pipecat-ai/pipecat-examples/main/moondream-chatbot/image.png" width="400" /></a>
 </p>
 
 ## 📱 Client SDKs
@@ -49,97 +51,123 @@ You can connect to Pipecat from any platform using our official SDKs:
 
 ## 🧩 Available services
 
-| Category            | Services                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
-| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Speech-to-Text      | [AssemblyAI](https://docs.pipecat.ai/server/services/stt/assemblyai), [Azure](https://docs.pipecat.ai/server/services/stt/azure), [Deepgram](https://docs.pipecat.ai/server/services/stt/deepgram), [Fal Wizper](https://docs.pipecat.ai/server/services/stt/fal), [Gladia](https://docs.pipecat.ai/server/services/stt/gladia), [Google](https://docs.pipecat.ai/server/services/stt/google), [Groq (Whisper)](https://docs.pipecat.ai/server/services/stt/groq), [OpenAI (Whisper)](https://docs.pipecat.ai/server/services/stt/openai), [Parakeet (NVIDIA)](https://docs.pipecat.ai/server/services/stt/parakeet), [Ultravox](https://docs.pipecat.ai/server/services/stt/ultravox), [Whisper](https://docs.pipecat.ai/server/services/stt/whisper)                                                                                                                                                                                                                                            |
-| LLMs                | [Anthropic](https://docs.pipecat.ai/server/services/llm/anthropic), [Azure](https://docs.pipecat.ai/server/services/llm/azure), [Cerebras](https://docs.pipecat.ai/server/services/llm/cerebras), [DeepSeek](https://docs.pipecat.ai/server/services/llm/deepseek), [Fireworks AI](https://docs.pipecat.ai/server/services/llm/fireworks), [Gemini](https://docs.pipecat.ai/server/services/llm/gemini), [Grok](https://docs.pipecat.ai/server/services/llm/grok), [Groq](https://docs.pipecat.ai/server/services/llm/groq), [NVIDIA NIM](https://docs.pipecat.ai/server/services/llm/nim), [Ollama](https://docs.pipecat.ai/server/services/llm/ollama), [OpenAI](https://docs.pipecat.ai/server/services/llm/openai), [OpenRouter](https://docs.pipecat.ai/server/services/llm/openrouter), [Perplexity](https://docs.pipecat.ai/server/services/llm/perplexity), [Qwen](https://docs.pipecat.ai/server/services/llm/qwen), [Together AI](https://docs.pipecat.ai/server/services/llm/together) |
-| Text-to-Speech      | [AWS](https://docs.pipecat.ai/server/services/tts/aws), [Azure](https://docs.pipecat.ai/server/services/tts/azure), [Cartesia](https://docs.pipecat.ai/server/services/tts/cartesia), [Deepgram](https://docs.pipecat.ai/server/services/tts/deepgram), [ElevenLabs](https://docs.pipecat.ai/server/services/tts/elevenlabs), [FastPitch (NVIDIA)](https://docs.pipecat.ai/server/services/tts/fastpitch), [Fish](https://docs.pipecat.ai/server/services/tts/fish), [Google](https://docs.pipecat.ai/server/services/tts/google), [LMNT](https://docs.pipecat.ai/server/services/tts/lmnt), [Neuphonic](https://docs.pipecat.ai/server/services/tts/neuphonic), [OpenAI](https://docs.pipecat.ai/server/services/tts/openai), [Piper](https://docs.pipecat.ai/server/services/tts/piper), [PlayHT](https://docs.pipecat.ai/server/services/tts/playht), [Rime](https://docs.pipecat.ai/server/services/tts/rime), [XTTS](https://docs.pipecat.ai/server/services/tts/xtts)                       |
-| Speech-to-Speech    | [Gemini Multimodal Live](https://docs.pipecat.ai/server/services/s2s/gemini), [OpenAI Realtime](https://docs.pipecat.ai/server/services/s2s/openai)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
-| Transport           | [Daily (WebRTC)](https://docs.pipecat.ai/server/services/transport/daily), [FastAPI Websocket](https://docs.pipecat.ai/server/services/transport/fastapi-websocket), [SmallWebRTCTransport](https://docs.pipecat.ai/server/services/transport/small-webrtc), [WebSocket Server](https://docs.pipecat.ai/server/services/transport/websocket-server), Local                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
-| Video               | [Tavus](https://docs.pipecat.ai/server/services/video/tavus), [Simli](https://docs.pipecat.ai/server/services/video/simli)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
-| Memory              | [mem0](https://docs.pipecat.ai/server/services/memory/mem0)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
-| Vision & Image      | [fal](https://docs.pipecat.ai/server/services/image-generation/fal), [Google Imagen](https://docs.pipecat.ai/server/services/image-generation/fal), [Moondream](https://docs.pipecat.ai/server/services/vision/moondream)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
-| Audio Processing    | [Silero VAD](https://docs.pipecat.ai/server/utilities/audio/silero-vad-analyzer), [Krisp](https://docs.pipecat.ai/server/utilities/audio/krisp-filter), [Koala](https://docs.pipecat.ai/server/utilities/audio/koala-filter), [Noisereduce](https://docs.pipecat.ai/server/utilities/audio/noisereduce-filter)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
-| Analytics & Metrics | [Canonical AI](https://docs.pipecat.ai/server/services/analytics/canonical), [Sentry](https://docs.pipecat.ai/server/services/analytics/sentry)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| Category            | Services                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Speech-to-Text      | [AssemblyAI](https://docs.pipecat.ai/server/services/stt/assemblyai), [AWS](https://docs.pipecat.ai/server/services/stt/aws), [Azure](https://docs.pipecat.ai/server/services/stt/azure), [Cartesia](https://docs.pipecat.ai/server/services/stt/cartesia), [Deepgram](https://docs.pipecat.ai/server/services/stt/deepgram), [Fal Wizper](https://docs.pipecat.ai/server/services/stt/fal), [Gladia](https://docs.pipecat.ai/server/services/stt/gladia), [Google](https://docs.pipecat.ai/server/services/stt/google), [Groq (Whisper)](https://docs.pipecat.ai/server/services/stt/groq), [NVIDIA Riva](https://docs.pipecat.ai/server/services/stt/riva), [OpenAI (Whisper)](https://docs.pipecat.ai/server/services/stt/openai), [SambaNova (Whisper)](https://docs.pipecat.ai/server/services/stt/sambanova), [Soniox](https://docs.pipecat.ai/server/services/stt/soniox), [Speechmatics](https://docs.pipecat.ai/server/services/stt/speechmatics), [Ultravox](https://docs.pipecat.ai/server/services/stt/ultravox), [Whisper](https://docs.pipecat.ai/server/services/stt/whisper)                                                                                                                                                                                          |
+| LLMs                | [Anthropic](https://docs.pipecat.ai/server/services/llm/anthropic), [AWS](https://docs.pipecat.ai/server/services/llm/aws), [Azure](https://docs.pipecat.ai/server/services/llm/azure), [Cerebras](https://docs.pipecat.ai/server/services/llm/cerebras), [DeepSeek](https://docs.pipecat.ai/server/services/llm/deepseek), [Fireworks AI](https://docs.pipecat.ai/server/services/llm/fireworks), [Gemini](https://docs.pipecat.ai/server/services/llm/gemini), [Grok](https://docs.pipecat.ai/server/services/llm/grok), [Groq](https://docs.pipecat.ai/server/services/llm/groq), [NVIDIA NIM](https://docs.pipecat.ai/server/services/llm/nim), [Ollama](https://docs.pipecat.ai/server/services/llm/ollama), [OpenAI](https://docs.pipecat.ai/server/services/llm/openai), [OpenRouter](https://docs.pipecat.ai/server/services/llm/openrouter), [Perplexity](https://docs.pipecat.ai/server/services/llm/perplexity), [Qwen](https://docs.pipecat.ai/server/services/llm/qwen), [SambaNova](https://docs.pipecat.ai/server/services/llm/sambanova) [Together AI](https://docs.pipecat.ai/server/services/llm/together)                                                                                                                                                          |
+| Text-to-Speech      | [Async](https://docs.pipecat.ai/server/services/tts/asyncai), [AWS](https://docs.pipecat.ai/server/services/tts/aws), [Azure](https://docs.pipecat.ai/server/services/tts/azure), [Cartesia](https://docs.pipecat.ai/server/services/tts/cartesia), [Deepgram](https://docs.pipecat.ai/server/services/tts/deepgram), [ElevenLabs](https://docs.pipecat.ai/server/services/tts/elevenlabs), [Fish](https://docs.pipecat.ai/server/services/tts/fish), [Google](https://docs.pipecat.ai/server/services/tts/google), [Groq](https://docs.pipecat.ai/server/services/tts/groq), [Inworld](https://docs.pipecat.ai/server/services/tts/inworld), [LMNT](https://docs.pipecat.ai/server/services/tts/lmnt), [MiniMax](https://docs.pipecat.ai/server/services/tts/minimax), [Neuphonic](https://docs.pipecat.ai/server/services/tts/neuphonic), [NVIDIA Riva](https://docs.pipecat.ai/server/services/tts/riva), [OpenAI](https://docs.pipecat.ai/server/services/tts/openai), [Piper](https://docs.pipecat.ai/server/services/tts/piper), [PlayHT](https://docs.pipecat.ai/server/services/tts/playht), [Rime](https://docs.pipecat.ai/server/services/tts/rime), [Sarvam](https://docs.pipecat.ai/server/services/tts/sarvam), [XTTS](https://docs.pipecat.ai/server/services/tts/xtts) |
+| Speech-to-Speech    | [AWS Nova Sonic](https://docs.pipecat.ai/server/services/s2s/aws), [Gemini Multimodal Live](https://docs.pipecat.ai/server/services/s2s/gemini), [OpenAI Realtime](https://docs.pipecat.ai/server/services/s2s/openai)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| Transport           | [Daily (WebRTC)](https://docs.pipecat.ai/server/services/transport/daily), [FastAPI Websocket](https://docs.pipecat.ai/server/services/transport/fastapi-websocket), [SmallWebRTCTransport](https://docs.pipecat.ai/server/services/transport/small-webrtc), [WebSocket Server](https://docs.pipecat.ai/server/services/transport/websocket-server), Local                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| Serializers         | [Plivo](https://docs.pipecat.ai/server/utilities/serializers/plivo), [Twilio](https://docs.pipecat.ai/server/utilities/serializers/twilio), [Telnyx](https://docs.pipecat.ai/server/utilities/serializers/telnyx)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+| Video               | [HeyGen](https://docs.pipecat.ai/server/services/video/heygen), [Tavus](https://docs.pipecat.ai/server/services/video/tavus), [Simli](https://docs.pipecat.ai/server/services/video/simli)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| Memory              | [mem0](https://docs.pipecat.ai/server/services/memory/mem0)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+| Vision & Image      | [fal](https://docs.pipecat.ai/server/services/image-generation/fal), [Google Imagen](https://docs.pipecat.ai/server/services/image-generation/fal), [Moondream](https://docs.pipecat.ai/server/services/vision/moondream)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| Audio Processing    | [Silero VAD](https://docs.pipecat.ai/server/utilities/audio/silero-vad-analyzer), [Krisp](https://docs.pipecat.ai/server/utilities/audio/krisp-filter), [Koala](https://docs.pipecat.ai/server/utilities/audio/koala-filter), [Noisereduce](https://docs.pipecat.ai/server/utilities/audio/noisereduce-filter)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
+| Analytics & Metrics | [OpenTelemetry](https://docs.pipecat.ai/server/utilities/opentelemetry), [Sentry](https://docs.pipecat.ai/server/services/analytics/sentry)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
 📚 [View full services documentation →](https://docs.pipecat.ai/server/services/supported-services)
 
 ## ⚡ Getting started
 
-You can get started with Pipecat running on your local machine, then move your agent processes to the cloud when you’re ready.
+You can get started with Pipecat running on your local machine, then move your agent processes to the cloud when you're ready.
 
-```shell
-# Install the module
-pip install pipecat-ai
+1. Install uv
 
-# Set up your environment
-cp dot-env.template .env
-```
+   ```bash
+   curl -LsSf https://astral.sh/uv/install.sh | sh
+   ```
 
-To keep things lightweight, only the core framework is included by default. If you need support for third-party AI services, you can add the necessary dependencies with:
+   > **Need help?** Refer to the [uv install documentation](https://docs.astral.sh/uv/getting-started/installation/).
 
-```shell
-pip install "pipecat-ai[option,...]"
-```
+2. Install the module
+
+   ```bash
+   # For new projects
+   uv init my-pipecat-app
+   cd my-pipecat-app
+   uv add pipecat-ai
+
+   # Or for existing projects
+   uv add pipecat-ai
+   ```
+
+3. Set up your environment
+
+   ```bash
+   cp env.example .env
+   ```
+
+4. To keep things lightweight, only the core framework is included by default. If you need support for third-party AI services, you can add the necessary dependencies with:
+
+   ```bash
+   uv add "pipecat-ai[option,...]"
+   ```
+
+> **Using pip?** You can still use `pip install pipecat-ai` and `pip install "pipecat-ai[option,...]"` to get set up.
 
 ## 🧪 Code examples
 
 - [Foundational](https://github.com/pipecat-ai/pipecat/tree/main/examples/foundational) — small snippets that build on each other, introducing one or two concepts at a time
-- [Example apps](https://github.com/pipecat-ai/pipecat/tree/main/examples/) — complete applications that you can use as starting points for development
+- [Example apps](https://github.com/pipecat-ai/pipecat-examples) — complete applications that you can use as starting points for development
 
-## 🛠️ Hacking on the framework itself
+## 🛠️ Contributing to the framework
 
-1. Set up a virtual environment before following these instructions. From the root of the repo:
+### Prerequisites
 
-   ```shell
-   python3 -m venv venv
-   source venv/bin/activate
+**Python Version:** 3.10+
+
+### Setup Steps
+
+1. Clone the repository and navigate to it:
+
+   ```bash
+   git clone https://github.com/pipecat-ai/pipecat.git
+   cd pipecat
    ```
 
-2. Install the development dependencies:
+2. Install development and testing dependencies:
 
-   ```shell
-   pip install -r dev-requirements.txt
+   ```bash
+   uv sync --group dev --all-extras --no-extra gstreamer --no-extra krisp --no-extra local
    ```
 
-3. Install the git pre-commit hooks (these help ensure your code follows project rules):
+3. Install the git pre-commit hooks:
 
-   ```shell
-   pre-commit install
+   ```bash
+   uv run pre-commit install
    ```
 
-4. Install the `pipecat-ai` package locally in editable mode:
+### Python 3.13+ Compatibility
 
-   ```shell
-   pip install -e .
-   ```
+Some features require PyTorch, which doesn't yet support Python 3.13+. Install using:
 
-   > The `-e` or `--editable` option allows you to modify the code without reinstalling.
+```bash
+uv sync --group dev --all-extras \
+  --no-extra gstreamer \
+  --no-extra krisp \
+  --no-extra local \
+  --no-extra local-smart-turn \
+  --no-extra mlx-whisper \
+  --no-extra moondream \
+  --no-extra ultravox
+```
 
-5. Include optional dependencies as needed. For example:
+> **Tip:** For full compatibility, use Python 3.12: `uv python pin 3.12`
 
-   ```shell
-   pip install -e ".[daily,deepgram,cartesia,openai,silero]"
-   ```
-
-6. (Optional) If you want to use this package from another directory:
-
-   ```shell
-   pip install "path_to_this_repo[option,...]"
-   ```
+> **Note**: Some extras (local, gstreamer) require system dependencies. See documentation if you encounter build errors.
 
 ### Running tests
 
-Install the test dependencies:
+To run all tests, from the root directory:
 
-```shell
-pip install -r test-requirements.txt
+```bash
+uv run pytest
 ```
 
-From the root directory, run:
+Run a specific test suite:
 
-```shell
-pytest
+```bash
+uv run pytest tests/test_name.py
 ```
 
 ### Setting up your editor

dev-requirements.txt

@@ -1,13 +0,0 @@
-build~=1.2.2
-coverage~=7.6.12
-grpcio-tools~=1.67.1
-pip-tools~=7.4.1
-pre-commit~=4.0.1
-pyright~=1.1.397
-pytest~=8.3.4
-pytest-asyncio~=0.25.3
-pytest-aiohttp==1.1.0
-ruff~=0.11.1
-setuptools~=70.0.0
-setuptools_scm~=8.1.0
-python-dotenv~=1.0.1

docs/api/build-docs.sh

@@ -1,10 +1,27 @@
 #!/bin/bash
 
+# Build docs using uv
+echo "Installing dependencies with uv..."
+uv sync --group docs --all-extras --no-extra krisp --no-extra gstreamer --no-extra ultravox --no-extra local_smart_turn --no-extra moondream --no-extra riva --no-extra mlx-whisper
+
+# Check if sphinx-build is available
+if ! uv run sphinx-build --version &> /dev/null; then
+    echo "Error: sphinx-build is not available" >&2
+    exit 1
+fi
+
 # Clean previous build
 rm -rf _build
 
+echo "Building documentation..."
 # Build docs matching ReadTheDocs configuration
-sphinx-build -b html -d _build/doctrees . _build/html -W --keep-going
+uv run sphinx-build -b html -d _build/doctrees . _build/html -W --keep-going
 
-# Open docs (MacOS)
-open _build/html/index.html
+if [ $? -eq 0 ]; then
+    echo "Documentation built successfully!"
+    # Open docs (MacOS)
+    open _build/html/index.html
+else
+    echo "Documentation build failed!" >&2
+    exit 1
+fi

docs/api/conf.py

@@ -1,5 +1,7 @@
 import logging
+import os
 import sys
+from datetime import datetime
 from pathlib import Path
 
 # Configure logging
@@ -13,7 +15,8 @@ sys.path.insert(0, str(project_root / "src"))
 
 # Project information
 project = "pipecat-ai"
-copyright = "2024, Daily"
+current_year = datetime.now().year
+copyright = f"2024-{current_year}, Daily" if current_year > 2024 else "2024, Daily"
 author = "Daily"
 
 # General configuration
@@ -24,107 +27,60 @@ extensions = [
     "sphinx.ext.intersphinx",
 ]
 
+suppress_warnings = [
+    "autodoc.mocked_object",
+    "toc.not_included",
+]
+
 # Napoleon settings
 napoleon_google_docstring = True
-napoleon_numpy_docstring = False
 napoleon_include_init_with_doc = True
 
 # AutoDoc settings
 autodoc_default_options = {
     "members": True,
     "member-order": "bysource",
-    "special-members": "__init__",
-    "undoc-members": True,
-    "exclude-members": "__weakref__",
-    "no-index": True,
+    "undoc-members": False,
+    "exclude-members": "__weakref__,model_config",
     "show-inheritance": True,
 }
 
 # Mock imports for optional dependencies
 autodoc_mock_imports = [
-    "riva",
-    "livekit",
-    "pyht",  # Base PlayHT package
-    "pyht.async_client",  # PlayHT specific imports
-    "pyht.client",
-    "pyht.protos",
-    "pyht.protos.api_pb2",
-    "pipecat_ai_playht",  # PlayHT wrapper
-    "aiortc",
-    "aiortc.mediastreams",
-    "cv2",
-    "av",
-    "pyneuphonic",
-    "mem0",
-    "mlx_whisper",
-    "anthropic",
-    "assemblyai",
-    "boto3",
-    "azure",
-    "cartesia",
-    "deepgram",
-    "elevenlabs",
-    "fal",
-    "gladia",
-    "google",
-    "krisp",
-    "langchain",
-    "lmnt",
-    "noisereduce",
-    "openai",
-    "openpipe",
-    "simli",
-    "soundfile",
+    # Krisp - has build issues on some platforms
     "pipecat_ai_krisp",
-    "pyaudio",
+    "krisp",
+    # System-specific GUI libraries
     "_tkinter",
     "tkinter",
-    "daily",
-    "daily_python",
-    "pydantic.BaseModel",
-    "pydantic.Field",
-    "pydantic._internal._model_construction",
-    "pydantic._internal._fields",
-    # Moondream dependencies
-    "torch",
-    "transformers",
-    "intel_extension_for_pytorch",
-    # Ultravox dependencies
-    "huggingface_hub",
+    # Platform-specific audio libraries (if needed)
+    "gi",
+    "gi.require_version",
+    "gi.repository",
+    # OpenCV - sometimes has import issues during docs build
+    "cv2",
+    # Heavy ML packages excluded from ReadTheDocs
+    # ultravox dependencies
     "vllm",
     "vllm.engine.arg_utils",
+    # local-smart-turn dependencies
+    "coremltools",
+    "coremltools.models",
+    "coremltools.models.MLModel",
+    "torch",
+    "torch.nn",
+    "torch.nn.functional",
+    "torchaudio",
+    # moondream dependencies
+    "transformers",
     "transformers.AutoTokenizer",
-    # Langchain dependencies
-    "langchain_core",
-    "langchain_core.messages",
-    "langchain_core.runnables",
-    "langchain_core.messages.AIMessageChunk",
-    "langchain_core.runnables.Runnable",
-    # LiveKit dependencies
-    "livekit",
-    "livekit.rtc",
-    "livekit_api",
-    "livekit_protocol",
-    "tenacity",
-    "tenacity.retry",
-    "tenacity.stop_after_attempt",
-    "tenacity.wait_exponential",
-    "rtc",
-    "rtc.Room",
-    "rtc.RoomOptions",
-    "rtc.AudioSource",
-    "rtc.LocalAudioTrack",
-    "rtc.TrackPublishOptions",
-    "rtc.TrackSource",
-    "rtc.AudioStream",
-    "rtc.AudioFrameEvent",
-    "rtc.AudioFrame",
-    "rtc.Track",
-    "rtc.TrackKind",
-    "rtc.RemoteParticipant",
-    "rtc.RemoteTrackPublication",
-    "rtc.DataPacket",
-    # Riva dependencies
+    "transformers.AutoFeatureExtractor",
+    "AutoFeatureExtractor",
+    "timm",
+    "einops",
+    "intel_extension_for_pytorch",
+    "huggingface_hub",
+    # riva dependencies
     "riva",
     "riva.client",
     "riva.client.Auth",
@@ -134,96 +90,45 @@ autodoc_mock_imports = [
     "riva.client.AudioEncoding",
     "riva.client.proto.riva_tts_pb2",
     "riva.client.SpeechSynthesisService",
-    # Local CoreML Smart Turn dependencies
-    "coremltools",
-    "coremltools.models",
-    "coremltools.models.MLModel",
-    "torch",
-    "torch.nn",
-    "torch.nn.functional",
-    "transformers",
-    "transformers.AutoFeatureExtractor",
-    # Also add specific classes that are imported
-    "AutoFeatureExtractor",
+    # MLX dependencies (Apple Silicon specific)
+    "mlx",
+    "mlx_whisper",  # Note: might need underscore format too
 ]
 
 # HTML output settings
 html_theme = "sphinx_rtd_theme"
-html_static_path = ["_static"]
-autodoc_typehints = "description"
+html_static_path = ["_static"] if os.path.exists("_static") else []
+autodoc_typehints = "signature"  # Show type hints in the signature only, not in the docstring
 html_show_sphinx = False
 
 
-def verify_modules():
-    """Verify that required modules are available."""
-    required_modules = {
-        "services": [
-            "assemblyai",
-            "aws",
-            "cartesia",
-            "deepgram",
-            "google",
-            "lmnt",
-            "riva",
-            "simli",
-        ],
-        "serializers": ["livekit"],
-        "vad": ["silero", "vad_analyzer"],
-        "transports": {
-            "services": ["daily", "livekit"],
-            "local": ["audio", "tk"],
-            "network": ["fastapi_websocket", "websocket_server"],
-        },
-    }
+def import_core_modules():
+    """Import core pipecat modules for autodoc to discover."""
+    core_modules = [
+        "pipecat",
+        "pipecat.frames",
+        "pipecat.pipeline",
+        "pipecat.processors",
+        "pipecat.services",
+        "pipecat.transports",
+        "pipecat.audio",
+        "pipecat.adapters",
+        "pipecat.clocks",
+        "pipecat.metrics",
+        "pipecat.observers",
+        "pipecat.runner",
+        "pipecat.serializers",
+        "pipecat.sync",
+        "pipecat.transcriptions",
+        "pipecat.utils",
+    ]
 
-    # Skip importing modules that are in autodoc_mock_imports
-    skipped_modules = set(autodoc_mock_imports)
-
-    missing = []
-    for category, modules in required_modules.items():
-        if isinstance(modules, dict):
-            # Handle nested structure
-            for subcategory, submodules in modules.items():
-                for module in submodules:
-                    # Check if module is in autodoc_mock_imports
-                    if (
-                        f"pipecat.{category}.{subcategory}.{module}" in skipped_modules
-                        or module in skipped_modules
-                    ):
-                        logger.info(
-                            f"Skipping import of mocked module: pipecat.{category}.{subcategory}.{module}"
-                        )
-                        continue
-
-                    try:
-                        __import__(f"pipecat.{category}.{subcategory}.{module}")
-                        logger.info(
-                            f"Successfully imported pipecat.{category}.{subcategory}.{module}"
-                        )
-                    except (ImportError, TypeError, NameError) as e:
-                        missing.append(f"pipecat.{category}.{subcategory}.{module}")
-                        logger.warning(
-                            f"Optional module not available: pipecat.{category}.{subcategory}.{module} - {str(e)}"
-                        )
-        else:
-            # Handle flat structure
-            for module in modules:
-                # Check if module is in autodoc_mock_imports
-                if f"pipecat.{category}.{module}" in skipped_modules or module in skipped_modules:
-                    logger.info(f"Skipping import of mocked module: pipecat.{category}.{module}")
-                    continue
-
-                try:
-                    __import__(f"pipecat.{category}.{module}")
-                    logger.info(f"Successfully imported pipecat.{category}.{module}")
-                except (ImportError, TypeError, NameError) as e:
-                    missing.append(f"pipecat.{category}.{module}")
-                    logger.warning(
-                        f"Optional module not available: pipecat.{category}.{module} - {str(e)}"
-                    )
-
-    if missing:
-        logger.warning(f"Some optional modules are not available: {missing}")
+    for module_name in core_modules:
+        try:
+            __import__(module_name)
+            logger.info(f"Successfully imported {module_name}")
+        except ImportError as e:
+            logger.warning(f"Failed to import {module_name}: {e}")
 
 
 def clean_title(title: str) -> str:
@@ -235,36 +140,7 @@ def clean_title(title: str) -> str:
     parts = title.split(".")
     title = parts[-1]
 
-    # Special cases for service names and common acronyms
-    special_cases = {
-        "ai": "AI",
-        "aws": "AWS",
-        "api": "API",
-        "vad": "VAD",
-        "assemblyai": "AssemblyAI",
-        "deepgram": "Deepgram",
-        "elevenlabs": "ElevenLabs",
-        "openai": "OpenAI",
-        "openpipe": "OpenPipe",
-        "playht": "PlayHT",
-        "xtts": "XTTS",
-        "lmnt": "LMNT",
-    }
-
-    # Check if the entire title is a special case
-    if title.lower() in special_cases:
-        return special_cases[title.lower()]
-
-    # Otherwise, capitalize each word
-    words = title.split("_")
-    cleaned_words = []
-    for word in words:
-        if word.lower() in special_cases:
-            cleaned_words.append(special_cases[word.lower()])
-        else:
-            cleaned_words.append(word.capitalize())
-
-    return " ".join(cleaned_words)
+    return title
 
 
 def setup(app):
@@ -289,9 +165,8 @@ def setup(app):
 
     excludes = [
         str(project_root / "src/pipecat/pipeline/to_be_updated"),
-        str(project_root / "src/pipecat/processors/gstreamer"),
-        str(project_root / "src/pipecat/services/to_be_updated"),
-        str(project_root / "src/pipecat/vad"),  # deprecated
+        str(project_root / "src/pipecat/examples"),
+        str(project_root / "src/pipecat/tests"),
         "**/test_*.py",
         "**/tests/*.py",
     ]
@@ -332,5 +207,4 @@ def setup(app):
         logger.error(f"Error generating API documentation: {e}", exc_info=True)
 
 
-# Run module verification
-verify_modules()
+import_core_modules()

docs/api/index.rst

@@ -1,60 +1,20 @@
-Pipecat API Reference Docs
-==========================
+Pipecat API Reference
+=====================
 
-Welcome to Pipecat's API reference documentation!
+Welcome to the Pipecat API reference.
 
-Pipecat is an open source framework for building voice and multimodal assistants.
-It provides a flexible pipeline architecture for connecting various AI services,
-audio processing, and transport layers.
+Use the navigation on the left to browse modules, or search using the search box.
+
+**New to Pipecat?** Check out the `main documentation <https://docs.pipecat.ai>`_ for tutorials, guides, and client SDK information.
 
 Quick Links
 -----------
 
 * `GitHub Repository <https://github.com/pipecat-ai/pipecat>`_
-* `Website <https://pipecat.ai>`_
-
-API Reference
--------------
-
-Core Components
-~~~~~~~~~~~~~~~
-
-* :mod:`Frames <pipecat.frames>`
-* :mod:`Processors <pipecat.processors>`
-* :mod:`Pipeline <pipecat.pipeline>`
-
-Audio Processing
-~~~~~~~~~~~~~~~~
-
-* :mod:`Audio <pipecat.audio>`
-
-Services
-~~~~~~~~
-
-* :mod:`Services <pipecat.services>`
-
-Transport & Serialization
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-* :mod:`Transports <pipecat.transports>`
-   * :mod:`Local <pipecat.transports.local>`
-   * :mod:`Network <pipecat.transports.network>`
-   * :mod:`Services <pipecat.transports.services>`
-* :mod:`Serializers <pipecat.serializers>`
-
-Utilities
-~~~~~~~~~
-
-* :mod:`Adapters <pipecat.adapters>`
-* :mod:`Clocks <pipecat.clocks>`
-* :mod:`Metrics <pipecat.metrics>`
-* :mod:`Observers <pipecat.observers>`
-* :mod:`Sync <pipecat.sync>`
-* :mod:`Transcriptions <pipecat.transcriptions>`
-* :mod:`Utils <pipecat.utils>`
+* `Join our Community <https://discord.gg/pipecat>`_
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 2
    :caption: API Reference
    :hidden:
 
@@ -66,16 +26,10 @@ Utilities
    Observers <api/pipecat.observers>
    Pipeline <api/pipecat.pipeline>
    Processors <api/pipecat.processors>
+   Runner <api/pipecat.runner>
    Serializers <api/pipecat.serializers>
    Services <api/pipecat.services>
    Sync <api/pipecat.sync>
    Transcriptions <api/pipecat.transcriptions>
    Transports <api/pipecat.transports>
-   Utils <api/pipecat.utils>
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   Utils <api/pipecat.utils>

docs/api/requirements.txt

@@ -1,54 +0,0 @@
-# Sphinx dependencies
-sphinx>=8.1.3
-sphinx-rtd-theme
-sphinx-markdown-builder
-sphinx-autodoc-typehints
-toml
-
-# Install all extras individually to ensure they're properly resolved
-pipecat-ai[anthropic]
-pipecat-ai[assemblyai]
-pipecat-ai[aws]
-pipecat-ai[azure]
-pipecat-ai[canonical]
-pipecat-ai[cartesia]
-pipecat-ai[cerebras]
-pipecat-ai[deepseek]
-pipecat-ai[daily]
-pipecat-ai[deepgram]
-pipecat-ai[elevenlabs]
-pipecat-ai[fal]
-pipecat-ai[fireworks]
-pipecat-ai[fish]
-pipecat-ai[gladia]
-pipecat-ai[google]
-pipecat-ai[grok]
-pipecat-ai[groq]
-# pipecat-ai[krisp] # Mocked
-pipecat-ai[koala]
-# pipecat-ai[langchain] # Mocked
-# pipecat-ai[livekit] # Mocked
-pipecat-ai[lmnt]
-pipecat-ai[local]
-# pipecat-ai[local-smart-turn] # Mocked
-# pipecat-ai[mem0] # Mocked
-# pipecat-ai[mlx-whisper] # Mocked
-# pipecat-ai[moondream] # Mocked
-pipecat-ai[nim]
-# pipecat-ai[neuphonic] # Mocked
-pipecat-ai[noisereduce]
-pipecat-ai[openai]
-# pipecat-ai[openpipe]
-# pipecat-ai[playht] # Mocked due to grpcio conflict with riva
-pipecat-ai[qwen]
-pipecat-ai[remote-smart-turn]
-# pipecat-ai[riva] # Mocked
-pipecat-ai[silero]
-pipecat-ai[simli]
-pipecat-ai[soundfile]
-pipecat-ai[tavus]
-pipecat-ai[together]
-# pipecat-ai[ultravox] # Mocked
-# pipecat-ai[webrtc] # Mocked
-pipecat-ai[websocket]
-pipecat-ai[whisper]

env.example

@@ -1,6 +1,10 @@
 # Anthropic
 ANTHROPIC_API_KEY=...
 
+# Async
+ASYNCAI_API_KEY=...
+ASYNCAI_VOICE_ID=...
+
 # AWS
 AWS_SECRET_ACCESS_KEY=...
 AWS_ACCESS_KEY_ID=...
@@ -25,6 +29,9 @@ CARTESIA_API_KEY=...
 DAILY_API_KEY=...
 DAILY_SAMPLE_ROOM_URL=https://...
 
+# Deepgram
+DEEPGRAM_API_KEY=...
+
 # ElevenLabs
 ELEVENLABS_API_KEY=...
 ELEVENLABS_VOICE_ID=...
@@ -40,6 +47,13 @@ FIREWORKS_API_KEY=...
 
 # Gladia
 GLADIA_API_KEY=...
+GLADIA_REGION=...
+
+# Google
+GOOGLE_API_KEY=...
+GOOGLE_CLOUD_PROJECT_ID=...
+GOOGLE_TEST_CREDENTIALS=...
+GOOGLE_VERTEX_TEST_CREDENTIALS=...
 
 # LMNT
 LMNT_API_KEY=...
@@ -76,6 +90,9 @@ GROQ_API_KEY=...
 # Grok
 GROK_API_KEY=...
 
+# Inworld
+INWORLD_API_KEY=...
+
 # Together.ai
 TOGETHER_API_KEY=...
 
@@ -95,9 +112,31 @@ OPENROUTER_API_KEY=...
 PIPER_BASE_URL=...
 
 # Smart turn
-LOCAL_SMART_TURN_MODEL_PATH=
+LOCAL_SMART_TURN_MODEL_PATH=...
 FAL_SMART_TURN_API_KEY=...
 
 # Twilio
-TWILIO_ACCOUNT_SID=
-TWILIO_AUTH_TOKEN=
+TWILIO_ACCOUNT_SID=...
+TWILIO_AUTH_TOKEN=...
+
+# MiniMax
+MINIMAX_API_KEY=...
+MINIMAX_GROUP_ID=...
+
+# Sarvam AI
+SARVAM_API_KEY=...
+
+# Soniox
+SONIOX_API_KEY=
+
+# Speechmatics
+SPEECHMATICS_API_KEY=...
+
+# SambaNova
+SAMBANOVA_API_KEY=...
+
+# Sentry
+SENTRY_DSN=...
+
+# Heygen
+HEYGEN_API_KEY=...

examples/README.md

@@ -1,88 +1,31 @@
+# Pipecat Examples
 
+This directory contains examples to help you learn how to build with Pipecat.
 
-# Pipecat — Examples
+## Getting Started
 
-## Foundational snippets
-Small snippets that build on each other, introducing one or two concepts at a time.
+New to Pipecat? Start here:
 
-➡️ [Take a look](https://github.com/pipecat-ai/pipecat/tree/main/examples/foundational)
+- **[Quickstart](quickstart/)** - Get your first voice AI bot running in 5 minutes _(coming soon)_
+- **[Client/Server Web](client-server-web/)** - Learn to build web applications with Pipecat's client SDKs _(coming soon)_
+- **[Phone Bot with Twilio](phone-bot-twilio/)** - Connect your bot to a phone number _(coming soon)_
 
-## Chatbot examples
-Collection of self-contained real-time voice and video AI demo applications built with Pipecat.
+## Foundational Examples
 
-### Quickstart
+Single-file examples that introduce core Pipecat concepts one at a time. These examples:
 
-Each project has its own set of dependencies and configuration variables. They intentionally avoids shared code across projects — you can grab whichever demo folder you want to work with as a starting point.
+- Build on each other progressively
+- Focus on specific features or integrations
+- Are used for testing with every Pipecat release
 
-We recommend you start with a virtual environment:
+See the **[Foundational Examples README](foundational/)** for the complete list.
 
-```shell
-cd pipecat-ai/examples/simple-chatbot
+## More Advanced Examples
 
-python -m venv venv
+Ready to explore complex use cases? Visit **[pipecat-examples](https://github.com/pipecat-ai/pipecat-examples)** for:
 
-source venv/bin/activate
-
-pip install -r requirements.txt
-```
-
-Next, follow the steps in the README for each demo.
-
-ℹ️ Make sure you `pip install -r requirements.txt` for each demo project, so you can be sure to have the necessary service dependencies that extend the functionality of Pipecat. You can read more about the framework architecture [here](https://github.com/pipecat-ai/pipecat/tree/main/docs).
-
-## Projects:
-
-| Project                                      | Description                                                                                                                                | Services                                                          |
-|----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------|
-| [Simple Chatbot](simple-chatbot)             | Basic voice-driven conversational bot. A good starting point for learning the flow of the framework.                                       | Deepgram, ElevenLabs, OpenAI, Daily, Daily Prebuilt UI            |
-| [Storytelling Chatbot](storytelling-chatbot) | Stitches together multiple third-party services to create a collaborative storytime experience.                                            | Deepgram, ElevenLabs, OpenAI, Fal, Daily, Custom UI               |
-| [Translation Chatbot](translation-chatbot)   | Listens for user speech, then translates that speech to Spanish and speaks the translation back. Demonstrates multi-participant use-cases. | Deepgram, Azure, OpenAI, Daily, Daily Prebuilt UI                 |
-| [Moondream Chatbot](moondream-chatbot)       | Demonstrates how to add vision capabilities to GPT4. **Note: works best with a GPU**                                                       | Deepgram, ElevenLabs, OpenAI, Moondream, Daily, Daily Prebuilt UI |
-| [Patient intake](patient-intake)             | A chatbot that can call functions in response to user input.                                                                               | Deepgram, ElevenLabs, OpenAI, Daily, Daily Prebuilt UI            |
-| [Phone Chatbot](phone-chatbot)             | A chatbot that connects to PSTN/SIP phone calls, powered by Daily or Twilio.                                                                    | Deepgram, ElevenLabs, OpenAI, Daily, Twilio                       |
-| [Twilio Chatbot](twilio-chatbot)             | A chatbot that connects to an incoming phone call from Twilio.                                                                             | Deepgram, ElevenLabs, OpenAI, Daily, Twilio                       |
-| [studypal](studypal)                         | A chatbot to have a conversation about any article on the web                                                                              |                                                                   |
-| [WebSocket Chatbot Server](websocket-server) | A real-time websocket server that handles audio streaming and bot interactions with speech-to-text and text-to-speech capabilities. | Cartesia, Deepgram, OpenAI, Websockets |
-
-> [!IMPORTANT]
-> These example projects use Daily as a WebRTC transport and can be joined using their hosted Prebuilt UI.
-> It provides a quick way to join a real-time session with your bot and test your ideas without building any frontend code. If you'd like to see an example of a custom UI, try Storybot.
-
-
-## FAQ
-
-### Deployment
-
-For each of these demos we've included a `Dockerfile`. Out of the box, this should provide everything needed to get the respective demo running on a VM:
-
-```shell
-docker build username/app:tag .
-
-docker run -p 7860:7860 --env-file ./.env username/app:tag
-
-docker push ...
-```
-
-### SSL
-
-If you're working with a custom UI (such as with the Storytelling Chatbot), it's important to ensure your deployment platform supports HTTPS, as accessing user devices such as mics and webcams requires SSL.
-
-If you try to run a custom UI without SSL, you may see an error in the console telling you that `navigator` is undefined, or no devices are available.
-
-### Are these examples production ready?
-
-Yes, kind of.
-
-These demos attempt to keep things simple and are unopinionated regarding environment or scalability.
-
-We're using FastAPI to spawn a subprocess for the bots / agents — useful for small tests, but not so great for production grade apps with many concurrent users. You can see how this works in each project's `start` endpoint in `server.py`.
-
-Creating virtualized worker pools and on-demand instances is out of scope for these examples, but we hope to add some examples to this repo soon!
-
-For projects that have CUDA as a requirement, such as Moondream Chatbot, be sure to deploy to a GPU-powered platform (such as [fly.io](https://fly.io) or [Runpod](https://runpod.io).)
-
-## Getting help
-
-➡️ [Join our Discord](https://discord.gg/pipecat)
-
-➡️ [Reach us on Twitter](https://x.com/pipecat_ai)
+- Production-ready applications
+- Multi-platform client implementations
+- Telephony integrations
+- Multimodal and creative applications
+- Deployment and monitoring examples

examples/bot-ready-signalling/README.md

@@ -1,45 +0,0 @@
-# Bot ready signaling
-
-A simple Pipecat example demonstrating how to handle signaling between the client and the bot, 
-ensuring that the bot starts sending audio only when the client is available, 
-thereby avoiding the risk of cutting off the beginning of the audio.
-
-## Quick Start
-
-### First, start the bot server:
-
-1. Navigate to the server directory:
-   ```bash
-   cd server
-   ```
-2. Create and activate a virtual environment:
-   ```bash
-   python3 -m venv venv
-   source venv/bin/activate  # On Windows: venv\Scripts\activate
-   ```
-3. Install requirements:
-   ```bash
-   pip install -r requirements.txt
-   ```
-4. Copy env.example to .env and configure:
-   - Add your API keys
-5. Start the server:
-   ```bash
-   python server.py
-   ```
-
-### Next, connect using the client app:
-
-For client-side setup, refer to the [JavaScript Guide](client/javascript/README.md).
-
-## Important Note
-
-Ensure the bot server is running before using any client implementations.
-
-## Requirements
-
-- Python 3.10+
-- Node.js 16+ (for JavaScript)
-- Daily API key
-- Cartesia API key
-- Modern web browser with WebRTC support

examples/bot-ready-signalling/client/javascript/README.md

@@ -1,27 +0,0 @@
-# JavaScript Implementation
-
-Basic implementation using the [Pipecat JavaScript SDK](https://docs.pipecat.ai/client/js/introduction).
-
-## Setup
-
-1. Run the bot server. See the [server README](../../README).
-
-2. Navigate to the `client/javascript` directory:
-
-```bash
-cd client/javascript
-```
-
-3. Install dependencies:
-
-```bash
-npm install
-```
-
-4. Run the client app:
-
-```
-npm run dev
-```
-
-5. Visit http://localhost:5173 in your browser.

examples/bot-ready-signalling/client/javascript/index.html

@@ -1,34 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-
-<head>
-  <meta charset="UTF-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <title>AI Chatbot</title>
-</head>
-
-<body>
-  <div class="container">
-    <div class="status-bar">
-      <div class="status">
-        Status: <span id="connection-status">Disconnected</span>
-      </div>
-      <div class="controls">
-        <button id="connect-btn">Connect</button>
-        <button id="disconnect-btn" disabled>Disconnect</button>
-      </div>
-    </div>
-
-    <audio id="bot-audio" autoplay></audio>
-
-    <div class="debug-panel">
-      <h3>Debug Info</h3>
-      <div id="debug-log"></div>
-    </div>
-  </div>
-
-  <script type="module" src="/src/app.js"></script>
-  <link rel="stylesheet" href="/src/style.css">
-</body>
-
-</html>

examples/bot-ready-signalling/client/javascript/package.json

@@ -1,20 +0,0 @@
-{
-  "name": "client",
-  "version": "1.0.0",
-  "main": "index.js",
-  "scripts": {
-    "dev": "vite",
-    "build": "vite build",
-    "preview": "vite preview"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "description": "",
-  "devDependencies": {
-    "vite": "^6.0.9"
-  },
-  "dependencies": {
-    "@daily-co/daily-js": "0.74.0"
-  }
-}

examples/bot-ready-signalling/client/javascript/src/app.js

@@ -1,216 +0,0 @@
-/**
- * Copyright (c) 2024–2025, Daily
- *
- * SPDX-License-Identifier: BSD 2-Clause License
- */
-
-import Daily from "@daily-co/daily-js";
-
-/**
- * ChatbotClient handles the connection and media management for a real-time
- * voice interaction with an AI bot.
- */
-class ChatbotClient {
-  constructor() {
-    // Initialize client state
-    this.dailyCallObject = null;
-    this.setupDOMElements();
-    this.setupEventListeners();
-  }
-
-  /**
-   * Set up references to DOM elements and create necessary media elements
-   */
-  setupDOMElements() {
-    // Get references to UI control elements
-    this.connectBtn = document.getElementById('connect-btn');
-    this.disconnectBtn = document.getElementById('disconnect-btn');
-    this.statusSpan = document.getElementById('connection-status');
-    this.debugLog = document.getElementById('debug-log');
-
-    // Create an audio element for bot's voice output
-    this.botAudio = document.createElement('audio');
-    this.botAudio.autoplay = true;
-    this.botAudio.playsInline = true;
-    document.body.appendChild(this.botAudio);
-  }
-
-  /**
-   * Set up event listeners for connect/disconnect buttons
-   */
-  setupEventListeners() {
-    this.connectBtn.addEventListener('click', () => this.connect());
-    this.disconnectBtn.addEventListener('click', () => this.disconnect());
-  }
-
-  /**
-   * Add a timestamped message to the debug log
-   */
-  log(message) {
-    const entry = document.createElement('div');
-    entry.textContent = `${new Date().toISOString()} - ${message}`;
-
-    // Add styling based on message type
-    if (message.startsWith('User: ')) {
-      entry.style.color = '#2196F3'; // blue for user
-    } else if (message.startsWith('Bot: ')) {
-      entry.style.color = '#4CAF50'; // green for bot
-    }
-
-    this.debugLog.appendChild(entry);
-    this.debugLog.scrollTop = this.debugLog.scrollHeight;
-    console.log(message);
-  }
-
-  /**
-   * Update the connection status display
-   */
-  updateStatus(status) {
-    this.statusSpan.textContent = status;
-    this.log(`Status: ${status}`);
-  }
-
-  handleEventToConsole (evt) {
-    this.log(`Received event: ${evt.action}`);
-  };
-
-  /**
-   * Set up listeners for track events (start/stop)
-   * This handles new tracks being added during the session
-   */
-  setupTrackListeners() {
-    if (!this.dailyCallObject) return;
-
-    this.dailyCallObject.on("joined-meeting", () => {
-      this.updateStatus('Connected');
-      this.connectBtn.disabled = true;
-      this.disconnectBtn.disabled = false;
-      this.log('Client connected');
-    });
-    this.dailyCallObject.on("track-started", (evt) => {
-      if (evt.track.kind === "audio" && evt.participant.local === false) {
-        this.log("Audio track started.")
-        this.setupAudioTrack(evt.track);
-      }
-    });
-    this.dailyCallObject.on("track-stopped", this.handleEventToConsole.bind(this));
-    this.dailyCallObject.on("participant-joined", this.handleEventToConsole.bind(this));
-    this.dailyCallObject.on("participant-updated", this.handleEventToConsole.bind(this));
-    this.dailyCallObject.on("participant-left", () => {
-      // When the bot leaves, we are also disconnecting from the call
-      this.disconnect()
-    });
-    this.dailyCallObject.on("left-meeting", () => {
-      this.updateStatus('Disconnected');
-      this.connectBtn.disabled = false;
-      this.disconnectBtn.disabled = true;
-      this.log('Client disconnected');
-    });
-    this.dailyCallObject.on("error", this.handleEventToConsole.bind(this));
-  }
-
-  /**
-   * Set up an audio track for playback
-   * Handles both initial setup and track updates
-   */
-  setupAudioTrack(track) {
-    this.log(`Setting up audio track, track state: ${track.readyState}, muted: ${track.muted}`);
-
-    // Check if we're already playing this track
-    if (this.botAudio.srcObject) {
-      const oldTrack = this.botAudio.srcObject.getAudioTracks()[0];
-      if (oldTrack?.id === track.id) return;
-    }
-    // Create a new MediaStream with the track and set it as the audio source
-    this.botAudio.srcObject = new MediaStream([track]);
-    this.botAudio.onplaying = async (event) => {
-      this.log("onplaying")
-      this.log("Will send the audio message to play the audio at the next tick")
-      this.dailyCallObject.sendAppMessage("playable")
-    }
-  }
-
-  async fetchRoomInfo() {
-    let connectUrl = '/connect'
-    let res = await fetch(connectUrl, {
-      method: "POST",
-      mode: "cors",
-      headers: new Headers({
-        "Content-Type": "application/json"
-      }),
-    })
-    if (res.ok) {
-      return res.json();
-    }
-  }
-
-  /**
-   * Initialize and connect to the bot
-   * This sets up the RTVI client, initializes devices, and establishes the connection
-   */
-  async connect() {
-    try {
-      // Initialize the client
-      this.dailyCallObject = Daily.createCallObject({
-        subscribeToTracksAutomatically: true,
-      });
-
-      // Set up listeners for media track events
-      this.setupTrackListeners();
-
-      this.log('Creating the bot...');
-      let roomInfo = await this.fetchRoomInfo()
-
-      // Connect to the bot
-      this.log('Connecting to bot...');
-      // Only for making debugger easier
-      window.callObject = this.dailyCallObject;
-      await this.dailyCallObject.join({
-        url: roomInfo.room_url,
-      });
-
-      this.log('Connection complete');
-    } catch (error) {
-      // Handle any errors during connection
-      this.log(`Error connecting: ${error.message}`);
-      this.log(`Error stack: ${error.stack}`);
-      this.updateStatus('Error');
-
-      // Clean up if there's an error
-      if (this.dailyCallObject) {
-        try {
-          await this.dailyCallObject.leave();
-        } catch (disconnectError) {
-          this.log(`Error during disconnect: ${disconnectError.message}`);
-        }
-      }
-    }
-  }
-
-  /**
-   * Disconnect from the bot and clean up media resources
-   */
-  async disconnect() {
-    if (this.dailyCallObject) {
-      try {
-        // Disconnect the RTVI client
-        await this.dailyCallObject.leave();
-        await this.dailyCallObject.destroy();
-        this.dailyCallObject = null;
-
-        // Clean up audio
-        if (this.botAudio.srcObject) {
-          this.botAudio.srcObject.getTracks().forEach((track) => track.stop());
-          this.botAudio.srcObject = null;
-        }
-      } catch (error) {
-        this.log(`Error disconnecting: ${error.message}`);
-      }
-    }
-  }
-}
-
-// Initialize the client when the page loads
-window.addEventListener('DOMContentLoaded', () => {
-  new ChatbotClient();
-});

examples/bot-ready-signalling/client/javascript/src/style.css

@@ -1,98 +0,0 @@
-body {
-  margin: 0;
-  padding: 20px;
-  font-family: Arial, sans-serif;
-  background-color: #f0f0f0;
-}
-
-.container {
-  max-width: 1200px;
-  margin: 0 auto;
-}
-
-.status-bar {
-  display: flex;
-  justify-content: space-between;
-  align-items: center;
-  padding: 10px;
-  background-color: #fff;
-  border-radius: 8px;
-  margin-bottom: 20px;
-}
-
-.controls button {
-  padding: 8px 16px;
-  margin-left: 10px;
-  border: none;
-  border-radius: 4px;
-  cursor: pointer;
-}
-
-#connect-btn {
-  background-color: #4caf50;
-  color: white;
-}
-
-#disconnect-btn {
-  background-color: #f44336;
-  color: white;
-}
-
-button:disabled {
-  opacity: 0.5;
-  cursor: not-allowed;
-}
-
-.main-content {
-  background-color: #fff;
-  border-radius: 8px;
-  padding: 20px;
-  margin-bottom: 20px;
-}
-
-.bot-container {
-  display: flex;
-  flex-direction: column;
-  align-items: center;
-}
-
-#bot-video-container {
-  width: 640px;
-  height: 360px;
-  background-color: #e0e0e0;
-  border-radius: 8px;
-  margin: 20px auto;
-  overflow: hidden;
-  display: flex;
-  align-items: center;
-  justify-content: center;
-}
-
-#bot-video-container video {
-  width: 100%;
-  height: 100%;
-  object-fit: cover;
-}
-
-.debug-panel {
-  background-color: #fff;
-  border-radius: 8px;
-  padding: 20px;
-}
-
-.debug-panel h3 {
-  margin: 0 0 10px 0;
-  font-size: 16px;
-  font-weight: bold;
-}
-
-#debug-log {
-  height: 200px;
-  overflow-y: auto;
-  background-color: #f8f8f8;
-  padding: 10px;
-  border-radius: 4px;
-  font-family: monospace;
-  font-size: 12px;
-  line-height: 1.4;
-}

examples/bot-ready-signalling/client/javascript/vite.config.js

@@ -1,13 +0,0 @@
-import { defineConfig } from 'vite';
-
-export default defineConfig({
-    server: {
-        proxy: {
-            // Proxy /api requests to the backend server
-            '/connect': {
-                target: 'http://0.0.0.0:7860', // Replace with your backend URL
-                changeOrigin: true,
-            },
-        },
-    },
-});

examples/bot-ready-signalling/client/react-native/.nvmrc

@@ -1 +0,0 @@
-22.14

examples/bot-ready-signalling/client/react-native/README.md

@@ -1,60 +0,0 @@
-# React Native Implementation
-
-Basic implementation using the [Pipecat React Native SDK](https://docs.pipecat.ai/client/react-native/introduction).
-
-## Usage
-
-### Expo requirements
-
-This project cannot be used with an [Expo Go](https://docs.expo.dev/workflow/expo-go/) app because [it requires custom native code](https://docs.expo.io/workflow/customizing/).
-
-When a project requires custom native code or a config plugin, we need to transition from using [Expo Go](https://docs.expo.dev/workflow/expo-go/) 
-to a [development build](https://docs.expo.dev/development/introduction/).
-
-More details about the custom native code used by this demo can be found in [rn-daily-js-expo-config-plugin](https://github.com/daily-co/rn-daily-js-expo-config-plugin).
-
-### Building remotely
-
-If you do not have experience with Xcode and Android Studio builds or do not have them installed locally on your computer, you will need to follow [this guide from Expo to use EAS Build](https://docs.expo.dev/development/create-development-builds/#create-and-install-eas-build).
-
-### Building locally
-
-You will need to have installed locally on your computer:
-- [Xcode](https://developer.apple.com/xcode/) to build for iOS;
-- [Android Studio](https://developer.android.com/studio) to build for Android;
-
-#### Install the demo dependencies
-
-```bash
-# Use the version of node specified in .nvmrc
-nvm i
-
-# Install dependencies
-npm i
-
-# Before a native app can be compiled, the native source code must be generated.
-npx expo prebuild
-
-# Configure the environment variable to connect to the local server
-cp env.example .env
-# edit .env and add your local ip address, for example: http://192.168.1.16:7860
-```
-
-#### Running on Android
-
-After plugging in an Android device [configured for debugging](https://developer.android.com/studio/debug/dev-options), run the following command:
-
-```
-npm run android
-```
-
-#### Running on iOS
-
-Run the following command:
-
-```
-npm run ios
-```
-
-#### Connect to the server
-Use the http://localhost:5173 in your app.

examples/bot-ready-signalling/client/react-native/app.json

@@ -1,75 +0,0 @@
-{
-  "expo": {
-    "name": "bot-ready-rn",
-    "slug": "bot-ready-rn",
-    "version": "1.0.0",
-    "orientation": "portrait",
-    "icon": "./assets/icon.png",
-    "userInterfaceStyle": "light",
-    "splash": {
-      "image": "./assets/splash.png",
-      "resizeMode": "contain",
-      "backgroundColor": "#ffffff"
-    },
-    "updates": {
-      "fallbackToCacheTimeout": 0
-    },
-    "assetBundlePatterns": [
-      "**/*"
-    ],
-    "ios": {
-      "supportsTablet": true,
-      "bitcode": false,
-      "bundleIdentifier": "co.daily.expo.BotReady",
-      "infoPlist": {
-        "UIBackgroundModes": [
-          "voip"
-        ]
-      },
-      "appleTeamId": "EEBGKV9N3N"
-    },
-    "android": {
-      "adaptiveIcon": {
-        "foregroundImage": "./assets/adaptive-icon.png",
-        "backgroundColor": "#FFFFFF"
-      },
-      "package": "co.daily.expo.BotReady",
-      "permissions": [
-        "android.permission.ACCESS_NETWORK_STATE",
-        "android.permission.BLUETOOTH",
-        "android.permission.CAMERA",
-        "android.permission.INTERNET",
-        "android.permission.MODIFY_AUDIO_SETTINGS",
-        "android.permission.RECORD_AUDIO",
-        "android.permission.SYSTEM_ALERT_WINDOW",
-        "android.permission.WAKE_LOCK",
-        "android.permission.FOREGROUND_SERVICE",
-        "android.permission.FOREGROUND_SERVICE_CAMERA",
-        "android.permission.FOREGROUND_SERVICE_MICROPHONE",
-        "android.permission.FOREGROUND_SERVICE_MEDIA_PROJECTION",
-        "android.permission.POST_NOTIFICATIONS"
-      ]
-    },
-    "web": {
-      "favicon": "./assets/favicon.png"
-    },
-    "plugins": [
-      "@config-plugins/react-native-webrtc",
-      "@daily-co/config-plugin-rn-daily-js",
-      [
-        "expo-build-properties",
-        {
-          "android": {
-            "minSdkVersion": 24,
-            "compileSdkVersion": 35,
-            "targetSdkVersion": 34,
-            "buildToolsVersion": "35.0.0"
-          },
-          "ios": {
-            "deploymentTarget": "15.1"
-          }
-        }
-      ]
-    ]
-  }
-}

examples/bot-ready-signalling/client/react-native/babel.config.js

@@ -1,7 +0,0 @@
-module.exports = function(api) {
-  api.cache(true);
-  return {
-    presets: ['babel-preset-expo'],
-    plugins: [["module:react-native-dotenv"]],
-  };
-};

examples/bot-ready-signalling/client/react-native/env.example

@@ -1 +0,0 @@
-API_BASE_URL=http://YOUR_LOCAL_IP:7860

examples/bot-ready-signalling/client/react-native/index.js

@@ -1,7 +0,0 @@
-import { registerRootComponent } from "expo";
-
-import App from "./src/App";
-
-// registerRootComponent calls AppRegistry.registerComponent('main', () => App);
-// It also ensures that the environment is set up appropriately
-registerRootComponent(App);

examples/bot-ready-signalling/client/react-native/metro.config.js

@@ -1,4 +0,0 @@
-// Learn more https://docs.expo.io/guides/customizing-metro
-const { getDefaultConfig } = require('expo/metro-config');
-
-module.exports = getDefaultConfig(__dirname);

examples/bot-ready-signalling/client/react-native/package.json

@@ -1,31 +0,0 @@
-{
-  "name": "bot-ready-rn",
-  "version": "1.0.0",
-  "scripts": {
-    "start": "expo start --dev-client",
-    "android": "expo run:android --device",
-    "ios": "expo run:ios --device",
-    "web": "expo start --web"
-  },
-  "dependencies": {
-    "@config-plugins/react-native-webrtc": "^10.0.0",
-    "@daily-co/config-plugin-rn-daily-js": "0.0.7",
-    "@daily-co/react-native-daily-js": "^0.70.0",
-    "@daily-co/react-native-webrtc": "^118.0.3-daily.2",
-    "@react-native-async-storage/async-storage": "1.23.1",
-    "expo": "^52.0.0",
-    "expo-build-properties": "~0.13.1",
-    "expo-dev-client": "~5.0.5",
-    "expo-splash-screen": "~0.29.16",
-    "expo-status-bar": "~2.0.0",
-    "react": "18.3.1",
-    "react-native": "0.76.3",
-    "react-native-background-timer": "^2.4.1",
-    "react-native-dotenv": "^3.4.11",
-    "react-native-get-random-values": "^1.11.0"
-  },
-  "devDependencies": {
-    "@babel/core": "^7.12.9"
-  },
-  "private": true
-}

examples/bot-ready-signalling/client/react-native/src/App.js

@@ -1,121 +0,0 @@
-import React, { useState, useEffect } from 'react';
-import {SafeAreaView, View, Text, Button, StyleSheet, ScrollView} from 'react-native';
-import Daily from "@daily-co/react-native-daily-js";
-import { API_BASE_URL } from "@env";
-
-const CallScreen = () => {
-  const [connectionStatus, setConnectionStatus] = useState('Disconnected');
-  const [isConnected, setIsConnected] = useState(false);
-  const [callObject, setCallObject] = useState(null);
-  const [logs, setLogs] = useState([]);
-
-  useEffect(() => {
-    if (callObject) {
-      setupTrackListeners(callObject);
-    }
-  }, [callObject]);
-
-  const log = (message) => {
-    setLogs((prevLogs) => [...prevLogs, `${new Date().toISOString()} - ${message}`]);
-    console.log(message);
-  };
-
-  const setupTrackListeners = (callObject) => {
-    callObject.on("joined-meeting", () => {
-      setConnectionStatus('Connected');
-      setIsConnected(true);
-      log('Client connected');
-    });
-    callObject.on("left-meeting", () => {
-      setConnectionStatus('Disconnected');
-      setIsConnected(false);
-      log('Client disconnected');
-    });
-    callObject.on("participant-left", () => {
-      // When the bot leaves, we are also disconnecting from the call
-      disconnect().catch((err) => {
-        log(`Failed to disconnect ${err}`);
-      })
-    });
-    // Trigger so the bot can start sending audio
-    callObject.on("track-started", (evt) => {
-      if (evt.track.kind === "audio" && evt.participant.local === false) {
-        handleEventToConsole(evt)
-        log("Sending the message that will trigger the bot to play the audio.")
-        callObject.sendAppMessage("playable")
-      }
-    });
-    callObject.on("error", (evt) => log(`Error: ${evt.error}`));
-    // Other events just for awareness
-    callObject.on("track-stopped", handleEventToConsole);
-    callObject.on("participant-joined", handleEventToConsole);
-    callObject.on("participant-updated", handleEventToConsole);
-  };
-
-  const handleEventToConsole = (evt) => {
-    log(`Received event: ${evt.action}`);
-  };
-
-  const connect = async () => {
-    try {
-      const callObject = Daily.createCallObject({ subscribeToTracksAutomatically: true });
-      setCallObject(callObject);
-      const connectionUrl = `${API_BASE_URL}/connect`
-      const res = await fetch(connectionUrl, { method: "POST", headers: { "Content-Type": "application/json" } });
-      const roomInfo = await res.json();
-      await callObject.join({ url: roomInfo.room_url });
-    } catch (error) {
-      log(`Error connecting: ${error.message}`);
-    }
-  };
-
-  const disconnect = async () => {
-    if (callObject) {
-      try {
-        await callObject.leave();
-        await callObject.destroy();
-        setCallObject(null);
-      } catch (error) {
-        log(`Error disconnecting: ${error.message}`);
-      }
-    }
-  };
-
-  return (
-      <SafeAreaView style={styles.safeArea}>
-        <View style={styles.container}>
-          <View style={styles.statusBar}>
-            <Text>Status: <Text style={styles.status}>{connectionStatus}</Text></Text>
-            <View style={styles.controls}>
-              <Button
-                title={isConnected ? "Disconnect" : "Connect"}
-                onPress={isConnected ? disconnect : connect}
-              />
-            </View>
-          </View>
-
-          <View style={styles.debugPanel}>
-            <Text style={styles.debugTitle}>Debug Info</Text>
-            <ScrollView style={styles.debugLog}>
-              {logs.map((logEntry, index) => (
-                  <Text key={index} style={styles.logText}>{logEntry}</Text>
-              ))}
-            </ScrollView>
-          </View>
-        </View>
-      </SafeAreaView>
-  );
-};
-
-const styles = StyleSheet.create({
-  safeArea: { flex: 1, backgroundColor: '#f0f0f0', padding: 20 },
-  container: { flex: 1, margin: 20 },
-  statusBar: { flexDirection: 'row', justifyContent: 'space-between', alignItems: 'center', padding: 10, backgroundColor: '#fff', borderRadius: 8, marginBottom: 20 },
-  status: { fontWeight: 'bold' },
-  controls: { flexDirection: 'row', gap: 10 },
-  debugPanel: { height: '80%', backgroundColor: '#fff', borderRadius: 8, padding: 20},
-  debugTitle: { fontSize: 16, fontWeight: 'bold' },
-  debugLog: { height: '100%', overflow: 'scroll', backgroundColor: '#f8f8f8', padding: 10, borderRadius: 4, fontFamily: 'monospace', fontSize: 12, lineHeight: 1.4 },
-});
-
-export default CallScreen;

examples/bot-ready-signalling/server/README.md

@@ -1,50 +0,0 @@
-# Bot ready signaling Server
-
-A FastAPI server that manages bot instances and provide endpoint for Pipecat client connections.
-
-## Endpoints
-
-- `POST /connect` - Pipecat client connection endpoint
-
-## Environment Variables
-
-Copy `env.example` to `.env` and configure:
-
-```ini
-# Required API Keys
-DAILY_API_KEY=           # Your Daily API key
-CARTESIA_API_KEY=        # Your Cartesia API key
-
-# Optional Configuration
-DAILY_API_URL=           # Optional: Daily API URL (defaults to https://api.daily.co/v1)
-DAILY_SAMPLE_ROOM_URL=   # Optional: Fixed room URL for development
-HOST=                    # Optional: Host address (defaults to 0.0.0.0)
-FAST_API_PORT=           # Optional: Port number (defaults to 7860)
-```
-
-## Running the Server
-
-Set up and activate your virtual environment:
-
-```bash
-python3 -m venv venv
-source venv/bin/activate  # On Windows: venv\Scripts\activate
-```
-
-Install dependencies:
-
-```bash
-pip install -r requirements.txt
-```
-
-If you want to use the local version of `pipecat` in this repo rather than the last published version, also run:
-
-```bash
-pip install --editable "../../../[daily,cartesia,openai]"
-```
-
-Run the server:
-
-```bash
-python server.py
-```

examples/bot-ready-signalling/server/env.example

@@ -1,3 +0,0 @@
-DAILY_SAMPLE_ROOM_URL=https://yourdomain.daily.co/yourroom # (for joining the bot to the same room repeatedly for local dev)
-DAILY_API_KEY=
-CARTESIA_API_KEY=

examples/bot-ready-signalling/server/requirements.txt

@@ -1,4 +0,0 @@
-python-dotenv
-fastapi[all]
-uvicorn
-pipecat-ai[daily,cartesia,openai]

examples/bot-ready-signalling/server/runner.py

@@ -1,64 +0,0 @@
-#
-# Copyright (c) 2024–2025, Daily
-#
-# SPDX-License-Identifier: BSD 2-Clause License
-#
-
-import argparse
-import os
-from typing import Optional
-
-import aiohttp
-
-from pipecat.transports.services.helpers.daily_rest import DailyRESTHelper
-
-
-async def configure(aiohttp_session: aiohttp.ClientSession):
-    (url, token, _) = await configure_with_args(aiohttp_session)
-    return (url, token)
-
-
-async def configure_with_args(
-    aiohttp_session: aiohttp.ClientSession, parser: Optional[argparse.ArgumentParser] = None
-):
-    if not parser:
-        parser = argparse.ArgumentParser(description="Daily AI SDK Bot Sample")
-    parser.add_argument(
-        "-u", "--url", type=str, required=False, help="URL of the Daily room to join"
-    )
-    parser.add_argument(
-        "-k",
-        "--apikey",
-        type=str,
-        required=False,
-        help="Daily API Key (needed to create an owner token for the room)",
-    )
-
-    args, unknown = parser.parse_known_args()
-
-    url = args.url or os.getenv("DAILY_SAMPLE_ROOM_URL")
-    key = args.apikey or os.getenv("DAILY_API_KEY")
-
-    if not url:
-        raise Exception(
-            "No Daily room specified. use the -u/--url option from the command line, or set DAILY_SAMPLE_ROOM_URL in your environment to specify a Daily room URL."
-        )
-
-    if not key:
-        raise Exception(
-            "No Daily API key specified. use the -k/--apikey option from the command line, or set DAILY_API_KEY in your environment to specify a Daily API key, available from https://dashboard.daily.co/developers."
-        )
-
-    daily_rest_helper = DailyRESTHelper(
-        daily_api_key=key,
-        daily_api_url=os.getenv("DAILY_API_URL", "https://api.daily.co/v1"),
-        aiohttp_session=aiohttp_session,
-    )
-
-    # Create a meeting token for the given room with an expiration 1 hour in
-    # the future.
-    expiry_time: float = 60 * 60
-
-    token = await daily_rest_helper.get_token(url, expiry_time)
-
-    return (url, token, args)

examples/bot-ready-signalling/server/server.py

@@ -1,147 +0,0 @@
-#
-# Copyright (c) 2025, Daily
-#
-# SPDX-License-Identifier: BSD 2-Clause License
-#
-
-import argparse
-import os
-import subprocess
-from contextlib import asynccontextmanager
-from typing import Any, Dict
-
-import aiohttp
-from dotenv import load_dotenv
-from fastapi import FastAPI, HTTPException, Request
-from fastapi.middleware.cors import CORSMiddleware
-from fastapi.responses import JSONResponse
-
-from pipecat.transports.services.helpers.daily_rest import DailyRESTHelper, DailyRoomParams
-
-# Load environment variables from .env file
-load_dotenv(override=True)
-
-# Dictionary to track bot processes: {pid: (process, room_url)}
-bot_procs = {}
-
-# Store Daily API helpers
-daily_helpers = {}
-
-
-def cleanup():
-    """Cleanup function to terminate all bot processes.
-
-    Called during server shutdown.
-    """
-    for entry in bot_procs.values():
-        proc = entry[0]
-        proc.terminate()
-        proc.wait()
-
-
-@asynccontextmanager
-async def lifespan(app: FastAPI):
-    """FastAPI lifespan manager that handles startup and shutdown tasks.
-
-    - Creates aiohttp session
-    - Initializes Daily API helper
-    - Cleans up resources on shutdown
-    """
-    aiohttp_session = aiohttp.ClientSession()
-    daily_helpers["rest"] = DailyRESTHelper(
-        daily_api_key=os.getenv("DAILY_API_KEY", ""),
-        daily_api_url=os.getenv("DAILY_API_URL", "https://api.daily.co/v1"),
-        aiohttp_session=aiohttp_session,
-    )
-    yield
-    await aiohttp_session.close()
-    cleanup()
-
-
-# Initialize FastAPI app with lifespan manager
-app = FastAPI(lifespan=lifespan)
-
-# Configure CORS to allow requests from any origin
-app.add_middleware(
-    CORSMiddleware,
-    allow_origins=["*"],
-    allow_credentials=True,
-    allow_methods=["*"],
-    allow_headers=["*"],
-)
-
-
-async def create_room_and_token() -> tuple[str, str]:
-    """Helper function to create a Daily room and generate an access token.
-
-    Returns:
-        tuple[str, str]: A tuple containing (room_url, token)
-
-    Raises:
-        HTTPException: If room creation or token generation fails
-    """
-    room = await daily_helpers["rest"].create_room(DailyRoomParams())
-    if not room.url:
-        raise HTTPException(status_code=500, detail="Failed to create room")
-
-    token = await daily_helpers["rest"].get_token(room.url)
-    if not token:
-        raise HTTPException(status_code=500, detail=f"Failed to get token for room: {room.url}")
-
-    return room.url, token
-
-
-@app.post("/connect")
-async def bot_connect(request: Request) -> Dict[Any, Any]:
-    """Connect endpoint that creates a room and returns connection credentials.
-
-    This endpoint is called by client to establish a connection.
-
-    Returns:
-        Dict[Any, Any]: Authentication bundle containing room_url and token
-
-    Raises:
-        HTTPException: If room creation, token generation, or bot startup fails
-    """
-    print("Creating room for RTVI connection")
-    room_url, token = await create_room_and_token()
-    print(f"Room URL: {room_url}")
-
-    # Start the bot process
-    try:
-        bot_file = "signalling_bot"
-        proc = subprocess.Popen(
-            [f"python3 -m {bot_file} -u {room_url} -t {token}"],
-            shell=True,
-            bufsize=1,
-            cwd=os.path.dirname(os.path.abspath(__file__)),
-        )
-        bot_procs[proc.pid] = (proc, room_url)
-    except Exception as e:
-        raise HTTPException(status_code=500, detail=f"Failed to start subprocess: {e}")
-
-    # Return the authentication bundle in format expected by DailyTransport
-    return {"room_url": room_url, "token": token}
-
-
-if __name__ == "__main__":
-    import uvicorn
-
-    # Parse command line arguments for server configuration
-    default_host = os.getenv("HOST", "0.0.0.0")
-    default_port = int(os.getenv("FAST_API_PORT", "7860"))
-
-    parser = argparse.ArgumentParser(description="Daily Travel Companion FastAPI server")
-    parser.add_argument("--host", type=str, default=default_host, help="Host address")
-    parser.add_argument("--port", type=int, default=default_port, help="Port number")
-    parser.add_argument("--reload", action="store_true", help="Reload code on change")
-
-    config = parser.parse_args()
-
-    # Start the FastAPI server
-    uvicorn.run(
-        "server:app",
-        host=config.host,
-        port=config.port,
-        reload=config.reload,
-    )

examples/bot-ready-signalling/server/signalling_bot.py

@@ -1,95 +0,0 @@
-#
-# Copyright (c) 2024–2025, Daily
-#
-# SPDX-License-Identifier: BSD 2-Clause License
-#
-
-import asyncio
-import os
-import sys
-from dataclasses import dataclass
-
-import aiohttp
-from dotenv import load_dotenv
-from loguru import logger
-from runner import configure
-
-from pipecat.frames.frames import AudioRawFrame, EndFrame, OutputAudioRawFrame, TTSSpeakFrame
-from pipecat.pipeline.pipeline import Pipeline
-from pipecat.pipeline.runner import PipelineRunner
-from pipecat.pipeline.task import PipelineTask
-from pipecat.services.cartesia.tts import CartesiaTTSService
-from pipecat.transports.services.daily import DailyParams, DailyTransport
-
-load_dotenv(override=True)
-
-logger.remove(0)
-logger.add(sys.stderr, level="DEBUG")
-
-
-@dataclass
-class SilenceFrame(OutputAudioRawFrame):
-    def __init__(
-        self,
-        *,
-        sample_rate: int,
-        duration: float,
-    ):
-        # Initialize the parent class with the silent frame's data
-        super().__init__(
-            audio=self.create_silent_audio_frame(sample_rate, 1, duration).audio,
-            sample_rate=sample_rate,
-            num_channels=1,
-        )
-
-    @staticmethod
-    def create_silent_audio_frame(
-        sample_rate: int, num_channels: int, duration: float
-    ) -> AudioRawFrame:
-        """Create an AudioRawFrame containing silence."""
-        frame_size = num_channels * 2  # 2 bytes per sample for 16-bit audio
-        total_frames = int(sample_rate * duration)
-        total_bytes = total_frames * frame_size
-        silent_audio = bytes(total_bytes)  # Create a byte array filled with zeros
-        return AudioRawFrame(audio=silent_audio, sample_rate=sample_rate, num_channels=num_channels)
-
-
-async def main():
-    async with aiohttp.ClientSession() as session:
-        (room_url, _) = await configure(session)
-
-        transport = DailyTransport(
-            room_url, None, "Say One Thing", DailyParams(audio_out_enabled=True)
-        )
-
-        tts = CartesiaTTSService(
-            api_key=os.getenv("CARTESIA_API_KEY"),
-            voice_id="71a7ad14-091c-4e8e-a314-022ece01c121",  # British Reading Lady
-        )
-
-        runner = PipelineRunner()
-
-        task = PipelineTask(Pipeline([tts, transport.output()]))
-
-        # Register an event handler so we can play the audio when we receive a specific message
-        @transport.event_handler("on_app_message")
-        async def on_app_message(transport, message, sender):
-            logger.debug(f"Received app message: {message} - {sender}")
-            if "playable" not in message:
-                return
-            await task.queue_frames(
-                [
-                    SilenceFrame(
-                        sample_rate=task.params.audio_out_sample_rate,
-                        duration=0.5,
-                    ),
-                    TTSSpeakFrame(f"Hello there, how are you doing today ?"),
-                    EndFrame(),
-                ]
-            )
-
-        await runner.run(task)
-
-
-if __name__ == "__main__":
-    asyncio.run(main())

examples/canonical-metrics/.gitignore

@@ -1,161 +0,0 @@
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$py.class
-recordings/
-# C extensions
-*.so
-
-# Distribution / packaging
-.Python
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-share/python-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-MANIFEST
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.nox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-*.py,cover
-.hypothesis/
-.pytest_cache/
-cover/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-.pybuilder/
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
-
-# pyenv
-#   For a library or package, you might want to ignore these files since the code is
-#   intended to run in multiple environments; otherwise, check them in:
-# .python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# poetry
-#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
-#   This is especially recommended for binary packages to ensure reproducibility, and is more
-#   commonly ignored for libraries.
-#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock
-
-# pdm
-#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
-#pdm.lock
-#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
-#   in version control.
-#   https://pdm.fming.dev/#use-with-ide
-.pdm.toml
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
-.env
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
-
-# pytype static type analyzer
-.pytype/
-
-# Cython debug symbols
-cython_debug/
-
-# PyCharm
-#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-#  and can be added to the global gitignore or merged into this file.  For a more nuclear
-#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
-runpod.toml

examples/canonical-metrics/Dockerfile

@@ -1,10 +0,0 @@
-FROM python:3.10-bullseye
-RUN mkdir /app
-COPY *.py /app/
-COPY requirements.txt /app/
-WORKDIR /app
-RUN pip3 install -r requirements.txt
-
-EXPOSE 7860
-
-CMD ["python3", "server.py"]

examples/canonical-metrics/README.md

@@ -1,66 +0,0 @@
-# Chatbot with canonical-metrics
-
-This project implements a chatbot using a pipeline architecture that integrates audio processing, transcription, and a language model for conversational interactions. The chatbot operates within a daily communication environment, utilizing various services for text-to-speech and language model responses.
-
-## Features
-
-- **Audio Input and Output**: Captures microphone input and plays back audio responses.
-- **Voice Activity Detection**: Utilizes Silero VAD to manage audio input intelligently.
-- **Text-to-Speech**: Integrates ElevenLabs TTS service to convert text responses into audio.
-- **Language Model Interaction**: Uses OpenAI's GPT-4 model to generate responses based on user input.
-- **Transcription Services**: Captures and transcribes participant speech for analytics.
-- **Metrics Collection**: Sends audio data for analysis via Canonical Metrics Service.
-
-## Requirements
-
-- Python 3.10+
-- `python-dotenv`
-- Additional libraries from the `pipecat` package.
-
-## Setup
-
-1. Clone the repository.
-2. Install the required packages.
-3. Set up environment variables for API keys:
-   - `OPENAI_API_KEY`
-   - `ELEVENLABS_API_KEY`
-   - `CANONICAL_API_KEY`
-   - `CANONICAL_API_URL`
-4. Run the script.
-
-## Usage
-
-The chatbot introduces itself and engages in conversations, providing brief and creative responses. Designed for flexibility, it can support multiple languages with appropriate configuration.
-
-## Events
-
-- Participants joining or leaving the call are handled dynamically, adjusting the chatbot's behavior accordingly.
-
-
-ℹ️ The first time, things might take extra time to get started since VAD (Voice Activity Detection) model needs to be downloaded.
-
-## Get started
-
-```python
-python3 -m venv venv
-source venv/bin/activate
-pip install -r requirements.txt
-
-cp env.example .env # and add your credentials
-
-```
-
-## Run the server
-
-```bash
-python server.py
-```
-
-Then, visit `http://localhost:7860/` in your browser to start a chatbot session.
-
-## Build and test the Docker image
-
-```
-docker build -t chatbot .
-docker run --env-file .env -p 7860:7860 chatbot
-```

examples/canonical-metrics/bot.py

@@ -1,146 +0,0 @@
-#
-# Copyright (c) 2024–2025, Daily
-#
-# SPDX-License-Identifier: BSD 2-Clause License
-#
-
-import asyncio
-import os
-import sys
-import uuid
-
-import aiohttp
-from dotenv import load_dotenv
-from loguru import logger
-from runner import configure
-
-from pipecat.audio.vad.silero import SileroVADAnalyzer
-from pipecat.frames.frames import EndFrame
-from pipecat.pipeline.pipeline import Pipeline
-from pipecat.pipeline.runner import PipelineRunner
-from pipecat.pipeline.task import PipelineParams, PipelineTask
-from pipecat.processors.aggregators.openai_llm_context import OpenAILLMContext
-from pipecat.processors.audio.audio_buffer_processor import AudioBufferProcessor
-from pipecat.services.canonical.metrics import CanonicalMetricsService
-from pipecat.services.elevenlabs.tts import ElevenLabsTTSService
-from pipecat.services.openai.llm import OpenAILLMService
-from pipecat.transports.services.daily import DailyParams, DailyTransport
-
-load_dotenv(override=True)
-
-logger.remove(0)
-logger.add(sys.stderr, level="DEBUG")
-
-
-async def main():
-    async with aiohttp.ClientSession() as session:
-        (room_url, token) = await configure(session)
-
-        transport = DailyTransport(
-            room_url,
-            token,
-            "Chatbot",
-            DailyParams(
-                audio_out_enabled=True,
-                audio_in_enabled=True,
-                video_out_enabled=False,
-                vad_analyzer=SileroVADAnalyzer(),
-                transcription_enabled=True,
-                #
-                # Spanish
-                #
-                # transcription_settings=DailyTranscriptionSettings(
-                #     language="es",
-                #     tier="nova",
-                #     model="2-general"
-                # )
-            ),
-        )
-
-        tts = ElevenLabsTTSService(
-            api_key=os.getenv("ELEVENLABS_API_KEY"),
-            #
-            # English
-            #
-            voice_id="cgSgspJ2msm6clMCkdW9",
-            #
-            # Spanish
-            #
-            # model="eleven_multilingual_v2",
-            # voice_id="gD1IexrzCvsXPHUuT0s3",
-        )
-
-        llm = OpenAILLMService(api_key=os.getenv("OPENAI_API_KEY"))
-
-        messages = [
-            {
-                "role": "system",
-                #
-                # English
-                #
-                "content": "You are Chatbot, a friendly, helpful robot. Your goal is to demonstrate your capabilities in a succinct way. Your output will be converted to audio so don't include special characters in your answers. Respond to what the user said in a creative and helpful way, but keep your responses brief. Start by introducing yourself. Keep all your responses to 12 words or fewer.",
-                #
-                # Spanish
-                #
-                # "content": "Eres Chatbot, un amigable y útil robot. Tu objetivo es demostrar tus capacidades de una manera breve. Tus respuestas se convertiran a audio así que nunca no debes incluir caracteres especiales. Contesta a lo que el usuario pregunte de una manera creativa, útil y breve. Empieza por presentarte a ti mismo.",
-            },
-        ]
-
-        context = OpenAILLMContext(messages)
-        context_aggregator = llm.create_context_aggregator(context)
-
-        """
-        CanonicalMetrics uses AudioBufferProcessor under the hood to buffer the audio. On
-        call completion, CanonicalMetrics will send the audio buffer to Canonical for
-        analysis. Visit https://voice.canonical.chat to learn more.
-        """
-        audio_buffer_processor = AudioBufferProcessor(num_channels=2)
-        canonical = CanonicalMetricsService(
-            audio_buffer_processor=audio_buffer_processor,
-            aiohttp_session=session,
-            api_key=os.getenv("CANONICAL_API_KEY"),
-            call_id=str(uuid.uuid4()),
-            assistant="pipecat-chatbot",
-            assistant_speaks_first=True,
-            context=context,
-        )
-        pipeline = Pipeline(
-            [
-                transport.input(),  # microphone
-                context_aggregator.user(),
-                llm,
-                tts,
-                transport.output(),
-                canonical,  # uploads audio buffer to Canonical AI for metrics
-                audio_buffer_processor,  # captures audio into a buffer
-                context_aggregator.assistant(),
-            ]
-        )
-
-        task = PipelineTask(pipeline, params=PipelineParams(allow_interruptions=True))
-
-        @transport.event_handler("on_first_participant_joined")
-        async def on_first_participant_joined(transport, participant):
-            await audio_buffer_processor.start_recording()
-            await transport.capture_participant_transcription(participant["id"])
-            await task.queue_frames([context_aggregator.user().get_context_frame()])
-
-        @transport.event_handler("on_participant_left")
-        async def on_participant_left(transport, participant, reason):
-            print(f"Participant left: {participant}")
-            await task.cancel()
-
-        @transport.event_handler("on_call_state_updated")
-        async def on_call_state_updated(transport, state):
-            if state == "left":
-                # Here we don't want to cancel, we just want to finish sending
-                # whatever is queued, so we use an EndFrame().
-                await task.queue_frame(EndFrame())
-
-        runner = PipelineRunner()
-
-        await runner.run(task)
-
-
-if __name__ == "__main__":
-    asyncio.run(main())

examples/canonical-metrics/env.example

@@ -1,6 +0,0 @@
-DAILY_SAMPLE_ROOM_URL=https://yourdomain.daily.co/yourroom # (for joining the bot to the same room repeatedly for local dev)
-DAILY_API_KEY=7df...
-OPENAI_API_KEY=sk-PL...
-ELEVENLABS_API_KEY=aeb...
-CANONICAL_API_KEY=can...
-CANONICAL_API_URL=

examples/canonical-metrics/requirements.txt

@@ -1,5 +0,0 @@
-python-dotenv
-fastapi[all]
-uvicorn
-pipecat-ai[daily,openai,silero,elevenlabs,canonical]
-

examples/canonical-metrics/runner.py

@@ -1,55 +0,0 @@
-#
-# Copyright (c) 2024–2025, Daily
-#
-# SPDX-License-Identifier: BSD 2-Clause License
-#
-
-import argparse
-import os
-
-import aiohttp
-
-from pipecat.transports.services.helpers.daily_rest import DailyRESTHelper
-
-
-async def configure(aiohttp_session: aiohttp.ClientSession):
-    parser = argparse.ArgumentParser(description="Daily AI SDK Bot Sample")
-    parser.add_argument(
-        "-u", "--url", type=str, required=False, help="URL of the Daily room to join"
-    )
-    parser.add_argument(
-        "-k",
-        "--apikey",
-        type=str,
-        required=False,
-        help="Daily API Key (needed to create an owner token for the room)",
-    )
-
-    args, unknown = parser.parse_known_args()
-
-    url = args.url or os.getenv("DAILY_SAMPLE_ROOM_URL")
-    key = args.apikey or os.getenv("DAILY_API_KEY")
-
-    if not url:
-        raise Exception(
-            "No Daily room specified. use the -u/--url option from the command line, or set DAILY_SAMPLE_ROOM_URL in your environment to specify a Daily room URL."
-        )
-
-    if not key:
-        raise Exception(
-            "No Daily API key specified. use the -k/--apikey option from the command line, or set DAILY_API_KEY in your environment to specify a Daily API key, available from https://dashboard.daily.co/developers."
-        )
-
-    daily_rest_helper = DailyRESTHelper(
-        daily_api_key=key,
-        daily_api_url=os.getenv("DAILY_API_URL", "https://api.daily.co/v1"),
-        aiohttp_session=aiohttp_session,
-    )
-
-    # Create a meeting token for the given room with an expiration 1 hour in
-    # the future.
-    expiry_time: float = 60 * 60
-
-    token = await daily_rest_helper.get_token(url, expiry_time)
-
-    return (url, token)

examples/canonical-metrics/server.py

@@ -1,139 +0,0 @@
-#
-# Copyright (c) 2024–2025, Daily
-#
-# SPDX-License-Identifier: BSD 2-Clause License
-#
-
-import argparse
-import os
-import subprocess
-from contextlib import asynccontextmanager
-
-import aiohttp
-from dotenv import load_dotenv
-from fastapi import FastAPI, HTTPException, Request
-from fastapi.middleware.cors import CORSMiddleware
-from fastapi.responses import JSONResponse, RedirectResponse
-
-from pipecat.transports.services.helpers.daily_rest import DailyRESTHelper, DailyRoomParams
-
-MAX_BOTS_PER_ROOM = 1
-
-# Bot sub-process dict for status reporting and concurrency control
-bot_procs = {}
-
-daily_helpers = {}
-
-load_dotenv(override=True)
-
-
-def cleanup():
-    # Clean up function, just to be extra safe
-    for entry in bot_procs.values():
-        proc = entry[0]
-        proc.terminate()
-        proc.wait()
-
-
-@asynccontextmanager
-async def lifespan(app: FastAPI):
-    aiohttp_session = aiohttp.ClientSession()
-    daily_helpers["rest"] = DailyRESTHelper(
-        daily_api_key=os.getenv("DAILY_API_KEY", ""),
-        daily_api_url=os.getenv("DAILY_API_URL", "https://api.daily.co/v1"),
-        aiohttp_session=aiohttp_session,
-    )
-    yield
-    await aiohttp_session.close()
-    cleanup()
-
-
-app = FastAPI(lifespan=lifespan)
-
-app.add_middleware(
-    CORSMiddleware,
-    allow_origins=["*"],
-    allow_credentials=True,
-    allow_methods=["*"],
-    allow_headers=["*"],
-)
-
-
-@app.get("/")
-async def start_agent(request: Request):
-    print(f"!!! Creating room")
-    room = await daily_helpers["rest"].create_room(DailyRoomParams())
-    print(f"!!! Room URL: {room.url}")
-    # Ensure the room property is present
-    if not room.url:
-        raise HTTPException(
-            status_code=500,
-            detail="Missing 'room' property in request data. Cannot start agent without a target room!",
-        )
-
-    # Check if there is already an existing process running in this room
-    num_bots_in_room = sum(
-        1 for proc in bot_procs.values() if proc[1] == room.url and proc[0].poll() is None
-    )
-    if num_bots_in_room >= MAX_BOTS_PER_ROOM:
-        raise HTTPException(status_code=500, detail=f"Max bot limited reach for room: {room.url}")
-
-    # Get the token for the room
-    token = await daily_helpers["rest"].get_token(room.url)
-
-    if not token:
-        raise HTTPException(status_code=500, detail=f"Failed to get token for room: {room.url}")
-
-    # Spawn a new agent, and join the user session
-    # Note: this is mostly for demonstration purposes (refer to 'deployment' in README)
-    try:
-        proc = subprocess.Popen(
-            [f"python3 -m bot -u {room.url} -t {token}"],
-            shell=True,
-            bufsize=1,
-            cwd=os.path.dirname(os.path.abspath(__file__)),
-        )
-        bot_procs[proc.pid] = (proc, room.url)
-    except Exception as e:
-        raise HTTPException(status_code=500, detail=f"Failed to start subprocess: {e}")
-
-    return RedirectResponse(room.url)
-
-
-@app.get("/status/{pid}")
-def get_status(pid: int):
-    # Look up the subprocess
-    proc = bot_procs.get(pid)
-
-    # If the subprocess doesn't exist, return an error
-    if not proc:
-        raise HTTPException(status_code=404, detail=f"Bot with process id: {pid} not found")
-
-    # Check the status of the subprocess
-    if proc[0].poll() is None:
-        status = "running"
-    else:
-        status = "finished"
-
-    return JSONResponse({"bot_id": pid, "status": status})
-
-
-if __name__ == "__main__":
-    import uvicorn
-
-    default_host = os.getenv("HOST", "0.0.0.0")
-    default_port = int(os.getenv("FAST_API_PORT", "7860"))
-
-    parser = argparse.ArgumentParser(description="Daily Storyteller FastAPI server")
-    parser.add_argument("--host", type=str, default=default_host, help="Host address")
-    parser.add_argument("--port", type=int, default=default_port, help="Port number")
-    parser.add_argument("--reload", action="store_true", help="Reload code on change")
-
-    config = parser.parse_args()
-
-    uvicorn.run(
-        "server:app",
-        host=config.host,
-        port=config.port,
-        reload=config.reload,
-    )

examples/chatbot-audio-recording/.gitignore

@@ -1,161 +0,0 @@
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$py.class
-
-# C extensions
-*.so
-
-# Distribution / packaging
-.Python
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-share/python-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-MANIFEST
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.nox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-*.py,cover
-.hypothesis/
-.pytest_cache/
-cover/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-.pybuilder/
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
-
-# pyenv
-#   For a library or package, you might want to ignore these files since the code is
-#   intended to run in multiple environments; otherwise, check them in:
-# .python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# poetry
-#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
-#   This is especially recommended for binary packages to ensure reproducibility, and is more
-#   commonly ignored for libraries.
-#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock
-
-# pdm
-#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
-#pdm.lock
-#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
-#   in version control.
-#   https://pdm.fming.dev/#use-with-ide
-.pdm.toml
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
-.env
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
-
-# pytype static type analyzer
-.pytype/
-
-# Cython debug symbols
-cython_debug/
-
-# PyCharm
-#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-#  and can be added to the global gitignore or merged into this file.  For a more nuclear
-#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
-runpod.toml

examples/chatbot-audio-recording/Dockerfile

@@ -1,15 +0,0 @@
-FROM python:3.10-bullseye
-
-RUN mkdir /app
-RUN mkdir /app/assets
-RUN mkdir /app/utils
-COPY *.py /app/
-COPY requirements.txt /app/
-
-
-WORKDIR /app
-RUN pip3 install -r requirements.txt
-
-EXPOSE 7860
-
-CMD ["python3", "server.py"]

examples/chatbot-audio-recording/README.md

@@ -1,37 +0,0 @@
-# Simple Chatbot
-
-<img src="image.png" width="420px">
-
-This app connects you to a chatbot powered by GPT-4, complete with animations generated by Stable Video Diffusion.
-
-See a video of it in action: https://x.com/kwindla/status/1778628911817183509
-
-And a quick video walkthrough of the code: https://www.loom.com/share/13df1967161f4d24ade054e7f8753416
-
-ℹ️ The first time, things might take extra time to get started since VAD (Voice Activity Detection) model needs to be downloaded.
-
-## Get started
-
-```python
-python3 -m venv venv
-source venv/bin/activate
-pip install -r requirements.txt
-
-cp env.example .env # and add your credentials
-
-```
-
-## Run the server
-
-```bash
-python server.py
-```
-
-Then, visit `http://localhost:7860/` in your browser to start a chatbot session.
-
-## Build and test the Docker image
-
-```
-docker build -t chatbot .
-docker run --env-file .env -p 7860:7860 chatbot
-```

examples/chatbot-audio-recording/bot.py

@@ -1,162 +0,0 @@
-#
-# Copyright (c) 2024–2025, Daily
-#
-# SPDX-License-Identifier: BSD 2-Clause License
-#
-
-import asyncio
-import datetime
-import io
-import os
-import sys
-import wave
-
-import aiofiles
-import aiohttp
-from dotenv import load_dotenv
-from loguru import logger
-from runner import configure
-
-from pipecat.audio.vad.silero import SileroVADAnalyzer
-from pipecat.pipeline.pipeline import Pipeline
-from pipecat.pipeline.runner import PipelineRunner
-from pipecat.pipeline.task import PipelineParams, PipelineTask
-from pipecat.processors.aggregators.openai_llm_context import OpenAILLMContext
-from pipecat.processors.audio.audio_buffer_processor import AudioBufferProcessor
-from pipecat.services.elevenlabs.tts import ElevenLabsTTSService
-from pipecat.services.openai.llm import OpenAILLMService
-from pipecat.transports.services.daily import DailyParams, DailyTransport
-
-load_dotenv(override=True)
-
-logger.remove(0)
-logger.add(sys.stderr, level="DEBUG")
-
-# Create the recordings directory if it doesn't exist
-os.makedirs("recordings", exist_ok=True)
-
-
-async def save_audio(audio: bytes, sample_rate: int, num_channels: int, name: str):
-    if len(audio) > 0:
-        filename = os.path.join(
-            "recordings",
-            f"{name}_conversation_recording{datetime.datetime.now().strftime('%Y%m%d_%H%M%S')}.wav",
-        )
-        with io.BytesIO() as buffer:
-            with wave.open(buffer, "wb") as wf:
-                wf.setsampwidth(2)
-                wf.setnchannels(num_channels)
-                wf.setframerate(sample_rate)
-                wf.writeframes(audio)
-            async with aiofiles.open(filename, "wb") as file:
-                await file.write(buffer.getvalue())
-        print(f"Merged audio saved to {filename}")
-    else:
-        print("No audio data to save")
-
-
-async def main():
-    async with aiohttp.ClientSession() as session:
-        (room_url, token) = await configure(session)
-
-        transport = DailyTransport(
-            room_url,
-            token,
-            "Chatbot",
-            DailyParams(
-                audio_out_enabled=True,
-                audio_in_enabled=True,
-                video_out_enabled=False,
-                vad_analyzer=SileroVADAnalyzer(),
-                transcription_enabled=True,
-                #
-                # Spanish
-                #
-                # transcription_settings=DailyTranscriptionSettings(
-                #     language="es",
-                #     tier="nova",
-                #     model="2-general"
-                # )
-            ),
-        )
-
-        tts = ElevenLabsTTSService(
-            api_key=os.getenv("ELEVENLABS_API_KEY"),
-            #
-            # English
-            #
-            voice_id="cgSgspJ2msm6clMCkdW9",
-            #
-            # Spanish
-            #
-            # model="eleven_multilingual_v2",
-            # voice_id="gD1IexrzCvsXPHUuT0s3",
-        )
-
-        llm = OpenAILLMService(api_key=os.getenv("OPENAI_API_KEY"))
-
-        messages = [
-            {
-                "role": "system",
-                #
-                # English
-                #
-                "content": "You are Chatbot, a friendly, helpful robot. Your goal is to demonstrate your capabilities in a succinct way. Your output will be converted to audio so don't include special characters in your answers. Respond to what the user said in a creative and helpful way, but keep your responses brief. Start by introducing yourself. Keep all your response to 12 words or fewer.",
-                #
-                # Spanish
-                #
-                # "content": "Eres Chatbot, un amigable y útil robot. Tu objetivo es demostrar tus capacidades de una manera breve. Tus respuestas se convertiran a audio así que nunca no debes incluir caracteres especiales. Contesta a lo que el usuario pregunte de una manera creativa, útil y breve. Empieza por presentarte a ti mismo.",
-            },
-        ]
-
-        context = OpenAILLMContext(messages)
-        context_aggregator = llm.create_context_aggregator(context)
-
-        # NOTE: Watch out! This will save all the conversation in memory. You
-        # can pass `buffer_size` to get periodic callbacks.
-        audiobuffer = AudioBufferProcessor(enable_turn_audio=True)
-
-        pipeline = Pipeline(
-            [
-                transport.input(),  # microphone
-                context_aggregator.user(),
-                llm,
-                tts,
-                transport.output(),
-                audiobuffer,  # used to buffer the audio in the pipeline
-                context_aggregator.assistant(),
-            ]
-        )
-
-        task = PipelineTask(pipeline, params=PipelineParams(allow_interruptions=True))
-
-        @audiobuffer.event_handler("on_audio_data")
-        async def on_audio_data(buffer, audio, sample_rate, num_channels):
-            await save_audio(audio, sample_rate, num_channels, "full")
-
-        @audiobuffer.event_handler("on_user_turn_audio_data")
-        async def on_user_turn_audio_data(buffer, audio, sample_rate, num_channels):
-            await save_audio(audio, sample_rate, num_channels, "user")
-
-        @audiobuffer.event_handler("on_bot_turn_audio_data")
-        async def on_bot_turn_audio_data(buffer, audio, sample_rate, num_channels):
-            await save_audio(audio, sample_rate, num_channels, "bot")
-
-        @transport.event_handler("on_first_participant_joined")
-        async def on_first_participant_joined(transport, participant):
-            await audiobuffer.start_recording()
-            await transport.capture_participant_transcription(participant["id"])
-            await task.queue_frames([context_aggregator.user().get_context_frame()])
-
-        @transport.event_handler("on_participant_left")
-        async def on_participant_left(transport, participant, reason):
-            print(f"Participant left: {participant}")
-            await task.cancel()
-
-        runner = PipelineRunner()
-
-        await runner.run(task)
-
-
-if __name__ == "__main__":
-    asyncio.run(main())

examples/chatbot-audio-recording/env.example

@@ -1,4 +0,0 @@
-DAILY_SAMPLE_ROOM_URL=https://yourdomain.daily.co/yourroom # (for joining the bot to the same room repeatedly for local dev)
-DAILY_API_KEY=7df...
-OPENAI_API_KEY=sk-PL...
-ELEVENLABS_API_KEY=aeb...

examples/chatbot-audio-recording/requirements.txt

@@ -1,5 +0,0 @@
-aiofiles
-python-dotenv
-fastapi[all]
-uvicorn
-pipecat-ai[daily,openai,silero,elevenlabs]

examples/chatbot-audio-recording/runner.py

@@ -1,56 +0,0 @@
-#
-# Copyright (c) 2024–2025, Daily
-#
-# SPDX-License-Identifier: BSD 2-Clause License
-#
-
-import argparse
-import os
-
-import aiohttp
-
-from pipecat.transports.services.helpers.daily_rest import DailyRESTHelper
-
-
-async def configure(aiohttp_session: aiohttp.ClientSession):
-    parser = argparse.ArgumentParser(description="Daily AI SDK Bot Sample")
-    parser.add_argument(
-        "-u", "--url", type=str, required=False, help="URL of the Daily room to join"
-    )
-    parser.add_argument(
-        "-k",
-        "--apikey",
-        type=str,
-        required=False,
-        help="Daily API Key (needed to create an owner token for the room)",
-    )
-
-    args, unknown = parser.parse_known_args()
-
-    url = args.url or os.getenv("DAILY_SAMPLE_ROOM_URL")
-    key = args.apikey or os.getenv("DAILY_API_KEY")
-
-    if not url:
-        raise Exception(
-            "No Daily room specified. use the -u/--url option from the command line, or set DAILY_SAMPLE_ROOM_URL in your environment to specify a Daily room URL."
-        )
-
-    if not key:
-        raise Exception(
-            "No Daily API key specified. use the -k/--apikey option from the command line, or set DAILY_API_KEY in your environment to specify a Daily API key, available from https://dashboard.daily.co/developers."
-        )
-
-    daily_rest_helper = DailyRESTHelper(
-        daily_api_key=key,
-        daily_api_url=os.getenv("DAILY_API_URL", "https://api.daily.co/v1"),
-        aiohttp_session=aiohttp_session,
-    )
-
-    # Create a meeting token for the given room with an expiration 1 hour in
-    # the future.
-    expiry_time: float = 60 * 60
-
-    token = await daily_rest_helper.get_token(url, expiry_time)
-
-    return (url, token)
-    return (url, token)

examples/chatbot-audio-recording/server.py

@@ -1,139 +0,0 @@
-#
-# Copyright (c) 2024–2025, Daily
-#
-# SPDX-License-Identifier: BSD 2-Clause License
-#
-
-import argparse
-import os
-import subprocess
-from contextlib import asynccontextmanager
-
-import aiohttp
-from dotenv import load_dotenv
-from fastapi import FastAPI, HTTPException, Request
-from fastapi.middleware.cors import CORSMiddleware
-from fastapi.responses import JSONResponse, RedirectResponse
-
-from pipecat.transports.services.helpers.daily_rest import DailyRESTHelper, DailyRoomParams
-
-MAX_BOTS_PER_ROOM = 1
-
-# Bot sub-process dict for status reporting and concurrency control
-bot_procs = {}
-
-daily_helpers = {}
-
-load_dotenv(override=True)
-
-
-def cleanup():
-    # Clean up function, just to be extra safe
-    for entry in bot_procs.values():
-        proc = entry[0]
-        proc.terminate()
-        proc.wait()
-
-
-@asynccontextmanager
-async def lifespan(app: FastAPI):
-    aiohttp_session = aiohttp.ClientSession()
-    daily_helpers["rest"] = DailyRESTHelper(
-        daily_api_key=os.getenv("DAILY_API_KEY", ""),
-        daily_api_url=os.getenv("DAILY_API_URL", "https://api.daily.co/v1"),
-        aiohttp_session=aiohttp_session,
-    )
-    yield
-    await aiohttp_session.close()
-    cleanup()
-
-
-app = FastAPI(lifespan=lifespan)
-
-app.add_middleware(
-    CORSMiddleware,
-    allow_origins=["*"],
-    allow_credentials=True,
-    allow_methods=["*"],
-    allow_headers=["*"],
-)
-
-
-@app.get("/")
-async def start_agent(request: Request):
-    print(f"!!! Creating room")
-    room = await daily_helpers["rest"].create_room(DailyRoomParams())
-    print(f"!!! Room URL: {room.url}")
-    # Ensure the room property is present
-    if not room.url:
-        raise HTTPException(
-            status_code=500,
-            detail="Missing 'room' property in request data. Cannot start agent without a target room!",
-        )
-
-    # Check if there is already an existing process running in this room
-    num_bots_in_room = sum(
-        1 for proc in bot_procs.values() if proc[1] == room.url and proc[0].poll() is None
-    )
-    if num_bots_in_room >= MAX_BOTS_PER_ROOM:
-        raise HTTPException(status_code=500, detail=f"Max bot limited reach for room: {room.url}")
-
-    # Get the token for the room
-    token = await daily_helpers["rest"].get_token(room.url)
-
-    if not token:
-        raise HTTPException(status_code=500, detail=f"Failed to get token for room: {room.url}")
-
-    # Spawn a new agent, and join the user session
-    # Note: this is mostly for demonstration purposes (refer to 'deployment' in README)
-    try:
-        proc = subprocess.Popen(
-            [f"python3 -m bot -u {room.url} -t {token}"],
-            shell=True,
-            bufsize=1,
-            cwd=os.path.dirname(os.path.abspath(__file__)),
-        )
-        bot_procs[proc.pid] = (proc, room.url)
-    except Exception as e:
-        raise HTTPException(status_code=500, detail=f"Failed to start subprocess: {e}")
-
-    return RedirectResponse(room.url)
-
-
-@app.get("/status/{pid}")
-def get_status(pid: int):
-    # Look up the subprocess
-    proc = bot_procs.get(pid)
-
-    # If the subprocess doesn't exist, return an error
-    if not proc:
-        raise HTTPException(status_code=404, detail=f"Bot with process id: {pid} not found")
-
-    # Check the status of the subprocess
-    if proc[0].poll() is None:
-        status = "running"
-    else:
-        status = "finished"
-
-    return JSONResponse({"bot_id": pid, "status": status})
-
-
-if __name__ == "__main__":
-    import uvicorn
-
-    default_host = os.getenv("HOST", "0.0.0.0")
-    default_port = int(os.getenv("FAST_API_PORT", "7860"))
-
-    parser = argparse.ArgumentParser(description="Daily Storyteller FastAPI server")
-    parser.add_argument("--host", type=str, default=default_host, help="Host address")
-    parser.add_argument("--port", type=int, default=default_port, help="Port number")
-    parser.add_argument("--reload", action="store_true", help="Reload code on change")
-
-    config = parser.parse_args()
-
-    uvicorn.run(
-        "server:app",
-        host=config.host,
-        port=config.port,
-        reload=config.reload,
-    )

examples/deployment/flyio-example/Dockerfile

@@ -1,13 +0,0 @@
-FROM python:3.11-bullseye
-
-# Open port 7860 for http service
-ENV FAST_API_PORT=7860
-EXPOSE 7860
-
-# Install Python dependencies
-COPY *.py .
-COPY ./requirements.txt requirements.txt
-RUN pip3 install --no-cache-dir --upgrade -r requirements.txt
-
-# Start the FastAPI server
-CMD python3 bot_runner.py --port ${FAST_API_PORT}

examples/deployment/flyio-example/README.md

@@ -1,39 +0,0 @@
-# Fly.io deployment example
-
-This project modifies the `bot_runner.py` server to launch a new machine for each user session. This is a recommended approach for production vs. running shell processess as your deployment will quickly run out of system resources under load.
-
-For this example, we are using Daily as a WebRTC transport and provisioning a new room and token for each session. You can use another transport, such as WebSockets, by modifying the `bot.py` and `bot_runner.py` files accordingly.
-
-## Setting up your fly.io deployment
-
-### Create your fly.toml file
-
-You can copy the `example-fly.toml` as a reference. Be sure to change the app name to something unique.
-
-### Create your .env file
-
-Copy the base `env.example` to `.env` and enter the necessary API keys.
-
-`FLY_APP_NAME` should match that in the `fly.toml` file.
-
-### Launch a new fly.io project
-
-`fly launch` or `fly launch --org your-org-name`
-
-### Set the necessary app secrets from your .env
-
-Note: you can do this manually via the fly.io dashboard under the "secrets" sub-section of your deployment (e.g. "https://fly.io/apps/fly-app-name/secrets") or run the following terminal command:
-
-`cat .env | tr '\n' ' ' | xargs flyctl secrets set`
-
-### Deploy your machine
-
-`fly deploy`
-
-## Connecting to your bot
-
-Send a post request to your running fly.io instance:
-
-`curl --location --request POST 'https://YOUR_FLY_APP_NAME/'`
-
-This request will wait until the machine enters into a `starting` state, before returning the a room URL and token to join.

examples/deployment/flyio-example/bot.py

@@ -1,107 +0,0 @@
-#
-# Copyright (c) 2024–2025, Daily
-#
-# SPDX-License-Identifier: BSD 2-Clause License
-#
-
-import argparse
-import asyncio
-import os
-import sys
-
-from dotenv import load_dotenv
-from loguru import logger
-
-from pipecat.audio.vad.silero import SileroVADAnalyzer
-from pipecat.frames.frames import EndFrame
-from pipecat.pipeline.pipeline import Pipeline
-from pipecat.pipeline.runner import PipelineRunner
-from pipecat.pipeline.task import PipelineParams, PipelineTask
-from pipecat.processors.aggregators.openai_llm_context import OpenAILLMContext
-from pipecat.services.elevenlabs.tts import ElevenLabsTTSService
-from pipecat.services.openai.llm import OpenAILLMService
-from pipecat.transports.services.daily import DailyParams, DailyTransport
-
-load_dotenv(override=True)
-
-logger.remove(0)
-logger.add(sys.stderr, level="DEBUG")
-
-daily_api_key = os.getenv("DAILY_API_KEY", "")
-daily_api_url = os.getenv("DAILY_API_URL", "https://api.daily.co/v1")
-
-
-async def main(room_url: str, token: str):
-    transport = DailyTransport(
-        room_url,
-        token,
-        "Chatbot",
-        DailyParams(
-            api_url=daily_api_url,
-            api_key=daily_api_key,
-            audio_in_enabled=True,
-            audio_out_enabled=True,
-            video_out_enabled=False,
-            vad_analyzer=SileroVADAnalyzer(),
-            transcription_enabled=True,
-        ),
-    )
-
-    tts = ElevenLabsTTSService(
-        api_key=os.getenv("ELEVENLABS_API_KEY", ""),
-        voice_id=os.getenv("ELEVENLABS_VOICE_ID", ""),
-    )
-
-    llm = OpenAILLMService(api_key=os.getenv("OPENAI_API_KEY"))
-
-    messages = [
-        {
-            "role": "system",
-            "content": "You are Chatbot, a friendly, helpful robot. Your output will be converted to audio so don't include special characters other than '!' or '?' in your answers. Respond to what the user said in a creative and helpful way, but keep your responses brief. Start by saying hello.",
-        },
-    ]
-
-    context = OpenAILLMContext(messages)
-    context_aggregator = llm.create_context_aggregator(context)
-
-    pipeline = Pipeline(
-        [
-            transport.input(),
-            context_aggregator.user(),
-            llm,
-            tts,
-            transport.output(),
-            context_aggregator.assistant(),
-        ]
-    )
-
-    task = PipelineTask(pipeline, params=PipelineParams(allow_interruptions=True))
-
-    @transport.event_handler("on_first_participant_joined")
-    async def on_first_participant_joined(transport, participant):
-        await transport.capture_participant_transcription(participant["id"])
-        await task.queue_frames([context_aggregator.user().get_context_frame()])
-
-    @transport.event_handler("on_participant_left")
-    async def on_participant_left(transport, participant, reason):
-        await task.cancel()
-
-    @transport.event_handler("on_call_state_updated")
-    async def on_call_state_updated(transport, state):
-        if state == "left":
-            # Here we don't want to cancel, we just want to finish sending
-            # whatever is queued, so we use an EndFrame().
-            await task.queue_frame(EndFrame())
-
-    runner = PipelineRunner()
-
-    await runner.run(task)
-
-
-if __name__ == "__main__":
-    parser = argparse.ArgumentParser(description="Pipecat Bot")
-    parser.add_argument("-u", type=str, help="Room URL")
-    parser.add_argument("-t", type=str, help="Token")
-    config = parser.parse_args()
-
-    asyncio.run(main(config.u, config.t))

examples/deployment/flyio-example/bot_runner.py

@@ -1,209 +0,0 @@
-#
-# Copyright (c) 2024–2025, Daily
-#
-# SPDX-License-Identifier: BSD 2-Clause License
-#
-
-import argparse
-import os
-import subprocess
-from contextlib import asynccontextmanager
-
-import aiohttp
-from dotenv import load_dotenv
-from fastapi import FastAPI, HTTPException, Request
-from fastapi.middleware.cors import CORSMiddleware
-from fastapi.responses import JSONResponse
-
-from pipecat.transports.services.helpers.daily_rest import (
-    DailyRESTHelper,
-    DailyRoomObject,
-    DailyRoomParams,
-    DailyRoomProperties,
-)
-
-load_dotenv(override=True)
-
-
-# ------------ Configuration ------------ #
-
-MAX_SESSION_TIME = 5 * 60  # 5 minutes
-REQUIRED_ENV_VARS = [
-    "DAILY_API_KEY",
-    "OPENAI_API_KEY",
-    "ELEVENLABS_API_KEY",
-    "ELEVENLABS_VOICE_ID",
-    "FLY_API_KEY",
-    "FLY_APP_NAME",
-]
-
-FLY_API_HOST = os.getenv("FLY_API_HOST", "https://api.machines.dev/v1")
-FLY_APP_NAME = os.getenv("FLY_APP_NAME", "pipecat-fly-example")
-FLY_API_KEY = os.getenv("FLY_API_KEY", "")
-FLY_HEADERS = {"Authorization": f"Bearer {FLY_API_KEY}", "Content-Type": "application/json"}
-
-daily_helpers = {}
-
-
-# ----------------- API ----------------- #
-
-
-@asynccontextmanager
-async def lifespan(app: FastAPI):
-    aiohttp_session = aiohttp.ClientSession()
-    daily_helpers["rest"] = DailyRESTHelper(
-        daily_api_key=os.getenv("DAILY_API_KEY", ""),
-        daily_api_url=os.getenv("DAILY_API_URL", "https://api.daily.co/v1"),
-        aiohttp_session=aiohttp_session,
-    )
-    yield
-    await aiohttp_session.close()
-
-
-app = FastAPI(lifespan=lifespan)
-
-app.add_middleware(
-    CORSMiddleware,
-    allow_origins=["*"],
-    allow_credentials=True,
-    allow_methods=["*"],
-    allow_headers=["*"],
-)
-
-# ----------------- Main ----------------- #
-
-
-async def spawn_fly_machine(room_url: str, token: str):
-    async with aiohttp.ClientSession() as session:
-        # Use the same image as the bot runner
-        async with session.get(
-            f"{FLY_API_HOST}/apps/{FLY_APP_NAME}/machines", headers=FLY_HEADERS
-        ) as r:
-            if r.status != 200:
-                text = await r.text()
-                raise Exception(f"Unable to get machine info from Fly: {text}")
-
-            data = await r.json()
-            image = data[0]["config"]["image"]
-
-        # Machine configuration
-        cmd = f"python3 bot.py -u {room_url} -t {token}"
-        cmd = cmd.split()
-        worker_props = {
-            "config": {
-                "image": image,
-                "auto_destroy": True,
-                "init": {"cmd": cmd},
-                "restart": {"policy": "no"},
-                "guest": {"cpu_kind": "shared", "cpus": 1, "memory_mb": 1024},
-            },
-        }
-
-        # Spawn a new machine instance
-        async with session.post(
-            f"{FLY_API_HOST}/apps/{FLY_APP_NAME}/machines", headers=FLY_HEADERS, json=worker_props
-        ) as r:
-            if r.status != 200:
-                text = await r.text()
-                raise Exception(f"Problem starting a bot worker: {text}")
-
-            data = await r.json()
-            # Wait for the machine to enter the started state
-            vm_id = data["id"]
-
-        async with session.get(
-            f"{FLY_API_HOST}/apps/{FLY_APP_NAME}/machines/{vm_id}/wait?state=started",
-            headers=FLY_HEADERS,
-        ) as r:
-            if r.status != 200:
-                text = await r.text()
-                raise Exception(f"Bot was unable to enter started state: {text}")
-
-    print(f"Machine joined room: {room_url}")
-
-
-@app.post("/")
-async def start_bot(request: Request) -> JSONResponse:
-    try:
-        data = await request.json()
-        # Is this a webhook creation request?
-        if "test" in data:
-            return JSONResponse({"test": True})
-    except Exception as e:
-        pass
-
-    # Use specified room URL, or create a new one if not specified
-    room_url = os.getenv("DAILY_SAMPLE_ROOM_URL", "")
-
-    if not room_url:
-        params = DailyRoomParams(properties=DailyRoomProperties())
-        try:
-            room: DailyRoomObject = await daily_helpers["rest"].create_room(params=params)
-        except Exception as e:
-            raise HTTPException(status_code=500, detail=f"Unable to provision room {e}")
-    else:
-        # Check passed room URL exists, we should assume that it already has a sip set up
-        try:
-            room: DailyRoomObject = await daily_helpers["rest"].get_room_from_url(room_url)
-        except Exception:
-            raise HTTPException(status_code=500, detail=f"Room not found: {room_url}")
-
-    # Give the agent a token to join the session
-    token = await daily_helpers["rest"].get_token(room.url, MAX_SESSION_TIME)
-
-    if not room or not token:
-        raise HTTPException(status_code=500, detail=f"Failed to get token for room: {room_url}")
-
-    # Launch a new fly.io machine, or run as a shell process (not recommended)
-    run_as_process = os.getenv("RUN_AS_PROCESS", False)
-
-    if run_as_process:
-        try:
-            subprocess.Popen(
-                [f"python3 -m bot -u {room.url} -t {token}"],
-                shell=True,
-                bufsize=1,
-                cwd=os.path.dirname(os.path.abspath(__file__)),
-            )
-        except Exception as e:
-            raise HTTPException(status_code=500, detail=f"Failed to start subprocess: {e}")
-    else:
-        try:
-            await spawn_fly_machine(room.url, token)
-        except Exception as e:
-            raise HTTPException(status_code=500, detail=f"Failed to spawn VM: {e}")
-
-    # Grab a token for the user to join with
-    user_token = await daily_helpers["rest"].get_token(room.url, MAX_SESSION_TIME)
-
-    return JSONResponse(
-        {
-            "room_url": room.url,
-            "token": user_token,
-        }
-    )
-
-
-if __name__ == "__main__":
-    # Check environment variables
-    for env_var in REQUIRED_ENV_VARS:
-        if env_var not in os.environ:
-            raise Exception(f"Missing environment variable: {env_var}.")
-
-    parser = argparse.ArgumentParser(description="Pipecat Bot Runner")
-    parser.add_argument(
-        "--host", type=str, default=os.getenv("HOST", "0.0.0.0"), help="Host address"
-    )
-    parser.add_argument("--port", type=int, default=os.getenv("PORT", 7860), help="Port number")
-    parser.add_argument(
-        "--reload", action="store_true", default=False, help="Reload code on change"
-    )
-
-    config = parser.parse_args()
-
-    try:
-        import uvicorn
-
-        uvicorn.run("bot_runner:app", host=config.host, port=config.port, reload=config.reload)
-    except KeyboardInterrupt:
-        print("Pipecat runner shutting down...")

examples/deployment/flyio-example/env.example

@@ -1,8 +0,0 @@
-DAILY_API_KEY=
-DAILY_SAMPLE_ROOM_URL= # Enter a Daily room URL to use a set room URL each time (useful for local testing)
-OPENAI_API_KEY=
-ELEVENLABS_API_KEY=
-ELEVENLABS_VOICE_ID=
-FLY_API_KEY=
-FLY_APP_NAME=
-RUN_AS_PROCESS= # Spawn fly.io machine for each session or run as local process

examples/deployment/flyio-example/example-fly.toml

@@ -1,25 +0,0 @@
-# fly.toml app configuration file generated for pipecat-fly-example on 2024-07-01T15:04:53+01:00
-#
-# See https://fly.io/docs/reference/configuration/ for information about how to use this file.
-#
-
-app = 'pipecat-fly-example'
-primary_region = 'sjc'
-
-[build]
-
-[env]
-  FLY_APP_NAME = 'pipecat-fly-example'
-
-[http_service]
-  internal_port = 7860
-  force_https = true
-  auto_stop_machines = true
-  auto_start_machines = true
-  min_machines_running = 0
-  processes = ['app']
-
-[[vm]]
-  memory = 512
-  cpu_kind = 'shared'
-  cpus = 1

examples/deployment/flyio-example/requirements.txt

@@ -1,5 +0,0 @@
-pipecat-ai[daily,openai,silero]
-fastapi
-uvicorn
-python-dotenv
-loguru

examples/deployment/modal-example/.gitignore

@@ -1,91 +0,0 @@
-# Python
-__pycache__/
-*.py[cod]
-*$py.class
-*.so
-.Python
-build/
-dist/
-*.egg-info/
-*.egg
-.installed.cfg
-.eggs/
-downloads/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-share/python-wheels/
-MANIFEST
-
-# Virtual Environments
-venv/
-env/
-.env
-.venv/
-ENV/
-env.bak/
-venv.bak/
-
-# IDE
-.idea/
-.vscode/
-.spyderproject
-.spyproject
-.ropeproject
-
-# Testing and Coverage
-.coverage
-.coverage.*
-htmlcov/
-.pytest_cache/
-.tox/
-.nox/
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-.hypothesis/
-cover/
-
-# Logs and Databases
-*.log
-*.db
-db.sqlite3
-db.sqlite3-journal
-pip-log.txt
-
-# System Files
-.DS_Store
-Thumbs.db
-desktop.ini
-*.swp
-*.swo
-*.bak
-*.tmp
-*~
-
-# Build and Documentation
-docs/_build/
-.pybuilder/
-target/
-instance/
-.webassets-cache
-.pdm.toml
-.pdm-python
-.pdm-build/
-__pypackages__/
-
-# Other
-*.mo
-*.pot
-*.sage.py
-.mypy_cache/
-.dmypy.json
-dmypy.json
-.pyre/
-.pytype/
-cython_debug/
-.ipynb_checkpoints

examples/deployment/modal-example/README.md

@@ -1,37 +0,0 @@
-# Deploying Pipecat to Modal.com
-
-Barebones deployment example for [modal.com](https://www.modal.com)
-
-1. Install dependencies
-
-```bash
-python -m venv venv
-source venv/bin/active # or OS equivalent
-pip install -r requirements.txt
-```
-
-2. Setup .env
-
-```bash
-cp env.example .env
-```
-
-Alternatively, you can configure your Modal app to use [secrets](https://modal.com/docs/guide/secrets)
-
-3. Test the app locally
-
-```bash
-modal serve app.py
-```
-
-4. Deploy to production
-
-```bash
-modal deploy app.py
-```
-
-## Configuration options
-
-This app sets some sensible defaults for reducing cold starts, such as `minkeep_warm=1`, which will keep at least 1 warm instance ready for your bot function.
-
-It has been configured to only allow a concurrency of 1 (`max_inputs=1`) as each user will require their own running function.

examples/deployment/modal-example/app.py

@@ -1,80 +0,0 @@
-#
-# Copyright (c) 2024–2025, Daily
-#
-# SPDX-License-Identifier: BSD 2-Clause License
-#
-
-import os
-
-import aiohttp
-import modal
-from bot import _voice_bot_process
-from fastapi import HTTPException
-from fastapi.responses import JSONResponse
-from loguru import logger
-
-MAX_SESSION_TIME = 15 * 60  # 15 minutes
-
-app = modal.App("pipecat-modal")
-
-
-image = modal.Image.debian_slim(python_version="3.12").pip_install_from_requirements(
-    "requirements.txt"
-)
-
-
-@app.function(
-    image=image,
-    cpu=1.0,
-    secrets=[modal.Secret.from_dotenv()],
-    keep_warm=1,
-    enable_memory_snapshot=True,
-    max_inputs=1,  # Do not reuse instances across requests
-    retries=0,
-)
-def launch_bot_process(room_url: str, token: str):
-    _voice_bot_process(room_url, token)
-
-
-@app.function(
-    image=image,
-    secrets=[modal.Secret.from_dotenv()],
-)
-@modal.web_endpoint(method="POST")
-async def start():
-    from pipecat.transports.services.helpers.daily_rest import (
-        DailyRESTHelper,
-        DailyRoomParams,
-    )
-
-    logger.info("Request received")
-
-    async with aiohttp.ClientSession() as session:
-        daily_rest_helper = DailyRESTHelper(
-            daily_api_key=os.getenv("DAILY_API_KEY", ""),
-            daily_api_url=os.getenv("DAILY_API_URL", "https://api.daily.co/v1"),
-            aiohttp_session=session,
-        )
-
-        # Create new Daily room
-        room = await daily_rest_helper.create_room(DailyRoomParams())
-        if not room.url:
-            raise HTTPException(
-                status_code=500,
-                detail="Unable to create room",
-            )
-        logger.info(f"Created room: {room.url}")
-
-        # Create bot token for room
-        token = await daily_rest_helper.get_token(room.url, MAX_SESSION_TIME)
-        if not token:
-            raise HTTPException(status_code=500, detail=f"Failed to get token for room: {room.url}")
-
-        logger.info(f"Bot token created: {token}")
-
-        # Spawn a new bot process
-        launch_bot_process.spawn(room_url=room.url, token=token)
-
-        # Return room URL to the user to join
-        # Note: in production, you would want to return a token to the user
-        return JSONResponse(content={"room_url": room.url, token: token})

examples/deployment/modal-example/bot.py

@@ -1,95 +0,0 @@
-#
-# Copyright (c) 2024–2025, Daily
-#
-# SPDX-License-Identifier: BSD 2-Clause License
-#
-
-import asyncio
-import os
-import sys
-
-from dotenv import load_dotenv
-from loguru import logger
-
-from pipecat.audio.vad.silero import SileroVADAnalyzer
-from pipecat.pipeline.pipeline import Pipeline
-from pipecat.pipeline.runner import PipelineRunner
-from pipecat.pipeline.task import PipelineParams, PipelineTask
-from pipecat.processors.aggregators.openai_llm_context import OpenAILLMContext
-from pipecat.services.cartesia.tts import CartesiaTTSService
-from pipecat.services.openai.llm import OpenAILLMService
-from pipecat.transports.services.daily import DailyParams, DailyTransport
-
-load_dotenv(override=True)
-
-logger.remove(0)
-logger.add(sys.stderr, level="DEBUG")
-
-
-async def main(room_url: str, token: str):
-    transport = DailyTransport(
-        room_url,
-        token,
-        "bot",
-        DailyParams(
-            audio_in_enabled=True,
-            audio_out_enabled=True,
-            transcription_enabled=True,
-            vad_analyzer=SileroVADAnalyzer(),
-        ),
-    )
-
-    tts = CartesiaTTSService(
-        api_key=os.getenv("CARTESIA_API_KEY", ""), voice_id="71a7ad14-091c-4e8e-a314-022ece01c121"
-    )
-
-    llm = OpenAILLMService(api_key=os.getenv("OPENAI_API_KEY"))
-
-    messages = [
-        {
-            "role": "system",
-            "content": "You are a helpful LLM in a WebRTC call. Your goal is to demonstrate your capabilities in a succinct way. Your output will be converted to audio so don't include special characters in your answers. Respond to what the user said in a creative and helpful way.",
-        },
-    ]
-
-    context = OpenAILLMContext(messages)
-    context_aggregator = llm.create_context_aggregator(context)
-
-    pipeline = Pipeline(
-        [
-            transport.input(),
-            context_aggregator.user(),
-            llm,
-            tts,
-            transport.output(),
-            context_aggregator.assistant(),
-        ]
-    )
-
-    task = PipelineTask(
-        pipeline,
-        params=PipelineParams(
-            allow_interruptions=True,
-            enable_metrics=True,
-            enable_usage_metrics=True,
-            report_only_initial_ttfb=True,
-        ),
-    )
-
-    @transport.event_handler("on_first_participant_joined")
-    async def on_first_participant_joined(transport, participant):
-        await transport.capture_participant_transcription(participant["id"])
-        messages.append({"role": "system", "content": "Please introduce yourself to the user."})
-        await task.queue_frames([context_aggregator.user().get_context_frame()])
-
-    @transport.event_handler("on_participant_left")
-    async def on_participant_left(transport, participant, reason):
-        await task.cancel()
-
-    runner = PipelineRunner()
-
-    await runner.run(task)
-
-
-def _voice_bot_process(room_url: str, token: str):
-    asyncio.run(main(room_url, token))

examples/deployment/modal-example/env.example

@@ -1,3 +0,0 @@
-DAILY_API_KEY=
-OPENAI_API_KEY=
-CARTESIA_API_KEY=

examples/deployment/modal-example/requirements.txt

@@ -1,4 +0,0 @@
-python-dotenv==1.0.1
-modal==0.71.3
-pipecat-ai[daily,silero,cartesia,openai]
-fastapi==0.115.6

examples/deployment/pipecat-cloud-daily-pstn-server/README.md

@@ -1,178 +0,0 @@
-# Handling PSTN/SIP Dial-in on Pipecat Cloud
-
-This repository contains two server implementations for handling
-the pinless dial-in workflow in Pipecat Cloud. This is the companion to the
-Pipecat Cloud [pstn_sip starter image](https://github.com/daily-co/pipecat-cloud-images/tree/main/pipecat-starters/pstn_sip).
-In addition you can use `/api/dial` to trigger dial-out, and
-eventually, call-transfers.
-
-1. [FastAPI Server](fastapi-webhook-server/README.md) -
-   A FastAPI implementation that handles PSTN (Public Switched Telephone
-   Network) and SIP (Session Initiation Protocol) calls using the Daily API.
-
-2. [Next.js Serverless](nextjs-webhook-server/README.md) -
-   A Next.js API implementation designed for deployment on Vercel's
-   serverless platform.
-
-Both implementations provide:
-
-- HMAC signature validation for pinless webhook
-- Structured logging
-- Support for dial-in and dial-out settings
-- Voicemail detection and call transfer functionality (coming soon)
-- Test request handling
-
-## Choosing an Implementation
-
-- Use the **FastAPI Server** if you:
-
-  - Need a standalone server
-  - Prefer Python and FastAPI
-  - Want to deploy to traditional hosting platforms
-
-- Use the **Next.js Serverless** implementation if you:
-  - Want serverless deployment
-  - Prefer JavaScript/TypeScript
-  - Already use Next.js and Vercel for other projects
-  - Need quick scaling and zero maintenance
-
-## Prerequisites
-
-### Environment Variables
-
-Both implementations require similar environment variables:
-
-- `PIPECAT_CLOUD_API_KEY`: Pipecat Cloud API Key, begins with pk\_\*
-- `AGENT_NAME`: Your Daily agent name
-- `PINLESS_HMAC_SECRET`: Your HMAC secret for request verification
-- `LOG_LEVEL`: (Optional) Logging level (defaults to 'info')
-
-See the individual README files in each implementation directory for
-specific setup instructions.
-
-### Phone number setup
-
-You can buy a phone number through the Pipecat Cloud Dashboard:
-
-1. Go to `Settings` > `Telephony`
-2. Follow the UI to purchase a phone number
-3. Configure the webhook URL to receive incoming calls (e.g. `https://my-webhook-url.com/api/dial`)
-
-Or purchase the number using Daily's
-[PhoneNumbers API](https://docs.daily.co/reference/rest-api/phone-numbers).
-
-```bash
-curl --request POST \
---url https://api.daily.co/v1/domain-dialin-config \
---header 'Authorization: Bearer $TOKEN' \
---header 'Content-Type: application/json' \
---data-raw '{
-	"type": "pinless_dialin",
-	"name_prefix": "Customer1",
-    "phone_number": "+1PURCHASED_NUM",
-	"room_creation_api": "https://example.com/api/dial",
-    "hold_music_url": "https://example.com/static/ringtone.mp3",
-	"timeout_config": {
-		"message": "No agent is available right now"
-	}
-}'
-```
-
-The API will return a static SIP URI (`sip_uri`) that can be called
-from other SIP services.
-
-### `room_creation_api`
-
-To make and receive calls currently you have to host a server that
-handles incoming calls. In the coming weeks, incoming calls will be
-directly handled within Daily and we will expose an endpoint similar
-to `{service}/start` that will manage this for you.
-
-In the meantime, the server described below serves as the webhook
-handler for the `room_creation_api`. Configure your pinless phone
-number or SIP interconnect to the `ngrok` tunnel or
-the actual server URL, append `/api/dial` to the webhook URL.
-
-## Example curl commands
-
-Note: Replace `http://localhost:3000` with your actual server URL and
-phone numbers with valid values for your use case.
-
-### Dialin Request
-
-The server will receive a request when a call is received from Daily.
-
-### Dialout Request
-
-Dial a number, will use any purchased number
-
-```bash
-curl -X POST http://localhost:3000/api/dial \
-  -H "Content-Type: application/json" \
-  -d '{
-    "dialout_settings": [
-      {
-        "phoneNumber": "+1234567890",
-      }
-    ]
-  }'
-```
-
-Dial a number with callerId, which is the UUID of a purchased number.
-
-```bash
-curl -X POST http://localhost:3000/api/dial \
-  -H "Content-Type: application/json" \
-  -d '{
-    "dialout_settings": [
-      {
-        "phoneNumber": "+1234567890",
-        "callerId": "purchased_phone_uuid"
-      }
-    ]
-  }'
-```
-
-Dial a number
-
-```bash
-curl -X POST http://localhost:3000/api/dial \
-  -H "Content-Type: application/json" \
-  -d '{
-    "dialout_settings": [
-      {
-        "phoneNumber": "+1234567890",
-        "callerId": "purchased_phone_uuid"
-      }
-    ]
-  }'
-```
-
-### Advanced Request with Voicemail Detection
-
-```bash
-curl -X POST http://localhost:3000/api/dial \
-  -H "Content-Type: application/json" \
-  -d '{
-    "To": "+1234567890",
-    "From": "+1987654321",
-    "callId": "call-uuid-123",
-    "callDomain": "domain-uuid-456",
-    "dialout_settings": [
-      {
-        "phoneNumber": "+1234567890",
-        "callerId": "purchased_phone_uuid"
-      }
-    ],
-    "voicemail_detection": {
-      "testInPrebuilt": true
-    },
-    "call_transfer": {
-      "mode": "dialout",
-      "speakSummary": true,
-      "storeSummary": true,
-      "operatorNumber": "+1234567890",
-      "testInPrebuilt": true
-    }
-  }'
-```

examples/deployment/pipecat-cloud-daily-pstn-server/fastapi-webhook-server/README.md

@@ -1,98 +0,0 @@
-# FastAPI server for handling Daily PSTN/SIP Webhook
-
-A FastAPI server that handles PSTN (Public Switched Telephone Network) and SIP (Session Initiation Protocol) calls using the Daily API.
-
-## Setup
-
-1. Clone the repository
-
-2. Navigate to the `fastapi-webhook-server` directory:
-
-   ```bash
-   cd fastapi-webhook-server
-   ```
-
-3. Install dependencies:
-
-   ```bash
-   pip install -r requirements.txt
-   ```
-
-4. Copy `env.example` to `.env`:
-
-   ```bash
-   cp env.example .env
-   ```
-
-5. Update `.env` with your credentials:
-
-   - `AGENT_NAME`: Your Daily agent name
-   - `PIPECAT_CLOUD_API_KEY`: Your Daily API key
-   - `PINLESS_HMAC_SECRET`: Your HMAC secret for request verification
-
-## Running the Server
-
-Start the server:
-
-```bash
-python server.py
-```
-
-The server will run on `http://localhost:7860` and you can expose it via ngrok for testing:
-
-```bash
-`ngrok http 7860`
-```
-
-> Tip: Use a subdomain for a consistent URL (e.g. `ngrok http -subdomain=mydomain http://localhost:7860`)
-
-## API Endpoints
-
-### GET /
-
-Health check endpoint that returns a "Hello, World!" message.
-
-### POST /api/dial
-
-Initiates a PSTN/SIP call with the following request body format:
-
-```json
-{
-  "To": "+14152251493",
-  "From": "+14158483432",
-  "callId": "string-contains-uuid",
-  "callDomain": "string-contains-uuid",
-  "dialout_settings": [
-    {
-      "phoneNumber": "+14158483432",
-      "callerId": "+14152251493"
-    }
-  ],
-  "voicemail_detection": {
-    "testInPrebuilt": true
-  },
-  "call_transfer": {
-    "mode": "dialout",
-    "speakSummary": true,
-    "storeSummary": true,
-    "operatorNumber": "+14152250006",
-    "testInPrebuilt": true
-  }
-}
-```
-
-#### Response
-
-Returns a JSON object containing:
-
-- `status`: Success/failure status
-- `data`: Response from Daily API
-- `room_properties`: Properties of the created Daily room
-
-## Error Handling
-
-- 401: Invalid signature
-- 400: Invalid authorization header (e.g. missing Daily API key in bot.py)
-- 405: Method not allowed (e.g. incorrect route on the webhook URL)
-- 500: Server errors (missing API key, network issues)
-- Other status codes are passed through from the Daily API

examples/deployment/pipecat-cloud-daily-pstn-server/fastapi-webhook-server/env.example

@@ -1,3 +0,0 @@
-AGENT_NAME="your-agent-name"
-PIPECAT_CLOUD_API_KEY="your-daily-api-key"
-PINLESS_HMAC_SECRET="hmac-secret-pinless-dialin"

examples/deployment/pipecat-cloud-daily-pstn-server/fastapi-webhook-server/requirements.txt

@@ -1,6 +0,0 @@
-fastapi
-uvicorn
-python-dotenv
-requests
-pydantic
-loguru

examples/deployment/pipecat-cloud-daily-pstn-server/fastapi-webhook-server/server.py

@@ -1,202 +0,0 @@
-#
-# Copyright (c) 2025, Daily
-#
-# SPDX-License-Identifier: BSD 2-Clause License
-#
-
-# server.py
-
-
-import base64  # for calculating hmac signature
-import hmac
-import os  # for accessing environment variables
-import time  # for setting expiration time
-from typing import Any, Dict, List, Optional
-
-import requests
-from dotenv import load_dotenv
-from fastapi import FastAPI, HTTPException, Request
-from loguru import logger
-from pydantic import BaseModel, Field
-
-load_dotenv(override=True)
-
-app = FastAPI()
-
-
-class RoomRequest(BaseModel):
-    test: Optional[str] = Field(None, alias="Test", description="Test field")
-    To: Optional[str] = Field(None, alias="to", description="Destination phone number")
-    From: Optional[str] = Field(None, alias="from", description="Source phone number")
-    callId: Optional[str] = Field(None, alias="call_id", description="Unique call identifier")
-    callDomain: Optional[str] = Field(
-        None, alias="call_domain", description="Call domain identifier"
-    )
-    dialout_settings: Optional[List[Dict[str, Any]]] = Field(
-        None, description="An array of phone numbers or SIP URIs to dialout to"
-    )
-    voicemail_detection: Optional[Dict[str, Any]] = Field(
-        None, description="A flag to perform voicemail or answeing-machine detection"
-    )
-    call_transfer: Optional[Dict[str, Any]] = Field(None, description="to initiate a call transfer")
-
-    class Config:
-        populate_by_name = True
-        alias_generator = None
-
-
-"""
-    body can contain any fields, but for handling PSTN/SIP, 
-    we recommend sending the following custom values:
-    dialin, dialout, voicemail detection, and call transfer
-    
-    
-    "To": "+14152251493",
-    "From": "+14158483432",
-    "callId": "string-contains-uuid",
-    "callDomain": "string-contains-uuid"
-    These need to be remapped to dialin_settings
-
-    "dialout_settings": [
-        {"phoneNumber": "+14158483432", "callerId": "+14152251493"}, 
-        {"sipUri": "sip:username@sip.hostname"}
-        ],
-    },
-
-    voicemail_detection:{
-        testInPrebuilt: true
-    },
-
-    "call_transfer": {
-        "mode": "dialout",
-        "speakSummary": true,
-        "storeSummary": true,
-        "operatorNumber": "+14152250006",
-        "testInPrebuilt": true
-    }
-"""
-
-
-@app.get("/")
-async def read_root():
-    return {"message": "Hello, World!"}
-
-
-@app.post("/api/dial")
-async def dial(request: RoomRequest, raw_request: Request):
-    logger.info("Incoming request to /dial:")
-    logger.info(f"Headers: {dict(raw_request.headers)}")
-    raw_body = await raw_request.body()
-    raw_body_str = raw_body.decode()
-    logger.info(f"Raw body: {raw_body_str}")
-    logger.info(f"Parsed body: {request.dict()}")
-
-    # calculate signature and compare/verify
-    hmac_secret = os.getenv("PINLESS_HMAC_SECRET")
-    timestamp = raw_request.headers.get("x-pinless-timestamp")
-    signature = raw_request.headers.get("x-pinless-signature")
-
-    if not hmac_secret:
-        logger.debug("Skipping HMAC validation - PINLESS_HMAC_SECRET not set")
-    elif timestamp and signature:
-        message = timestamp + "." + raw_body_str
-
-        base64_decoded_secret = base64.b64decode(hmac_secret)
-        computed_signature = base64.b64encode(
-            hmac.new(base64_decoded_secret, message.encode(), "sha256").digest()
-        ).decode()
-
-        if computed_signature != signature:
-            logger.error(f"Invalid signature. Expected {signature}, got {computed_signature}")
-            raise HTTPException(status_code=401, detail="Invalid signature")
-    else:
-        logger.debug("Skipping HMAC validation - no signature headers present")
-
-    if request.test == "test":
-        logger.debug("Test request received")
-        return {"status": "success", "message": "Test request received"}
-
-    dialin_settings = None
-    # these fields are camelCase in the request
-    required_fields = ["To", "From", "callId", "callDomain"]
-    if all(
-        field in request.dict() and request.dict()[field] is not None for field in required_fields
-    ):
-        # transform from camelCase to snake_case because daily-python expects snake_case
-        dialin_settings = {
-            "From": request.From,
-            "To": request.To,
-            "call_id": request.callId,
-            "call_domain": request.callDomain,
-            # transform from camelCase to snake_case
-        }
-        logger.debug(f"Populated dialin_settings from request: {dialin_settings}")
-
-    daily_room_properties = {
-        "enable_dialout": request.dialout_settings is not None,
-    }
-
-    if dialin_settings is not None:
-        sip_config = {
-            "display_name": request.From,
-            "sip_mode": "dial-in",
-            "num_endpoints": 2 if request.call_transfer is not None else 1,
-            "codecs": {"audio": ["OPUS"]},
-        }
-        daily_room_properties["sip"] = sip_config
-
-    # Setting default expiry to 5 minutes from now
-    daily_room_properties["exp"] = int(time.time()) + (5 * 60)
-
-    logger.debug(f"Daily room properties: {daily_room_properties}")
-    payload = {
-        "createDailyRoom": True,
-        "dailyRoomProperties": daily_room_properties,
-        "body": {
-            "dialin_settings": dialin_settings,
-            "dialout_settings": request.dialout_settings,
-            "voicemail_detection": request.voicemail_detection,
-            "call_transfer": request.call_transfer,
-        },
-    }
-
-    pcc_api_key = os.getenv("PIPECAT_CLOUD_API_KEY")
-    agent_name = os.getenv("AGENT_NAME", "my-first-agent")
-
-    if not pcc_api_key:
-        raise HTTPException(status_code=500, detail="DAILY_API_KEY environment variable is not set")
-
-    headers = {"Authorization": f"Bearer {pcc_api_key}", "Content-Type": "application/json"}
-
-    url = f"https://api.pipecat.daily.co/v1/public/{agent_name}/start"
-
-    logger.debug(f"Making API call to Daily: {url} {headers} {payload}")
-
-    try:
-        response = requests.post(url, json=payload, headers=headers)
-        response.raise_for_status()
-        response_data = response.json()
-        logger.debug(f"Response: {response_data}")
-        return {
-            "status": "success",
-            "data": response_data,
-            "room_properties": daily_room_properties,
-        }
-    except requests.exceptions.HTTPError as e:
-        # Pass through the status code and error details from the Daily API
-        status_code = e.response.status_code
-        error_detail = e.response.json() if e.response.content else str(e)
-        logger.error(f"HTTP error: {error_detail}")
-        raise HTTPException(status_code=status_code, detail=error_detail)
-    except requests.exceptions.RequestException as e:
-        logger.error(f"Request error: {str(e)}")
-        raise HTTPException(status_code=500, detail=str(e))
-
-
-if __name__ == "__main__":
-    try:
-        import uvicorn
-
-        uvicorn.run(app, host="0.0.0.0", port=7860)
-    except KeyboardInterrupt:
-        logger.info("Server stopped manually")

examples/deployment/pipecat-cloud-daily-pstn-server/nextjs-webhook-server/.gitignore

@@ -1,53 +0,0 @@
-# dependencies
-/node_modules
-/.pnp
-.pnp.js
-
-# testing
-/coverage
-
-# next.js
-/.next/
-/out/
-
-# production
-/build
-
-# misc
-.DS_Store
-*.pem
-
-# debug
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-.pnpm-debug.log*
-
-# local env files
-.env*.local
-
-# vercel
-.vercel
-
-# typescript
-*.tsbuildinfo
-next-env.d.ts
-
-# IDE specific files
-.idea/
-.vscode/
-*.swp
-*.swo
-
-# Logs
-logs
-*.log
-
-# OS generated files
-.DS_Store
-.DS_Store?
-._*
-.Spotlight-V100
-.Trashes
-ehthumbs.db
-Thumbs.db

examples/deployment/pipecat-cloud-daily-pstn-server/nextjs-webhook-server/README.md

@@ -1,115 +0,0 @@
-# Next.js server for handling Daily PSTN/SIP Webhook
-
-Next.js API routes for handling Daily PSTN/SIP Pipecat requests.
-
-## Features
-
-- API endpoint for handling Daily PSTN/SIP Pipecat requests
-- HMAC signature validation
-- Structured logging with Pino
-- Support for dial-in and dial-out settings
-- Voicemail detection and call transfer functionality
-- Test request handling
-
-## Setup
-
-1. Clone the repository
-
-2. Navigate to the `nextjs-webhook-server` directory:
-
-   ```bash
-   cd nextjs-webhook-server
-   ```
-
-3. Install dependencies:
-
-   ```bash
-   npm install
-   ```
-
-4. Create `.env.local` file with your credentials:
-
-   ```bash
-   cp env.local.example .env.local
-   ```
-
-5. Update your `.env` with your secrets:
-
-   ```bash
-   PIPECAT_CLOUD_API_KEY=pk_*
-   AGENT_NAME=my-first-agent
-   PINLESS_HMAC_SECRET=your_hmac_secret
-   LOG_LEVEL=info
-   ```
-
-### Running the server
-
-Run the development server:
-
-```bash
-npm run dev
-```
-
-The server will run on `http://localhost:7860` and you can expose it via ngrok for testing:
-
-```bash
-`ngrok http 7860`
-```
-
-> Tip: Use a subdomain for a consistent URL (e.g. `ngrok http -subdomain=mydomain http://localhost:7860`)
-
-## API Endpoints
-
-### GET /api
-
-Returns a simple "Hello, World!" message with a cute cat emoji to verify the server is running.
-
-### POST /api/dial
-
-Handles dial-in and dial-out requests for Pipecat Cloud.
-
-#### Test Requests
-
-The endpoint handles test requests when a webhook is configured. Send a request with `"Test": "test"` to verify your setup:
-
-```json
-{
-  "Test": "test"
-}
-```
-
-#### Production Request Format
-
-```json
-{
-  // for dial-in from webhook
-  "To": "+14152251493",
-  "From": "+14158483432",
-  "callId": "string-contains-uuid",
-  "callDomain": "string-contains-uuid",
-  // for making a dial out to a phone or SIP
-  "dialout_settings": [
-    { "phoneNumber": "+14158483432", "callerId": "purchased_phone_uuid" },
-    { "sipUri": "sip:username@sip.hostname.com" }
-  ]
-}
-```
-
-## Deployment
-
-The application is configured for Vercel deployment:
-
-1. Push your code to a Git repository
-2. Import your project in Vercel dashboard
-3. Configure environment variables:
-   - `PIPECAT_CLOUD_API_KEY`
-   - `AGENT_NAME`
-   - `PINLESS_HMAC_SECRET`
-   - `LOG_LEVEL` (optional, defaults to 'info')
-4. Deploy!
-
-## Security
-
-- HMAC signature validation for request authentication
-- Environment variables for sensitive credentials
-- Method validation (POST only for /dial)

examples/deployment/pipecat-cloud-daily-pstn-server/nextjs-webhook-server/env.local.example

@@ -1,4 +0,0 @@
-AGENT_NAME=my-first-agent
-PIPECAT_CLOUD_API_KEY=your_daily_api_key
-PINLESS_HMAC_SECRET=your_hmac_secret
-LOG_LEVEL="info"

examples/deployment/pipecat-cloud-daily-pstn-server/nextjs-webhook-server/package.json

@@ -1,22 +0,0 @@
-{
-  "name": "my-daily-app",
-  "version": "0.1.0",
-  "private": true,
-  "scripts": {
-    "dev": "next dev -p 7860",
-    "build": "next build",
-    "start": "next start -p 7860",
-    "lint": "next lint"
-  },
-  "dependencies": {
-    "axios": "^1.6.0",
-    "next": "^14.0.0",
-    "pino": "^8.15.0",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0"
-  },
-  "devDependencies": {
-    "eslint": "^8.46.0",
-    "eslint-config-next": "^14.0.0"
-  }
-}

examples/deployment/pipecat-cloud-daily-pstn-server/nextjs-webhook-server/pages/api/dial.js

@@ -1,176 +0,0 @@
-import { logger } from '../../lib/utils'; 
-import axios from 'axios';
-import crypto from 'crypto';
-
-const validateSignature = (body, signature, timestamp, secret) => {
-  // Skip if any required fields are missing
-  if (!signature || !timestamp || !secret) {
-    logger.warn('Missing required fields for HMAC validation');
-    return true;
-  }
-
-  try {
-    const decodedSecret = Buffer.from(secret, 'base64');
-    const hmac = crypto.createHmac('sha256', decodedSecret);
-    const signatureData = `${timestamp}.${body}`;
-    const computedSignature = hmac.update(signatureData).digest('base64');
-    
-    logger.debug('Signature validation:', {
-      timestamp,
-      signatureData: signatureData.substring(0, 50) + '...',
-      computedSignature,
-      receivedSignature: signature
-    });
-    
-    return computedSignature === signature;
-  } catch (error) {
-    logger.error('Error validating signature:', error);
-    return true; // Allow request to proceed on error
-  }
-};
-
-export default async function handler(req, res) {
-  // Only allow POST requests
-  if (req.method !== 'POST') {
-    return res.status(405).json({ error: 'Method not allowed' });
-  }
-
-  try {
-    logger.info('Incoming request to /api/dial:');
-    logger.info(`Headers: ${JSON.stringify(req.headers)}`);
-    
-    const rawBody = JSON.stringify(req.body);
-    logger.info(`Raw body: ${rawBody}`);
-
-    const signature = req.headers['x-pinless-signature'];
-    const timestamp = req.headers['x-pinless-timestamp'];
-    
-    if (signature && timestamp) {
-      logger.info('Validating HMAC signature');
-      if (!validateSignature(rawBody, signature, timestamp, process.env.PINLESS_HMAC_SECRET)) {
-        logger.error('Invalid HMAC signature', { signature, timestamp });
-        return res.status(401).json({ 
-          error: 'Invalid signature',
-          message: 'Invalid HMAC signature'
-        });
-      }
-    } else {
-      logger.info('Skipping HMAC validation - no signature headers present');
-    }
-
-    // Extract request data
-    const {
-      Test: test,
-      To,
-      From,
-      callId,
-      callDomain,
-      dialout_settings,
-      voicemail_detection,
-      call_transfer
-    } = req.body;
-
-    // Handle test requests when a webhook is configured
-    if (test === 'test') {
-      logger.debug('Test request received');
-      return res.status(200).json({ status: 'success', message: 'Test request received' });
-    }
-
-    // Process dialin settings
-    let dialin_settings = null;
-    const requiredFields = ['To', 'From', 'callId', 'callDomain'];
-    
-    if (requiredFields.every(field => req.body[field] !== undefined && req.body[field] !== null)) {
-      dialin_settings = {
-        // snake_case because pipecat expects this format
-        From,
-        To,
-        call_id: callId, 
-        call_domain: callDomain,
-      };
-      logger.debug(`Populated dialin_settings from request: ${JSON.stringify(dialin_settings)}`);
-    }
-
-    // Set up Daily room properties
-    const daily_room_properties = {
-      enable_dialout: dialout_settings !== undefined && dialout_settings !== null,
-      exp: Math.floor(Date.now() / 1000) + (5 * 60), // 5 minutes from now
-    };
-
-    // Configure SIP if dialin settings are provided
-    if (dialin_settings !== null) {
-      const sip_config = {
-        display_name: From,
-        sip_mode: 'dial-in',
-        num_endpoints: call_transfer !== null ? 2 : 1,
-        codecs: {"audio": ["OPUS"]},
-      };
-      daily_room_properties.sip = sip_config;
-    }
-
-    // Prepare payload for {service}/start API call
-    const payload = {
-      createDailyRoom: true,
-      dailyRoomProperties: daily_room_properties,
-      body: {
-        dialin_settings,
-        dialout_settings,
-        voicemail_detection,
-        call_transfer,
-      },
-    };
-
-    logger.debug(`Daily room properties: ${JSON.stringify(daily_room_properties)}`);
-
-    // Get Daily API key and agent name from environment variables
-    const pccApiKey = process.env.PIPECAT_CLOUD_API_KEY;
-    const agentName = process.env.AGENT_NAME || 'my-first-agent';
-
-    if (!pccApiKey) {
-      throw new Error('PIPECAT_CLOUD_API_KEY environment variable is not set');
-    }
-
-    // Set up headers for Daily API call
-    const headers = {
-      'Authorization': `Bearer ${pccApiKey}`,
-      'Content-Type': 'application/json',
-    };
-
-    const url = `https://api.pipecat.daily.co/v1/public/${agentName}/start`;
-    logger.debug(`Making API call to Daily: ${url} ${JSON.stringify(headers)} ${JSON.stringify(payload)}`);
-    
-    try {
-      const response = await axios.post(url, payload, { headers });
-      logger.debug(`Response: ${JSON.stringify(response.data)}`);
-      
-      return res.status(200).json({
-        status: 'success',
-        data: response.data,
-        room_properties: daily_room_properties,
-      });
-    } catch (error) {
-      if (error.response) {
-        // Pass through status code and error details from the Daily API
-        const statusCode = error.response.status;
-        const errorDetail = error.response.data || error.message;
-        logger.error(`HTTP error: ${JSON.stringify(errorDetail)}`);
-        return res.status(statusCode).json(errorDetail);
-      } else {
-        logger.error(`Request error: ${error.message}`);
-        return res.status(500).json({ error: error.message });
-      }
-    }    
-  } catch (error) {
-    logger.error(`Unexpected error: ${error.message}`);
-    return res.status(500).json({ error: 'Internal server error', message: error.message });
-  }
-}
-
-// Configure body parser to preserve raw body text
-export const config = {
-  api: {
-    bodyParser: {
-      sizeLimit: '1mb',
-    },
-  },
-};

examples/deployment/pipecat-cloud-daily-pstn-server/nextjs-webhook-server/pages/api/index.js

@@ -1,6 +0,0 @@
-import { logger } from '../../lib/utils';
-
-export default function handler(req, res) {
-  logger.info('Received request to /api');
-  res.status(200).json({ message: 'Hello, World! from ᓚᘏᗢ' });
-}

examples/deployment/pipecat-cloud-daily-pstn-server/nextjs-webhook-server/vercel.js

@@ -1,6 +0,0 @@
-module.exports = {
-  version: 2,
-  buildCommand: "next build",
-  outputDirectory: ".next",
-  cleanUrls: true
-};

examples/deployment/pipecat-cloud-example/.gitignore

@@ -1,94 +0,0 @@
-# Python
-__pycache__/
-*.py[cod]
-*$py.class
-*.so
-.Python
-build/
-dist/
-*.egg-info/
-*.egg
-.installed.cfg
-.eggs/
-downloads/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-share/python-wheels/
-MANIFEST
-
-# Virtual Environments
-venv/
-env/
-.env
-.venv/
-ENV/
-env.bak/
-venv.bak/
-
-# IDE
-.idea/
-.vscode/
-.spyderproject
-.spyproject
-.ropeproject
-
-# Testing and Coverage
-.coverage
-.coverage.*
-htmlcov/
-.pytest_cache/
-.tox/
-.nox/
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-.hypothesis/
-cover/
-
-# Logs and Databases
-*.log
-*.db
-db.sqlite3
-db.sqlite3-journal
-pip-log.txt
-
-# System Files
-.DS_Store
-Thumbs.db
-desktop.ini
-*.swp
-*.swo
-*.bak
-*.tmp
-*~
-
-# Build and Documentation
-docs/_build/
-.pybuilder/
-target/
-instance/
-.webassets-cache
-.pdm.toml
-.pdm-python
-.pdm-build/
-__pypackages__/
-
-# Other
-*.mo
-*.pot
-*.sage.py
-.mypy_cache/
-.dmypy.json
-dmypy.json
-.pyre/
-.pytype/
-cython_debug/
-.ipynb_checkpoints
-
-# Pipecat cloud
-.pcc-deploy.toml

examples/deployment/pipecat-cloud-example/Dockerfile

@@ -1,7 +0,0 @@
-FROM dailyco/pipecat-base:latest
-
-COPY ./requirements.txt requirements.txt
-
-RUN pip install --no-cache-dir --upgrade -r requirements.txt
-
-COPY ./bot.py bot.py

examples/deployment/pipecat-cloud-example/README.md

@@ -1,196 +0,0 @@
-# Pipecat Cloud Starter Project
-
-[![Docs](https://img.shields.io/badge/Documentation-blue)](https://docs.pipecat.daily.co) [![Discord](https://img.shields.io/discord/1217145424381743145)](https://discord.gg/dailyco)
-
-A template voice agent for [Pipecat Cloud](https://www.daily.co/products/pipecat-cloud/) that demonstrates building and deploying a conversational AI agent.
-
-> **For a detailed step-by-step guide, see our [Quickstart Documentation](https://docs.pipecat.daily.co/quickstart).**
-
-## Prerequisites
-
-- Python 3.10+
-- Linux, MacOS, or Windows Subsystem for Linux (WSL)
-- [Docker](https://www.docker.com) and a Docker repository (e.g., [Docker Hub](https://hub.docker.com))
-- A Docker Hub account (or other container registry account)
-- [Pipecat Cloud](https://pipecat.daily.co) account
-
-> **Note**: If you haven't installed Docker yet, follow the official installation guides for your platform ([Linux](https://docs.docker.com/engine/install/), [Mac](https://docs.docker.com/desktop/setup/install/mac-install/), [Windows](https://docs.docker.com/desktop/setup/install/windows-install/)). For Docker Hub, [create a free account](https://hub.docker.com/signup) and log in via terminal with `docker login`.
-
-## Get Started
-
-### 1. Get the starter project
-
-Clone the starter project from GitHub:
-
-```bash
-git clone https://github.com/daily-co/pipecat-cloud-starter
-cd pipecat-cloud-starter
-```
-
-### 2. Set up your Python environment
-
-We recommend using a virtual environment to manage your Python dependencies.
-
-```bash
-# Create a virtual environment
-python -m venv .venv
-
-# Activate it
-source .venv/bin/activate  # On Windows: .venv\Scripts\activate
-
-# Install the Pipecat Cloud CLI
-pip install pipecatcloud
-```
-
-### 3. Authenticate with Pipecat Cloud
-
-```bash
-pcc auth login
-```
-
-### 4. Acquire required API keys
-
-This starter requires the following API keys:
-
-- **OpenAI API Key**: Get from [platform.openai.com/api-keys](https://platform.openai.com/api-keys)
-- **Cartesia API Key**: Get from [play.cartesia.ai/keys](https://play.cartesia.ai/keys)
-- **Daily API Key**: Automatically provided through your Pipecat Cloud account
-
-### 5. Configure to run locally (optional)
-
-You can test your agent locally before deploying to Pipecat Cloud:
-
-```bash
-# Set environment variables with your API keys
-export CARTESIA_API_KEY="your_cartesia_key"
-export DAILY_API_KEY="your_daily_key"
-export OPENAI_API_KEY="your_openai_key"
-```
-
-> Your `DAILY_API_KEY` can be found at [https://pipecat.daily.co](https://pipecat.daily.co) under the `Settings` in the `Daily (WebRTC)` tab.
-
-First install requirements:
-
-```bash
-pip install -r requirements.txt
-```
-
-Then, launch the bot.py script locally:
-
-```bash
-LOCAL_RUN=1 python bot.py
-```
-
-## Deploy & Run
-
-### 1. Build and push your Docker image
-
-```bash
-# Build the image (targeting ARM architecture for cloud deployment)
-docker build --platform=linux/arm64 -t my-first-agent:latest .
-
-# Tag with your Docker username and version
-docker tag my-first-agent:latest your-username/my-first-agent:0.1
-
-# Push to Docker Hub
-docker push your-username/my-first-agent:0.1
-```
-
-### 2. Create a secret set for your API keys
-
-The starter project requires API keys for OpenAI and Cartesia:
-
-```bash
-# Copy the example env file
-cp env.example .env
-
-# Edit .env to add your API keys:
-# CARTESIA_API_KEY=your_cartesia_key
-# OPENAI_API_KEY=your_openai_key
-
-# Create a secret set from your .env file
-pcc secrets set my-first-agent-secrets --file .env
-```
-
-Alternatively, you can create secrets directly via CLI:
-
-```bash
-pcc secrets set my-first-agent-secrets \
-  CARTESIA_API_KEY=your_cartesia_key \
-  OPENAI_API_KEY=your_openai_key
-```
-
-### 3. Deploy to Pipecat Cloud
-
-```bash
-pcc deploy my-first-agent your-username/my-first-agent:0.1 --secrets my-first-agent-secrets
-```
-
-> **Note (Optional)**: For a more maintainable approach, you can use the included `pcc-deploy.toml` file:
->
-> ```toml
-> agent_name = "my-first-agent"
-> image = "your-username/my-first-agent:0.1"
-> secret_set = "my-first-agent-secrets"
->
-> [scaling]
->     min_instances = 0
-> ```
->
-> Then simply run `pcc deploy` without additional arguments.
-
-> **Note**: If your repository is private, you'll need to add credentials:
->
-> ```bash
-> # Create pull secret (you’ll be prompted for credentials)
-> pcc secrets image-pull-secret pull-secret https://index.docker.io/v1/
->
-> # Deploy with credentials
-> pcc deploy my-first-agent your-username/my-first-agent:0.1 --credentials pull-secret
-> ```
-
-### 4. Check deployment and scaling (optional)
-
-By default, your agent will use "scale-to-zero" configuration, which means it may have a cold start of around 10 seconds when first used. By default, idle instances are maintained for 5 minutes before being terminated when using scale-to-zero.
-
-For more responsive testing, you can scale your deployment to keep a minimum of one instance warm:
-
-```bash
-# Ensure at least one warm instance is always available
-pcc deploy my-first-agent your-username/my-first-agent:0.1 --min-instances 1
-
-# Check the status of your deployment
-pcc agent status my-first-agent
-```
-
-By default, idle instances are maintained for 5 minutes before being terminated when using scale-to-zero.
-
-### 5. Create an API key
-
-```bash
-# Create a public API key for accessing your agent
-pcc organizations keys create
-
-# Set it as the default key to use with your agent
-pcc organizations keys use
-```
-
-### 6. Start your agent
-
-```bash
-# Start a session with your agent in a Daily room
-pcc agent start my-first-agent --use-daily
-```
-
-This will return a URL, which you can use to connect to your running agent.
-
-## Documentation
-
-For more details on Pipecat Cloud and its capabilities:
-
-- [Pipecat Cloud Documentation](https://docs.pipecat.daily.co)
-- [Pipecat Project Documentation](https://docs.pipecat.ai)
-
-## Support
-
-Join our [Discord community](https://discord.gg/dailyco) for help and discussions.

examples/deployment/pipecat-cloud-example/bot.py

@@ -1,161 +0,0 @@
-#
-# Copyright (c) 2025, Daily
-#
-# SPDX-License-Identifier: BSD 2-Clause License
-#
-
-import os
-
-import aiohttp
-from dotenv import load_dotenv
-from loguru import logger
-from pipecatcloud.agent import DailySessionArguments
-
-from pipecat.audio.vad.silero import SileroVADAnalyzer
-from pipecat.frames.frames import LLMMessagesFrame
-from pipecat.pipeline.pipeline import Pipeline
-from pipecat.pipeline.runner import PipelineRunner
-from pipecat.pipeline.task import PipelineParams, PipelineTask
-from pipecat.processors.aggregators.openai_llm_context import OpenAILLMContext
-from pipecat.services.cartesia.tts import CartesiaTTSService
-from pipecat.services.openai.llm import OpenAILLMService
-from pipecat.transports.services.daily import DailyParams, DailyTransport
-
-# Check if we're in local development mode
-LOCAL_RUN = os.getenv("LOCAL_RUN")
-if LOCAL_RUN:
-    import asyncio
-    import webbrowser
-
-    try:
-        from local_runner import configure
-    except ImportError:
-        logger.error("Could not import local_runner module. Local development mode may not work.")
-
-# Load environment variables
-load_dotenv(override=True)
-
-
-async def main(room_url: str, token: str):
-    """Main pipeline setup and execution function.
-
-    Args:
-        room_url: The Daily room URL
-        token: The Daily room token
-    """
-    logger.debug("Starting bot in room: {}", room_url)
-
-    transport = DailyTransport(
-        room_url,
-        token,
-        "bot",
-        DailyParams(
-            audio_in_enabled=True,
-            audio_out_enabled=True,
-            transcription_enabled=True,
-            vad_analyzer=SileroVADAnalyzer(),
-        ),
-    )
-
-    tts = CartesiaTTSService(
-        api_key=os.getenv("CARTESIA_API_KEY"), voice_id="79a125e8-cd45-4c13-8a67-188112f4dd22"
-    )
-
-    llm = OpenAILLMService(api_key=os.getenv("OPENAI_API_KEY"))
-
-    messages = [
-        {
-            "role": "system",
-            "content": "You are a helpful LLM in a WebRTC call. Your goal is to demonstrate your capabilities in a succinct way. Your output will be converted to audio so don't include special characters in your answers. Respond to what the user said in a creative and helpful way.",
-        },
-    ]
-
-    context = OpenAILLMContext(messages)
-    context_aggregator = llm.create_context_aggregator(context)
-
-    pipeline = Pipeline(
-        [
-            transport.input(),
-            context_aggregator.user(),
-            llm,
-            tts,
-            transport.output(),
-            context_aggregator.assistant(),
-        ]
-    )
-
-    task = PipelineTask(
-        pipeline,
-        params=PipelineParams(
-            allow_interruptions=True,
-            enable_metrics=True,
-            enable_usage_metrics=True,
-            report_only_initial_ttfb=True,
-        ),
-    )
-
-    @transport.event_handler("on_first_participant_joined")
-    async def on_first_participant_joined(transport, participant):
-        logger.info("First participant joined: {}", participant["id"])
-        await transport.capture_participant_transcription(participant["id"])
-        # Kick off the conversation.
-        messages.append(
-            {
-                "role": "system",
-                "content": "Please start with 'Hello World' and introduce yourself to the user.",
-            }
-        )
-        await task.queue_frames([LLMMessagesFrame(messages)])
-
-    @transport.event_handler("on_participant_left")
-    async def on_participant_left(transport, participant, reason):
-        logger.info("Participant left: {}", participant)
-        await task.cancel()
-
-    runner = PipelineRunner()
-
-    await runner.run(task)
-
-
-async def bot(args: DailySessionArguments):
-    """Main bot entry point compatible with the FastAPI route handler.
-
-    Args:
-        room_url: The Daily room URL
-        token: The Daily room token
-        body: The configuration object from the request body
-        session_id: The session ID for logging
-    """
-    logger.info(f"Bot process initialized {args.room_url} {args.token}")
-
-    try:
-        await main(args.room_url, args.token)
-        logger.info("Bot process completed")
-    except Exception as e:
-        logger.exception(f"Error in bot process: {str(e)}")
-        raise
-
-
-# Local development functions
-async def local_main():
-    """Function for local development testing."""
-    try:
-        async with aiohttp.ClientSession() as session:
-            (room_url, token) = await configure(session)
-            logger.warning("_")
-            logger.warning("_")
-            logger.warning(f"Talk to your voice agent here: {room_url}")
-            logger.warning("_")
-            logger.warning("_")
-            webbrowser.open(room_url)
-            await main(room_url, token)
-    except Exception as e:
-        logger.exception(f"Error in local development mode: {e}")
-
-
-# Local development entry point
-if LOCAL_RUN and __name__ == "__main__":
-    try:
-        asyncio.run(local_main())
-    except Exception as e:
-        logger.exception(f"Failed to run in local mode: {e}")

examples/deployment/pipecat-cloud-example/env.example

@@ -1,2 +0,0 @@
-CARTESIA_API_KEY=
-OPENAI_API_KEY=