Skip to content

Commit ce55f34

Browse files
authored
Merge pull request #148 from DeepLcom/acl/acl-2127-rework-voice-docs
ACL-2127: Rework display of some doc elements
2 parents c2783a8 + 1fd4b57 commit ce55f34

1 file changed

Lines changed: 30 additions & 30 deletions

File tree

api-reference/voice.mdx

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,8 @@ The API uses a two-step flow:
2525

2626
## Supported Languages
2727

28-
### Source Languages
29-
3028
The following source languages are supported for voice input:
31-
29+
<Accordion title="Show supported source languages">
3230
* Chinese (Mandarin)
3331
* Dutch
3432
* English
@@ -46,11 +44,11 @@ The following source languages are supported for voice input:
4644
* Swedish
4745
* Turkish
4846
* Ukrainian
49-
50-
### Target Languages
47+
</Accordion>
5148

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

51+
<Accordion title="Show supported target languages">
5452
* Arabic
5553
* Bulgarian
5654
* Chinese (Simplified)
@@ -86,35 +84,13 @@ All source languages can be translated into the following target languages:
8684
* Turkish
8785
* Ukrainian
8886
* Vietnamese
87+
</Accordion>
8988

9089
## Two-Step API Flow
9190

92-
The Voice API uses a two-step flow to initiate streaming:
93-
94-
### Step 1: Request Session and Stream URL (REST)
95-
96-
Make a POST request to obtain an ephemeral streaming URL and authentication token:
97-
98-
```http
99-
POST https://api.deepl.com/v1/voice/realtime
100-
```
101-
102-
This step handles:
103-
* Authentication and authorization
104-
* Main configuration options (audio format, languages, glossaries, etc.)
105-
106-
See the [Get Streaming URL](/api-reference/voice/get-streaming-url) documentation for details.
107-
108-
### Step 2: Streaming Audio and Text (WebSocket)
109-
110-
Use the received URL to establish a WebSocket connection for:
111-
* Sending audio data
112-
* Receiving transcriptions and translations in real-time
113-
114-
See the [WebSocket Streaming](/api-reference/voice/websocket-streaming) documentation for details.
115-
116-
### Message Flow
91+
The Voice API uses a two-step flow to initiate streaming.
11792

93+
<Accordion title="Show streaming flow">
11894
```mermaid
11995
sequenceDiagram
12096
participant Client
@@ -155,6 +131,30 @@ sequenceDiagram
155131
156132
Note over Client,Voice API: Connection Closed
157133
```
134+
</Accordion>
135+
136+
<Steps>
137+
<Step title="Request Session and Stream URL">
138+
Make a POST request to obtain an ephemeral streaming URL and authentication token:
139+
140+
```http
141+
POST https://api.deepl.com/v1/voice/realtime
142+
```
143+
144+
This step handles:
145+
* Authentication and authorization
146+
* Main configuration options (audio format, languages, glossaries, etc.)
147+
148+
See the [Get Streaming URL](/api-reference/voice/get-streaming-url) documentation for details.
149+
</Step>
150+
<Step title="Streaming Audio and Text (WebSocket)">
151+
Use the received URL to establish a WebSocket connection for:
152+
* Sending audio data
153+
* Receiving transcriptions and translations in real-time
154+
155+
See the [WebSocket Streaming](/api-reference/voice/websocket-streaming) documentation for details.
156+
</Step>
157+
</Steps>
158158

159159
## Limitations and Constraints
160160

0 commit comments

Comments
 (0)