# Typecast (/en/ai/platform/models/tts/typecast)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

> Documentation: Conversational AI.
> Documentation version: Preview.
> This document describes only this version. [Version index](/llms/doc-versions-convoai-guides-v2.txt).


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

## Sample configuration

The following example shows how to configure Typecast as the agent's TTS when you create or update an agent. For a complete example, see [Create an agent and start a session](/en/ai/platform/get-started/start-stop-agent#create-an-agent).

Typecast supports BYOK only. It isn't available in managed mode. Store your Typecast API key in a secret set, and refer to it from the agent. For details, see [Use your own provider keys](/en/ai/platform/build/use-your-own-keys).

**Python SDK**

```python
from agora_agent import Agent, TypecastTTS, secret_ref

# client is your configured Agora client
agent = (
    Agent(client=client)
    .with_stt(...)  # configure your ASR vendor
    .with_llm(...)  # configure your LLM vendor
    .with_tts(
        TypecastTTS(
            api_key=secret_ref("support_prod", "typecast"),
            voice_id="tc_60e5426de8b95f1d3000d7b5",
            model="ssfm-v30",
        )
    )
)
```

**TypeScript SDK**

```ts
import { Agent, TypecastTTS, secretRef } from 'agora-agents';

// client is your configured Agora client
const agent = new Agent({ client })
  .withStt(/* configure your ASR vendor */)
  .withLlm(/* configure your LLM vendor */)
  .withTts(
    new TypecastTTS({
      apiKey: secretRef('support_prod', 'typecast'),
      voiceId: 'tc_60e5426de8b95f1d3000d7b5',
      model: 'ssfm-v30',
    }),
  );
```

**Go SDK**

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

**REST API**

Set `credential.mode` to `byok` and `credential.fields.api_key` to a reference to your Typecast API key in a secret set. In the following example, the key is stored as `typecast` in the `support_prod` set:

```json
"tts": {
  "credential": {
    "mode": "byok",
    "fields": {
      "api_key": "$secrets.support_prod.typecast"
    }
  },
  "vendor": "typecast",
  "params": {
    "voice_id": "tc_60e5426de8b95f1d3000d7b5",
    "model": "ssfm-v30"
  }
}
```

## Key parameters

The `tts` block takes the following fields. In the SDKs, the Typecast TTS class sets them from its options.

**tts**

**`vendor` (string) required**

Set to `typecast`.

**`credential` (object) required**

Set `mode` to `byok` and `fields.api_key` to a `$secrets.<set>.<key>` reference to your Typecast API key.

**`params` (object) required**

**`voice_id` (string) required**

The Typecast voice identifier to use, for example `tc_60e5426de8b95f1d3000d7b5`.

**`model` (string) required**

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

> **Caution**
>
> The parameters listed on this page are validated for use with the Conversational AI Platform. Required parameters must be provided as documented. Any additional parameters in `params` are passed through directly to Typecast without validation. For a full list of supported options, refer to the [Typecast documentation](https://typecast.ai/docs/api-reference/text-to-speech/text-to-speech).

This integration is fully supported for use with the Conversational AI Platform. 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.