# Get Streaming URL

**POST /v3/voice/realtime**




## Servers
- DeepL API Pro: https://api.deepl.com (DeepL API Pro)
- DeepL API Free: https://api-free.deepl.com (DeepL API Free)


## Authentication methods
- Auth header


## Parameters



### Body: application/json (object)

- **source_media_content_type** (string)
  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.

- **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.

- **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

- **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.

- **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



## Responses
### 200
Successfully obtained streaming URL and token
#### Headers

- **X-Trace-ID** ()
  A unique identifier for the request that can be included in bug reports to DeepL support.


#### Body: application/json (object)
- **streaming_url** (string)
  The WebSocket URL to use for establishing the streaming connection. This URL is ephemeral and valid for one-time use only.

- **token** (string)
  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.
#### Headers

- **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.
#### Headers

- **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.
#### Headers

- **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.
#### Headers

- **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.
#### Headers

- **X-Trace-ID** ()
  A unique identifier for the request that can be included in bug reports to DeepL support.


### 500
Internal error.
#### Headers

- **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.
#### Headers

- **X-Trace-ID** ()
  A unique identifier for the request that can be included in bug reports to DeepL support.



[Powered by Bump.sh](https://bump.sh)