Skip to content

Commit c902235

Browse files
docs(agentkit): align TTS provider reference fields
1 parent cb9ab8b commit c902235

1 file changed

Lines changed: 15 additions & 4 deletions

File tree

docs/reference/vendors.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,8 @@ The SDK also includes named helpers for the remaining Agora-supported LLM provid
180180
| `region` | `str` | Yes || Azure region (e.g., `eastus`) |
181181
| `voice_name` | `str` | Yes || Voice name (e.g., `en-US-JennyNeural`) |
182182
| `sample_rate` | `int` | No | `None` | Sample rate: 8000, 16000, 24000, or 48000 Hz |
183+
| `speed` | `float` | No | `None` | Speaking rate multiplier |
184+
| `volume` | `float` | No | `None` | Audio volume |
183185
| `skip_patterns` | `List[int]` | No | `None` | Skip patterns |
184186

185187
### `OpenAITTS`
@@ -203,6 +205,8 @@ The SDK also includes named helpers for the remaining Agora-supported LLM provid
203205
| `api_key` | `str` | Yes || Cartesia API key |
204206
| `voice_id` | `str` | Yes || Voice ID (serialized as `{"mode": "id", "id": "..."}`) |
205207
| `model_id` | `str` | Yes || Model ID |
208+
| `base_url` | `str` | No | `None` | WebSocket URL |
209+
| `language` | `str` | No | `None` | Target language |
206210
| `sample_rate` | `int` | No | `None` | Sample rate: 8000–48000 Hz |
207211
| `skip_patterns` | `List[int]` | No | `None` | Skip patterns |
208212

@@ -213,6 +217,7 @@ The SDK also includes named helpers for the remaining Agora-supported LLM provid
213217
| `key` | `str` | Yes || Google Cloud API key |
214218
| `voice_name` | `str` | Yes || Voice name |
215219
| `language_code` | `str` | No | `None` | Language code (e.g., `en-US`) |
220+
| `sample_rate_hertz` | `int` | No | `None` | Sample rate in Hz |
216221
| `skip_patterns` | `List[int]` | No | `None` | Skip patterns |
217222

218223
### `AmazonTTS`
@@ -273,13 +278,15 @@ The SDK also includes named helpers for the remaining Agora-supported LLM provid
273278

274279
| Parameter | Type | Required | Default | Description |
275280
|---|---|---|---|---|
276-
| `key` | `str` | Yes | | MiniMax API key |
277-
| `group_id` | `str` | Yes | | MiniMax group ID |
281+
| `key` | `str` | BYOK only | `None` | MiniMax API key. Optional for supported Agora-managed MiniMax models |
282+
| `group_id` | `str` | BYOK only | `None` | MiniMax group ID |
278283
| `model` | `str` | Yes || Model name (e.g., `speech-02-turbo`) |
279-
| `voice_id` | `str` | Yes | | Voice style identifier |
280-
| `url` | `str` | Yes | | WebSocket endpoint |
284+
| `voice_id` | `str` | BYOK only | `None` | Voice style identifier |
285+
| `url` | `str` | BYOK only | `None` | WebSocket endpoint |
281286
| `skip_patterns` | `List[int]` | No | `None` | Skip patterns |
282287

288+
`key`, `group_id`, `voice_id`, and `url` are required together for BYOK. Without `key`, `model` must be one of the supported Agora-managed MiniMax models.
289+
283290
### `MurfTTS`
284291

285292
| Parameter | Type | Required | Default | Description |
@@ -301,6 +308,10 @@ The SDK also includes named helpers for the remaining Agora-supported LLM provid
301308
| `key` | `str` | Yes || Sarvam API key |
302309
| `speaker` | `str` | Yes || Speaker name |
303310
| `target_language_code` | `str` | Yes || Target language code |
311+
| `pitch` | `float` | No | `None` | Pitch adjustment |
312+
| `pace` | `float` | No | `None` | Speed of speech |
313+
| `loudness` | `float` | No | `None` | Volume level |
314+
| `sample_rate` | `int` | No | `None` | Audio sample rate |
304315
| `skip_patterns` | `List[int]` | No | `None` | Skip patterns |
305316

306317
---

0 commit comments

Comments
 (0)