Prerequisites
Before you begin, you’ll need:- A Pipecat Cloud account
- Docker installed
- Python 3.10+
- The Pipecat Cloud CLI:
pip install pipecatcloud
Quickstart Guide
Follow a step-by-step guided experience to deploy your first agent
Choosing a starting point
Pipecat Cloud offers several ways to get started:- Use a starter template - Pre-built agent configurations for common use cases
- Build from the base image - Create a custom agent using the official base image
- Clone the starter project - A bare-bones project template to customize
Starter templates
Pipecat Cloud provides several ready-made templates for common agent types:Template | Description |
---|---|
voice | Voice conversation agent with STT, LLM and TTS |
twilio | Telephony agent that works with Twilio |
natural_conversation | Agent focused on natural dialogue flow, allowing a user time to think |
openai_realtime | Agent using OpenAI’s Realtime API |
gemini_multimodal_live | Multimodal agent using Google’s Gemini Multimodal Live API |
vision | Computer vision agent that can analyze images |
Project structure
Whether using a starter template or building from scratch, a basic Pipecat Cloud project typically includes:Agent implementation with bot.py
Your agent’sbot.py
code must include a specific bot()
function that serves as the entry point for Pipecat Cloud. This function has different signatures depending on the transport method:
For WebRTC/Daily transports
For WebSocket transports (e.g., Twilio)
Complete Example: Voice Bot
View a complete WebRTC voice bot implementation
Complete Example: Twilio Bot
View a complete Twilio WebSocket bot implementation
Example Dockerfile
Pipecat Cloud provides base images that include common dependencies for Pipecat agents:- Uses the official Pipecat base image
- Installs Python dependencies from requirements.txt
- Copies your bot.py file to the container
The base image (dailyco/pipecat-base) includes the HTTP API server, session
management, and platform integration required to run on Pipecat Cloud. See the
base image source
code
for details.
Building and pushing your Docker image
With your project structure in place, build and push your Docker image:Pipecat Cloud requires ARM64 images. Make sure to specify the
--platform=linux/arm64
flag when building.Managing secrets
Your agent likely requires API keys and other credentials. Create a secret set to store them securely:Deploying your agent
Deploy your agent with the CLI:pcc-deploy.toml
file: