VoiceAPI

Request Reconnection

Changed on

Exchange a session token for a fresh WebSocket URL and token so a client can rejoin a voice session after the connection drops. Session options are carried over from the original session.

get/v3/voice/realtime

Request

  • Base URL
    https://api.deepl.com
  • URL
    https://api.deepl.com/v3/voice/realtime
  • Auth
    API key in header Authorization

Query parameters

tokenstring required

The latest ephemeral token obtained for the stream.

Response

Successfully obtained streaming URL and reconnection token.

streaming_urlstring required

The WebSocket URL to use for establishing the stream connection.

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

session_idstring

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

Example response

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

Changes

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status