Skip to content

ACL-2127: Rework display of some doc elements #148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sj-dl merged 1 commit into from
Nov 14, 2025
Merged

ACL-2127: Rework display of some doc elements #148

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 30 additions & 30 deletions api-reference/voice.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,8 @@

## Supported Languages

### Source Languages

The following source languages are supported for voice input:

<Accordion title="Show supported source languages">
* Chinese (Mandarin)
* Dutch
* English
Expand All @@ -46,11 +44,11 @@
* Swedish
* Turkish
* Ukrainian

### Target Languages
</Accordion>

All source languages can be translated into the following target languages:

<Accordion title="Show supported target languages">
* Arabic
* Bulgarian
* Chinese (Simplified)
Expand Down Expand Up @@ -86,37 +84,15 @@
* Turkish
* Ukrainian
* Vietnamese
</Accordion>

## Two-Step API Flow

The Voice API uses a two-step flow to initiate streaming:

### Step 1: Request Session and Stream URL (REST)

Make a POST request to obtain an ephemeral streaming URL and authentication token:

```http
POST https://api.deepl.com/v1/voice/realtime
```

This step handles:
* Authentication and authorization
* Main configuration options (audio format, languages, glossaries, etc.)

See the [Get Streaming URL](/api-reference/voice/get-streaming-url) documentation for details.

### Step 2: Streaming Audio and Text (WebSocket)

Use the received URL to establish a WebSocket connection for:
* Sending audio data
* Receiving transcriptions and translations in real-time

See the [WebSocket Streaming](/api-reference/voice/websocket-streaming) documentation for details.

### Message Flow
The Voice API uses a two-step flow to initiate streaming.

<Accordion title="Show streaming flow">
```mermaid
sequenceDiagram

Check warning on line 95 in api-reference/voice.mdx

View check run for this annotation

Mintlify / Mintlify Validation (deepl-c950b784) - vale-spellcheck

api-reference/voice.mdx#L95 

Did you really mean 'sequenceDiagram'?
participant Client
participant Voice API

Expand Down Expand Up @@ -155,6 +131,30 @@

Note over Client,Voice API: Connection Closed
```
</Accordion>

<Steps>
<Step title="Request Session and Stream URL">
Make a POST request to obtain an ephemeral streaming URL and authentication token:

```http
POST https://api.deepl.com/v1/voice/realtime
```

This step handles:
* Authentication and authorization
* Main configuration options (audio format, languages, glossaries, etc.)

See the [Get Streaming URL](/api-reference/voice/get-streaming-url) documentation for details.
</Step>
<Step title="Streaming Audio and Text (WebSocket)">
Use the received URL to establish a WebSocket connection for:
* Sending audio data
* Receiving transcriptions and translations in real-time

See the [WebSocket Streaming](/api-reference/voice/websocket-streaming) documentation for details.
</Step>
</Steps>

## Limitations and Constraints

Expand Down