Flux WebSocket STT

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

Cycle de vie

{"type":"setup","model_name":"default","input_format":"pcm","json_config":{"language":"en","delay_in_frames":16}}
{"type":"audio","audio":"base64_encoded_audio"}
{"type":"flush","flush_id":1}
{"type":"end_of_stream"}

Le serveur répond par ready, puis par des messages text, end_text, step et flushed au fur et à mesure, et enfin par end_of_stream. Consultez Cycle de vie WebSocket pour le comportement de la connexion, les sockets réutilisables, les tokens navigateur et les erreurs.

Messages client

`setup`

Champ	Type	Obligatoire	Description
`type`	string	Oui	Toujours `"setup"`.
`model_name`	string	Non	Alias du modèle, `"default"` par défaut.
`input_format`	string	Non	`pcm`, `wav`, `opus`, `ulaw_8000`, `alaw_8000`, ou des fréquences PCM explicites comme `pcm_16000`. `wav` par défaut.
`json_config`	object ou string	Oui	Paramètres STT, par exemple `{"language":"en","delay_in_frames":16}`. `language` est obligatoire (`en`, `fr`, `es`, `pt`, `de`, ou `any` pour la détection automatique). Accepte aussi un dictionnaire `keywords` (`{"words":[...],"boost":3}`) pour orienter la transcription vers des termes personnalisés. Consultez Paramètres de transcription.
`client_req_id`	string	Non	Met en corrélation les requêtes multiplexées.
`close_ws_on_eos`	boolean	Non	`true` par défaut ; définissez `false` pour garder le socket ouvert.
`retry_for_s`	number	Non	Fenêtre facultative de nouvelle tentative du setup, en secondes.

`audio`

Champ	Type	Obligatoire	Description
`type`	string	Oui	Toujours `"audio"`.
`audio`	string	Oui	Fragment audio encodé en Base64.
`client_req_id`	string	Non	Obligatoire pour router une requête multiplexée.

`flush`

Champ	Type	Obligatoire	Description
`type`	string	Oui	Toujours `"flush"`.
`flush_id`	integer	Oui	Renvoyé dans la réponse `flushed` correspondante.
`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 serveur

`ready`

Champ	Type	Description
`type`	string	Toujours `"ready"`.
`request_id`	string	Identifiant de requête Gradium, pour les logs et le support.
`model_name`	string	Alias du modèle demandé.
`sample_rate`	integer	Fréquence d’échantillonnage d’entrée après le setup.
`frame_size`	integer	Taille de trame, en échantillons.
`delay_in_frames`	integer	Délai du modèle, en trames de 80 ms.
`text_stream_names`	string[]	Flux de texte nommés, le cas échéant.
`client_req_id`	string	Présent pour les requêtes multiplexées.
`residency`	string	Résidence des données de la session (par exemple `pinned; zone=eu`, `best-effort; zone=us` ou `none`), le cas échéant. Consultez Résidence des données.

`text`

Champ	Type	Description
`type`	string	Toujours `"text"`.
`text`	string	Segment de texte transcrit.
`start_s`	number	Début du segment, en secondes.
`stream_id`	integer	Identifiant du flux, le cas échéant.
`client_req_id`	string	Présent pour les requêtes multiplexées.

`end_text`

Champ	Type	Description
`type`	string	Toujours `"end_text"`.
`stop_s`	number	Fin du segment de texte précédent.
`stream_id`	integer	Identifiant du flux, le cas échéant.
`client_req_id`	string	Présent pour les requêtes multiplexées.

`step`

Champ	Type	Description
`type`	string	`"step"` ou l’ancien `"vad"`.
`vad`	object[]	Prédictions par horizon, avec `horizon_s` et `inactivity_prob`.
`step_idx`	integer	Index du pas.
`step_duration_s`	number	Durée du pas en secondes, généralement `0.08`.
`total_duration_s`	number	Durée d’audio traitée jusqu’ici.
`client_req_id`	string	Présent pour les requêtes multiplexées.

`flushed`

Champ	Type	Description
`type`	string	Toujours `"flushed"`.
`flush_id`	integer	Le `flush_id` de la requête correspondante.
`client_req_id`	string	Présent pour les requêtes multiplexées.

Messages de fin

Type	Description
`end_of_stream`	La requête est terminée.
`error`	Message d’erreur final ; 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 client

`setup`

`audio`

`flush`

`end_of_stream`

Messages serveur

`ready`

`text`

`end_text`

`step`

`flushed`

Messages de fin

Autorisations

En-têtes

Réponse

​Cycle de vie

​Messages client

​setup

​audio

​flush

​end_of_stream

​Messages serveur

​ready

​text

​end_text

​step

​flushed

​Messages de fin

Autorisations

En-têtes

Réponse

Cycle de vie

Messages client

`setup`

`audio`

`flush`

`end_of_stream`

Messages serveur

`ready`

`text`

`end_text`

`step`

`flushed`

Messages de fin