Skip to main content
Conversational AI Engine: Create advanced voice apps by combining Agora's real-time audio with powerful conversational AI.

PlayHT (Beta)

PlayHT provides fast, reliable text-to-speech (TTS) with customizable voices.

Sample configuration​

The following example shows a starting tts parameter configuration you can use when you Start a conversational AI agent.


_10
"tts": {
_10
"vendor": "playht",
_10
"params": {
_10
"api_key": "<PLAYHT_TTS_SECRET_KEY>",
_10
"user_id": "<PLAYHT_TTS_USER_ID>",
_10
"voice_engine": "Play3.0-mini",
_10
"voice": "alex",
_10
"speed": 1.0
_10
}
_10
}

caution

The parameters listed on this page are validated for use with Conversational AI Engine. To avoid unpredictable behavior, Agora strongly recommends using only the supported parameters. For a complete reference, consult the PlayHT documentation.

Key parameters​

paramsrequired
  • api_key stringrequired

    The API key used for authentication. Get your API key from the PlayHT Dashboard.

  • user_id stringrequired

    The user ID associated with your PlayHT account. Get your user ID from the PlayHT Dashboard.

  • voice_engine stringrequired

    The voice engine to use for speech synthesis. Supported values: PlayDialog, Play3.0-mini, PlayHT2.0-turbo.

  • voice stringrequired

    The voice ID to use for speech generation, for example, alex. See available voices for supported voice IDs.

  • speed numbernullable

    The speed of speech, where 1.0 is the normal speed. Values less than 1.0 slow down the speech, while values greater than 1.0 speed it up.