agent command provides sub-commands for managing your deployed agents. These commands allow you to view status, start agents, see logs, and manage deployments.
start
Start a deployed agent instance, creating an active session. Usage:string
required
Unique string identifier for the agent deployment. Must not contain spaces.
string
Path to an alternate deploy config file. Defaults to
pcc-deploy.toml.string
Public API key to authenticate the agent deployment. Will default to any key
set in your config.For more information, see API keys.
string
Stringified JSON object to pass to the agent deployment. This data will be
available to the agent as a
data parameter in your bot() method.More information here.boolean
default:"false"
Skip summary confirmation before issuing start request.
boolean
default:"false"
Create a Daily WebRTC session for the agent.
string
Stringified JSON object with Daily room properties to customize the WebRTC
session. Only used when
--use-daily is set to true.See Daily API
documentation for
available properties.str
Organization to start the agent for. If not provided, uses the current
organization from your configuration.
stop
Stop an active agent session and clean up its resources. Usage:string
required
Name of the agent. Must not contain spaces.
string
Path to an alternate deploy config file. Defaults to
pcc-deploy.toml.string
required
ID of the session to stop.
string
Organization which the agent belongs to. If not provided, uses the current
organization from your configuration.
boolean
default:"false"
Bypass prompt for confirmation before stopping the session.
status
Shows the current status of an agent deployment, including health and conditions. Usage:string
required
Unique string identifier for the agent deployment. Must not contain spaces.
deployments
Lists deployment history for an agent, including image versions and timestamps. Usage:string
required
Unique string identifier for the agent deployment. Must not contain spaces.
logs
Displays combined logs from all agent instances, useful for debugging issues. Usage:string
required
Unique string identifier for the agent deployment. Must not contain spaces.
string
default:"ALL"
Filter logs by severity:
ALL, DEBUG, INFO, WARNING, ERROR,
CRITICAL.int
default:"100"
Limit the number of log lines to display.
str
Filter results for specific agent deployment ID (obtainable from
pipecat cloud agent deployments [agent-name]).str
Filter results for specific session ID (obtainable from
pipecat cloud agent sessions [agent-name]).list
Lists all agents in an organization with their details. Usage:string
Organization to list agents for. If not provided, uses the current
organization from your configuration.
string
Filter agents by region. Only agents deployed in the specified region will be
shown. If not provided, agents from all regions are listed.
sessions
Lists active sessions for a specified agent. When there are no active sessions, it suggests how to start a new session. When used with the--id option, displays detailed information about a specific session including CPU and memory usage with sparkline visualizations and percentile summaries.
Usage:
string
required
Name of the agent to list active sessions for.
string
Path to an alternate deploy config file. Defaults to
pcc-deploy.toml.string
Session ID to view detailed metrics for. When provided, displays CPU and
memory usage statistics including sparkline visualizations and percentile
summaries (p50, p90, p99).
string
Organization to list sessions for. If not provided, uses the current
organization from your configuration.
delete
Deletes an agent deployment. This will prevent starting new agents and remove all associated data. Usage:string
required
Unique string identifier for the agent deployment. Must not contain spaces.
string
Do not prompt for confirmation before deleting the agent.