Reconnect Session - DeepL Documentation

Request Reconnection

curl --request GET \
  --url https://api.deepl.com/v3/voice/realtime \
  --header 'Authorization: <api-key>'

{
  "streaming_url": "wss://api.deepl.com/v3/voice/realtime/connect",
  "token": "VGhpcyBpcyBhIGZha2UgdG9rZW4K",
  "session_id": "4f911080-cfe2-41d4-8269-0e6ec15a0354"
}

{
  "message": "<string>",
  "code": "invalid_content_type"
}

{
  "message": "<string>",
  "code": "invalid_content_type"
}

{
  "message": "<string>",
  "code": "invalid_content_type"
}

{
  "message": "<string>",
  "code": "invalid_content_type"
}

{
  "message": "<string>",
  "code": "invalid_content_type"
}

GET

/

v3

/

voice

/

realtime

Request Reconnection

curl --request GET \
  --url https://api.deepl.com/v3/voice/realtime \
  --header 'Authorization: <api-key>'

{
  "streaming_url": "wss://api.deepl.com/v3/voice/realtime/connect",
  "token": "VGhpcyBpcyBhIGZha2UgdG9rZW4K",
  "session_id": "4f911080-cfe2-41d4-8269-0e6ec15a0354"
}

{
  "message": "<string>",
  "code": "invalid_content_type"
}

{
  "message": "<string>",
  "code": "invalid_content_type"
}

{
  "message": "<string>",
  "code": "invalid_content_type"
}

{
  "message": "<string>",
  "code": "invalid_content_type"
}

{
  "message": "<string>",
  "code": "invalid_content_type"
}

Authorizations

Authorization

string

header

default:DeepL-Auth-Key

required

Authentication with Authorization header and DeepL-Auth-Key authentication scheme. Example: DeepL-Auth-Key <api-key>

Query Parameters

token

string

required

The latest ephemeral token obtained for the stream.

Response

Successfully obtained streaming URL and reconnection token.

streaming_url

string

required

The WebSocket URL to use for establishing the stream connection.

Example:

"wss://api.deepl.com/v3/voice/realtime/connect"

token

string

required

A unique ephemeral token for authentication with the streaming endpoint. Pass this as a query parameter when connecting to the streaming URL. This token is ephemeral and valid for a short time and one-time use only.

Example:

"VGhpcyBpcyBhIGZha2UgdG9rZW4K"

session_id

string

Internal use only. A unique identifier for the requested stream.

Example:

"4f911080-cfe2-41d4-8269-0e6ec15a0354"

WebSocket Streaming Retrieve languages

⌘I