Skip to main content

​
Overview

Pipecat is an open-source framework for building voice agents. Preclinical supports testing Pipecat agents deployed on Pipecat Cloud via WebRTC.

​
Transport Options

Pipecat supports two transport modes:
TransportDescriptionUse Case
Daily WebRTCDefault Pipecat Cloud transportStandard Pipecat Cloud deployments
LiveKit WebRTCAlternative using LiveKit SDKWhen using LiveKit infrastructure

​
Configuration (Daily WebRTC)

To add a Pipecat integration with Daily transport, you’ll need:
FieldDescription
API KeyPipecat Cloud API key
Agent IDPipecat agent ID

​
Optional Settings

FieldDescriptionDefault
TimeoutMaximum test duration2 minutes
MetadataCustom metadata to pass to agentNone

​
Configuration (LiveKit Transport)

To use LiveKit transport instead, you’ll need:
FieldDescription
LiveKit URLYour LiveKit server URL (wss://…)
LiveKit API KeyLiveKit API key
LiveKit API SecretLiveKit API secret
Agent NameName of the Pipecat agent

​
Setup Steps (Daily WebRTC)

1

Deploy to Pipecat Cloud

Deploy your Pipecat agent to Pipecat Cloud
2

Get API Credentials

From Pipecat Cloud dashboard:
  • Copy your API key
  • Copy the deployed agent ID
3

Add Integration

In Preclinical, create a new agent with your Pipecat credentials.

​
Setup Steps (LiveKit Transport)

1

Configure Pipecat with LiveKit

Set up your Pipecat agent to use LiveKit transport:
from pipecat.transports.livekit import LiveKitTransport

transport = LiveKitTransport(
    url=os.environ["LIVEKIT_URL"],
    api_key=os.environ["LIVEKIT_API_KEY"],
    api_secret=os.environ["LIVEKIT_API_SECRET"],
)
2

Deploy Agent

Deploy your agent and register it with LiveKit agent dispatch
3

Add Integration

In Preclinical, create a new Pipecat agent with LiveKit transport configuration.

​
Features

Multi-Transport

Support for Daily and LiveKit transports

Open Source

Test agents built with open-source Pipecat

Cloud Hosted

Easy integration with Pipecat Cloud

Metrics

Connection and conversation metrics

​
Metrics Captured

MetricDescription
Connection timeTime to establish connection
Session IDPipecat session identifier
Turn countNumber of conversation turns
Total durationFull conversation time

​
Error Handling

​
Common Errors

ErrorCauseResolution
401 UnauthorizedInvalid API keyCheck Pipecat Cloud API key
404 Not FoundInvalid agent IDVerify agent is deployed
Connection timeoutAgent not respondingCheck agent health
Transport errorWebRTC issuesVerify network connectivity

​
Troubleshooting

  • Verify agent is deployed on Pipecat Cloud
  • Check agent logs in Pipecat Cloud dashboard
  • Test agent manually via Pipecat playground
  • Verify Pipecat Cloud API key
  • Check agent ID is correct
  • Ensure agent is running

​
Choosing a Transport

FactorDaily WebRTCLiveKit Transport
Setup complexitySimplerMore setup required
InfrastructurePipecat Cloud managedSelf-managed or LiveKit Cloud
Existing LiveKitN/AReuses existing setup
FlexibilityStandardMore control
If you’re already using LiveKit for other purposes, use the LiveKit transport to consolidate infrastructure. Otherwise, Daily WebRTC is simpler to set up.

​
Next Steps

Run a Test

Execute your first test run

LiveKit Setup

Detailed LiveKit configuration