xAI
Updated
Integrate xAI ASR with the Conversational AI Engine.
xAI provides real-time automatic speech recognition (ASR) over WebSocket 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 asr parameter configuration you can use when you Start a conversational AI agent.
"asr": {
"vendor": "xai",
"params": {
"api_key": "${env:XAI_API_KEY}",
"base_url": "wss://api.x.ai/v1/stt",
"sample_rate": 16000,
"language": "en"
}
}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 Speech to Text documentation.
Key parameters
api_keystringThe xAI API key used to authenticate requests. You must provide a valid key for the service to function.
base_urlstringThe WebSocket endpoint URL for the xAI streaming STT API. Defaults to wss://api.x.ai/v1/stt.
sample_rateintegerThe audio sample rate in Hz. Supported values: 8000, 16000, 22050, 24000, 44100, 48000.
languagestringThe language code to use for transcription. For example, use en for English. Setting this enables text formatting of numbers, currencies, and units. For supported language codes, refer to the xAI documentation.