Get Streaming URL | Deepl API documentation

Get Streaming URL Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://bump.sh/polo/hub/about-mcp/doc/deepl/mcp

Standard setup for AI tools providing an mcp.json file

{
  "Deepl MCP server": {
    "url": "https://bump.sh/polo/hub/about-mcp/doc/deepl/mcp"
  }
}

POST /v3/voice/realtime

Auth header

application/json

Body Required

source_media_content_type string Required

The audio format for streaming. Specifies container, codec, and encoding parameters. Supported formats include PCM (recommended), OPUS (recommended for low bandwidth), FLAC, MP3, and AAC. PCM formats require explicit sample rate. Mono audio only.

Values are audio/auto, audio/flac, audio/mpeg, audio/ogg, audio/webm, audio/x-matroska, audio/ogg; codecs=flac, audio/ogg; codecs=opus, audio/pcm; encoding=s16le; rate=8000, audio/pcm; encoding=s16le; rate=16000, audio/pcm; encoding=s16le; rate=44100, audio/pcm; encoding=s16le; rate=48000, audio/webm; codecs=opus, audio/x-matroska; codecs=aac, audio/x-matroska; codecs=flac, audio/x-matroska; codecs=mp3, or audio/x-matroska; codecs=opus.
source_language string

Source language of the audio stream. Must be one of the supported Voice API source languages. Language identifier must comply with IETF BCP 47 language tags.

Values are zh, nl, en, fr, de, id, it, ja, ko, pl, pt, ro, ru, es, sv, tr, or uk.
source_language_mode string
Controls how the source_language value is used.
- auto: Treats source language as a hint; server can override
- fixed: Treats source language as mandatory; server must use this language
Values are auto or fixed. Default value is auto.
target_languages array[string]

List of target languages for translation. The stream will emit translations for each language. Maximum 5 target languages per stream. Language identifiers must comply with IETF BCP 47.

Not more than 5 elements.
glossary_id string

A unique ID assigned to a glossary.
formality string
Sets whether the translated text should lean towards formal or informal language. Possible options are:
- default - use the default formality for the target language
- formal/more - for a more formal language
- informal/less - for a more informal language
Values are default, formal, more, informal, or less. Default value is default.

Responses

200 application/json

Successfully obtained streaming URL and token
Hide headers attribute Show headers attribute
- X-Trace-ID
  
  A unique identifier for the request that can be included in bug reports to DeepL support.
Hide response attributes Show response attributes object
- streaming_url string Required
  
  The WebSocket URL to use for establishing the streaming connection. This URL is ephemeral and valid for one-time use only.
- token string Required
  
  A unique ephemeral token for authentication with the streaming endpoint. Pass this as a query parameter when connecting to the WebSocket URL.
- session_id string
  
  Internal use only. A unique identifier for the requested stream.
400

Bad request. Please check error message and your parameters.
Hide headers attribute Show headers attribute
- X-Trace-ID
  
  A unique identifier for the request that can be included in bug reports to DeepL support.
401

Authorization failed. Please supply a valid DeepL-Auth-Key via the Authorization header.
Hide headers attribute Show headers attribute
- X-Trace-ID
  
  A unique identifier for the request that can be included in bug reports to DeepL support.
403

Authorization failed. Please supply a valid DeepL-Auth-Key via the Authorization header.
Hide headers attribute Show headers attribute
- X-Trace-ID
  
  A unique identifier for the request that can be included in bug reports to DeepL support.
429

Too many requests. Please wait and resend your request.
Hide headers attribute Show headers attribute
- X-Trace-ID
  
  A unique identifier for the request that can be included in bug reports to DeepL support.
456

Quota exceeded. The character limit has been reached.
Hide headers attribute Show headers attribute
- X-Trace-ID
  
  A unique identifier for the request that can be included in bug reports to DeepL support.
500

Internal error.
Hide headers attribute Show headers attribute
- X-Trace-ID
  
  A unique identifier for the request that can be included in bug reports to DeepL support.
503

Resource currently unavailable. Try again later.
Hide headers attribute Show headers attribute
- X-Trace-ID
  
  A unique identifier for the request that can be included in bug reports to DeepL support.

POST /v3/voice/realtime

curl \
 --request POST 'https://api.deepl.com/v3/voice/realtime' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"source_media_content_type":"audio/ogg; codecs=opus","source_language":"en","source_language_mode":"auto","target_languages":["de","fr","es"]}'

Request examples

{
  "source_media_content_type": "audio/ogg; codecs=opus",
  "source_language": "en",
  "source_language_mode": "auto",
  "target_languages": [
    "de",
    "fr",
    "es"
  ]
}

{
  "source_media_content_type": "audio/pcm; encoding=s16le; rate=16000",
  "source_language": "en",
  "source_language_mode": "fixed",
  "target_languages": [
    "de",
    "fr"
  ],
  "glossary_id": "def3a26b-3e84-45b3-84ae-0c0aaf3525f7",
  "formality": "formal"
}

Response examples (200)

{
  "streaming_url": "wss://api.deepl.com/v3/voice/realtime/connect",
  "token": "VGhpcyBpcyBhIGZha2UgdG9rZW4K"
}