xAI

Updated

Integrate xAI TTS with the Conversational AI Engine.

xAI provides text-to-speech (TTS) with a range of expressive voices for conversational AI applications.

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 example shows a starting tts parameter configuration you can use when you Start a conversational AI agent.

"tts": {
  "vendor": "xai",
  "params": {
    "api_key": "${env:XAI_API_KEY}",
    "voice_id": "eve",
    "language": "en",
    "sample_rate": 16000
  }
}

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 xAI Text to Speech documentation.

Key parameters

paramsrequired
api_keystring
required

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

voice_idstring
optional

The voice to use for speech synthesis. For voice IDs and samples, refer to the xAI documentation.

languagestring
required

The BCP-47 language code for speech synthesis. For example, use en for English. For supported language codes, refer to the xAI documentation.

sample_rateinteger
optional

The audio sample rate in Hz. Supported values: 8000, 16000, 22050, 24000, 44100, 48000.

For more information, refer to the xAI Text to Speech documentation.