Skip to main content

Typecast is an AI text-to-speech API that converts text into lifelike, expressive speech in many languages.

Project description

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(
    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

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)
Python 3.10+
Transports Daily / Twilio / WebRTC

Support


Maintainer: Neosapience / Typecast team (@neosapience)

BSD-2-Clause License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pipecat_ai_typecast-0.2.1.tar.gz (288.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pipecat_ai_typecast-0.2.1-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

Details for the file pipecat_ai_typecast-0.2.1.tar.gz.

File metadata

  • Download URL: pipecat_ai_typecast-0.2.1.tar.gz
  • Upload date:
  • Size: 288.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for pipecat_ai_typecast-0.2.1.tar.gz
Algorithm Hash digest
SHA256 de4d4e72238dbe2ec5e240575fcc50ddb37f6ffaa9cad7e61fbedc01ff14f4d0
MD5 6be538ee081bc416c057ca09a038b21e
BLAKE2b-256 dba056f7161a9f846e21353237fc8bca762ed77308f8a1a1d9f76790fe812bac

See more details on using hashes here.

File details

Details for the file pipecat_ai_typecast-0.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for pipecat_ai_typecast-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 818afd5c6b8dc6dc24445b28eb91ade3b1ad4d76e974517559688a92cbc42ad6
MD5 1f68cbbe17b82d6845db4220731b2b64
BLAKE2b-256 bd2d7a4d577b32db009475fcd41af7a469df525a69fe9dac9d68d44937d1e56c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page