Skip to main content
The Pipecat Cloud SDK defines several exception classes to help you handle different error conditions.

Base Exception Class

Error

Base class for all Pipecat Cloud exceptions.

Session Errors

AgentStartError

Raised when an agent fails to start.

Properties

message
string
Error message with details about the failure.
error_code
string
Error code that can be used for conditional handling of different error types.

AgentNotHealthyError

Raised when attempting to interact with an agent that is not in a ready state.

Properties

message
string
Error message with details about the agent’s status.
error_code
string
Error code identifying the specific issue with the agent.

Authentication Errors

AuthError

Raised when authentication fails or token has expired.

Properties

message
string
Message explaining the authentication failure.

Configuration Errors

ConfigError

Raised when there are issues with configuration storage or retrieval.

Properties

message
string
default:"'Failed to update configuration'"
Message explaining the configuration issue.

ConfigFileError

Raised when the configuration file is malformed.

InvalidError

Raised when an invalid operation is attempted.