Skip to content

ENG-87042: document language on TTS WebSocket and simplify locale note #266

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rishabh-bhargava merged 1 commit into from
Apr 30, 2026
+11 −2
Merged

ENG-87042: document language on TTS WebSocket and simplify locale note #266

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3863,7 +3863,7 @@ paths:
**Connection Setup:**
- Protocol: WebSocket (wss://)
- Authentication: Pass API key as Bearer token in Authorization header
- Parameters: Sent as query parameters (model, voice, max_partial_length)
- Parameters: Sent as query parameters (model, voice, max_partial_length, language)

**Client Events:**
- `tts_session.updated`: Update session parameters like voice
Expand Down Expand Up @@ -4145,6 +4145,15 @@ paths:
description: |
Maximum number of characters in partial text before forcing TTS generation
even without a sentence ending. Helps reduce latency for long text without punctuation.
- in: query
name: language
required: false
schema:
type: string
default: en
example: en
description: |
Language or locale of input text. Accepts ISO 639-1 language codes (e.g., `en`, `fr`, `es`, `zh`) as well as locale codes for region-specific variants. Locale codes must be lowercase (e.g., `zh-hk` for Cantonese). Can also be set via `tts_session.updated` event.
responses:
'101':
description: |
Expand Down Expand Up @@ -10089,7 +10098,7 @@ components:
language:
type: string
description: |
Language or locale of input text. Accepts ISO 639-1 language codes (e.g., `en`, `fr`, `es`, `zh`) as well as locale codes for region-specific variants. Locale codes must be lowercase (e.g., `zh-hk` for Cantonese, not `zh-HK`).
Language or locale of input text. Accepts ISO 639-1 language codes (e.g., `en`, `fr`, `es`, `zh`) as well as locale codes for region-specific variants. Locale codes must be lowercase (e.g., `zh-hk` for Cantonese).
default: en
example: en
response_encoding:
Expand Down
Loading