Typecast

Updated

Integrate Typecast TTS with the Conversational AI Engine.

Typecast provides text-to-speech (TTS) with expressive, natural-sounding voices.

Info

This integration is fully supported for use with Conversational AI Engine. While it has completed functional validation, it is newer to the platform, and additional provider-specific edge cases may be identified as usage scales across a broader range of applications and workloads.

Sample configuration

The following examples show how to configure Typecast TTS when starting a conversational AI agent.

from agora_agent import Agent
from agora_agent.agentkit.vendors import TypecastTTS

# client is your configured Agora client
agent = (
    Agent(client)
    .with_stt(...)  # configure your STT vendor
    .with_llm(...)  # configure your LLM vendor
    .with_tts(TypecastTTS(
        api_key='your-typecast-key',
        voice_id='tc_60e5426de8b95f1d3000d7b5',
        model='ssfm-v30',
    ))
)
import { Agent, TypecastTTS } from 'agora-agents';

// client is your configured Agora client
const agent = new Agent({ client })
  .withStt(/* configure your STT vendor */)
  .withLlm(/* configure your LLM vendor */)
  .withTts(new TypecastTTS({
    apiKey: 'your-typecast-key',
    voiceId: 'tc_60e5426de8b95f1d3000d7b5',
    model: 'ssfm-v30',
  }));
import "github.com/AgoraIO/agora-agents-go/v2/agentkit/vendors"

// client is your configured Agora client
agent := agentkit.NewAgent(client).WithStt(/* configure your STT vendor */).
  WithLlm(/* configure your LLM vendor */).
  WithTts(
    vendors.NewTypecastTTS(vendors.TypecastTTSOptions{
        APIKey:  "your-typecast-key",
        VoiceID: "tc_60e5426de8b95f1d3000d7b5",
        Model:   "ssfm-v30",
    }),
)

Use the following tts configuration in your request:

"tts": {
  "vendor": "typecast",
  "params": {
    "api_key": "<typecast_api_key>",
    "voice_id": "tc_60e5426de8b95f1d3000d7b5",
    "model": "ssfm-v30"
  }
}

Caution

The parameters listed on this page are validated for use with Conversational AI Engine. Required parameters must be provided as documented. Any additional parameters are passed through directly to the underlying vendor without validation. For a full list of supported options, refer to the Typecast documentation.

Key parameters

paramsrequired
api_keystring
required

The Typecast API key used to authenticate requests. You must provide a valid key for the service to function.

voice_idstring
required

The Typecast voice identifier to use. For example, tc_60e5426de8b95f1d3000d7b5.

modelstring
required

The Typecast TTS model to use. For example, ssfm-v30.