pipecatcloud 1.0.0

Cloud hosting for Pipecat AI applications

Pipecat Cloud

Python module and CLI for interacting with Pipecat Cloud.

Requirements

• Python 3.11+
• Docker and a Docker repository (e.g. Docker Hub)
• Active Pipecat Cloud account

Documentation

Documentation for Pipecat Cloud is available here.

Installation

The Pipecat Cloud CLI ships as part of the Pipecat CLI — its commands are available under pipecat cloud. Install the Pipecat CLI:

uv tool install pipecat-ai-cli

pipecat cloud --help
pipecat cloud auth login

! All CLI commands have a --help flag that will display the command usage and options.

To use Pipecat Cloud programmatically (without the CLI), install the package directly with uv add pipecatcloud and see Usage in Python scripts.

Usage

1. Create an account at Pipecat Cloud

2. Login to your account pipecat cloud auth login

3. Generate secrets pipecat cloud secrets set

4. Build and deploy your agent pipecat cloud deploy

Usage in Python scripts

If want to programmatically start an agent within a Python script, you can use the pipecatcloud.session module.

from pipecatcloud.session import Session
from pipecatcloud.exception import AgentStartError
import asyncio

async def main():
    session = Session(
        agent_name="your-agent-name",
        api_key="pk_...",
    )

    try:
        await session.start()
    except AgentStartError as e:
        print(e)
    except Exception as e:
        raise (e)

if __name__ == "__main__":
    asyncio.run(main())

Troubleshooting

SSL certificate errors on macOS

If pipecat cloud auth login fails with an SSL certificate verification error, your Python installation may not have access to the macOS system certificate store. This is common with Python installed via pyenv, conda, or the python.org installer.

To diagnose:

import ssl, sys, os
print(ssl.get_default_verify_paths())
print(os.path.realpath(sys.executable))

To fix, install certifi and point Python to its certificates:

pip install certifi
export SSL_CERT_FILE=$(python -c "import certifi; print(certifi.where())")

For the python.org installer, you can also run the bundled Install Certificates.command script found in /Applications/Python X.Y/.

🛠️ Contributing

Setup Steps

1. Clone the repository and navigate to it:

   git clone https://github.com/daily-co/pipecat-cloud.git
   cd pipecat-cloud
   

2. Install development and testing dependencies:

   uv sync --group dev
   

3. Install the git pre-commit hooks:

   uv run pre-commit install
   

Running tests

To run all tests, from the root directory:

uv run pytest

Run a specific test suite:

uv run pytest tests/test_name.py