Ir para a navegação
ElevenAPIRealtime Translation

WebSocket

The Realtime Translation WebSocket API streams translation audio continuously to a target language given source audio. Currently for enterprise workspaces only.

Handshake

WSS
/v1/translation/realtime

Cabeçalhos

xi-api-keystringOpcional

Parâmetros de consulta

authorizationstringOpcional
Your authorization bearer token.
target_languagestringObrigatório

Target language as an ISO 639 code (e.g. de, es, fr, zh).

source_languagestringOpcional

Source language as an ISO 639 code. When omitted the server auto-detects the spoken language.

voice_idstringObrigatório
Voice ID used for the translated speech output.
input_formatanyOpcional
Audio encoding format for realtime translation input.
output_formatanyOpcional
Audio encoding format for realtime translation output.
tts_model_idenumOpcionalPadrão é eleven_v4_turbo
TTS model used to synthesize the translated speech.
Valores permitidos:
apply_text_normalizationenumOpcionalPadrão é off

This parameter controls text normalization with three modes: ‘auto’, ‘on’, and ‘off’. When set to ‘auto’, the system will automatically decide whether to apply text normalization (e.g., spelling out numbers). With ‘on’, text normalization will always be applied, while with ‘off’, it will be skipped.

Valores permitidos:
eagernessenumOpcionalPadrão é medium
How eagerly translation starts while the speaker is still talking. 'high' starts translating soonest for the lowest latency. 'low' waits for more of the sentence, giving higher quality translations with more delay.
Valores permitidos:
client_session_idstringOpcional

Optional client-defined session identifier for tracking purposes.

enable_zrmbooleanOpcionalPadrão é false

When enable_zrm is set to true, zero retention mode will be used for the request. Sensitive content (transcripts, translations, and TTS text) is not written to application logs or session history. Zero retention mode may only be used by enterprise customers.

Enviar

inputAudioChunkobjectObrigatório
Send a chunk of audio for translation.
OR
endOfStreamobjectObrigatório
Signal that the audio stream has ended.

Receber

sessionStartedobjectObrigatório
Sent by the server when the session is initialized.
OR
statusobjectObrigatório
Session lifecycle update indicating the session has started or stopped.
OR
partialTranscriptobjectObrigatório
Interim transcription of the source audio.
OR
finalTranscriptobjectObrigatório
Final transcription of a segment of source audio.
OR
translationobjectObrigatório
Translated text in the target language.
OR
audioobjectObrigatório

Base64-encoded audio of the translated speech.

OR
errorobjectObrigatório
Error encountered during translation.
OR
Translate Auth ErrorobjectObrigatório
Authentication failed for the session.
OR
Translate Rate Limited ErrorobjectObrigatório
The request rate limit was reached.
OR
Translate Queue Overflow ErrorobjectObrigatório
Audio was sent too frequently and the session was terminated.
OR
Translate Input ErrorobjectObrigatório

An input message could not be handled; check the message format.

OR
Translate Transcriber ErrorobjectObrigatório
The transcriber failed to process the audio.
OR
Translate Translation ErrorobjectObrigatório

Translation failed for a segment; the session continues.

OR
Translate Audio Output ErrorobjectObrigatório

Audio output for a segment failed or was dropped; the session continues.

OR
Translate Quota Exceeded ErrorobjectObrigatório

The workspace is out of credits; the session is closed.

OR
Translate Payment Issue ErrorobjectObrigatório

The workspace has a payment issue or is suspended; the session is closed.

OR
Translate Unaccepted Terms ErrorobjectObrigatório

The workspace has not accepted terms required for this feature; the session is closed.