Skip to content

Commit 96afe78

Browse files
align v2.1 provider docs with AgentKit validation
1 parent 0297a70 commit 96afe78

2 files changed

Lines changed: 5 additions & 4 deletions

File tree

docs/concepts/vendors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Used with `agent.with_tts()`. Each TTS vendor produces audio at a specific sampl
4646
|---|---|---|---|
4747
| `ElevenLabsTTS` | ElevenLabs | `key`, `model_id`, `voice_id`, `base_url` | 16000, 22050, 24000, or 44100 Hz |
4848
| `MicrosoftTTS` | Microsoft Azure | `key`, `region`, `voice_name` | 8000, 16000, 24000, or 48000 Hz |
49-
| `OpenAITTS` | OpenAI | `key`, `voice` | 24000 Hz (fixed) |
49+
| `OpenAITTS` | OpenAI | `voice` for Agora-managed `tts-1`; `api_key`, `model`, `base_url`, `voice` for BYOK | 24000 Hz (fixed) |
5050
| `CartesiaTTS` | Cartesia | `api_key`, `voice_id`, `model_id` | 8000–48000 Hz |
5151
| `GoogleTTS` | Google Cloud | `key`, `voice_name` ||
5252
| `AmazonTTS` | Amazon Polly | `access_key`, `secret_key`, `region`, `voice_id`, `engine` ||

docs/reference/vendors.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -184,14 +184,15 @@ The SDK also includes named helpers for the remaining Agora-supported LLM provid
184184

185185
| Parameter | Type | Required | Default | Description |
186186
|---|---|---|---|---|
187-
| `api_key` | `str` | Yes | | OpenAI API key |
187+
| `api_key` | `str` | BYOK only | `None` | OpenAI API key |
188188
| `voice` | `str` | Yes || Voice: `alloy`, `echo`, `fable`, `onyx`, `nova`, `shimmer` |
189-
| `model` | `str` | No | `None` | Model: `tts-1` or `tts-1-hd` |
189+
| `model` | `str` | BYOK only | `None` | Model: `tts-1` or `tts-1-hd` |
190+
| `base_url` | `str` | BYOK only | `None` | OpenAI TTS endpoint URL |
190191
| `response_format` | `str` | No | `None` | Audio format (e.g., `pcm`) |
191192
| `speed` | `float` | No | `None` | Speech speed multiplier |
192193
| `skip_patterns` | `List[int]` | No | `None` | Skip patterns |
193194

194-
Fixed sample rate: 24000 Hz.
195+
`api_key`, `model`, and `base_url` are required together for BYOK. Without `api_key`, AgentKit uses the Agora-managed `tts-1` path. Fixed sample rate: 24000 Hz.
195196

196197
### `CartesiaTTS`
197198

0 commit comments

Comments
 (0)