workflow_test working except for text_input node

.claude/skills/changelog/SKILL.md

@@ -1,40 +0,0 @@
----
-name: changelog
-description: Create changelog files for important commits in a PR
----
-
-Create changelog files for the important commits in this PR. The PR number is provided as an argument.
-
-## Instructions
-
-1. First, check what commits are on the current branch compared to main:
-   ```
-   git log main..HEAD --oneline
-   ```
-
-2. For each significant change, create a changelog file in the `changelog/` folder using the format:
-   - `{PR_NUMBER}.added.md` - for new features
-   - `{PR_NUMBER}.added.2.md`, `{PR_NUMBER}.added.3.md` - for additional new features
-   - `{PR_NUMBER}.changed.md` - for changes to existing functionality
-   - `{PR_NUMBER}.fixed.md` - for bug fixes
-   - `{PR_NUMBER}.deprecated.md` - for deprecations
-
-3. Each changelog file should at least contain a main single line starting with `- ` followed by a clear description of the change.
-
-4. If the change is complicated, changelog files can have indented lines after the main line with additional details or code samples.
-
-5. Use ⚠️ emoji prefix for breaking changes.
-
-## Example
-
-For PR #3519 with a new feature and a bug fix:
-
-`changelog/3519.added.md`:
-```
-- Added `SomeNewFeature` for doing something useful.
-```
-
-`changelog/3519.fixed.md`:
-```
-- Fixed an issue where something was not working correctly.
-```

.claude/skills/docstring/SKILL.md

@@ -1,257 +0,0 @@
----
-name: docstring
-description: Document a Python module and its classes using Google style
----
-
-Document a Python module and its classes using Google-style docstrings following project conventions. The class name is provided as an argument.
-
-## Instructions
-
-1. First, find the class in the codebase:
-   ```
-   Search for "class ClassName" in src/pipecat/
-   ```
-
-2. If multiple files contain that class name:
-   - List all matches with their file paths
-   - Ask the user which one they want to document
-   - Wait for confirmation before proceeding
-
-3. Once the file is identified, read the module to understand its structure:
-   - Identify all classes, functions, and important type aliases
-   - Understand the purpose of each component
-
-4. Apply documentation in this order:
-   - Module docstring (at top, after imports)
-   - Class docstrings
-   - `__init__` methods (always document constructor parameters)
-   - Public methods (not starting with `_`)
-   - Dataclass/config classes with field descriptions
-
-5. Skip documentation for:
-   - Private methods (starting with `_`)
-   - Simple dunder methods (`__str__`, `__repr__`, `__post_init__`)
-   - Very simple pass-through properties
-   - **Already documented code** - If a class, method, or function already has a complete docstring that follows the project style, do not modify it. A docstring is complete if it has:
-     - A one-line summary
-     - Args section (if it has parameters)
-     - Returns section (if it returns something meaningful)
-   - Only add or improve documentation where it is missing or incomplete
-
-## Module Docstring Format
-
-```python
-"""[One-line description of module purpose].
-
-[Optional: Longer explanation of functionality, key classes, or use cases.]
-"""
-```
-
-Example:
-```python
-"""Neuphonic text-to-speech service implementations.
-
-This module provides WebSocket and HTTP-based integrations with Neuphonic's
-text-to-speech API for real-time audio synthesis.
-"""
-```
-
-## Class Docstring Format
-
-```python
-class ClassName:
-    """One-line summary describing what the class does.
-
-    [Longer description explaining purpose, behavior, and key features.
-    Use action-oriented language.]
-
-    [Optional: Event handlers, usage notes, or important caveats.]
-    """
-```
-
-Example:
-```python
-class FrameProcessor(BaseObject):
-    """Base class for all frame processors in the pipeline.
-
-    Frame processors are the building blocks of Pipecat pipelines, they can be
-    linked to form complex processing pipelines. They receive frames, process
-    them, and pass them to the next or previous processor in the chain.
-
-    Event handlers available:
-
-    - on_before_process_frame: Called before a frame is processed
-    - on_after_process_frame: Called after a frame is processed
-
-    Example::
-
-        @processor.event_handler("on_before_process_frame")
-        async def on_before_process_frame(processor, frame):
-            ...
-
-        @processor.event_handler("on_after_process_frame")
-        async def on_after_process_frame(processor, frame):
-            ...
-    """
-```
-
-Note: When listing event handlers, do NOT use backticks. Include an `Example::` section (with double colon for Sphinx) showing the decorator pattern and function signature for each event.
-
-## Constructor (`__init__`) Format
-
-```python
-def __init__(self, *, param1: Type, param2: Type = default, **kwargs):
-    """Initialize the [ClassName].
-
-    Args:
-        param1: Description of param1 and its purpose.
-        param2: Description of param2. Defaults to [default].
-        **kwargs: Additional arguments passed to parent class.
-    """
-```
-
-Example:
-```python
-def __init__(
-    self,
-    *,
-    api_key: str,
-    voice_id: Optional[str] = None,
-    sample_rate: Optional[int] = 22050,
-    **kwargs,
-):
-    """Initialize the Neuphonic TTS service.
-
-    Args:
-        api_key: Neuphonic API key for authentication.
-        voice_id: ID of the voice to use for synthesis.
-        sample_rate: Audio sample rate in Hz. Defaults to 22050.
-        **kwargs: Additional arguments passed to parent InterruptibleTTSService.
-    """
-```
-
-## Method Docstring Format
-
-```python
-async def method_name(self, param1: Type) -> ReturnType:
-    """One-line summary of what method does.
-
-    [Longer description if behavior isn't obvious.]
-
-    Args:
-        param1: Description of param1.
-
-    Returns:
-        Description of return value.
-
-    Raises:
-        ExceptionType: When this exception is raised.
-    """
-```
-
-Example:
-```python
-async def put(self, item: Tuple[Frame, FrameDirection, FrameCallback]):
-    """Put an item into the priority queue.
-
-    System frames (`SystemFrame`) have higher priority than any other
-    frames. If a non-frame item is provided it will have the highest priority.
-
-    Args:
-        item: The item to enqueue.
-    """
-```
-
-## Dataclass/Config Format
-
-```python
-@dataclass
-class ConfigName:
-    """One-line description of configuration.
-
-    [Explanation of when/how to use this config.]
-
-    Parameters:
-        field1: Description of field1.
-        field2: Description of field2. Defaults to [default].
-    """
-
-    field1: Type
-    field2: Type = default_value
-```
-
-Example:
-```python
-@dataclass
-class FrameProcessorSetup:
-    """Configuration parameters for frame processor initialization.
-
-    Parameters:
-        clock: The clock instance for timing operations.
-        task_manager: The task manager for handling async operations.
-        observer: Optional observer for monitoring frame processing events.
-    """
-
-    clock: BaseClock
-    task_manager: BaseTaskManager
-    observer: Optional[BaseObserver] = None
-```
-
-## Enum Documentation Format
-
-```python
-class EnumName(Enum):
-    """One-line description of the enum purpose.
-
-    [Longer description of how the enum is used.]
-
-    Parameters:
-        VALUE1: Description of VALUE1.
-        VALUE2: Description of VALUE2.
-    """
-
-    VALUE1 = 1
-    VALUE2 = 2
-```
-
-## Writing Style Guidelines
-
-- **Concise and professional** - No casual language or filler words
-- **Action-oriented** - Start with verbs: "Processes...", "Manages...", "Converts..."
-- **Purpose before implementation** - Explain WHY before HOW
-- **Clear parameter descriptions** - Include type hints, defaults, and purpose
-- **No redundant type info** - Type hints are in the signature, don't repeat in description
-- **Use backticks for code references** - Wrap class names, method names, event names, parameter names, and code snippets in backticks
-
-Good: "Neuphonic API key for authentication."
-Bad: "str: The API key (string) that is used for authenticating with Neuphonic."
-
-Good: "Triggers `on_speech_started` when the `VADAnalyzer` detects speech."
-Bad: "Triggers on_speech_started when the VADAnalyzer detects speech."
-
-## Deprecation Notice Format
-
-When documenting deprecated code:
-
-```python
-"""[Description].
-
-.. deprecated:: X.X.X
-    `ClassName` is deprecated and will be removed in a future version.
-    Use `NewClassName` instead.
-"""
-```
-
-## Checklist
-
-Before finishing, verify:
-
-- [ ] Module has a docstring at the top (after copyright header and imports)
-- [ ] All public classes have docstrings
-- [ ] All `__init__` methods document their parameters
-- [ ] All public methods have docstrings with Args/Returns/Raises as needed
-- [ ] Dataclasses use "Parameters:" section for field descriptions
-- [ ] Enums document each value in "Parameters:" section
-- [ ] Writing is concise and action-oriented
-- [ ] No documentation added to private methods (starting with `_`)
-- [ ] Existing complete docstrings were left unchanged

.claude/skills/pr-description/SKILL.md

@@ -1,128 +0,0 @@
----
-name: pr-description
-description: Update a GitHub PR description with a summary of changes
----
-
-Update a GitHub pull request description based on the changes in the PR.
-
-## Arguments
-
-```
-/pr-description <PR_NUMBER> [--fixes <ISSUE_NUMBERS>]
-```
-
-- `PR_NUMBER` (required): The pull request number to update
-- `--fixes` (optional): Comma-separated issue numbers that this PR fixes (e.g., `--fixes 123,456`)
-
-Examples:
-- `/pr-description 3534`
-- `/pr-description 3534 --fixes 123`
-- `/pr-description 3534 --fixes 123,456,789`
-
-## Instructions
-
-1. First, gather information about the PR:
-   - Use GitHub plugin to get PR details (title, current description, base branch)
-   - Use local git to get commits: `git log main..HEAD --oneline`
-   - Use local git to get the diff: `git diff main..HEAD`
-   - Parse any `--fixes` argument for issue numbers
-
-2. Check the existing PR description:
-   - If it already has a complete, accurate description that reflects the changes, do nothing
-   - If it's missing sections, incomplete, or outdated compared to the actual changes, proceed to update
-   - If it only has the template placeholder text, generate a full description
-
-3. Analyze the changes:
-   - Understand the purpose of each commit
-   - Identify any breaking changes (API changes, removed features, behavior changes)
-   - Look for new features, bug fixes, refactoring, or documentation changes
-   - Collect issue numbers from:
-     - The `--fixes` argument (if provided)
-     - Commit messages (patterns like "Fixes #123", "Closes #456", "Resolves #789")
-
-4. Generate or update the PR description with these sections:
-
-## PR Description Format
-
-### Summary (always include)
-
-Brief bullet points describing what changed and why. Focus on the *purpose* and *impact*, not implementation details.
-
-```markdown
-## Summary
-
-- Added X to enable Y
-- Fixed bug where Z would happen
-- Refactored W for better maintainability
-```
-
-### Breaking Changes (include only if applicable)
-
-Document any changes that affect existing users or APIs.
-
-```markdown
-## Breaking Changes
-
-- `ClassName.method()` now requires a `param` argument
-- Removed deprecated `old_function()` - use `new_function()` instead
-```
-
-### Testing (include when non-obvious)
-
-How to verify the changes work. Skip for trivial changes.
-
-```markdown
-## Testing
-
-- Run `uv run pytest tests/test_feature.py` to verify the fix
-- Example usage: `uv run examples/new_feature.py`
-```
-
-### Fixes (include if issues are provided or found in commits)
-
-List issues this PR fixes. GitHub will automatically close these issues when the PR is merged.
-
-```markdown
-## Fixes
-
-- Fixes #123
-- Fixes #456
-```
-
-Note: Use "Fixes #X" format (not "Closes" or "Resolves") for consistency. Each issue should be on its own line with "Fixes" to ensure GitHub auto-closes them.
-
-## Guidelines
-
-- **Be concise** - Reviewers should understand the PR in 30 seconds
-- **Focus on why** - The diff shows *what* changed, explain *why*
-- **Skip empty sections** - Only include sections that have content
-- **Use bullet points** - Easier to scan than paragraphs
-- **Don't duplicate the diff** - Avoid listing every file or line changed
-
-## Example Output
-
-```markdown
-## Summary
-
-- Added `/docstring` skill for documenting Python modules with Google-style docstrings
-- Skill finds classes by name and handles conflicts when multiple matches exist
-- Skips already-documented code to avoid unnecessary changes
-
-## Testing
-
-/docstring ClassName
-
-## Fixes
-
-- Fixes #123
-```
-
-## Checklist
-
-Before updating the PR:
-
-- [ ] Verified existing description needs updating (not already complete)
-- [ ] Summary accurately reflects the changes
-- [ ] Breaking changes are clearly documented (if any)
-- [ ] No unnecessary sections included
-- [ ] Description is concise and scannable

.github/ISSUE_TEMPLATE/1-bug_report.yml

@@ -1,87 +0,0 @@
-name: Bug report
-description: Report a bug or unexpected behavior
-type: Bug
-body:
-  - type: markdown
-    attributes:
-      value: |
-        ## Bug Report
-
-        Thank you for taking the time to fill out this bug report.
-
-  - type: markdown
-    attributes:
-      value: |
-        ### Environment
-
-  - type: input
-    id: pipecat-version
-    attributes:
-      label: pipecat version
-      description: Which version are you using?
-      placeholder: e.g., 0.0.63
-    validations:
-      required: true
-
-  - type: input
-    id: python-version
-    attributes:
-      label: Python version
-      description: Which Python version are you using?
-      placeholder: e.g., 3.12.8
-    validations:
-      required: true
-
-  - type: input
-    id: os
-    attributes:
-      label: Operating System
-      description: Which OS are you using?
-      placeholder: e.g., Ubuntu 24.04, Windows 11, macOS 12.5
-    validations:
-      required: true
-
-  - type: textarea
-    id: description
-    attributes:
-      label: Issue description
-      description: Provide a clear description of the issue.
-    validations:
-      required: true
-
-  - type: textarea
-    id: repro
-    attributes:
-      label: Reproduction steps
-      description: List the steps to reproduce the issue.
-      placeholder: |
-        1. Do this...
-        2. Then do that...
-        3. Observe the error...
-    validations:
-      required: true
-
-  - type: textarea
-    id: expected
-    attributes:
-      label: Expected behavior
-      description: What did you expect to happen?
-    validations:
-      required: true
-
-  - type: textarea
-    id: actual
-    attributes:
-      label: Actual behavior
-      description: What actually happened?
-    validations:
-      required: true
-
-  - type: textarea
-    id: logs
-    attributes:
-      label: Logs
-      description: If applicable, include any relevant logs or error messages
-      render: shell
-    validations:
-      required: false

.github/ISSUE_TEMPLATE/2-question.yml

@@ -1,67 +0,0 @@
-name: Question
-description: Ask a question or get help
-type: Question
-body:
-  - type: markdown
-    attributes:
-      value: |
-        ## Question
-
-        Use this form to ask a question about pipecat.
-
-  - type: markdown
-    attributes:
-      value: |
-        ### Environment (if applicable)
-
-  - type: input
-    id: pipecat-version
-    attributes:
-      label: pipecat version
-      description: Which version are you using? (if applicable)
-      placeholder: e.g., 0.0.63
-    validations:
-      required: false
-
-  - type: input
-    id: python-version
-    attributes:
-      label: Python version
-      description: Which Python version are you using? (if applicable)
-      placeholder: e.g., 3.12.8
-    validations:
-      required: false
-
-  - type: input
-    id: os
-    attributes:
-      label: Operating System
-      description: Which OS are you using? (if applicable)
-      placeholder: e.g., Ubuntu 24.04, Windows 11, macOS 12.5
-    validations:
-      required: false
-
-  - type: textarea
-    id: question
-    attributes:
-      label: Question
-      description: Provide your question in detail here.
-    validations:
-      required: true
-
-  - type: textarea
-    id: tried
-    attributes:
-      label: What I've tried
-      description: Describe what you've already tried or research you've done.
-      placeholder: I've looked at the documentation and tried...
-    validations:
-      required: false
-
-  - type: textarea
-    id: context
-    attributes:
-      label: Context
-      description: Any additional context or information that might help others understand your question better.
-    validations:
-      required: false

.github/ISSUE_TEMPLATE/3-feature_request.yml

@@ -1,52 +0,0 @@
-name: Feature request
-description: Suggest an enhancement or new feature
-type: Enhancement
-body:
-  - type: markdown
-    attributes:
-      value: |
-        ## Feature Request
-
-        Thank you for suggesting an enhancement to pipecat.
-
-  - type: textarea
-    id: problem
-    attributes:
-      label: Problem Statement
-      description: A clear description of the problem this feature would solve.
-      placeholder: I'm always frustrated when...
-    validations:
-      required: true
-
-  - type: textarea
-    id: solution
-    attributes:
-      label: Proposed Solution
-      description: A clear and concise description of what you want to happen.
-    validations:
-      required: true
-
-  - type: textarea
-    id: alternatives
-    attributes:
-      label: Alternative Solutions
-      description: Any alternative solutions or features you've considered.
-    validations:
-      required: false
-
-  - type: textarea
-    id: context
-    attributes:
-      label: Additional Context
-      description: Add any other context, mockups, or screenshots about the feature request here.
-      placeholder: You can drag and drop images here to include them.
-    validations:
-      required: false
-
-  - type: checkboxes
-    id: contribution
-    attributes:
-      label: Would you be willing to help implement this feature?
-      options:
-        - label: Yes, I'd like to contribute
-        - label: No, I'm just suggesting

.github/ISSUE_TEMPLATE/4-service-issue.yml

@@ -1,82 +0,0 @@
-name: Service Issue
-description: An issue with a third-party service
-type: Service Issue
-body:
-  - type: markdown
-    attributes:
-      value: |
-        ## Service Issue
-
-        Use this form to report an issue with a third-party service integration.
-
-  - type: input
-    id: pipecat-version
-    attributes:
-      label: pipecat version
-      description: Which version are you using?
-      placeholder: e.g., 0.0.63
-    validations:
-      required: true
-
-  - type: input
-    id: service-name
-    attributes:
-      label: Service Name
-      description: Which third-party service is having issues?
-      placeholder: e.g., OpenAI, ElevenLabs, Anthropic
-    validations:
-      required: true
-
-  - type: input
-    id: service-version
-    attributes:
-      label: Service or model version
-      description: Which version of the service API or model are you using?
-      placeholder: e.g., v1, gpt-4.1
-    validations:
-      required: false
-
-  - type: textarea
-    id: description
-    attributes:
-      label: Issue Description
-      description: Provide a clear description of the service issue.
-    validations:
-      required: true
-
-  - type: textarea
-    id: reproduction
-    attributes:
-      label: Reproduction Steps
-      description: Provide steps to reproduce the issue.
-      placeholder: |
-        1. Configure service X
-        2. Call method Y
-        3. See error Z
-    validations:
-      required: true
-
-  - type: textarea
-    id: expected
-    attributes:
-      label: Expected Behavior
-      description: What did you expect to happen?
-    validations:
-      required: true
-
-  - type: textarea
-    id: actual
-    attributes:
-      label: Actual Behavior
-      description: What actually happened?
-    validations:
-      required: true
-
-  - type: textarea
-    id: logs
-    attributes:
-      label: Error Logs
-      description: If available, include any error messages or logs.
-      render: shell
-    validations:
-      required: false

.github/ISSUE_TEMPLATE/5-new-service.yml

@@ -1,56 +0,0 @@
-name: New Service
-description: Request to support a new third-party service
-type: New Service
-body:
-  - type: markdown
-    attributes:
-      value: |
-        ## New Service Request
-
-        Use this form to request support for a new third-party service in pipecat.
-
-  - type: input
-    id: service-name
-    attributes:
-      label: Service Name
-      description: What is the name of the third-party service?
-      placeholder: e.g., NewAPI, SomeService
-    validations:
-      required: true
-
-  - type: input
-    id: service-website
-    attributes:
-      label: Service Website
-      description: Link to the service's website or documentation
-      placeholder: e.g., https://newapi.com
-    validations:
-      required: true
-
-  - type: textarea
-    id: service-description
-    attributes:
-      label: Service Description
-      description: Briefly describe what this service does and how it works.
-    validations:
-      required: true
-
-  - type: textarea
-    id: api-info
-    attributes:
-      label: API Information
-      description: If available, provide details about the service's API.
-      placeholder: |
-        - API documentation link
-        - Authentication method
-        - Key endpoints you'd like supported
-    validations:
-      required: false
-
-  - type: checkboxes
-    id: contribution
-    attributes:
-      label: Would you be willing to help implement this service?
-      options:
-        - label: Yes, I'd like to contribute
-        - label: No, I'm just suggesting

.github/ISSUE_TEMPLATE/6-dependency.yml

@@ -1,74 +0,0 @@
-name: Dependency Issue
-description: An issue with a Pipecat dependency (not a third-party service)
-type: Dependency Issue
-body:
-  - type: markdown
-    attributes:
-      value: |
-        ## Dependency Issue
-
-        Use this form to report an issue with a Pipecat dependency.
-
-  - type: input
-    id: pipecat-version
-    attributes:
-      label: pipecat version
-      description: Which version are you using?
-      placeholder: e.g., 0.0.63
-    validations:
-      required: true
-
-  - type: input
-    id: dependency-name
-    attributes:
-      label: Dependency Name
-      description: Which Pipecat dependency is causing the issue?
-      placeholder: e.g., openai, anthropic, fastapi
-    validations:
-      required: true
-
-  - type: input
-    id: dependency-version
-    attributes:
-      label: Dependency Version
-      description: Which version of the dependency are you using?
-      placeholder: e.g., 1.2.3
-    validations:
-      required: true
-
-  - type: textarea
-    id: description
-    attributes:
-      label: Issue Description
-      description: Provide a clear description of the dependency issue.
-    validations:
-      required: true
-
-  - type: textarea
-    id: impact
-    attributes:
-      label: Impact
-      description: How is this dependency issue affecting your usage of pipecat?
-    validations:
-      required: true
-
-  - type: textarea
-    id: reproduction
-    attributes:
-      label: Reproduction Steps
-      description: If applicable, provide steps to reproduce the issue.
-      placeholder: |
-        1. Install dependency X
-        2. Run command Y
-        3. See error Z
-    validations:
-      required: false
-
-  - type: textarea
-    id: logs
-    attributes:
-      label: Error Logs
-      description: If applicable, include any relevant error messages or logs.
-      render: shell
-    validations:
-      required: false

.github/ISSUE_TEMPLATE/7-troubleshooting.yml

@@ -1,70 +0,0 @@
-name: Troubleshooting
-description: Help with a specific use case
-type: Troubleshooting
-body:
-  - type: markdown
-    attributes:
-      value: |
-        ## Troubleshooting Request
-
-        Use this form to get help with a specific use case or implementation.
-
-  - type: input
-    id: pipecat-version
-    attributes:
-      label: pipecat version
-      description: Which version are you using?
-      placeholder: e.g., 0.0.63
-    validations:
-      required: true
-
-  - type: input
-    id: python-version
-    attributes:
-      label: Python version
-      description: Which version of Python are you using?
-      placeholder: e.g., 3.12.8
-    validations:
-      required: true
-
-  - type: input
-    id: os
-    attributes:
-      label: Operating System
-      description: Which OS are you using?
-      placeholder: e.g., Ubuntu 24.04, Windows 11, macOS 12.5
-    validations:
-      required: true
-
-  - type: textarea
-    id: use-case
-    attributes:
-      label: Use Case Description
-      description: Describe what you're trying to accomplish with pipecat.
-    validations:
-      required: true
-
-  - type: textarea
-    id: current-approach
-    attributes:
-      label: Current Approach
-      description: What have you tried so far? Include code snippets if relevant.
-      render: python
-    validations:
-      required: true
-
-  - type: textarea
-    id: errors
-    attributes:
-      label: Errors or Unexpected Behavior
-      description: Describe any errors or unexpected behavior you're encountering.
-    validations:
-      required: true
-
-  - type: textarea
-    id: additional-context
-    attributes:
-      label: Additional Context
-      description: Any other information that might help us understand your situation.
-    validations:
-      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -1 +0,0 @@
-blank_issues_enabled: false

.github/PULL_REQUEST_TEMPLATE.md

@@ -1 +0,0 @@
-#### Please describe the changes in your PR. If it is addressing an issue, please reference that as well.

.github/workflows/build.yaml

@@ -21,20 +21,24 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@v3
-        with:
-          version: "latest"
-
       - name: Set up Python
-        run: uv python install 3.12
-
-      - name: Install development dependencies
-        run: uv sync --group dev
-
+        id: setup_python
+        uses: actions/setup-python@v4
+        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
       - name: Build project
-        run: uv build
-
-      - name: Install project in editable mode
-        run: uv pip install --editable .
+        run: |
+          source .venv/bin/activate
+          python -m build
+      - name: Install project and other Python dependencies
+        run: |
+          source .venv/bin/activate
+          pip install --editable .

.github/workflows/coverage.yaml

@@ -1,47 +0,0 @@
-name: coverage
-
-on:
-  workflow_dispatch:
-  push:
-    branches:
-      - main
-  pull_request:
-    branches:
-      - "**"
-    paths-ignore:
-      - "docs/**"
-
-jobs:
-  coverage:
-    name: "Coverage"
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repo
-        uses: actions/checkout@v4
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@v3
-        with:
-          version: "latest"
-
-      - name: Set up Python
-        run: uv python install 3.12
-
-      - name: Install system packages
-        run: |
-          sudo apt-get install -y portaudio19-dev
-
-      - name: Install dependencies
-        run: |
-          uv sync --group dev --extra anthropic --extra aws --extra google --extra langchain --extra livekit --extra websocket
-
-      - name: Run tests with coverage
-        run: |
-          uv run coverage run
-          uv run coverage xml
-
-      - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v5
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-          slug: pipecat-ai/pipecat

.github/workflows/format.yaml

@@ -17,27 +17,25 @@ concurrency:
 
 jobs:
   ruff-format:
-    name: "Code quality checks"
+    name: "Formatting checker"
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@v3
-        with:
-          version: "latest"
-
       - name: Set up Python
-        run: uv python install 3.12
-
-      - name: Install development dependencies
-        run: uv sync --group dev
-
+        uses: actions/setup-python@v4
+        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
       - name: Ruff formatter
-        id: ruff-format
-        run: uv run ruff format --diff
-
-      - name: Ruff linter (all rules)
-        id: ruff-check
-        run: uv run ruff check
+        id: ruff
+        run: |
+          source .venv/bin/activate
+          ruff format --config line-length=100 --diff --exclude "*_pb2.py"

.github/workflows/generate-changelog.yml

@@ -1,174 +0,0 @@
-name: Generate Changelog for Release
-
-on:
-  workflow_dispatch:
-    inputs:
-      version:
-        description: "Release version (e.g., 0.0.97)"
-        required: true
-        type: string
-      date:
-        description: "Release date (YYYY-MM-DD format, defaults to today)"
-        required: false
-        type: string
-        default: ""
-
-permissions:
-  contents: write
-  pull-requests: write
-
-jobs:
-  generate-changelog:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.12"
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@v4
-        with:
-          enable-cache: true
-
-      - name: Install dependencies
-        run: |
-          uv sync --group dev
-
-      - name: Set release date
-        id: set_date
-        run: |
-          if [ -z "${{ inputs.date }}" ]; then
-            RELEASE_DATE=$(date +%Y-%m-%d)
-            echo "Using today's date: $RELEASE_DATE"
-          else
-            RELEASE_DATE="${{ inputs.date }}"
-            echo "Using provided date: $RELEASE_DATE"
-          fi
-          echo "release_date=$RELEASE_DATE" >> $GITHUB_OUTPUT
-
-      - name: Validate inputs
-        run: |
-          # Validate version format (basic check)
-          if ! [[ "${{ inputs.version }}" =~ ^[0-9]+\.[0-9]+\.[0-9]+.*$ ]]; then
-            echo "Error: Version must be in format X.Y.Z (e.g., 0.0.97)"
-            exit 1
-          fi
-
-          # Validate date format if provided
-          if [ -n "${{ inputs.date }}" ]; then
-            if ! date -d "${{ inputs.date }}" >/dev/null 2>&1; then
-              # Try macOS date format
-              if ! date -j -f "%Y-%m-%d" "${{ inputs.date }}" >/dev/null 2>&1; then
-                echo "Error: Date must be in YYYY-MM-DD format (e.g., 2025-12-04)"
-                exit 1
-              fi
-            fi
-          fi
-
-      - name: Check for changelog fragments
-        id: check_fragments
-        run: |
-          FRAGMENT_COUNT=$(find changelog -name "*.md" ! -name "_template.md.j2" | wc -l | tr -d ' ')
-          echo "fragment_count=$FRAGMENT_COUNT" >> $GITHUB_OUTPUT
-
-          if [ "$FRAGMENT_COUNT" -eq "0" ]; then
-            echo "❌ Error: No changelog fragments found in changelog/"
-            echo ""
-            echo "Cannot create a release without changelog entries."
-            echo "Add changelog fragments to the changelog/ directory (e.g., 1234.added.md) and try again."
-            exit 1
-          fi
-
-          # Validate fragment types
-          VALID_TYPES="added changed deprecated removed fixed security other"
-          INVALID_FRAGMENTS=""
-
-          for file in changelog/*.md; do
-            # Skip template
-            if [[ "$file" == "changelog/_template.md.j2" ]]; then
-              continue
-            fi
-            
-            # Extract type from filename (e.g., 1234.added.md -> added)
-            filename=$(basename "$file")
-            # Handle both 1234.added.md and 1234.added.2.md patterns
-            type=$(echo "$filename" | sed -E 's/^[0-9]+\.([a-z]+)(\.[0-9]+)?\.md$/\1/')
-            
-            # Check if type is valid
-            if ! echo "$VALID_TYPES" | grep -wq "$type"; then
-              INVALID_FRAGMENTS="$INVALID_FRAGMENTS\n  - $filename (type: '$type')"
-            fi
-          done
-
-          if [ -n "$INVALID_FRAGMENTS" ]; then
-            echo "❌ Error: Invalid changelog fragment types found:"
-            echo -e "$INVALID_FRAGMENTS"
-            echo ""
-            echo "Valid types are: $VALID_TYPES"
-            echo "Example: 1234.added.md, 5678.fixed.md"
-            exit 1
-          fi
-
-          echo "✓ Found $FRAGMENT_COUNT changelog fragment(s)"
-          echo "has_fragments=true" >> $GITHUB_OUTPUT
-
-      - name: Preview changelog
-        run: |
-          echo "## Preview of changelog for version ${{ inputs.version }}"
-          echo ""
-          uv run towncrier build --draft --version "${{ inputs.version }}" --date "${{ steps.set_date.outputs.release_date }}"
-
-      - name: Build changelog
-        run: |
-          uv run towncrier build --version "${{ inputs.version }}" --date "${{ steps.set_date.outputs.release_date }}" --yes
-
-      - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v7
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          commit-message: "Update changelog for version ${{ inputs.version }}"
-          title: "Release ${{ inputs.version }} - Changelog Update"
-          body: |
-            ## Changelog Update for Release ${{ inputs.version }}
-
-            This PR updates the CHANGELOG.md with all changes for version **${{ inputs.version }}**.
-
-            ### Summary
-            - **Version:** ${{ inputs.version }}
-            - **Date:** ${{ steps.set_date.outputs.release_date }}
-            - **Fragments processed:** ${{ steps.check_fragments.outputs.fragment_count }}
-
-            ### What this PR does
-            - ✅ Adds new release section to CHANGELOG.md
-            - ✅ Removes processed changelog fragments
-            - ✅ Ready to merge for release
-
-            ### Next Steps
-            1. Review the changelog entries below
-            2. Make any necessary edits to CHANGELOG.md if needed
-            3. Merge this PR
-            4. Continue with your release process
-
-            ---
-
-            <details>
-            <summary>📋 Preview of changes</summary>
-
-            The changelog has been updated with entries from the following fragments:
-
-            ```bash
-            ${{ steps.check_fragments.outputs.fragment_count }} fragments processed
-            ```
-
-            </details>
-          branch: changelog-${{ inputs.version }}
-          delete-branch: true
-          labels: |
-            changelog
-            release

.github/workflows/publish.yaml

@@ -5,29 +5,35 @@ on:
     inputs:
       gitref:
         type: string
-        description: 'what git tag to build (e.g. v0.0.74)'
+        description: "what git ref to build"
         required: true
 
 jobs:
   build:
-    name: 'Build and upload wheels'
+    name: "Build and upload wheels"
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
         with:
           ref: ${{ github.event.inputs.gitref }}
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@v3
-        with:
-          version: 'latest'
       - name: Set up Python
-        run: uv python install 3.12
-      - name: Install development dependencies
-        run: uv sync --group dev
+        id: setup_python
+        uses: actions/setup-python@v4
+        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
       - name: Build project
-        run: uv build
+        run: |
+          source .venv/bin/activate
+          python -m build
       - name: Upload wheels
         uses: actions/upload-artifact@v4
         with:
@@ -35,9 +41,9 @@ jobs:
           path: ./dist
 
   publish-to-pypi:
-    name: 'Publish to PyPI'
+    name: "Publish to PyPI"
     runs-on: ubuntu-latest
-    needs: [build]
+    needs: [ build ]
     environment:
       name: pypi
       url: https://pypi.org/p/pipecat-ai
@@ -56,12 +62,12 @@ jobs:
           print-hash: true
 
   publish-to-test-pypi:
-    name: 'Publish to Test PyPI'
+    name: "Publish to Test PyPI"
     runs-on: ubuntu-latest
-    needs: [build]
+    needs: [ build ]
     environment:
       name: testpypi
-      url: https://test.pypi.org/p/pipecat-ai
+      url: https://pypi.org/p/pipecat-ai
     permissions:
       id-token: write
     steps:
@@ -70,7 +76,7 @@ jobs:
         with:
           name: wheels
           path: ./dist
-      - name: Publish to Test PyPI
+      - name: Publish to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           verbose: true

.github/workflows/publish_test.yaml

@@ -4,7 +4,7 @@ on: workflow_dispatch
 
 jobs:
   build:
-    name: 'Build and upload wheels'
+    name: "Build and upload wheels"
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
@@ -12,16 +12,23 @@ jobs:
         with:
           fetch-tags: true
           fetch-depth: 100
-      - name: Install uv
-        uses: astral-sh/setup-uv@v3
-        with:
-          version: 'latest'
       - name: Set up Python
-        run: uv python install 3.12
-      - name: Install development dependencies
-        run: uv sync --group dev
+        id: setup_python
+        uses: actions/setup-python@v4
+        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
       - name: Build project
-        run: uv build
+        run: |
+          source .venv/bin/activate
+          python -m build
       - name: Upload wheels
         uses: actions/upload-artifact@v4
         with:
@@ -29,12 +36,12 @@ jobs:
           path: ./dist
 
   publish-to-test-pypi:
-    name: 'Publish to Test PyPI'
+    name: "Publish to Test PyPI"
     runs-on: ubuntu-latest
-    needs: [build]
+    needs: [ build ]
     environment:
       name: testpypi
-      url: https://test.pypi.org/p/pipecat-ai
+      url: https://pypi.org/p/pipecat-ai
     permissions:
       id-token: write
     steps:
@@ -43,7 +50,7 @@ jobs:
         with:
           name: wheels
           path: ./dist
-      - name: Publish to Test PyPI
+      - name: Publish to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           verbose: true

.github/workflows/python-compatibility.yaml

@@ -1,60 +0,0 @@
-name: Python Compatibility Test
-
-on:
-  push:
-    branches: [main, develop]
-    paths: ['pyproject.toml']
-  pull_request:
-    branches: [main, develop]
-    paths: ['pyproject.toml']
-
-jobs:
-  test-compatibility:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: ['3.10.18', '3.11.13', '3.12.11', '3.13.5']
-
-    name: 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 local-smart-turn \
-            --no-extra moondream \
-            --no-extra mlx-whisper
-
-      - name: Verify installation
-        run: |
-          uv run python --version
-          uv run python -c "import pipecat; print('✅ Pipecat imports successfully')"

.github/workflows/sync-quickstart.yaml

@@ -1,51 +0,0 @@
-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 uv.lock and README.md)
-        run: |
-          # Copy all files except uv.lock and README.md
-          find examples/quickstart -type f \
-            -not -name "README.md" \
-            -not -name "uv.lock" \
-            -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

@@ -1,4 +1,4 @@
-name: tests
+name: test
 
 on:
   workflow_dispatch:
@@ -22,23 +22,31 @@ 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
-        run: uv python install 3.12
-
+        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
       - name: Install system packages
+        id: install_system_packages
         run: |
           sudo apt-get install -y portaudio19-dev
-
-      - name: Install dependencies
+      - name: Setup virtual environment
         run: |
-          uv sync --group dev --extra anthropic --extra aws --extra google --extra langchain --extra livekit --extra websocket
-
+          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
       - name: Test with pytest
         run: |
-          uv run pytest
+          source .venv/bin/activate
+          pytest --ignore-glob="*to_be_updated*" --ignore-glob=*pipeline_source* src tests

.gitignore

@@ -4,17 +4,9 @@ __pycache__/
 *~
 venv
 .venv
-.idea
-.gradle
-.next
-next-env.d.ts
-local.properties
-*.log
-*.lock
-smart_turn_audio_log
 #*#
 
-# Distribution / Packaging
+# Distribution / packaging
 .Python
 build/
 develop-eggs/
@@ -34,31 +26,5 @@ share/python-wheels/
 *.egg
 MANIFEST
 .DS_Store
-.env*
-fly.toml
-
-# Examples
-examples/**/node_modules/
-examples/**/.expo/
-examples/**/dist/
-examples/**/npm-debug.*
-examples/**/*.jks
-examples/**/*.p8
-examples/**/*.p12
-examples/**/*.key
-examples/**/*.mobileprovision
-examples/**/*.orig.*
-examples/**/web-build/
-
-# macOS
-.DS_Store
-
-# Documentation
-docs/api/_build/
-docs/api/api
-
-# uv
-.python-version
-
-# Pipecat
-whisker_setup.py
+.env
+fly.toml

.pre-commit-config.yaml

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

.readthedocs.yaml

@@ -1,28 +0,0 @@
-version: 2
-
-build:
-  os: ubuntu-22.04
-  tools:
-    python: '3.12'
-  apt_packages:
-    - portaudio19-dev
-    - python3-dev
-    - libasound2-dev
-  jobs:
-    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 local_smart_turn --no-extra moondream --no-extra riva --no-extra mlx-whisper
-
-sphinx:
-  configuration: docs/api/conf.py
-  fail_on_warning: false
-
-search:
-  ranking:
-    api/*: 5
-    getting-started/*: 4
-    guides/*: 3
-
-submodules:
-  include: all
-  recursive: true

COMMUNITY_INTEGRATIONS.md

@@ -1,336 +0,0 @@
-# Community Integrations Guide
-
-Pipecat welcomes community-maintained integrations! As our ecosystem grows, we've established a process for any developer to create and maintain their own service integrations while ensuring discoverability for the Pipecat community.
-
-## Overview
-
-**What we support:** Community-maintained integrations that live in separate repositories and are maintained by their authors.
-
-**What we don't do:** The Pipecat team does not code review, test, or maintain community integrations. We provide guidance and list approved integrations for discoverability.
-
-**Why this approach:** This allows the community to move quickly while keeping the Pipecat core team focused on maintaining the framework itself.
-
-## Submitting your Integration
-
-To be listed as an official community integration, follow these steps:
-
-### Step 1: Build Your Integration
-
-Create your integration following the patterns and examples shown in the "Integration Patterns and Examples" section below.
-
-### Step 2: Set Up Your Repository
-
-Your repository must contain these components:
-
-- **Source code** - Complete implementation following Pipecat patterns
-- **Foundational example** - Single file example showing basic usage (see [Pipecat examples](https://github.com/pipecat-ai/pipecat/tree/main/examples/foundational))
-- **README.md** - Must include:
-
-  - Introduction and explanation of your integration
-  - Installation instructions
-  - Usage instructions with Pipecat Pipeline
-  - How to run your example
-  - Pipecat version compatibility (e.g., "Tested with Pipecat v0.0.86")
-  - Company attribution: If you work for the company providing the service, please mention this in your README. This helps build confidence that the integration will be actively maintained.
-
-- **LICENSE** - Permissive license (BSD-2 like Pipecat, or equivalent open source terms)
-- **Code documentation** - Source code with docstrings (we recommend following [Pipecat's docstring conventions](https://github.com/pipecat-ai/pipecat/blob/main/CONTRIBUTING.md#docstring-conventions))
-- **Changelog** - Maintain a changelog for version updates
-
-### Step 3: Join Discord
-
-Join our Discord: https://discord.gg/pipecat
-
-### Step 4: Submit for Listing
-
-Submit a pull request to add your integration to our [Community Integrations documentation page](https://docs.pipecat.ai/server/services/community-integrations).
-
-**To submit:**
-
-1. Fork the [Pipecat docs repository](https://github.com/pipecat-ai/docs)
-2. Edit the file `server/services/community-integrations.mdx`
-3. Add your integration to the appropriate service category table with:
-   - Service name
-   - Link to your repository
-   - Maintainer GitHub username(s)
-4. Include a link to your demo video (approx 30-60 seconds) in your PR description showing:
-   - Core functionality of your integration
-   - Handling of an interruption (if applicable to service type)
-5. Submit your pull request
-
-Once your PR is submitted, post in the `#community-integrations` Discord channel to let us know.
-
-## Integration Patterns and Examples
-
-### STT (Speech-to-Text) Services
-
-#### Websocket-based Services
-
-**Base class:** `STTService`
-
-**Examples:**
-
-- [DeepgramSTTService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/deepgram/stt.py)
-- [SpeechmaticsSTTService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/speechmatics/stt.py)
-
-#### File-based Services
-
-**Base class:** `SegmentedSTTService`
-
-**Examples:**
-
-- [NvidiaSTTService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/nvidia/stt.py)
-- [FalSTTService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/fal/stt.py)
-
-#### Key requirements:
-
-- STT services should push `InterimTranscriptionFrames` and `TranscriptionFrames`
-- If confidence values are available, filter for values >50% confidence
-
-### LLM (Large Language Model) Services
-
-#### OpenAI-Compatible Services
-
-**Base class:** `OpenAILLMService`
-
-**Examples:**
-
-- [AzureLLMService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/azure/llm.py)
-- [GrokLLMService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/grok/llm.py) - Shows overriding the base class where needed
-
-#### Non-OpenAI Compatible Services
-
-**Requires:** Full implementation
-
-**Examples:**
-
-- [AnthropicLLMService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/anthropic/llm.py)
-- [GoogleLLMService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/google/llm.py)
-
-#### Key requirements:
-
-- **Frame sequence:** Output must follow this frame sequence pattern:
-
-  - `LLMFullResponseStartFrame` - Signals the start of an LLM response
-  - `LLMTextFrame` - Contains LLM content, typically streamed as tokens
-  - `LLMFullResponseEndFrame` - Signals the end of an LLM response
-
-- **Context aggregation:** Implement context aggregation to collect user and assistant content:
-  - Aggregators come in pairs with a `user()` instance and `assistant()` instance
-  - Context must adhere to the `LLMContext` universal format
-  - Aggregators should handle adding messages, function calls, and images to the context
-
-### TTS (Text-to-Speech) Services
-
-#### AudioContextWordTTSService
-
-**Use for:** Websocket-based services supporting word/timestamp alignment
-
-**Example:**
-
-- [CartesiaTTSService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/cartesia/tts.py)
-
-#### InterruptibleTTSService
-
-**Use for:** Websocket-based services without word/timestamp alignment, requiring disconnection on interruption
-
-**Example:**
-
-- [SarvamTTSService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/sarvam/tts.py)
-
-#### WordTTSService
-
-**Use for:** HTTP-based services supporting word/timestamp alignment
-
-**Example:**
-
-- [ElevenLabsHttpTTSService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/elevenlabs/tts.py)
-
-#### TTSService
-
-**Use for:** HTTP-based services without word/timestamp alignment
-
-**Example:**
-
-- [GoogleHttpTTSService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/google/tts.py)
-
-#### Key requirements:
-
-- For websocket services, use asyncio WebSocket implementation (required for v13+ support)
-- Handle idle service timeouts with keepalives
-- TTSServices push both audio (`TTSRawAudioFrame`) and text (`TTSTextFrame`) frames
-
-### Telephony Serializers
-
-Pipecat supports telephony provider integration using websocket connections to exchange MediaStreams. These services use a FrameSerializer to serialize and deserialize inputs from the FastAPIWebsocketTransport.
-
-**Examples:**
-
-- [Twilio](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/serializers/twilio.py)
-- [Telnyx](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/serializers/telnyx.py)
-
-#### Key requirements:
-
-- Include hang-up functionality using the provider's native API, ideally using `aiohttp`
-- Support DTMF (dual-tone multi-frequency) events if the provider supports them:
-  - Deserialize DTMF events from the provider's protocol to `InputDTMFFrame`
-  - Use `KeypadEntry` enum for valid keypad entries (0-9, \*, #, A-D)
-  - Handle invalid DTMF digits gracefully by returning `None`
-
-### Image Generation Services
-
-**Base class:** `ImageGenService`
-
-**Examples:**
-
-- [FalImageGenService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/fal/image.py)
-- [GoogleImageGenService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/google/image.py)
-
-#### Key requirements:
-
-- Must implement `run_image_gen` method returning an `AsyncGenerator`
-
-### Vision Services
-
-Vision services process images and provide analysis such as descriptions, object detection, or visual question answering.
-
-**Base class:** `VisionService`
-
-**Example:**
-
-- [MoondreamVisionService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/moondream/vision.py)
-
-#### Key requirements:
-
-- Must implement `run_vision` method that takes an `LLMContext` and returns an `AsyncGenerator[Frame, None]`
-- The method processes the latest image in the context and yields frames with analysis results
-- Typically yields `TextFrame` objects containing descriptions or answers
-
-## Implementation Guidelines
-
-### Naming Conventions
-
-- **STT:** `VendorSTTService`
-- **LLM:** `VendorLLMService`
-- **TTS:**
-  - Websocket: `VendorTTSService`
-  - HTTP: `VendorHttpTTSService`
-- **Image:** `VendorImageGenService`
-- **Vision:** `VendorVisionService`
-- **Telephony:** `VendorFrameSerializer`
-
-### Metrics Support
-
-Enable metrics in your service:
-
-```python
-def can_generate_metrics(self) -> bool:
-    """Check if this service can generate processing metrics.
-
-    Returns:
-        True, as this service supports metrics.
-    """
-    return True
-```
-
-### Dynamic Settings Updates
-
-STT, LLM, and TTS services support `ServiceUpdateSettingsFrame` for dynamic configuration changes. The base STTService has an `_update_settings()` method that handles settings, and the private `_settings` `Dict` is used to store settings and provide access to the subclass.
-
-```python
-async def set_language(self, language: Language):
-    """Set the recognition language and reconnect.
-
-    Args:
-        language: The language to use for speech recognition.
-    """
-    logger.info(f"Switching STT language to: [{language}]")
-    self._settings["language"] = language
-    await self._disconnect()
-    await self._connect()
-```
-
-Note that, in this example, Deepgram requires the websocket connection be disconnected and reconnected to reinitialize the service with the new value. Consider if your service requires reconnection.
-
-### Sample Rate Handling
-
-Sample rates are set via PipelineParams and passed to each frame processor at initialization. The pattern is to _not_ set the sample rate value in the constructor of a given service. Instead, use the `start()` method to initialize sample rates from the frame:
-
-```python
-async def start(self, frame: StartFrame):
-    """Start the service."""
-    await super().start(frame)
-    self._settings["output_format"]["sample_rate"] = self.sample_rate
-    await self._connect()
-```
-
-Note that `self.sample_rate` is a `@property` set in the TTSService base class, which provides access to the private sample rate value obtained from the StartFrame.
-
-### Tracing Decorators
-
-Use Pipecat's tracing decorators:
-
-- **STT:** `@traced_stt` - decorate a function that handles `transcript`, `is_final`, `language` as args
-- **LLM:** `@traced_llm` - decorate the `_process_context()` method
-- **TTS:** `@traced_tts` - decorate the `run_tts()` method
-
-## Best Practices
-
-### Packaging and Distribution
-
-- Use [uv](https://docs.astral.sh/uv/) for packaging (encouraged)
-- Consider releasing to PyPI for easier installation
-- Follow semantic versioning principles
-- Maintain a changelog
-
-### HTTP Communication
-
-For REST-based communication, use aiohttp. Pipecat includes this as a required dependency, so using it prevents adding an additional dependency to your integration.
-
-### Error Handling
-
-- Wrap API calls in appropriate try/catch blocks
-- Handle rate limits and network failures gracefully
-- Provide meaningful error messages
-- When errors occur, raise exceptions AND push `ErrorFrame`s to notify the pipeline:
-
-```python
-from pipecat.frames.frames import ErrorFrame
-
-try:
-    # Your API call
-    result = await self._make_api_call()
-except Exception as e:
-    # Push error frame to pipeline
-    await self.push_error(ErrorFrame(error=f"{self} error: {e}"))
-    # Raise or handle as appropriate
-    raise
-```
-
-### Testing
-
-- Your foundational example serves as a valuable integration-level test
-- Unit tests are nice to have. As the Pipecat teams provides better guidance, we will encourage unit testing more
-
-## Disclaimer
-
-Community integrations are community-maintained and not officially supported by the Pipecat team. Users should evaluate these integrations independently. The Pipecat team reserves the right to remove listings that become unmaintained or problematic.
-
-## Staying Up to Date
-
-Pipecat evolves rapidly to support the latest AI technologies and patterns. While we strive to minimize breaking changes, they do occur as the framework matures.
-
-**We strongly recommend:**
-
-- Join our Discord at https://discord.gg/pipecat and monitor the `#announcements` channel for release notifications
-- Follow our changelog: https://github.com/pipecat-ai/pipecat/blob/main/CHANGELOG.md
-- Test your integration against new Pipecat releases promptly
-- Update your README with the last tested Pipecat version
-
-This helps ensure your integration remains compatible and your users have clear expectations about version support.
-
-## Questions?
-
-Join our Discord community at https://discord.gg/pipecat and post in the `#community-integrations` channel for guidance and support.
-
-For additional questions, you can also reach out to us at pipecat-ai@daily.co.

CONTRIBUTING.md

@@ -1,439 +0,0 @@
-## Contributing to Pipecat
-
-**Want to add a new service integration?**
-We encourage community-maintained integrations! Please see our [Community Integration Guide](COMMUNITY_INTEGRATIONS.md) for the process and requirements.
-
-**Want to contribute to Pipecat core?**
-We welcome contributions of all kinds! Your help is appreciated. Follow these steps to get involved:
-
-1. **Fork this repository**: Start by forking the Pipecat Documentation repository to your GitHub account.
-
-2. **Clone the repository**: Clone your forked repository to your local machine.
-   ```bash
-   git clone https://github.com/your-username/pipecat
-   ```
-3. **Create a branch**: For your contribution, create a new branch.
-   ```bash
-   git checkout -b your-branch-name
-   ```
-4. **Make your changes**: Edit or add files as necessary.
-5. **Add a changelog entry**: Create a changelog fragment file (see [Changelog Entries](#changelog-entries) below).
-6. **Test your changes**: Ensure that your changes look correct and follow the style set in the codebase.
-7. **Commit your changes**: Once you're satisfied with your changes, commit them with a meaningful message.
-
-```bash
-git commit -m "Description of your changes"
-```
-
-8. **Push your changes**: Push your branch to your forked repository.
-
-```bash
-git push origin your-branch-name
-```
-
-9. **Submit a Pull Request (PR)**: Open a PR from your forked repository to the main branch of this repo.
-   > Important: Describe the changes you've made clearly!
-
-Our maintainers will review your PR, and once everything is good, your contributions will be merged!
-
-## Changelog Entries
-
-Every pull request that makes a user-facing change should include a changelog entry. We use a changelog fragment system to avoid merge conflicts.
-
-### Creating a Changelog Fragment
-
-1. Create a new file in the `changelog/` directory with this naming pattern:
-
-   ```
-   <PR_number>.<type>.md
-   ```
-
-2. Choose the appropriate type:
-
-   - `added.md` - New features
-   - `changed.md` - Changes in existing functionality
-   - `deprecated.md` - Soon-to-be removed features
-   - `removed.md` - Removed features
-   - `fixed.md` - Bug fixes
-   - `security.md` - Security fixes
-   - `other.md` - Other changes (documentation, dependencies, etc.)
-
-3. Write your changelog entry as a Markdown bullet point. Include the `-` at the start:
-
-**Example files:**
-
-`changelog/1234.added.md`:
-
-```markdown
-- Added support for Anthropic Claude 3.5 Sonnet with improved streaming performance.
-```
-
-`changelog/5678.fixed.md`:
-
-```markdown
-- Fixed an issue where audio frames were dropped during high-load scenarios.
-```
-
-**For entries with nested bullets:**
-
-`changelog/1234.changed.md`:
-
-```markdown
-- Updated service configuration:
-
-  - Changed default timeout to 30 seconds
-  - Added retry logic for failed connections
-```
-
-### Multiple Changes in One PR
-
-**Different types of changes:** Create separate fragment files for each type:
-
-```
-changelog/1234.added.md
-changelog/1234.fixed.md
-```
-
-**Multiple changes of the same type:** Create numbered fragment files:
-
-```
-changelog/1234.changed.md
-changelog/1234.changed.2.md
-```
-
-**Related changes:** Use nested bullets in a single fragment:
-
-```markdown
-- Updated service configuration:
-
-  - Changed default timeout to 30 seconds
-  - Added retry logic for failed connections
-```
-
-**Rule of thumb:** One logical change per fragment file. If changes are unrelated, use separate files.
-
-### Preview Your Changes
-
-To see what your changelog entry will look like:
-
-```bash
-towncrier build --draft --version Unreleased
-```
-
-This won't modify any files, just show you a preview.
-
-### When to Skip Changelog Entries
-
-You can skip adding a changelog entry for:
-
-- Documentation-only changes
-- Internal refactoring with no user-facing impact
-- Test-only changes
-- CI/build configuration changes
-
-If you're unsure whether your change needs a changelog entry, ask in your PR!
-
-## Dependency Management
-
-This project uses [uv](https://docs.astral.sh/uv/) for dependency management. The `uv.lock` file is committed to ensure reproducible builds.
-
-### Adding or Updating Dependencies
-
-1. Edit `pyproject.toml` to add/update dependencies
-2. Run `uv lock` to update the lockfile with new dependency resolution
-3. Run `uv sync` to install the updated dependencies locally
-4. Always commit both files together:
-   ```bash
-   git add pyproject.toml uv.lock
-   git commit -m "feat: add new dependency for feature X"
-   ```
-
-**Important:** Never manually edit `uv.lock`. It's auto-generated by `uv lock`.
-
-## Code Style and Documentation
-
-### Python Code Style
-
-We use Ruff for code linting and formatting. Please ensure your code passes all linting checks before submitting a PR.
-
-### Docstring Conventions
-
-We follow Google-style docstrings with these specific conventions:
-
-**Regular Classes:**
-
-- 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
-# Regular class
-class MyService(BaseService):
-    """Description of what the service does.
-
-    Provides detailed explanation of the service's functionality,
-    key features, and usage patterns.
-
-    Supported features:
-
-    - Feature one with detailed explanation
-    - Feature two with additional context
-    - Feature three for advanced use cases
-    """
-
-    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 sample_rate(self) -> int:
-        """Get the current sample rate.
-
-        Returns:
-            The sample rate in Hz.
-        """
-        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
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, caste, color, religion, or sexual
-identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-- Demonstrating empathy and kindness toward other people
-- Being respectful of differing opinions, viewpoints, and experiences
-- Giving and gracefully accepting constructive feedback
-- Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-- Focusing on what is best not just for us as individuals, but for the overall
-  community
-
-Examples of unacceptable behavior include:
-
-- The use of sexualized language or imagery, and sexual attention or advances of
-  any kind
-- Trolling, insulting or derogatory comments, and personal or political attacks
-- Public or private harassment
-- Publishing others' private information, such as a physical or email address,
-  without their explicit permission
-- Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official email address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at pipecat-ai@daily.co.
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of
-actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or permanent
-ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior, harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the
-community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.1, available at
-[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
-
-Community Impact Guidelines were inspired by
-[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
-
-For answers to common questions about this code of conduct, see the FAQ at
-[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
-[https://www.contributor-covenant.org/translations][translations].
-
-[homepage]: https://www.contributor-covenant.org
-[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
-[Mozilla CoC]: https://github.com/mozilla/diversity
-[FAQ]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations

Dockerfile

@@ -0,0 +1,40 @@
+# 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"]

LICENSE

@@ -1,6 +1,6 @@
 BSD 2-Clause License
 
-Copyright (c) 2024–2026, Daily
+Copyright (c) 2024, Daily
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

MANIFEST.in

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

README.md

@@ -1,199 +1,214 @@
-<h1><div align="center">
- <img alt="pipecat" width="300px" height="auto" src="https://raw.githubusercontent.com/pipecat-ai/pipecat/main/pipecat.png">
-</div></h1>
+<div align="center">
+ <img alt="pipecat" width="300px" height="auto" src="https://raw.githubusercontent.com/pipecat-ai/pipecat/main/pipecat.png">
+</div>
 
-[![PyPI](https://img.shields.io/pypi/v/pipecat-ai)](https://pypi.org/project/pipecat-ai) ![Tests](https://github.com/pipecat-ai/pipecat/actions/workflows/tests.yaml/badge.svg) [![codecov](https://codecov.io/gh/pipecat-ai/pipecat/graph/badge.svg?token=LNVUIVO4Y9)](https://codecov.io/gh/pipecat-ai/pipecat) [![Docs](https://img.shields.io/badge/Documentation-blue)](https://docs.pipecat.ai) [![Discord](https://img.shields.io/discord/1239284677165056021)](https://discord.gg/pipecat) [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/pipecat-ai/pipecat)
+# Pipecat
 
-# 🎙️ Pipecat: Real-Time Voice & Multimodal AI Agents
+[![PyPI](https://img.shields.io/pypi/v/pipecat-ai)](https://pypi.org/project/pipecat-ai) [![Discord](https://img.shields.io/discord/1239284677165056021)](https://discord.gg/pipecat) <a href="https://app.commanddash.io/agent/github_pipecat-ai_pipecat"><img src="https://img.shields.io/badge/AI-Code%20Agent-EB9FDA"></a>
 
-**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.
+`pipecat` is a framework for building voice (and multimodal) conversational agents. Things like personal coaches, meeting assistants, [story-telling toys for kids](https://storytelling-chatbot.fly.dev/), customer support bots, [intake flows](https://www.youtube.com/watch?v=lDevgsp9vn0), and snarky social companions.
 
-> 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
-- **AI Companions** – coaches, meeting assistants, characters
-- **Multimodal Interfaces** – voice, video, images, and more
-- **Interactive Storytelling** – creative tools with generative media
-- **Business Agents** – customer intake, support bots, guided flows
-- **Complex Dialog Systems** – design logic with structured conversations
-
-## 🧠 Why Pipecat?
-
-- **Voice-first**: Integrates speech recognition, text-to-speech, and conversation handling
-- **Pluggable**: Supports many AI services and tools
-- **Composable Pipelines**: Build complex behavior from modular components
-- **Real-Time**: Ultra-low latency interaction with different transports (e.g. WebSockets or WebRTC)
-
-## 🌐 Pipecat Ecosystem
-
-### 📱 Client SDKs
-
-Building client applications? You can connect to Pipecat from any platform using our official SDKs:
-
-<a href="https://docs.pipecat.ai/client/js/introduction">JavaScript</a> | <a href="https://docs.pipecat.ai/client/react/introduction">React</a> | <a href="https://docs.pipecat.ai/client/react-native/introduction">React Native</a> |
-<a href="https://docs.pipecat.ai/client/ios/introduction">Swift</a> | <a href="https://docs.pipecat.ai/client/android/introduction">Kotlin</a> | <a href="https://docs.pipecat.ai/client/c++/introduction">C++</a> | <a href="https://github.com/pipecat-ai/pipecat-esp32">ESP32</a>
-
-### 🧭 Structured conversations
-
-Looking to build structured conversations? Check out [Pipecat Flows](https://github.com/pipecat-ai/pipecat-flows) for managing complex conversational states and transitions.
-
-### 🪄 Beautiful UIs
-
-Want to build beautiful and engaging experiences? Checkout the [Voice UI Kit](https://github.com/pipecat-ai/voice-ui-kit), a collection of components, hooks and templates for building voice AI applications quickly.
-
-### 🛠️ Create and deploy projects
-
-Create a new project in under a minute with the [Pipecat CLI](https://github.com/pipecat-ai/pipecat-cli). Then use the CLI to monitor and deploy your agent to production.
-
-### 🔍 Debugging
-
-Looking for help debugging your pipeline and processors? Check out [Whisker](https://github.com/pipecat-ai/whisker), a real-time Pipecat debugger.
-
-### 🖥️ Terminal
-
-Love terminal applications? Check out [Tail](https://github.com/pipecat-ai/tail), a terminal dashboard for Pipecat.
-
-### 📺️ Pipecat TV Channel
-
-Catch new features, interviews, and how-tos on our [Pipecat TV](https://www.youtube.com/playlist?list=PLzU2zoMTQIHjqC3v4q2XVSR3hGSzwKFwH) channel.
-
-## 🎬 See it in action
+Take a look at some example apps:
 
 <p float="left">
-    <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>
+    <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="280" /></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="280" /></a>
     <br/>
-    <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/blob/main/examples/foundational/12-describe-video.py"><img src="https://github.com/pipecat-ai/pipecat/blob/main/examples/foundational/assets/moondream.png" width="400" /></a>
+    <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="280" /></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="280" /></a>
 </p>
 
-## 🧩 Available services
+## Getting started with voice agents
 
-| 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), [ElevenLabs](https://docs.pipecat.ai/server/services/stt/elevenlabs), [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), [Gradium](https://docs.pipecat.ai/server/services/stt/gradium), [Groq (Whisper)](https://docs.pipecat.ai/server/services/stt/groq), [Hathora](https://docs.pipecat.ai/server/services/stt/hathora), [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), [Sarvam](https://docs.pipecat.ai/server/services/stt/sarvam), [Soniox](https://docs.pipecat.ai/server/services/stt/soniox), [Speechmatics](https://docs.pipecat.ai/server/services/stt/speechmatics), [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), [Mistral](https://docs.pipecat.ai/server/services/llm/mistral), [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), [Camb AI](https://docs.pipecat.ai/server/services/tts/camb), [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), [Gradium](https://docs.pipecat.ai/server/services/tts/gradium), [Groq](https://docs.pipecat.ai/server/services/tts/groq), [Hathora](https://docs.pipecat.ai/server/services/tts/hathora), [Hume](https://docs.pipecat.ai/server/services/tts/hume), [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), [Speechmatics](https://docs.pipecat.ai/server/services/tts/speechmatics), [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), [Grok Voice Agent](https://docs.pipecat.ai/server/services/s2s/grok), [OpenAI Realtime](https://docs.pipecat.ai/server/services/s2s/openai), [Ultravox](https://docs.pipecat.ai/server/services/s2s/ultravox),                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
-| 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         | [Exotel](https://docs.pipecat.ai/server/utilities/serializers/exotel), [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), [Vonage](https://docs.pipecat.ai/server/utilities/serializers/vonage)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
-| 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/google-imagen), [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), [ai-coustics](https://docs.pipecat.ai/server/utilities/audio/aic-filter)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
-| Analytics & Metrics | [OpenTelemetry](https://docs.pipecat.ai/server/utilities/opentelemetry), [Sentry](https://docs.pipecat.ai/server/services/analytics/sentry)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+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 also add a 📞 telephone number, 🖼️ image output, 📺 video input, use different LLMs, and more.
 
-📚 [View full services documentation →](https://docs.pipecat.ai/server/services/supported-services)
+```shell
+# install the module
+pip install pipecat-ai
 
-## ⚡ Getting started
+# set up an .env file with API keys
+cp dot-env.template .env
+```
 
-You can get started with Pipecat running on your local machine, then move your agent processes to the cloud when you're ready.
+By default, in order to minimize dependencies, only the basic framework functionality is available. Some third-party AI services require additional dependencies that you can install with:
 
-1. Install uv
+```shell
+pip install "pipecat-ai[option,...]"
+```
 
-   ```bash
-   curl -LsSf https://astral.sh/uv/install.sh | sh
-   ```
+Your project may or may not need these, so they're made available as optional requirements. Here is a list:
 
-   > **Need help?** Refer to the [uv install documentation](https://docs.astral.sh/uv/getting-started/installation/).
+- **AI services**: `anthropic`, `assemblyai`, `aws`, `azure`, `deepgram`, `gladia`, `google`, `fal`, `lmnt`, `moondream`, `openai`, `openpipe`, `playht`, `silero`, `whisper`, `xtts`
+- **Transports**: `local`, `websocket`, `daily`
 
-2. Install the module
+## Code examples
 
-   ```bash
-   # For new projects
-   uv init my-pipecat-app
-   cd my-pipecat-app
-   uv add pipecat-ai
+- [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
 
-   # Or for existing projects
-   uv add pipecat-ai
-   ```
+## A simple voice agent running locally
 
-3. Set up your environment
+Here is a very basic Pipecat bot that greets a user when they join a real-time session. We'll use [Daily](https://daily.co) for real-time media transport, and [Cartesia](https://cartesia.ai/) for text-to-speech.
 
-   ```bash
-   cp env.example .env
-   ```
+```python
+import asyncio
 
-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:
+from pipecat.frames.frames import EndFrame, TextFrame
+from pipecat.pipeline.pipeline import Pipeline
+from pipecat.pipeline.task import PipelineTask
+from pipecat.pipeline.runner import PipelineRunner
+from pipecat.services.cartesia import CartesiaTTSService
+from pipecat.transports.services.daily import DailyParams, DailyTransport
 
-   ```bash
-   uv add "pipecat-ai[option,...]"
-   ```
+async def main():
+  # Use Daily as a real-time media transport (WebRTC)
+  transport = DailyTransport(
+    room_url=...,
+    token=...,
+    bot_name="Bot Name",
+    params=DailyParams(audio_out_enabled=True))
 
-> **Using pip?** You can still use `pip install pipecat-ai` and `pip install "pipecat-ai[option,...]"` to get set up.
+  # Use Cartesia for Text-to-Speech
+  tts = CartesiaTTSService(
+    api_key=...,
+    voice_id=...
+  )
 
-## 🧪 Code examples
+  # Simple pipeline that will process text to speech and output the result
+  pipeline = Pipeline([tts, transport.output()])
 
-- [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-examples) — complete applications that you can use as starting points for development
+  # Create Pipecat processor that can run one or more pipelines tasks
+  runner = PipelineRunner()
 
-## 🛠️ Contributing to the framework
+  # Assign the task callable to run the pipeline
+  task = PipelineTask(pipeline)
 
-### Prerequisites
+  # Register an event handler to play audio when a
+  # participant joins the transport WebRTC session
+  @transport.event_handler("on_first_participant_joined")
+  async def on_first_participant_joined(transport, participant):
+    participant_name = participant.get("info", {}).get("userName", "")
+    # Queue a TextFrame that will get spoken by the TTS service (Cartesia)
+    await task.queue_frame(TextFrame(f"Hello there, {participant_name}!"))
 
-**Minimum Python Version:** 3.10
-**Recommended Python Version:** 3.12
+  # Register an event handler to exit the application when the user leaves.
+  @transport.event_handler("on_participant_left")
+  async def on_participant_left(transport, participant, reason):
+    await task.queue_frame(EndFrame())
 
-### Setup Steps
+  # Run the pipeline task
+  await runner.run(task)
 
-1. Clone the repository and navigate to it:
+if __name__ == "__main__":
+  asyncio.run(main())
+```
 
-   ```bash
-   git clone https://github.com/pipecat-ai/pipecat.git
-   cd pipecat
-   ```
+Run it with:
 
-2. Install development and testing dependencies:
+```shell
+python app.py
+```
 
-   ```bash
-   uv sync --group dev --all-extras \
-     --no-extra gstreamer \
-     --no-extra krisp \
-     --no-extra local \
-   ```
+Daily provides a prebuilt WebRTC user interface. Whilst the app is running, you can visit at `https://<yourdomain>.daily.co/<room_url>` and listen to the bot say hello!
 
-3. Install the git pre-commit hooks:
+## WebRTC for production use
 
-   ```bash
-   uv run pre-commit install
-   ```
+WebSockets are fine for server-to-server communication or for initial development. But for production use, you’ll need client-server audio to use a protocol designed for real-time media transport. (For an explanation of the difference between WebSockets and WebRTC, see [this post.](https://www.daily.co/blog/how-to-talk-to-an-llm-with-your-voice/#webrtc))
 
-> **Note**: Some extras (local, gstreamer) require system dependencies. See documentation if you encounter build errors.
+One way to get up and running quickly with WebRTC is to sign up for a Daily developer account. Daily gives you SDKs and global infrastructure for audio (and video) routing. Every account gets 10,000 audio/video/transcription minutes free each month.
+
+Sign up [here](https://dashboard.daily.co/u/signup) and [create a room](https://docs.daily.co/reference/rest-api/rooms) in the developer Dashboard.
+
+## What is VAD?
+
+Voice Activity Detection &mdash; very important for knowing when a user has finished speaking to your bot. If you are not using press-to-talk, and want Pipecat to detect when the user has finished talking, VAD is an essential component for a natural feeling conversation.
+
+Pipecat makes use of WebRTC VAD by default when using a WebRTC transport layer. Optionally, you can use Silero VAD for improved accuracy at the cost of higher CPU usage.
+
+```shell
+pip install pipecat-ai[silero]
+```
+
+## Hacking on the framework itself
+
+_Note that you may need to set up a virtual environment before following the instructions below. For instance, you might need to run the following from the root of the repo:_
+
+```shell
+python3 -m venv venv
+source venv/bin/activate
+```
+
+From the root of this repo, run the following:
+
+```shell
+pip install -r dev-requirements.txt
+python -m build
+```
+
+This builds the package. To use the package locally (e.g. to run sample files), run
+
+```shell
+pip install --editable ".[option,...]"
+```
+
+If you want to use this package from another directory, you can run:
+
+```shell
+pip install "path_to_this_repo[option,...]"
+```
 
 ### Running tests
 
-To run all tests, from the root directory:
+From the root directory, run:
 
-```bash
-uv run pytest
+```shell
+pytest --doctest-modules --ignore-glob="*to_be_updated*" --ignore-glob=*pipeline_source* src tests
 ```
 
-Run a specific test suite:
+## Setting up your editor
 
-```bash
-uv run pytest tests/test_name.py
+This project uses strict [PEP 8](https://peps.python.org/pep-0008/) formatting via [Ruff](https://github.com/astral-sh/ruff).
+
+### Emacs
+
+You can use [use-package](https://github.com/jwiegley/use-package) to install [emacs-lazy-ruff](https://github.com/christophermadsen/emacs-lazy-ruff) package and configure `ruff` arguments:
+
+```elisp
+(use-package lazy-ruff
+  :ensure t
+  :hook ((python-mode . lazy-ruff-mode))
+  :config
+  (setq lazy-ruff-format-command "ruff format --config line-length=100")
+  (setq lazy-ruff-only-format-block t)
+  (setq lazy-ruff-only-format-region t)
+  (setq lazy-ruff-only-format-buffer t))
 ```
 
-## 🤝 Contributing
+`ruff` was installed in the `venv` environment described before, so you should be able to use [pyvenv-auto](https://github.com/ryotaro612/pyvenv-auto) to automatically load that environment inside Emacs.
 
-We welcome contributions from the community! Whether you're fixing bugs, improving documentation, or adding new features, here's how you can help:
+```elisp
+(use-package pyvenv-auto
+  :ensure t
+  :defer t
+  :hook ((python-mode . pyvenv-auto-run)))
 
-- **Found a bug?** Open an [issue](https://github.com/pipecat-ai/pipecat/issues)
-- **Have a feature idea?** Start a [discussion](https://discord.gg/pipecat)
-- **Want to contribute code?** Check our [CONTRIBUTING.md](CONTRIBUTING.md) guide
-- **Documentation improvements?** [Docs](https://github.com/pipecat-ai/docs) PRs are always welcome
+```
 
-Before submitting a pull request, please check existing issues and PRs to avoid duplicates.
+### Visual Studio Code
 
-We aim to review all contributions promptly and provide constructive feedback to help get your changes merged.
+Install the
+[Ruff](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff) extension. Then edit the user settings (_Ctrl-Shift-P_ `Open User Settings (JSON)`) and set it as the default Python formatter, enable formatting on save and configure `ruff` arguments:
 
-## 🛟 Getting help
+```json
+"[python]": {
+    "editor.defaultFormatter": "charliermarsh.ruff",
+    "editor.formatOnSave": true
+},
+"ruff.format.args": ["--config", "line-length=100"]
+```
+
+## Getting help
 
 ➡️ [Join our Discord](https://discord.gg/pipecat)
 
-➡️ [Read the docs](https://docs.pipecat.ai)
-
 ➡️ [Reach us on X](https://x.com/pipecat_ai)

SECURITY.md

@@ -1,5 +0,0 @@
-# Security Policy
-
-## Reporting a Vulnerability
-
-Please email `disclosures@daily.co`.

changelog/3510.added.2.md

@@ -1 +0,0 @@
-- Added `add_reached_upstream_filter()` and `add_reached_downstream_filter()` methods to `PipelineTask` for appending frame types.

changelog/3510.added.md

@@ -1 +0,0 @@
-- Added `reached_upstream_types` and `reached_downstream_types` read-only properties to `PipelineTask` for inspecting current frame filters.

changelog/3510.changed.3.md

@@ -1 +0,0 @@
-- Changed frame filter storage from tuples to sets in `PipelineTask`.

changelog/3519.added.2.md

@@ -1 +0,0 @@
-- Added `RTVIProcessor.create_rtvi_observer()` factory method for creating RTVI observers.

changelog/3519.added.3.md

@@ -1 +0,0 @@
-- Added `FrameProcessor.broadcast_frame_instance(frame)` method to broadcast a frame instance by extracting its fields and creating new instances for each direction.

changelog/3519.added.md

@@ -1 +0,0 @@
-- `PipelineTask` now automatically adds `RTVIProcessor` and registers `RTVIObserver` when `enable_rtvi=True` (default), simplifying pipeline setup.

changelog/3519.fixed.2.md

@@ -1 +0,0 @@
-- Fixed `FrameProcessor.broadcast_frame()` to deep copy kwargs, preventing shared mutable references between the downstream and upstream frame instances.

changelog/3519.fixed.md

@@ -1 +0,0 @@
-- Transports now properly broadcast `InputTransportMessageFrame` frames both upstream and downstream instead of only pushing downstream.

changelog/3520.added.md

@@ -1 +0,0 @@
-- Added `video_out_codec` parameter to `TransportParams` allowing configuration of the preferred video codec (e.g., `"VP8"`, `"H264"`, `"H265"`) for video output in `DailyTransport`.

changelog/3523.added.md

@@ -1 +0,0 @@
-- Added `location` parameter to Google TTS services (`GoogleHttpTTSService`, `GoogleTTSService`, `GeminiTTSService`) for regional endpoint support.

changelog/3525.added.md

@@ -1 +0,0 @@
-- Added new `SMART_TURN_LOG_DATA` environment variable, which causes Smart Turn input data to be saved to disk

changelog/3531.changed.md

@@ -1,2 +0,0 @@
-- Changed default Inworld TTS model from `inworld-tts-1` to                      
- `inworld-tts-1.5-max`.

changelog/_template.md.j2

@@ -1,16 +0,0 @@
-{% for section, _ in sections.items() %}
-{% if sections[section] %}
-{% for category, val in definitions.items() if category in sections[section]%}
-### {{ definitions[category]['name'] }}
-
-{% for text, values in sections[section][category].items() %}
-{{ text }}
-(PR {{ values|join(', ') }})
-
-{% endfor %}
-{% endfor %}
-{% else %}
-No significant changes.
-
-{% endif %}
-{% endfor %}

codecov.yml

@@ -1,11 +0,0 @@
-coverage:
-  range: 50..90 # coverage lower than 50 is red, higher than 90 green, between color code
-
-  status:
-    project:
-      default:
-        target: auto # auto % coverage target
-        threshold: 5%  # allow for 5% reduction of coverage without failing
-
-    # do not run coverage on patch nor changes
-    patch: false

dev-requirements.txt

@@ -0,0 +1,8 @@
+build~=1.2.1
+grpcio-tools~=1.62.2
+pip-tools~=7.4.1
+pyright~=1.1.376
+pytest~=8.3.2
+ruff~=0.6.7
+setuptools~=72.2.0
+setuptools_scm~=8.1.0

docs/README.md

@@ -0,0 +1,10 @@
+# Pipecat Docs
+
+## [Architecture Overview](architecture.md)
+
+Learn about the thinking behind the framework's design.
+
+## [A Frame's Progress](frame-progress.md)
+
+See how a Frame is processed through a Transport, a Pipeline, and a series of Frame Processors.
+

docs/api/Makefile

@@ -1,20 +0,0 @@
-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line, and also
-# from the environment for the first two.
-SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = .
-BUILDDIR      = _build
-
-# Put it first so that "make" without argument is like "make help".
-help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-.PHONY: help Makefile
-
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/api/README.md

@@ -1,109 +0,0 @@
-# Pipecat Documentation
-
-This directory contains the source files for auto-generating Pipecat's server API reference documentation.
-
-## Setup
-
-1. Install documentation dependencies:
-
-```bash
-pip install -r requirements.txt
-```
-
-2. Make the build scripts executable:
-
-```bash
-chmod +x build-docs.sh rtd-test.py
-```
-
-## Building Documentation
-
-From this directory, you can build the documentation in several ways:
-
-### Local Build
-
-```bash
-# Using the build script (automatically opens docs when done)
-./build-docs.sh
-
-# Or directly with sphinx-build
-sphinx-build -b html . _build/html -W --keep-going
-```
-
-### ReadTheDocs Test Build
-
-To test the documentation build process exactly as it would run on ReadTheDocs:
-
-```bash
-./rtd-test.py
-```
-
-This script:
-
-- Creates a fresh virtual environment
-- Installs all dependencies as specified in requirements files
-- Handles conflicting dependencies (like grpcio versions for Riva and PlayHT)
-- Builds the documentation in an isolated environment
-- Provides detailed logging of the build process
-
-Use this script to verify your documentation will build correctly on ReadTheDocs before pushing changes.
-
-## Viewing Documentation
-
-The built documentation will be available at `_build/html/index.html`. To open:
-
-```bash
-# On MacOS
-open _build/html/index.html
-
-# On Linux
-xdg-open _build/html/index.html
-
-# On Windows
-start _build/html/index.html
-```
-
-## Directory Structure
-
-```
-.
-├── api/            # Auto-generated API documentation
-├── _build/         # Built documentation
-├── _static/        # Static files (images, css, etc.)
-├── conf.py         # Sphinx configuration
-├── index.rst       # Main documentation entry point
-├── requirements-base.txt    # Base documentation dependencies
-├── requirements-riva.txt    # Riva-specific dependencies
-├── requirements-playht.txt  # PlayHT-specific dependencies
-├── build-docs.sh   # Local build script
-└── rtd-test.py     # ReadTheDocs test build script
-```
-
-## Notes
-
-- Documentation is auto-generated from Python docstrings
-- Service modules are automatically detected and included
-- The build process matches our ReadTheDocs configuration
-- Warnings are treated as errors (-W flag) to maintain consistency
-- The --keep-going flag ensures all errors are reported
-- Dependencies are split into multiple requirements files to handle version conflicts
-
-## Troubleshooting
-
-If you encounter missing service modules:
-
-1. Verify the service is installed with its extras: `pip install pipecat-ai[service-name]`
-2. Check the build logs for import errors
-3. Ensure the service module is properly initialized in the package
-4. Run `./rtd-test.py` to test in an isolated environment matching ReadTheDocs
-
-For dependency conflicts:
-
-1. Check the requirements files for version specifications
-2. Use `rtd-test.py` to verify dependency resolution
-3. Consider adding service-specific requirements files if needed
-
-For more information:
-
-- [ReadTheDocs Configuration](.readthedocs.yaml)
-- [Sphinx Documentation](https://www.sphinx-doc.org/)

docs/api/build-docs.sh

@@ -1,27 +0,0 @@
-#!/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 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
-uv run sphinx-build -b html -d _build/doctrees . _build/html -W --keep-going
-
-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,226 +0,0 @@
-import logging
-import os
-import sys
-from datetime import datetime
-from pathlib import Path
-
-# Configure logging
-logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s")
-logger = logging.getLogger("sphinx-build")
-
-# Add source directory to path
-docs_dir = Path(__file__).parent
-project_root = docs_dir.parent.parent
-sys.path.insert(0, str(project_root / "src"))
-
-# Project information
-project = "pipecat-ai"
-current_year = datetime.now().year
-copyright = f"2024-{current_year}, Daily" if current_year > 2024 else "2024, Daily"
-author = "Daily"
-
-# General configuration
-extensions = [
-    "sphinx.ext.autodoc",
-    "sphinx.ext.napoleon",
-    "sphinx.ext.viewcode",
-    "sphinx.ext.intersphinx",
-]
-
-suppress_warnings = [
-    "autodoc.mocked_object",
-    "toc.not_included",
-]
-
-# Napoleon settings
-napoleon_google_docstring = True
-napoleon_include_init_with_doc = True
-
-# AutoDoc settings
-autodoc_default_options = {
-    "members": True,
-    "member-order": "bysource",
-    "undoc-members": False,
-    "exclude-members": "__weakref__,model_config",
-    "show-inheritance": True,
-}
-
-# Mock imports for optional dependencies
-autodoc_mock_imports = [
-    # Krisp - has build issues on some platforms
-    "pipecat_ai_krisp",
-    "krisp",
-    "krisp_audio",
-    # System-specific GUI libraries
-    "_tkinter",
-    "tkinter",
-    # 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
-    # local-smart-turn dependencies
-    "coremltools",
-    "coremltools.models",
-    "coremltools.models.MLModel",
-    "torch",
-    "torch.nn",
-    "torch.nn.functional",
-    "torchaudio",
-    # moondream dependencies
-    "transformers",
-    "transformers.AutoTokenizer",
-    "transformers.AutoFeatureExtractor",
-    "AutoFeatureExtractor",
-    "timm",
-    "einops",
-    "intel_extension_for_pytorch",
-    "huggingface_hub",
-    # riva dependencies
-    "riva",
-    "riva.client",
-    "riva.client.Auth",
-    "riva.client.ASRService",
-    "riva.client.StreamingRecognitionConfig",
-    "riva.client.RecognitionConfig",
-    "riva.client.AudioEncoding",
-    "riva.client.proto.riva_tts_pb2",
-    "riva.client.SpeechSynthesisService",
-    # MLX dependencies (Apple Silicon specific)
-    "mlx",
-    "mlx_whisper",  # Note: might need underscore format too
-    # Pydantic v2 compatibility issues in third-party SDKs
-    "hume",
-    "hume.tts",
-    "hume.tts.types",
-    "cartesia",
-    "camb",
-    "sarvamai",
-    "openpipe",
-    "openai.types.beta.realtime",
-    "langchain_core",
-    "langchain_core.messages",
-    # FastAPI - Pydantic v2 compatibility issues during Sphinx autodoc
-    "fastapi",
-    "fastapi.applications",
-    "fastapi.routing",
-    "fastapi.params",
-    "fastapi.middleware",
-    "fastapi.responses",
-    "uvicorn",
-]
-
-# HTML output settings
-html_theme = "sphinx_rtd_theme"
-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 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.transcriptions",
-        "pipecat.utils",
-    ]
-
-    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:
-    """Automatically clean module titles."""
-    # Remove everything after space (like 'module', 'processor', etc.)
-    title = title.split(" ")[0]
-
-    # Get the last part of the dot-separated path
-    parts = title.split(".")
-    title = parts[-1]
-
-    return title
-
-
-def setup(app):
-    """Generate API documentation during Sphinx build."""
-    from sphinx.ext.apidoc import main
-
-    docs_dir = Path(__file__).parent
-    project_root = docs_dir.parent.parent
-    output_dir = str(docs_dir / "api")
-    source_dir = str(project_root / "src" / "pipecat")
-
-    # Clean existing files
-    if Path(output_dir).exists():
-        import shutil
-
-        shutil.rmtree(output_dir)
-        logger.info(f"Cleaned existing documentation in {output_dir}")
-
-    logger.info(f"Generating API documentation...")
-    logger.info(f"Output directory: {output_dir}")
-    logger.info(f"Source directory: {source_dir}")
-
-    excludes = [
-        str(project_root / "src/pipecat/pipeline/to_be_updated"),
-        str(project_root / "src/pipecat/examples"),
-        str(project_root / "src/pipecat/tests"),
-        "**/test_*.py",
-        "**/tests/*.py",
-    ]
-
-    try:
-        main(
-            [
-                "-f",  # Force overwriting
-                "-e",  # Don't generate empty files
-                "-M",  # Put module documentation before submodule documentation
-                "--no-toc",  # Don't create a table of contents file
-                "--separate",  # Put documentation for each module in its own page
-                "--module-first",  # Module documentation before submodule documentation
-                "--implicit-namespaces",  # Added: Handle implicit namespace packages
-                "-o",
-                output_dir,
-                source_dir,
-            ]
-            + excludes
-        )
-
-        logger.info("API documentation generated successfully!")
-
-        # Process generated RST files to update titles
-        for rst_file in Path(output_dir).glob("**/*.rst"):  # Changed to recursive glob
-            content = rst_file.read_text()
-            lines = content.split("\n")
-
-            # Find and clean up the title
-            if lines and "=" in lines[1]:  # Title is typically the first line
-                old_title = lines[0]
-                new_title = clean_title(old_title)
-                content = content.replace(old_title, new_title)
-                rst_file.write_text(content)
-                logger.info(f"Updated title: {old_title} -> {new_title}")
-
-    except Exception as e:
-        logger.error(f"Error generating API documentation: {e}", exc_info=True)
-
-
-import_core_modules()

docs/api/index.rst

@@ -1,35 +0,0 @@
-Pipecat API Reference
-=====================
-
-Welcome to the Pipecat API reference.
-
-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>`_
-* `Join our Community <https://discord.gg/pipecat>`_
-
-.. toctree::
-   :maxdepth: 2
-   :caption: API Reference
-   :hidden:
-
-   Adapters <api/pipecat.adapters>
-   Audio <api/pipecat.audio>
-   Clocks <api/pipecat.clocks>
-   Extensions <api/pipecat.extensions>
-   Frames <api/pipecat.frames>
-   Metrics <api/pipecat.metrics>
-   Observers <api/pipecat.observers>
-   Pipeline <api/pipecat.pipeline>
-   Processors <api/pipecat.processors>
-   Runner <api/pipecat.runner>
-   Serializers <api/pipecat.serializers>
-   Services <api/pipecat.services>
-   Transcriptions <api/pipecat.transcriptions>
-   Transports <api/pipecat.transports>
-   Utils <api/pipecat.utils>

docs/api/make.bat

@@ -1,35 +0,0 @@
-@ECHO OFF
-
-pushd %~dp0
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
-)
-set SOURCEDIR=.
-set BUILDDIR=_build
-
-%SPHINXBUILD% >NUL 2>NUL
-if errorlevel 9009 (
-	echo.
-	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
-	echo.installed, then set the SPHINXBUILD environment variable to point
-	echo.to the full path of the 'sphinx-build' executable. Alternatively you
-	echo.may add the Sphinx directory to PATH.
-	echo.
-	echo.If you don't have Sphinx installed, grab it from
-	echo.https://www.sphinx-doc.org/
-	exit /b 1
-)
-
-if "%1" == "" goto help
-
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-goto end
-
-:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-
-:end
-popd

docs/api/rtd-test.sh

@@ -1,38 +0,0 @@
-#!/bin/bash
-set -e
-
-# Configuration
-DOCS_DIR=$(pwd)
-PROJECT_ROOT=$(cd ../../ && pwd)
-TEST_DIR="/tmp/rtd-test-$(date +%Y%m%d_%H%M%S)"
-
-echo "Creating test directory: $TEST_DIR"
-mkdir -p "$TEST_DIR"
-cd "$TEST_DIR"
-
-# Create virtual environment
-python -m venv venv
-source venv/bin/activate
-
-echo "Installing build dependencies..."
-pip install --upgrade pip wheel setuptools
-
-echo "Installing documentation dependencies..."
-pip install -r "$DOCS_DIR/requirements.txt"
-
-echo "Building documentation..."
-cd "$DOCS_DIR"
-sphinx-build -b html . "_build/html"
-
-echo "Build complete. Check _build/html directory for output."
-
-# Print summary
-echo -e "\n=== Build Summary ==="
-echo "Documentation: $DOCS_DIR/_build/html"
-echo "Test environment: $TEST_DIR"
-echo -e "\nTo view the documentation:"
-echo "open $DOCS_DIR/_build/html/index.html"
-
-# Print installed packages for verification
-echo -e "\n=== Installed Packages ==="
-pip freeze | grep -E "sphinx|pipecat"

docs/architecture.md

@@ -0,0 +1,17 @@
+# Pipecat architecture guide
+
+## Frames
+
+Frames can represent discrete chunks of data, for instance a chunk of text, a chunk of audio, or an image. They can also be used to as control flow, for instance a frame that indicates that there is no more data available, or that a user started or stopped talking. They can also represent more complex data structures, such as a message array used for an LLM completion.
+
+## FrameProcessors
+
+Frame processors operate on frames. Every frame processor implements a `process_frame` method that consumes one frame and produces zero or more frames. Frame processors can do simple transforms, such as concatenating text fragments into sentences, or they can treat frames as input for an AI Service, and emit chat completions based on message arrays or transform text into audio or images.
+
+## Pipelines
+
+Pipelines are lists of frame processors linked together. Frame processors can push frames upstream or downstream to their peers. A very simple pipeline might chain an LLM frame processor to a text-to-speech frame processor, with a transport as an output.
+
+## Transports
+
+Transports provide input and output frame processors to receive or send frames respectively. For example, the `DailyTransport` does this with a WebRTC session joined to a Daily.co room.

docs/frame-progress.md

@@ -0,0 +1,46 @@
+# A Frame's Progress
+
+1. A user says “Hello, LLM” and the cloud transcription service delivers a transcription to the Transport.
+![A transcript frame arrives](images/frame-progress-01.png)
+
+2. The Transport places a Transcription frame in the Pipeline’s source queue.
+![Frame in source queue](images/frame-progress-02.png)
+
+3. The Pipeline passes the Transcription frame to the first Frame Processor in its list, the LLM User Message Aggregator.
+![To UMA](images/frame-progress-03.png)
+
+4. The LLM User Message Aggregator updates the LLM Context with a `{“user”: “Hello LLM”}` message.
+![Update context](images/frame-progress-04.png)
+
+5. The LLM User Message Aggregator yields an LLM Message Frame, containing the updated LLM Context. The Pipeline passes this frame to the LLM Frame Processor.
+![Update context](images/frame-progress-05.png)
+
+6. The LLM Frame Processor creates a streaming chat completion based on the LLM context and yields the first chunk of a response, Text Frame with the value “Hi, “. The Pipeline passes this frame to the TTS Frame Processor. The TTS Frame Processor aggregates this response but doesn’t yield anything, yet, because it’s waiting for a full sentence.
+![LLM yields Text](images/frame-progress-06.png)
+
+7. The LLM Frame Processor yields another Text Frame with the value “there.”. The Pipeline passes this frame to the TTS Frame Processor.
+![LLM yields more Text](images/frame-progress-07.png)
+
+8. The TTS Frame Processor now has a full sentence, so it starts streaming audio based on “Hi, there.” It yields the first chunk of streaming audio as an Audio frame, which the Pipeline passes to the LLM Assistant Message Aggregator.
+![TTS yields Audio](images/frame-progress-08.png)
+
+9. The LLM Assistant Message Aggregator doesn’t do anything with Audio frames, so it immediately yields the frame, unchanged. This is the convention for all Frame Processors: frames that the processor doesn’t process should be immediately yielded.
+![pass-through](images/frame-progress-09.png)
+
+10. The Pipeline places the first Audio frame in its sink queue, which is being watched by the Transport. Since the frame is now in a queue, the Pipeline can continue processing other frames. Note that the source and sink queues form a sort of “boundary of concurrent processing” between a Pipeline and the outside world. In a Pipeline, Frames are processed sequentially; once a Frame is on a queue it can be processed in parallel with the frames being processed by the Pipeline. TODO: link to a more in-depth section about this.
+![sink queue](images/frame-progress-10.png)
+
+11. The TTS Frame Processor yields another Audio frame as the Transport transmits the first Audio frame.
+![parallel audio](images/frame-progress-11.png)
+
+12. As before, the LLM Assistant Message Aggregator immediately yields the Audio frame and the Pipeline places the Audio frame in the sink queue.
+![sink queue 2](images/frame-progress-12.png)
+
+13. The TTS Frame Processor has no more frames to yield. The LLM Frame Processor emits an LLM Response End Frame, which the Pipeline passes to the TTS Frame Processor.
+![response end](images/frame-progress-13.png)
+
+14. The TTS Frame Processor immediately yields the LLM Response End Frame, so the Pipeline passes it along to the LLM Assistant Message Aggregator. The LLM Assistant Message Aggregator updates the LLM Context with the full response from the LLM. TODO TODO: I realized I forgot that the TSS Frame Processor also yields the Text frames that the LLM emitted so that the LLM Assistant Message Aggregator could accumulate them, arrggh.
+![response end](images/frame-progress-14.png)
+
+15. The system is quiet, and waiting for the next message from the Transport.
+![response end](images/frame-progress-15.png)

dot-env.template

@@ -0,0 +1,50 @@
+# Anthropic
+ANTHROPIC_API_KEY=...
+
+# AWS
+AWS_SECRET_ACCESS_KEY=...
+AWS_ACCESS_KEY_ID=...
+AWS_REGION=...
+
+# Azure
+AZURE_SPEECH_REGION=...
+AZURE_SPEECH_API_KEY=...
+
+AZURE_CHATGPT_API_KEY=...
+AZURE_CHATGPT_ENDPOINT=https://...
+AZURE_CHATGPT_MODEL=...
+
+AZURE_DALLE_API_KEY=...
+AZURE_DALLE_ENDPOINT=https://...
+AZURE_DALLE_MODEL=...
+
+# Daily
+DAILY_API_KEY=...
+DAILY_SAMPLE_ROOM_URL=https://...
+
+# ElevenLabs
+ELEVENLABS_API_KEY=...
+ELEVENLABS_VOICE_ID=...
+
+# Fal
+FAL_KEY=...
+
+# Fireworks
+FIREWORKS_API_KEY=...
+
+# Gladia
+GLADIA_API_KEY=...
+
+# LMNT
+LMNT_API_KEY=...
+LMNT_VOICE_ID=...
+
+# PlayHT
+PLAY_HT_USER_ID=...
+PLAY_HT_API_KEY=...
+
+# OpenAI
+OPENAI_API_KEY=...
+
+#OpenPipe
+OPENPIPE_API_KEY=...

env.example

@@ -1,208 +0,0 @@
-# AI-COUSTICS
-AICOUSTICS_LICENSE_KEY=...
-
-# Anthropic
-ANTHROPIC_API_KEY=...
-
-# Assembly AI
-ASSEMBLYAI_API_KEY=...
-
-# Async
-ASYNCAI_API_KEY=...
-ASYNCAI_VOICE_ID=...
-
-# AWS
-AWS_SECRET_ACCESS_KEY=...
-AWS_ACCESS_KEY_ID=...
-AWS_REGION=...
-
-# Azure
-AZURE_SPEECH_REGION=...
-AZURE_SPEECH_API_KEY=...
-
-AZURE_CHATGPT_API_KEY=...
-AZURE_CHATGPT_ENDPOINT=https://...
-AZURE_CHATGPT_MODEL=...
-
-AZURE_REALTIME_API_KEY=...
-AZURE_REALTIME_BASE_URL=...
-
-AZURE_DALLE_API_KEY=...
-AZURE_DALLE_ENDPOINT=https://...
-AZURE_DALLE_MODEL=...
-
-# Camb.ai
-CAMB_API_KEY=...
-
-# Cartesia
-CARTESIA_API_KEY=...
-CARTESIA_VOICE_ID=...
-
-# Cerebras
-CEREBRAS_API_KEY=...
-
-# Daily
-DAILY_API_KEY=...
-DAILY_SAMPLE_ROOM_URL=https://...
-
-# Deepgram
-DEEPGRAM_API_KEY=...
-SAGEMAKER_ENDPOINT_NAME=...
-
-# DeepSeek
-DEEPSEEK_API_KEY=...
-
-# ElevenLabs
-ELEVENLABS_API_KEY=...
-ELEVENLABS_VOICE_ID=...
-
-# Fal
-FAL_KEY=...
-
-# Fireworks
-FIREWORKS_API_KEY=...
-
-# Fish Audio
-FISH_API_KEY=...
-
-# Gladia
-GLADIA_API_KEY=...
-GLADIA_REGION=...
-
-# Google
-GOOGLE_API_KEY=...
-GOOGLE_VERTEX_TEST_CREDENTIALS=...
-GOOGLE_CLOUD_PROJECT_ID=...
-GOOGLE_CLOUD_LOCATION=...
-GOOGLE_TEST_CREDENTIALS=...
-
-# Gradium
-GRAPDIUM_API_KEY=...
-
-# Grok
-GROK_API_KEY=...
-
-# Groq
-GROQ_API_KEY=...
-
-# Hathora
-HATHORA_API_KEY=...
-
-# Heygen
-HEYGEN_API_KEY=...
-HEYGEN_LIVE_AVATAR_API_KEY=...
-
-# Hume
-HUME_API_KEY=...
-HUME_VOICE_ID=...
-
-# Inworld
-INWORLD_API_KEY=...
-
-# Krisp
-KRISP_MODEL_PATH=...
-
-# Krisp Viva
-KRISP_VIVA_FILTER_MODEL_PATH=...
-KRISP_VIVA_TURN_MODEL_PATH=...
-
-# LiveKit
-LIVEKIT_API_KEY=...
-LIVEKIT_API_SECRET=...
-
-# LMNT
-LMNT_API_KEY=...
-LMNT_VOICE_ID=...
-
-# MiniMax
-MINIMAX_API_KEY=...
-MINIMAX_GROUP_ID=...
-
-# Mistral
-MISTRAL_API_KEY=...
-
-# Neuphonic
-NEUPHONIC_API_KEY=...
-
-# NVIDIA
-NVIDIA_API_KEY=...
-
-# OpenAI
-OPENAI_API_KEY=...
-
-# OpenPipe
-OPENPIPE_API_KEY=...
-
-# OpenRouter
-OPENROUTER_API_KEY=...
-
-# Perplexity
-PERPLEXITY_API_KEY=...
-
-# Picovoice Koala
-KOALA_ACCESS_KEY=...
-
-# Piper
-PIPER_BASE_URL=...
-
-# PlayHT
-PLAYHT_USER_ID=...
-PLAYHT_API_KEY=...
-
-# Plivo
-PLIVO_AUTH_ID=...
-PLIVO_AUTH_TOKEN=...
-
-# Qwen
-QWEN_API_KEY=...
-
-# Rime
-RIME_API_KEY=...
-RIME_VOICE_ID=...
-
-# SambaNova
-SAMBANOVA_API_KEY=...
-
-# Sarvam AI
-SARVAM_API_KEY=...
-
-# Sentry
-SENTRY_DSN=...
-
-# Simli
-SIMLI_API_KEY=...
-SIMLI_FACE_ID=...
-
-# Smart turn
-LOCAL_SMART_TURN_MODEL_PATH=...
-FAL_SMART_TURN_API_KEY=...
-
-# Soniox
-SONIOX_API_KEY=...
-
-# Speechmatics
-SPEECHMATICS_API_KEY=...
-
-# Tavus
-TAVUS_API_KEY=...
-TAVUS_REPLICA_ID=...
-
-# Telnyx
-TELNYX_API_KEY=...
-TELNYX_ACCOUNT_SID=...
-
-# Together.ai
-TOGETHER_API_KEY=...
-
-# Twilio
-TWILIO_ACCOUNT_SID=...
-TWILIO_AUTH_TOKEN=...
-
-# Ultravox Realtime
-ULTRAVOX_API_KEY=...
-
-# WhatsApp
-WHATSAPP_TOKEN=...
-WHATSAPP_WEBHOOK_VERIFICATION_TOKEN=...
-WHATSAPP_PHONE_NUMBER_ID=...
-WHATSAPP_APP_SECRET=...

examples/README.md

@@ -1,31 +1,87 @@
-# Pipecat Examples
 
-This directory contains examples to help you learn how to build with Pipecat.
 
-## Getting Started
+# Pipecat — Examples
 
-New to Pipecat? Start here:
+## Foundational snippets
+Small snippets that build on each other, introducing one or two concepts at a time.
 
-- **[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)_
+➡️ [Take a look](https://github.com/pipecat-ai/pipecat/tree/main/examples/foundational)
 
-## Foundational Examples
+## Chatbot examples
+Collection of self-contained real-time voice and video AI demo applications built with Pipecat.
 
-Single-file examples that introduce core Pipecat concepts one at a time. These examples:
+### Quickstart
 
-- Build on each other progressively
-- Focus on specific features or integrations
-- Are used for testing with every Pipecat release
+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.
 
-See the **[Foundational Examples README](foundational/)** for the complete list.
+We recommend you start with a virtual environment:
 
-## More Advanced Examples
+```shell
+cd pipecat-ai/examples/simple-chatbot
 
-Ready to explore complex use cases? Visit **[pipecat-examples](https://github.com/pipecat-ai/pipecat-examples)** for:
+python -m venv venv
 
-- Production-ready applications
-- Multi-platform client implementations
-- Telephony integrations
-- Multimodal and creative applications
-- Deployment and monitoring examples
+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            |
+| [Dialin Chatbot](dialin-chatbot)             | A chatbot that connects to an incoming phone call from 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                                                                              |                                                                   |
+
+> [!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)

examples/canonical-metrics/.gitignore

@@ -0,0 +1,161 @@
+# 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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,37 @@
+# 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/canonical-metrics/bot.py

@@ -0,0 +1,146 @@
+#
+# Copyright (c) 2024, 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, 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.processors.audio.audio_buffer_processor import AudioBufferProcessor
+from pipecat.services.canonical import CanonicalMetricsService
+from pipecat.services.elevenlabs import ElevenLabsTTSService
+from pipecat.services.openai 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,
+                camera_out_enabled=False,
+                vad_enabled=True,
+                vad_audio_passthrough=True,
+                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",
+            aiohttp_session=session,
+            #
+            # Spanish
+            #
+            # model="eleven_multilingual_v2",
+            # voice_id="gD1IexrzCvsXPHUuT0s3",
+        )
+
+        llm = OpenAILLMService(api_key=os.getenv("OPENAI_API_KEY"), model="gpt-4o")
+
+        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()
+        canonical = CanonicalMetricsService(
+            audio_buffer_processor=audio_buffer_processor,
+            aiohttp_session=session,
+            api_key=os.getenv("CANONICAL_API_KEY"),
+            api_url=os.getenv("CANONICAL_API_URL"),
+            call_id=str(uuid.uuid4()),
+            assistant="pipecat-chatbot",
+            assistant_speaks_first=True,
+        )
+        pipeline = Pipeline(
+            [
+                transport.input(),  # microphone
+                context_aggregator.user(),
+                llm,
+                tts,
+                transport.output(),
+                audio_buffer_processor,  # captures audio into a buffer
+                canonical,  # uploads audio buffer to Canonical AI for metrics
+                context_aggregator.assistant(),
+            ]
+        )
+
+        task = PipelineTask(pipeline, PipelineParams(allow_interruptions=True))
+
+        @transport.event_handler("on_first_participant_joined")
+        async def on_first_participant_joined(transport, participant):
+            transport.capture_participant_transcription(participant["id"])
+            await task.queue_frames([LLMMessagesFrame(messages)])
+
+        @transport.event_handler("on_participant_left")
+        async def on_participant_left(transport, participant, reason):
+            print(f"Participant left: {participant}")
+            await task.queue_frame(EndFrame())
+
+        @transport.event_handler("on_call_state_updated")
+        async def on_call_state_updated(transport, state):
+            if state == "left":
+                await task.queue_frame(EndFrame())
+
+        runner = PipelineRunner()
+
+        await runner.run(task)
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

examples/canonical-metrics/env.example

@@ -0,0 +1,6 @@
+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

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

examples/canonical-metrics/runner.py

@@ -0,0 +1,56 @@
+#
+# Copyright (c) 2024, 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/canonical-metrics/server.py

@@ -0,0 +1,139 @@
+#
+# Copyright (c) 2024, 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

@@ -0,0 +1,161 @@
+# 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

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,37 @@
+# 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

@@ -0,0 +1,141 @@
+#
+# Copyright (c) 2024, Daily
+#
+# SPDX-License-Identifier: BSD 2-Clause License
+#
+
+import asyncio
+import os
+import sys
+
+import aiohttp
+import datetime
+import wave
+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, 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.processors.audio.audio_buffer_processor import AudioBufferProcessor
+from pipecat.services.elevenlabs import ElevenLabsTTSService
+from pipecat.services.openai 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 save_audio(audiobuffer):
+    if audiobuffer.has_audio():
+        merged_audio = audiobuffer.merge_audio_buffers()
+        filename = f"conversation_recording{datetime.datetime.now().strftime('%Y%m%d_%H%M%S')}.wav"
+        with wave.open(filename, "wb") as wf:
+            wf.setnchannels(2)
+            wf.setsampwidth(2)
+            wf.setframerate(audiobuffer._sample_rate)
+            wf.writeframes(merged_audio)
+        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,
+                camera_out_enabled=False,
+                vad_enabled=True,
+                vad_audio_passthrough=True,
+                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",
+            aiohttp_session=session,
+            #
+            # Spanish
+            #
+            # model="eleven_multilingual_v2",
+            # voice_id="gD1IexrzCvsXPHUuT0s3",
+        )
+
+        llm = OpenAILLMService(api_key=os.getenv("OPENAI_API_KEY"), model="gpt-4o")
+
+        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)
+
+        audiobuffer = AudioBufferProcessor()
+        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, PipelineParams(allow_interruptions=True))
+
+        @transport.event_handler("on_first_participant_joined")
+        async def on_first_participant_joined(transport, participant):
+            transport.capture_participant_transcription(participant["id"])
+            await task.queue_frames([LLMMessagesFrame(messages)])
+
+        @transport.event_handler("on_participant_left")
+        async def on_participant_left(transport, participant, reason):
+            print(f"Participant left: {participant}")
+            await task.queue_frame(EndFrame())
+            await save_audio(audiobuffer)
+
+        runner = PipelineRunner()
+
+        await runner.run(task)
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

examples/chatbot-audio-recording/env.example

@@ -0,0 +1,4 @@
+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

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

examples/chatbot-audio-recording/runner.py

@@ -0,0 +1,56 @@
+#
+# Copyright (c) 2024, 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

@@ -0,0 +1,139 @@
+#
+# Copyright (c) 2024, 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

@@ -0,0 +1,13 @@
+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

@@ -0,0 +1,39 @@
+# 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

@@ -0,0 +1,101 @@
+import asyncio
+import os
+import sys
+import argparse
+
+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.frames.frames import LLMMessagesFrame, EndFrame
+from pipecat.processors.aggregators.openai_llm_context import OpenAILLMContext
+from pipecat.services.openai import OpenAILLMService
+from pipecat.services.elevenlabs import ElevenLabsTTSService
+from pipecat.transports.services.daily import DailyParams, DailyTransport
+
+from loguru import logger
+
+from dotenv import load_dotenv
+
+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,
+            camera_out_enabled=False,
+            vad_enabled=True,
+            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"), model="gpt-4o")
+
+    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, PipelineParams(allow_interruptions=True))
+
+    @transport.event_handler("on_first_participant_joined")
+    async def on_first_participant_joined(transport, participant):
+        transport.capture_participant_transcription(participant["id"])
+        await task.queue_frames([LLMMessagesFrame(messages)])
+
+    @transport.event_handler("on_participant_left")
+    async def on_participant_left(transport, participant, reason):
+        await task.queue_frame(EndFrame())
+
+    @transport.event_handler("on_call_state_updated")
+    async def on_call_state_updated(transport, state):
+        if state == "left":
+            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

@@ -0,0 +1,211 @@
+#
+# Copyright (c) 2024, Daily
+#
+# SPDX-License-Identifier: BSD 2-Clause License
+#
+
+import aiohttp
+import argparse
+import subprocess
+import os
+
+from contextlib import asynccontextmanager
+
+from fastapi import FastAPI, Request, HTTPException
+from fastapi.middleware.cors import CORSMiddleware
+from fastapi.responses import JSONResponse
+
+from pipecat.transports.services.helpers.daily_rest import (
+    DailyRESTHelper,
+    DailyRoomObject,
+    DailyRoomProperties,
+    DailyRoomParams,
+)
+
+from dotenv import load_dotenv
+
+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

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,25 @@
+# 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

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

examples/dialin-chatbot/.dockerignore

@@ -0,0 +1,3 @@
+**/.DS_Store
+.env
+.env.*