Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion cli/cloud/build.mdx → api-reference/cli/cloud/build.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Manage cloud builds"

The `build` command provides tools for managing cloud builds on Pipecat Cloud. You can view build logs, check build status, and list recent builds.

Cloud builds are typically triggered automatically when you run [`pipecat cloud deploy`](/cli/cloud/deploy) without specifying an image. These commands help you monitor and manage those builds.
Cloud builds are typically triggered automatically when you run [`pipecat cloud deploy`](/api-reference/cli/cloud/deploy) without specifying an image. These commands help you monitor and manage those builds.

## logs

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ pipecat cloud deploy [ARGS] [OPTIONS]
- `tel`: Telephony model (up to 16kHz)
- `pro`: WebRTC model (up to 32kHz)

In addition to this flag, you also need to enable the `KrispVivaFilter()` for your transport. See the [Krisp VIVA](/server/utilities/audio/krisp-viva-filter) documentation for more information.
In addition to this flag, you also need to enable the `KrispVivaFilter()` for your transport. See the [Krisp VIVA](/api-reference/server/utilities/audio/krisp-viva-filter) documentation for more information.

</ParamField>

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
14 changes: 7 additions & 7 deletions cli/overview.mdx → api-reference/cli/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ description: "Command-line tool for scaffolding, deploying, and monitoring Pipec
---

<CardGroup cols={3}>
<Card title="Scaffold Projects" icon="wand-magic-sparkles" href="/cli/init">
<Card title="Scaffold Projects" icon="wand-magic-sparkles" href="/api-reference/cli/init">
Create new phone or web/mobile bots with interactive setup
</Card>
<Card title="Deploy to Cloud" icon="rocket" href="/cli/cloud/auth">
<Card title="Deploy to Cloud" icon="rocket" href="/api-reference/cli/cloud/auth">
Push your bots to production with one command
</Card>
<Card title="Monitor Live Bots" icon="chart-line" href="/cli/tail">
<Card title="Monitor Live Bots" icon="chart-line" href="/api-reference/cli/tail">
Watch real-time logs, conversations, and metrics
</Card>
</CardGroup>
Expand Down Expand Up @@ -39,11 +39,11 @@ pipecat --version

## Commands

**[`pipecat init`](/cli/init)** - Scaffold new projects with interactive setup
**[`pipecat init`](/api-reference/cli/init)** - Scaffold new projects with interactive setup

**[`pipecat tail`](/cli/tail)** - Monitor sessions in real-time with a terminal dashboard
**[`pipecat tail`](/api-reference/cli/tail)** - Monitor sessions in real-time with a terminal dashboard

**[`pipecat cloud`](/cli/cloud/auth)** - Deploy and manage bots on Pipecat Cloud
**[`pipecat cloud`](/api-reference/cli/cloud/auth)** - Deploy and manage bots on Pipecat Cloud

## Getting Help

Expand All @@ -58,6 +58,6 @@ pipecat cloud --help

## Next Steps

<Card title="Create Your First Bot" icon="rocket" href="/cli/init">
<Card title="Create Your First Bot" icon="rocket" href="/api-reference/cli/init">
Scaffold a new project with pipecat init
</Card>
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ All parameters are keyword-only.
>
Default context strategy for managing conversation context during node
transitions. Can be overridden per-node via
[`NodeConfig.context_strategy`](/pipecat-flows/reference/types#nodeconfig).
[`NodeConfig.context_strategy`](/api-reference/pipecat-flows/types#nodeconfig).
See
[ContextStrategyConfig](/pipecat-flows/reference/types#contextstrategyconfig).
[ContextStrategyConfig](/api-reference/pipecat-flows/types#contextstrategyconfig).
</ParamField>

<ParamField path="transport" type="BaseTransport" default="None">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,18 +62,18 @@ pip install "pipecat-ai[daily,openai,deepgram,cartesia,silero]"
<Card
title="FlowManager"
icon="gear"
href="/pipecat-flows/reference/flow-manager"
href="/api-reference/pipecat-flows/flow-manager"
>
Core orchestration class: constructor, properties, and methods
</Card>
<Card title="Types" icon="cube" href="/pipecat-flows/reference/types">
<Card title="Types" icon="cube" href="/api-reference/pipecat-flows/types">
NodeConfig, FlowsFunctionSchema, ActionConfig, context strategies, and type
aliases
</Card>
<Card
title="Exceptions"
icon="triangle-exclamation"
href="/pipecat-flows/reference/exceptions"
href="/api-reference/pipecat-flows/exceptions"
>
Error handling hierarchy for flow management
</Card>
Expand All @@ -91,7 +91,7 @@ Create transitions between conversation states, optionally processing data first

### Direct Functions

Functions passed directly to NodeConfig with automatic metadata extraction from signatures and docstrings. See [`flows_direct_function`](/pipecat-flows/reference/types#flows_direct_function-decorator) and [`FlowsDirectFunction`](/pipecat-flows/reference/types#flowsdirectfunction).
Functions passed directly to NodeConfig with automatic metadata extraction from signatures and docstrings. See [`flows_direct_function`](/api-reference/pipecat-flows/types#flows_direct_function-decorator) and [`FlowsDirectFunction`](/api-reference/pipecat-flows/types#flowsdirectfunction).

## LLM Provider Support

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Configuration for a single node in a conversation flow. `task_messages` is the o
List of function definitions available in this node. Accepts provider-specific
dict format, [`FlowsFunctionSchema`](#flowsfunctionschema) objects, or [direct
functions](#flowsdirectfunction). See [Function
Types](/pipecat-flows/reference/overview#function-types).
Types](/api-reference/pipecat-flows/overview#function-types).
</ParamField>

<ParamField path="pre_actions" type="List[ActionConfig]">
Expand All @@ -72,7 +72,7 @@ Configuration for a single node in a conversation flow. `task_messages` is the o
<ParamField path="context_strategy" type="ContextStrategyConfig">
Strategy for managing conversation context when transitioning to this node.
Overrides the default strategy set on
[FlowManager](/pipecat-flows/reference/flow-manager). See
[FlowManager](/api-reference/pipecat-flows/flow-manager). See
[ContextStrategyConfig](#contextstrategyconfig).
</ParamField>

Expand Down Expand Up @@ -179,7 +179,7 @@ TypedDict for configuring actions that execute during node transitions.
<ParamField path="handler" type="Callable" default="None">
Action handler function. Required for custom action types if not previously
registered via
[`FlowManager.register_action()`](/pipecat-flows/reference/flow-manager#register_action).
[`FlowManager.register_action()`](/api-reference/pipecat-flows/flow-manager#register_action).
Can be a legacy handler `(action)` or modern handler `(action, flow_manager)`.
</ParamField>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,6 @@ async def on_after_push(processor, frame):

## Related

- [Events](/server/events/overview) - Overview of all events in Pipecat
- [PipelineTask](/server/pipeline/pipeline-task#event-handlers) - Pipeline lifecycle events
- [Observer Pattern](/server/utilities/observers/observer-pattern) - Non-intrusive pipeline monitoring
- [Events](/api-reference/server/events/overview) - Overview of all events in Pipecat
- [PipelineTask](/api-reference/server/pipeline/pipeline-task#event-handlers) - Pipeline lifecycle events
- [Observer Pattern](/api-reference/server/utilities/observers/observer-pattern) - Non-intrusive pipeline monitoring
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ The table below lists all events available in Pipecat, grouped by component. Cli

### Pipeline

Events on [`PipelineTask`](/server/pipeline/pipeline-task#event-handlers).
Events on [`PipelineTask`](/api-reference/server/pipeline/pipeline-task#event-handlers).

| Event | Description |
| ----------------------------- | ---------------------------------------------------------------- |
Expand All @@ -90,7 +90,7 @@ Events on [`PipelineTask`](/server/pipeline/pipeline-task#event-handlers).

### Frame Processor

Events on every [`FrameProcessor`](/server/events/frame-processor-events). Since all services, transports, and processors inherit from `FrameProcessor`, these events are available on any processor in your pipeline.
Events on every [`FrameProcessor`](/api-reference/server/events/frame-processor-events). Since all services, transports, and processors inherit from `FrameProcessor`, these events are available on any processor in your pipeline.

| Event | Description |
| ------------------------- | --------------------------------------------------- |
Expand All @@ -102,7 +102,7 @@ Events on every [`FrameProcessor`](/server/events/frame-processor-events). Since

### Turn Management

Events on context aggregators from [`LLMContextAggregatorPair`](/server/utilities/turn-management/turn-events).
Events on context aggregators from [`LLMContextAggregatorPair`](/api-reference/server/utilities/turn-management/turn-events).

| Event | Emitter | Description |
| --------------------------- | ---------------------- | --------------------------------------------------- |
Expand All @@ -118,7 +118,7 @@ Events on context aggregators from [`LLMContextAggregatorPair`](/server/utilitie

### STT Services

Events on STT service instances. Available on all WebSocket-based STT services. See [Service Events](/server/events/service-events) for details.
Events on STT service instances. Available on all WebSocket-based STT services. See [Service Events](/api-reference/server/events/service-events) for details.

| Event | Description |
| --------------------- | ----------------------------------- |
Expand Down Expand Up @@ -161,7 +161,7 @@ Some STT services have additional events:

### TTS Services

Events on TTS service instances. Available on all WebSocket-based TTS services. See [Service Events](/server/events/service-events) for details.
Events on TTS service instances. Available on all WebSocket-based TTS services. See [Service Events](/api-reference/server/events/service-events) for details.

| Event | Description |
| --------------------- | ------------------------------------- |
Expand All @@ -172,7 +172,7 @@ Events on TTS service instances. Available on all WebSocket-based TTS services.

### LLM Services

Events on LLM service instances. See [Service Events](/server/events/service-events) for details.
Events on LLM service instances. See [Service Events](/api-reference/server/events/service-events) for details.

| Event | Description |
| --------------------------- | ------------------------------------------ |
Expand All @@ -188,7 +188,7 @@ Events on LLM service instances. See [Service Events](/server/events/service-eve

### Daily Transport

Events on [`DailyTransport`](/server/services/transport/daily#event-handlers) instances.
Events on [`DailyTransport`](/api-reference/server/services/transport/daily#event-handlers) instances.

| Event | Description |
| ----------------------------- | --------------------------------- |
Expand Down Expand Up @@ -222,7 +222,7 @@ Events on [`DailyTransport`](/server/services/transport/daily#event-handlers) in

### LiveKit Transport

Events on [`LiveKitTransport`](/server/services/transport/livekit#event-handlers) instances.
Events on [`LiveKitTransport`](/api-reference/server/services/transport/livekit#event-handlers) instances.

| Event | Description |
| ----------------------------- | -------------------------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,6 @@ async def on_completion_timeout(service):

## Related

- [Events Overview](/server/events/overview) - Overview of all events in Pipecat
- [FrameProcessor Events](/server/events/frame-processor-events) - Error handling and frame monitoring events
- [Turn Events](/server/utilities/turn-management/turn-events) - User and assistant turn lifecycle events
- [Events Overview](/api-reference/server/events/overview) - Overview of all events in Pipecat
- [FrameProcessor Events](/api-reference/server/events/frame-processor-events) - Error handling and frame monitoring events
- [Turn Events](/api-reference/server/utilities/turn-management/turn-events) - User and assistant turn lifecycle events
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Control Frames"
description: "Reference for ControlFrame types: pipeline lifecycle, response boundaries, service settings, and runtime configuration"
---

ControlFrames signal boundaries, state changes, and configuration updates within the pipeline. They are queued and processed in order alongside DataFrames. ControlFrames are cancelled on `InterruptionFrame` unless combined with `UninterruptibleFrame`. See the [frames overview](/server/frames/overview) for base class details and the full frame hierarchy.
ControlFrames signal boundaries, state changes, and configuration updates within the pipeline. They are queued and processed in order alongside DataFrames. ControlFrames are cancelled on `InterruptionFrame` unless combined with `UninterruptibleFrame`. See the [frames overview](/api-reference/server/frames/overview) for base class details and the full frame hierarchy.

## Pipeline Lifecycle

Expand Down Expand Up @@ -50,7 +50,7 @@ Internally, each processor has two queues: a high-priority input queue for Syste
stay paused. To resume a paused processor from outside, use the `SystemFrame`
variant `FrameProcessorResumeUrgentFrame` instead — it bypasses the process
queue entirely. See [System
Frames](/server/frames/system-frames#processor-pauseresume-urgent).
Frames](/api-reference/server/frames/system-frames#processor-pauseresume-urgent).
</Note>

### FrameProcessorPauseFrame
Expand Down Expand Up @@ -236,7 +236,7 @@ Signals the end of a TTS audio response.

## Service Settings

Runtime settings updates for LLM, TTS, STT, and other services. These let you change service configuration mid-conversation without rebuilding the pipeline. Push an `LLMUpdateSettingsFrame`, `TTSUpdateSettingsFrame`, or `STTUpdateSettingsFrame` to update the corresponding service. See the [Changing Service Settings at Runtime](/server/frames/overview#changing-service-settings-at-runtime) pattern for an example.
Runtime settings updates for LLM, TTS, STT, and other services. These let you change service configuration mid-conversation without rebuilding the pipeline. Push an `LLMUpdateSettingsFrame`, `TTSUpdateSettingsFrame`, or `STTUpdateSettingsFrame` to update the corresponding service. See the [Changing Service Settings at Runtime](/api-reference/server/frames/overview#changing-service-settings-at-runtime) pattern for an example.

### ServiceUpdateSettingsFrame

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ description: "Reference for DataFrame types: audio, image, text, transcription,

## Overview

DataFrames carry the main content flowing through a pipeline: audio chunks, text, images, transcriptions, and messages. They are queued and processed in order with other DataFrames and ControlFrames, and any pending DataFrames are discarded when a user interrupts. See the [Frames overview](/server/frames/overview) for base class details, mixin fields, and frame properties common to all frames.
DataFrames carry the main content flowing through a pipeline: audio chunks, text, images, transcriptions, and messages. They are queued and processed in order with other DataFrames and ControlFrames, and any pending DataFrames are discarded when a user interrupts. See the [Frames overview](/api-reference/server/frames/overview) for base class details, mixin fields, and frame properties common to all frames.

## Audio Frames

These frames carry raw audio through the pipeline toward the output transport. Each inherits the `audio`, `sample_rate`, `num_channels`, and `num_frames` fields from the [`AudioRawFrame`](/server/frames/overview#audiorawframe) mixin.
These frames carry raw audio through the pipeline toward the output transport. Each inherits the `audio`, `sample_rate`, `num_channels`, and `num_frames` fields from the [`AudioRawFrame`](/api-reference/server/frames/overview#audiorawframe) mixin.

### OutputAudioRawFrame

Expand All @@ -35,7 +35,7 @@ Inherits from `OutputAudioRawFrame`.

## Image Frames

Frames for carrying image data to the output transport. Each inherits `image`, `size`, and `format` from the [`ImageRawFrame`](/server/frames/overview#imagerawframe) mixin.
Frames for carrying image data to the output transport. Each inherits `image`, `size`, and `format` from the [`ImageRawFrame`](/api-reference/server/frames/overview#imagerawframe) mixin.

### OutputImageRawFrame

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,6 @@ Configures how a function call result is handled after execution.

LLM-related frames organized by base type:

- **Data Frames**: [Context Management](/server/frames/data-frames#llm-context-management), [Thinking](/server/frames/data-frames#llm-thinking), [Tool Configuration](/server/frames/data-frames#llm-tool-configuration), [Function Call Results](/server/frames/data-frames#function-call-results)
- **Control Frames**: [Response Boundaries](/server/frames/control-frames#llm-response-boundaries), [Context Summarization](/server/frames/control-frames#llm-context-summarization), [Thought Frames](/server/frames/control-frames#llm-thought-frames), [Function Calling](/server/frames/control-frames#function-calling), [Service Settings](/server/frames/control-frames#service-settings)
- **System Frames**: [Function Calling](/server/frames/system-frames#function-calling)
- **Data Frames**: [Context Management](/api-reference/server/frames/data-frames#llm-context-management), [Thinking](/api-reference/server/frames/data-frames#llm-thinking), [Tool Configuration](/api-reference/server/frames/data-frames#llm-tool-configuration), [Function Call Results](/api-reference/server/frames/data-frames#function-call-results)
- **Control Frames**: [Response Boundaries](/api-reference/server/frames/control-frames#llm-response-boundaries), [Context Summarization](/api-reference/server/frames/control-frames#llm-context-summarization), [Thought Frames](/api-reference/server/frames/control-frames#llm-thought-frames), [Function Calling](/api-reference/server/frames/control-frames#function-calling), [Service Settings](/api-reference/server/frames/control-frames#service-settings)
- **System Frames**: [Function Calling](/api-reference/server/frames/system-frames#function-calling)
Original file line number Diff line number Diff line change
Expand Up @@ -277,23 +277,23 @@ class ResponseLogger(FrameProcessor):
The individual reference pages below document every frame class, organized by function:

<CardGroup cols={2}>
<Card title="Data Frames" icon="database" href="/server/frames/data-frames">
<Card title="Data Frames" icon="database" href="/api-reference/server/frames/data-frames">
Audio, image, text, transcription, and transport message frames that carry
content through the pipeline.
</Card>
<Card
title="Control Frames"
icon="sliders"
href="/server/frames/control-frames"
href="/api-reference/server/frames/control-frames"
>
Pipeline lifecycle, LLM response boundaries, TTS state, service settings,
and filter/mixer configuration.
</Card>
<Card title="System Frames" icon="bolt" href="/server/frames/system-frames">
<Card title="System Frames" icon="bolt" href="/api-reference/server/frames/system-frames">
Interruptions, user/bot speaking state, VAD events, errors, metrics, and raw
input frames.
</Card>
<Card title="LLM Frames" icon="brain" href="/server/frames/llm-frames">
<Card title="LLM Frames" icon="brain" href="/api-reference/server/frames/llm-frames">
LLM context frame, function calling helper dataclasses, and links to
LLM-related frames on other pages.
</Card>
Expand Down
Loading
Loading