Skip to main content
New to Pipecat Flows? Check out the introduction and guides first.
Pipecat Flows is an add-on framework for Pipecat that allows you to build structured conversations in your AI applications. It enables you to define conversation paths while handling the complexities of state management and LLM interactions.

API Reference

Complete API documentation and method details

GitHub Repository

Source code, examples, and issue tracking

Hello World Example

Working example with basic conversation flow

​
Installation

​
Pipecat Flows

To use Pipecat Flows, install the required dependency: 
uv add pipecat-ai-flows

​
Pipecat Dependencies

For fresh installations, you’ll need to install Pipecat with dependencies for your Transport, STT, LLM, and TTS providers. For example, to use Daily, OpenAI, Deepgram, Cartesia, and Silero: 
uv add "pipecat-ai[daily,openai,deepgram,cartesia,silero]"

​
Reference Pages

FlowManager

Core orchestration class: constructor, properties, and methods

Types

NodeConfig, FlowsFunctionSchema, ActionConfig, context strategies, and type aliases

Exceptions

Error handling hierarchy for flow management

​
Function Types

A node’s functions either do work within the current node or transition to another node:
  • Node functions do work within the current conversation state without switching nodes. They return (result, None).
  • Edge functions transition to another conversation state, optionally doing work first. They return (result, next_node).
Define either kind as a direct function, or — for advanced usage — with a FlowsFunctionSchema. See the Functions guide.

​
LLM Provider Support

Pipecat Flows works with any LLM service that supports function calling. Pipecat handles provider-specific format conversion internally.
ProviderInstallation
OpenAIuv add "pipecat-ai[openai]"
OpenAI-compatibleProvider-specific (see below)
Anthropicuv add "pipecat-ai[anthropic]"
Google Geminiuv add "pipecat-ai[google]"
AWS Bedrockuv add "pipecat-ai[aws]"
Any service that extends Pipecat’s LLMService base class is supported. This includes OpenAI-compatible services like Groq, Together, Cerebras, DeepSeek, and others.

​
Realtime (S2S) LLMs

Realtime speech-to-speech services such as Gemini Live and OpenAI Realtime are not currently supported due to missing API functionality.

​
Additional Notes

  • State Management: Use flow_manager.state dictionary for persistent conversation data
  • Automatic Function Call Registration and Validation: All functions are automatically registered and validated at run-time
  • Provider Compatibility: Pipecat handles provider-specific format conversion internally