Skip to content

Commit 72445db

Browse files
committed
Update docs.html
1 parent 0b9162f commit 72445db

File tree

1 file changed

+43
-1
lines changed

1 file changed

+43
-1
lines changed

ttsfm-web/templates/docs.html

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,19 @@ <h4 class="card-title">
198198
<span class="method-badge method-get">GET</span>
199199
/api/formats
200200
</h4>
201-
<p class="card-text">{{ _('docs.get_formats_desc') }}</p>
201+
<p class="card-text">Get available audio formats for speech generation.</p>
202+
203+
<h6>Available Formats</h6>
204+
<p>We support multiple format requests, but internally:</p>
205+
<ul>
206+
<li><strong>mp3</strong> - Returns actual MP3 format</li>
207+
<li><strong>All other formats</strong> (opus, aac, flac, wav, pcm) - Mapped to WAV format</li>
208+
</ul>
209+
210+
<div class="alert alert-info">
211+
<i class="fas fa-info-circle me-2"></i>
212+
<strong>Note:</strong> When you request opus, aac, flac, wav, or pcm, you'll receive WAV audio data.
213+
</div>
202214

203215
<h6>{{ _('docs.response_example') }}</h6>
204216
<div class="response-example">
@@ -209,6 +221,36 @@ <h6>{{ _('docs.response_example') }}</h6>
209221
"name": "MP3",
210222
"mime_type": "audio/mp3",
211223
"description": "MP3 audio format"
224+
},
225+
{
226+
"id": "opus",
227+
"name": "Opus",
228+
"mime_type": "audio/wav",
229+
"description": "Returns WAV format"
230+
},
231+
{
232+
"id": "aac",
233+
"name": "AAC",
234+
"mime_type": "audio/wav",
235+
"description": "Returns WAV format"
236+
},
237+
{
238+
"id": "flac",
239+
"name": "FLAC",
240+
"mime_type": "audio/wav",
241+
"description": "Returns WAV format"
242+
},
243+
{
244+
"id": "wav",
245+
"name": "WAV",
246+
"mime_type": "audio/wav",
247+
"description": "WAV audio format"
248+
},
249+
{
250+
"id": "pcm",
251+
"name": "PCM",
252+
"mime_type": "audio/wav",
253+
"description": "Returns WAV format"
212254
}
213255
],
214256
"count": 6

0 commit comments

Comments
 (0)