Skip to main content

pipecat-ai-typecast

Typecast TTS Integration for Pipecat AI Pipelines

PyPI version Python License

Add high-quality neural voices from Typecast to your Pipecat AI pipelines.

Installation | Quick Start | Configuration | Examples


Installation

pip install pipecat-ai-typecast

Prerequisites

Variable Required Description
TYPECAST_API_KEY Yes Get your API key here
TYPECAST_VOICE_ID No Voice override (defaults to tc_672c5f5ce59fac2a48faeaee)

Quick Start

TypecastTTSService integrates Typecast's streaming text-to-speech into a Pipecat pipeline. It converts LLM text output into expressive speech while leveraging Pipecat's transport, STT, and turn-taking stack.

import os, aiohttp
from pipecat.pipeline.pipeline import Pipeline
from pipecat_typecast.tts import TypecastTTSService

async with aiohttp.ClientSession() as session:
    llm = ...
    stt = ...
    tts = TypecastTTSService(
        aiohttp_session=session,
        api_key=os.getenv("TYPECAST_API_KEY"),
        voice_id=os.getenv("TYPECAST_VOICE_ID", "tc_672c5f5ce59fac2a48faeaee"),
    )

    pipeline = Pipeline([
        transport.input(),               # audio/user input
        stt,                             # speech to text
        context_aggregator.user(),       # add user text to context
        llm,                             # LLM generates response
        tts,                             # Typecast TTS synthesis
        transport.output(),              # stream audio back to user
        context_aggregator.assistant(),  # store assistant response
    ])

See example.py for a complete working example including event handlers and transport setup.


Configuration

TypecastTTSService exposes structured parameter models for emotion and audio control.

ssfm-v30 (Default) - Preset Emotion Control

from pipecat_typecast.tts import (
    TypecastTTSService,
    TypecastInputParams,
    PresetPromptOptions,
    OutputOptions,
)

params = TypecastInputParams(
    streaming=False,                  # Required when using volume.
    prompt_options=PresetPromptOptions(
        emotion_preset="happy",      # normal | happy | sad | angry | whisper | toneup | tonedown
        emotion_intensity=1.3,       # 0.0 - 2.0
    ),
    output_options=OutputOptions(
        volume=110,                  # 0 - 200 (percent). Defaults to None
                                     # so the server-side default of 100
                                     # kicks in when neither this nor
                                     # `target_lufs` is set.
        audio_pitch=2,               # -12 to 12 (semitones)
        audio_tempo=1.05,            # 0.5 - 2.0 (playback speed)
        audio_format="wav",          # Only 'wav' supported
        # target_lufs=-16.0,         # Absolute loudness target in LUFS
                                     # (-70.0 to 0.0). Mutually exclusive
                                     # with `volume` — leave `volume` unset
                                     # when using `target_lufs`.
    ),
)

tts = TypecastTTSService(
    aiohttp_session=session,
    api_key=os.getenv("TYPECAST_API_KEY"),
    voice_id="tc_672c5f5ce59fac2a48faeaee",
    model="ssfm-v30",
    params=params,
)

ssfm-v30 - Smart Emotion Control

For context-aware emotional delivery, use SmartPromptOptions which infers emotion from surrounding text:

from pipecat_typecast.tts import (
    TypecastTTSService,
    TypecastInputParams,
    SmartPromptOptions,
)

params = TypecastInputParams(
    prompt_options=SmartPromptOptions(
        previous_text="I just got the best news ever!",   # max 2000 chars
        next_text="I can't wait to share this with everyone!",
    ),
)

tts = TypecastTTSService(
    aiohttp_session=session,
    api_key=os.getenv("TYPECAST_API_KEY"),
    params=params,
)

Legacy Model (ssfm-v21)

For backward compatibility with ssfm-v21
from pipecat_typecast.tts import (
    TypecastTTSService,
    TypecastInputParams,
    PromptOptions,
)

params = TypecastInputParams(
    prompt_options=PromptOptions(
        emotion_preset="happy",      # normal | happy | sad | angry
        emotion_intensity=1.3,
    ),
)

tts = TypecastTTSService(
    aiohttp_session=session,
    api_key=os.getenv("TYPECAST_API_KEY"),
    model="ssfm-v21",
    params=params,
)

Parameter Reference

Parameter Range Description
emotion_preset varies by voice ssfm-v30 adds: whisper, toneup, tonedown
emotion_intensity 0.0 - 2.0 Values > 1.0 increase expressiveness
audio_pitch -12 to 12 Semitone adjustment
audio_tempo 0.5 - 2.0 Recommended: 0.85 - 1.15
volume 0 - 200 Defaults to None (server-side default of 100 applies). Mutually exclusive with target_lufs.
target_lufs -70.0 to 0.0 Absolute loudness normalization target in LUFS. Server rejects requests that set both target_lufs and volume — leave volume unset when using target_lufs, or the model raises a ValidationError locally.
seed integer Deterministic synthesis for identical text
streaming boolean Defaults to True and uses Typecast's HTTP streaming endpoint. Set False for volume-based non-streaming synthesis.

Running the Example

# 1. Install dependencies
uv sync

# 2. Configure environment
cp env.example .env

# 3. Run
uv run python example.py

The bot will create a call (e.g. Daily room) and speak responses using Typecast voices.


Compatibility

Requirement Version
Pipecat v0.0.94+ (tested with v0.0.94 and v1.4.0)
typecast-python v0.3.8+
Python 3.11+
Transports Daily / Twilio / WebRTC

Support


Maintainer: Neosapience / Typecast team (@neosapience)

BSD-2-Clause License

Metadata

Release files for pipecat-ai-typecast 0.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pipecat-ai-typecast 0.3.1
File Size Uploaded
pipecat_ai_typecast-0.3.1.tar.gz 257.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pipecat-ai-typecast 0.3.1
File Interpreter ABI Platform
pipecat_ai_typecast-0.3.1-py3-none-any.whl Python 3 none any Details

Total release size: 268.0 kB

Release files / pipecat_ai_typecast-0.3.1.tar.gz

Download URL pipecat_ai_typecast-0.3.1.tar.gz
Size 257.7 kB
Tags Source
SHA-256 checksum
How to use checksums
81f39fa86b4ffe5ee279593622833716b9ef2e5d9f7d3e67e7a52bbcf6956d03
BLAKE2b-256 checksum
How to use checksums
7cf3f10fe9c3a30d35d4caa3b3062e39e391a0794063bae38d816b1fbbc6b708
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / pipecat_ai_typecast-0.3.1-py3-none-any.whl

Download URL pipecat_ai_typecast-0.3.1-py3-none-any.whl
Size 10.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f0151e37f03cb8a4a1a0f847f4a3b9f45d7535c2707f1ccb0056ec556d0b5438
BLAKE2b-256 checksum
How to use checksums
2e0723ef0830f139b2bf011feb503095f4adf0737fef556c8ac58ccb77554047
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release history Release notifications | RSS feed

0.3.2

2 release files

This release

0.3.1 This release

2 release files

0.3.0

2 release files

0.2.1

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page