Flux WebSocket TTS

wscat -c "wss://api.gradium.ai/api/speech/tts" \
  -H "x-api-key: YOUR_API_KEY"

Cycle de vie

{"type":"setup","voice_id":"YTpq7expH9539ERJ","model_name":"default","output_format":"pcm"}
{"type":"text","text":"Hello, world."}
{"type":"end_of_stream"}

Le serveur répond par ready, puis par un ou plusieurs messages audio et text, et enfin par end_of_stream. Consultez Cycle de vie WebSocket pour le comportement de la connexion, la réutilisation des sockets, les tokens navigateur et les erreurs.

Messages du client

`setup`

Champ	Type	Obligatoire	Description
`type`	string	Oui	Toujours `"setup"`.
`model_name`	string	Non	Par défaut `"default"` (stable). Utilisez `"gradium-tts-beta"` pour suivre les versions bêta. Voir Choix du modèle.
`voice_id`	string	Recommandé	ID d’une voix de la bibliothèque ou d’une voix personnalisée.
`voice`	string	Non	Nom de voix utilisé à défaut lorsque `voice_id` n’est pas fourni.
`output_format`	string	Non	`wav`, `pcm`, `opus`, `ulaw_8000`, `alaw_8000`, ou une fréquence PCM explicite comme `pcm_16000`. Par défaut `wav`.
`json_config`	object ou string	Non	Paramètres avancés de synthèse vocale. Voir Paramètres de voix.
`pronunciation_id`	string	Non	ID du dictionnaire de prononciation.
`client_req_id`	string	Non	Permet de corréler les requêtes multiplexées.
`close_ws_on_eos`	boolean	Non	Par défaut `true` ; indiquez `false` pour garder le socket ouvert.
`retry_for_s`	number	Non	Fenêtre facultative de nouvelle tentative du setup, en secondes.

`text`

Champ	Type	Obligatoire	Description
`type`	string	Oui	Toujours `"text"`.
`text`	string	Oui	Fragment de texte à synthétiser.
`client_req_id`	string	Non	Obligatoire pour router une requête multiplexée.

`end_of_stream`

Champ	Type	Obligatoire	Description
`type`	string	Oui	Toujours `"end_of_stream"`.
`client_req_id`	string	Non	Termine la requête multiplexée correspondante.

Messages du serveur

`ready`

Champ	Type	Description
`type`	string	Toujours `"ready"`.
`request_id`	string	ID de requête Gradium, pour la journalisation et le support.
`model_name`	string	Alias du modèle demandé.
`model_ext`	string	Identifiant résolu du modèle, s’il est présent.
`sample_rate`	integer	Fréquence d’échantillonnage de sortie.
`frame_size`	integer	Taille de trame de sortie, en échantillons.
`audio_stream_names`	string[]	Flux audio nommés, s’ils sont présents.
`text_stream_names`	string[]	Flux de texte nommés, s’ils sont présents.
`client_req_id`	string	Présent pour les requêtes multiplexées.
`residency`	string	Résidence des données de la session (par ex. `pinned; zone=eu`, `best-effort; zone=us` ou `none`), si présente. Voir Résidence des données.

`audio`

Champ	Type	Description
`type`	string	Toujours `"audio"`.
`audio`	string	Fragment audio encodé en base64.
`start_s`	number	Instant de début du fragment, en secondes.
`stop_s`	number	Instant de fin du fragment, en secondes.
`stream_id`	integer	Identifiant du flux, s’il est présent.
`client_req_id`	string	Présent pour les requêtes multiplexées.

`text`

Champ	Type	Description
`type`	string	Toujours `"text"`.
`text`	string	Segment de texte associé à l’audio généré.
`start_s`	number	Instant de début du segment, en secondes.
`stop_s`	number	Instant de fin du segment, en secondes.
`stream_id`	integer	Identifiant du flux, s’il est présent.
`client_req_id`	string	Présent pour les requêtes multiplexées.

Messages terminaux

Type	Description
`end_of_stream`	La requête est terminée.
`flushed`	Réservé aux accusés de réception de flush.
`error`	Message d’erreur terminal ; le socket se ferme après l’erreur.

Error

{"type":"error","message":"Error description","code":1008}

Autorisations

x-api-key

string

header

requis

API key for authentication. Passed via the x-api-key header.

En-têtes

x-api-key

string

requis

Your Gradium API key

Réponse

101

WebSocket connection established

Vue d'ensemble

Synthèse vocale (TTS)

Transcription (STT)

Speech-to-Speech

Voix

Voice Design

Voice Enhance

Voice Localization

Prononciations

Consommation

Cycle de vie

Messages du client

`setup`

`text`

`end_of_stream`

Messages du serveur

`ready`

`audio`

`text`

Messages terminaux

Autorisations

En-têtes

Réponse

​Cycle de vie

​Messages du client

​setup

​text

​end_of_stream

​Messages du serveur

​ready

​audio

​text

​Messages terminaux

Autorisations

En-têtes

Réponse

Cycle de vie

Messages du client

`setup`

`text`

`end_of_stream`

Messages du serveur

`ready`

`audio`

`text`

Messages terminaux