Skip to main content

Quick Start

Installation​

Install Whispey using pip:

pip install whispey

Or install from PyPI:

pip install Whispey

Get Your Credentials​

  1. Sign up at Whispey Dashboard
  2. Get your Agent ID from the dashboard
  3. Generate your API Key from your workspace

Environment Setup​

Create a .env file in your project root:

# Whispey Voice Analytics
WHISPEY_API_KEY=your_whispey_api_key_here

Basic Integration​

Here's a minimal example to get started:

from dotenv import load_dotenv
from livekit import agents
from whispey import LivekitObserve
import os

# Load environment variables
load_dotenv()

# Initialize Whispey
whispey = LivekitObserve(
    agent_id="your-agent-id-from-dashboard",  # Get this from dashboard
    apikey=os.getenv("WHISPEY_API_KEY")
)

# Start tracking a session
session_id = whispey.start_session(
    session=your_livekit_session,
    phone_number="+1234567890",  # Optional
    customer_name="John Doe"     # Optional
)

# Export on shutdown via callback
async def whispey_shutdown():
    await whispey.export(session_id)

ctx.add_shutdown_callback(whispey_shutdown)

# Start your LiveKit session
await session.start(...)

Next Steps​