Overview

SimliVideoService integrates with Simli to create real-time AI avatar video experiences using WebRTC streaming. The service processes audio input to generate synchronized avatar video and audio output, handling real-time streaming, audio resampling, and conversation interruptions for engaging conversational AI applications.

Installation

To use Simli services, install the required dependency:
pip install "pipecat-ai[simli]"

Prerequisites

Simli Account Setup

Before using Simli video services, you need:
  1. Simli Account: Sign up at Simli Platform
  2. API Key: Generate an API key from your account dashboard
  3. Face Selection: Choose or create avatar faces for video generation
  4. WebRTC Setup: Configure real-time streaming capabilities

Required Environment Variables

  • SIMLI_API_KEY: Your Simli API key for authentication
  • SIMLI_FACE_ID: ID of your avatar face