Skip to main content
POST
cURL

Authorizations

xi-api-key
string
header
required

Breeze Developer API key.

Path Parameters

voice_id
string
required

Voice identifier to synthesize. Use GET /v1/voices to discover available IDs.

Body

application/json
model_id
string | null

Optional model identifier to use for realtime synthesis.

Required string length: 1 - 120
language_code
string | null

Optional ISO 639-1 two-letter language code. The selected model must list the code in supported_languages.

Required string length: 2
Pattern: ^[A-Za-z]{2}$
instructions
string | null

Optional initial performance instructions for the realtime session. Use Chinese for Chinese TTS and English for English or any other language; realtime sessions do not translate instructions automatically. While the WebSocket is idle, send session.update to change them; after session.updated confirms the change, the new instructions apply starting with the next turn.

voice_settings
RealtimeTtsVoiceSettingsPayload · object | null

Optional realtime voice settings.

inactivity_timeout_seconds
integer | null

Idle timeout for the WebSocket session. Defaults to 30 seconds and is capped at 180 seconds.

Required range: 1 <= x <= 180
enable_logging
boolean | null

Whether realtime turns should be stored in generation history.

Response

Realtime WebSocket session token and compatible transport URLs.

client_secret
string
required

Short-lived token for browser WebSocket connections.

websocket_url
string
required

WebSocket URL including the client_secret query parameter.

expires_at
string
required

ISO-8601 expiration timestamp for the client secret.

direct_websocket_url
string | null

Optional direct WebSocket URL without credentials in its query. Authenticate with the documented WebSocket subprotocols.

audio_format
RealtimeTtsAudioFormat · object

Fixed realtime audio stream format.