Rime
Updated
Integrate Rime TTS with the Conversational AI Engine.
Rime provides high-quality text-to-speech (TTS) with low latency, supporting multiple speakers and models.
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 Rime TTS when starting a conversational AI agent.
from agora_agent import Agent
from agora_agent.agentkit.vendors import RimeTTS
# client is your configured Agora client
agent = (
Agent(client)
.with_stt(...) # configure your STT vendor
.with_llm(...) # configure your LLM vendor
.with_tts(RimeTTS(
key='your-rime-key',
speaker='cove',
model_id='mistv2',
))
)import { Agent, RimeTTS } 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 RimeTTS({
key: 'your-rime-key',
speaker: 'cove',
modelId: 'mistv2',
}));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.NewRimeTTS(vendors.RimeTTSOptions{
Key: "your-rime-key",
Speaker: "cove",
ModelID: "mistv2",
}),
)Use the following tts configuration in your request:
"tts": {
"vendor": "rime",
"params": {
"api_key": "<rime_key>",
"speaker": "cove",
"modelId": "mistv2",
"base_url": "wss://users.rime.ai/ws2"
}
}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 Rime documentation for Arcana and Mist v2.
Key parameters
api_keystringThe Rime API key used to authenticate requests. You must provide a valid key for the service to function.
speakerstringThe speaker voice to use for TTS output. For example, cove.
modelIdstringThe Rime TTS model to use. For example, mistv2. Different models provide different voice qualities and capabilities.
base_urlstringThe WebSocket URL for the Rime streaming API. For example, wss://users.rime.ai/ws2.