Skip to main content

pipecat cloud

Docs PyPI

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pipecatcloud-1.0.1.tar.gz (281.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pipecatcloud-1.0.1-py3-none-any.whl (84.6 kB view details)

Uploaded Python 3

File details

Details for the file pipecatcloud-1.0.1.tar.gz.

File metadata

  • Download URL: pipecatcloud-1.0.1.tar.gz
  • Upload date:
  • Size: 281.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pipecatcloud-1.0.1.tar.gz
Algorithm Hash digest
SHA256 9c14a030c1d124310fea37663b315d7e1d60e62188062211a922b6fdefec37bd
MD5 37868b4ccecb871599b159986454ba3e
BLAKE2b-256 aff6a62e3259518414c31963d97e22e1909f01279df92fe5ae2944943b07cf94

See more details on using hashes here.

Provenance

The following attestation bundles were made for pipecatcloud-1.0.1.tar.gz:

Publisher: publish-pypi.yml on daily-co/pipecat-cloud

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pipecatcloud-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: pipecatcloud-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 84.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pipecatcloud-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ecd236f78bca37a363a07bb50f6401ab3093f3d1da0caa3a61f7cc3526960d5d
MD5 44d5e367db42324befe07e3374986f88
BLAKE2b-256 a1a6eb6aec9fc9de8a367dcaefc5c4069789fab60ebbf724f72117e9041a90b4

See more details on using hashes here.

Provenance

The following attestation bundles were made for pipecatcloud-1.0.1-py3-none-any.whl:

Publisher: publish-pypi.yml on daily-co/pipecat-cloud

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page