Deploying an agent
Deploying agents to Pipecat Cloud requires first pushing your built image to a container registry, such as Docker Hub.deploy
command requires both of the following arguments:
agent-name
: The name of the agent to deploy.image
: The repository and tag of the image to deploy.
Deployment status
Once complete, Pipecat Cloud will return the status of your deployment or any errors that occurred during the deployment process.Using pcc-deploy.toml
To support shareable deployment configurations, you can create apcc-deploy.toml
file in the root of your project (adjacent to where you run your CLI commands.)
The CLI will automatically detect this file and use it to populate the deployment configuration. Any CLI arguments you provide will override the values in the pcc-deploy.toml
file.
An example pcc-deploy.toml
file might look like this:
You can verify your configuration by running
pcc --config
.Checking status of a deployment
You can check the status of a deployment using the CLI:ready
status.
Modifying a deployment
Agents are referenced as a mutable manifest in Pipecat Cloud. Pushing a new image or configuration to the same agent name will update your agent manifest and be used for any new requests.my-first-agent
deployment to use the new image and set the minimum number of instances to 2.
To avoid interruption of any active sessions, any running agent instances will continue on the old image until the session concludes.
Idle agent instances in your agent pool will be replaced with the new configuration according to the Pipecat Cloud auto-scaling strategy.
New agent requests may, therefore, start with prior deployment configuration if updates are not fully propagated. This ensures on-demand availability
remains consistent and avoids potential cold starts.
Failed deployments
If a deployment fails (i.e. fails to enter aready
state), requests will be routed to any prior deployments in a ready state.
This ensures that your agent remains available to end-users even when a deployment fails.
Delete a deployment
This action is irreversible and will remove all data related to the agent from
Pipecat Cloud.
delete
command: