You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit c7aeab2
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: .mintlify/skills/fish-audio-api/SKILL.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,7 +47,7 @@ Required headers:
47
47
48
48
Optional headers:
49
49
50
-
-`model`: values `s1` (deprecated), `s2-pro`, `s2.1-pro`, `s2.1-pro-free`, `drama-3-preview`. If omitted or unrecognized, the server falls back to `s2.1-pro` (paid). Default to `s2.1-pro` for production; use `s2.1-pro-free` for free-tier evaluation and prototyping (same model, no TTFA/DPA guarantees). `drama-3-preview` is a preview model; its behavior and availability may change. Do not choose `s1` for new code: S1 is deprecated and will be retired on December 31, 2026. After that date, requests that specify `s1` are served by `s2.1-pro`. Migration: `https://docs.fish.audio/developer-guide/models-pricing/migrate-from-s1`.
50
+
-`model`: values `s1` (deprecated), `s2-pro`, `s2.1-pro`, `s2.1-pro-free`, `drama-3`. If omitted or unrecognized, the server falls back to `s2.1-pro` (paid). Default to `s2.1-pro` for production; use `s2.1-pro-free` for free-tier evaluation and prototyping (same model, no TTFA/DPA guarantees). Do not choose `s1` for new code: S1 is deprecated and will be retired on December 31, 2026. After that date, requests that specify `s1` are served by `s2.1-pro`. Migration: `https://docs.fish.audio/developer-guide/models-pricing/migrate-from-s1`.
51
51
52
52
Response: streaming audio bytes (`Transfer-Encoding: chunked`) in the format set by `format`. Write to a file or pipe to a player. There is **no JSON wrapper** on success.
53
53
@@ -56,7 +56,7 @@ Response: streaming audio bytes (`Transfer-Encoding: chunked`) in the format set
56
56
| Field | Type | Default | Notes |
57
57
| --- | --- | --- | --- |
58
58
|`text`| string | — (required) | The text to synthesize. Use speaker tags `<\|speaker:0\|>`, `<\|speaker:1\|>` for multi-speaker. |
59
-
|`reference_id`| string \| string[]\| null | null | Voice model ID. Array = multi-speaker (`s2-pro`, the S2.1-Pro family, and `drama-3-preview`). |
59
+
|`reference_id`| string \| string[]\| null | null | Voice model ID. Array = multi-speaker (`s2-pro`, the S2.1-Pro family, and `drama-3`). |
60
60
|`references`| ReferenceAudio[]\| ReferenceAudio[][]\| null | null | Inline zero-shot cloning samples. **Requires `application/msgpack`** because `audio` is raw bytes. 2D array for multi-speaker. |
61
61
|`temperature`| number 0–1 | 0.7 | Expressiveness. |
62
62
|`top_p`| number 0–1 | 0.7 | Nucleus sampling. |
@@ -82,7 +82,7 @@ Response: streaming audio bytes (`Transfer-Encoding: chunked`) in the format set
82
82
83
83
1.**Library / custom voice model** → set `reference_id` to the model `_id`. Simplest path.
84
84
2.**Zero-shot from audio** → set `references` (array of `{audio, text}`) and use **MessagePack** body. JSON cannot carry raw audio bytes.
85
-
3.**Multi-speaker dialogue (`s2-pro`, the S2.1-Pro family, and `drama-3-preview`)** → `reference_id: [id0, id1, ...]` and embed `<|speaker:0|>` / `<|speaker:1|>` markers inside `text`. For zero-shot multi-speaker, `references` is an array-of-arrays, one inner array per speaker.
85
+
3.**Multi-speaker dialogue (`s2-pro`, the S2.1-Pro family, and `drama-3`)** → `reference_id: [id0, id1, ...]` and embed `<|speaker:0|>` / `<|speaker:1|>` markers inside `text`. For zero-shot multi-speaker, `references` is an array-of-arrays, one inner array per speaker.
86
86
87
87
### Single-speaker curl
88
88
@@ -491,7 +491,7 @@ For low-latency / streaming TTS (e.g. LLM token stream → speech). All frames a
491
491
### Connection headers
492
492
493
493
-`Authorization: Bearer <FISH_API_KEY>`
494
-
-`model`: optional; values `s1` (deprecated, retires December 31, 2026, then served by `s2.1-pro`), `s2-pro`, `s2.1-pro`, `s2.1-pro-free` (falls back to `s2.1-pro` when omitted or unrecognized)
494
+
-`model`: optional; values `s1` (deprecated, retires December 31, 2026, then served by `s2.1-pro`), `s2-pro`, `s2.1-pro`, `s2.1-pro-free`, `drama-3` (falls back to `s2.1-pro` when omitted or unrecognized)
495
495
496
496
### Event sequence
497
497
@@ -622,7 +622,7 @@ S2-Pro and the S2.1-Pro models use free-form `[bracket]` natural-language tags i
622
622
- 402 → out of credit. Check `/wallet/self/api-credit`.
623
623
- 404 → bad `model/{id}` (voice model doesn't exist or isn't visible to you).
624
624
- 422 → validation. The response is an array; each item's `loc` points at the offending field. Most common causes:
625
-
-`reference_id` is an array but model is `s1` (multi-speaker requires `s2-pro`, an S2.1-Pro model, or `drama-3-preview`).
625
+
-`reference_id` is an array but model is `s1` (multi-speaker requires `s2-pro`, an S2.1-Pro model, or `drama-3`).
626
626
-`references` sent with`Content-Type: application/json` (must be msgpack).
Copy file name to clipboardExpand all lines: api-reference/asyncapi.yml
+2-1Lines changed: 2 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -64,6 +64,7 @@ channels:
64
64
- s2-pro
65
65
- s2.1-pro
66
66
- s2.1-pro-free
67
+
- drama-3
67
68
description: TTS model to use for this session. If omitted or set to an unrecognized value, the session falls back to `s2.1-pro`. Use `s2-pro` or an S2.1-Pro model for multi-speaker dialogue synthesis. `s1` is deprecated and will be retired on December 31, 2026. After that date, requests that specify `s1` are served by `s2.1-pro`.
68
69
description: |
69
70
Real-time TTS streaming channel. Clients send text chunks and receive audio chunks concurrently.
@@ -101,7 +102,7 @@ channels:
101
102
- s2-pro
102
103
- s2.1-pro
103
104
- s2.1-pro-free
104
-
- drama-3-preview
105
+
- drama-3
105
106
description: TTS model to use for this session. If omitted or set to an unrecognized value, the session falls back to `s2.1-pro`. `s1` is deprecated and will be retired on December 31, 2026. After that date, requests that specify `s1` are served by `s2.1-pro`.
106
107
description: |
107
108
Real-time TTS streaming channel with word-level timestamps. Clients send
S1 is deprecated and will be retired on December 31, 2026. After that date, requests that specify `s1` are served by `s2.1-pro`and billed as `s2.1-pro`, at the same price.
10
+
Text-to-speech model you direct in plain language. Describe tone, pacing, and character without a fixed set of audio tags.
11
11
12
-
To migrate, switch the model ID to `s2.1-pro` and convert `(parenthesis)` emotion tags to `[bracket]` tags.
12
+
Use model ID `drama-3` in the API.
13
13
14
-
[Migrate from S1](/developer-guide/models-pricing/migrate-from-s1) | [Model deprecations](/developer-guide/models-pricing/deprecations)
14
+
[Drama 3 guide](/features/text-to-speech/drama-3) | [Text to Speech API](/api-reference/endpoint/openapi-v1/text-to-speech)
Preview text-to-speech model you direct in plain language. Describe tone, pacing, and character without a fixed set of audio tags.
20
+
S1 is deprecated and will be retired on December 31, 2026. After that date, requests that specify `s1` are served by `s2.1-pro` and billed as `s2.1-pro`, at the same price.
21
21
22
-
Use model ID `drama-3-preview` in the API. Behavior and availability may change while it is in preview.
22
+
To migrate, switch the model ID to `s2.1-pro`and convert `(parenthesis)` emotion tags to `[bracket]` tags.
23
23
24
-
[Drama 3 guide](/features/text-to-speech/drama-3) | [Text to Speech API](/api-reference/endpoint/openapi-v1/text-to-speech)
24
+
[Migrate from S1](/developer-guide/models-pricing/migrate-from-s1) | [Model deprecations](/developer-guide/models-pricing/deprecations)
Copy file name to clipboardExpand all lines: features/text-to-speech.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -110,7 +110,7 @@ curl --request POST https://api.fish.audio/v1/tts \
110
110
111
111
-**`s2.1-pro`**: recommended for production, with improved quality, latency, and throughput over S2-Pro.
112
112
-**`s2.1-pro-free`**: the same model at $0 for testing, prototyping, development, and smaller businesses, without TTFA or DPA guarantees.
113
-
-**`drama-3-preview`**: preview model you direct in plain language, with sounds, pauses, and paired tags for specific words. See [Drama 3](/features/text-to-speech/drama-3).
113
+
-**`drama-3`**: model you direct in plain language, with sounds, pauses, and paired tags for specific words. See [Drama 3](/features/text-to-speech/drama-3).
114
114
-**`s2-pro`**: previous-generation S2 model with multi-speaker and natural-language expression control.
115
115
-**`s1`**: previous generation, `(parenthesis)` emotion tags. S1 is deprecated and will be retired on December 31, 2026. After that date, requests that specify `s1` are served by `s2.1-pro`. See [Migrate from S1](/developer-guide/models-pricing/migrate-from-s1).
Copy file name to clipboardExpand all lines: features/text-to-speech/drama-3.mdx
+3-8Lines changed: 3 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ Drama 3 is our latest text-to-speech model built for voice direction and content
14
14
- Direct a performance in plain language, including a language other than the script.
15
15
- Add a sound or a pause where it happens, or limit a delivery to specific words.
16
16
- Switch language for a phrase, or pin a pronunciation with phoneme tags.
17
-
- Keep your current `POST /v1/tts` request and set the model header to `drama-3-preview`.
17
+
- Keep your current `POST /v1/tts` request and set the model header to `drama-3`.
18
18
19
19
## Voice cast
20
20
@@ -28,12 +28,7 @@ Choosing a voice that fits the role is key to getting the best out of Drama 3. T
28
28
29
29
## How to use
30
30
31
-
To use Drama 3, set the `model` header to `drama-3-preview` on your existing `POST /v1/tts` request.
32
-
33
-
| Status | Model header | Availability |
34
-
|---|---|---|
35
-
| Released |`drama-3`| Available now |
36
-
| Preview |`drama-3-preview`| Available now |
31
+
To use Drama 3, set the `model` header to `drama-3` on your existing `POST /v1/tts` request.
37
32
38
33
<Warning>
39
34
If the `model` header is missing or misspelled, the request doesn't fail: it
@@ -185,7 +180,7 @@ The names in the script above are for reading. The request sends the same lines
185
180
curl --fail --show-error --request POST https://api.fish.audio/v1/tts \
186
181
--header "Authorization: Bearer $FISH_API_KEY" \
187
182
--header "Content-Type: application/json" \
188
-
--header "model: drama-3-preview" \
183
+
--header "model: drama-3" \
189
184
--data '{
190
185
"text": "<|speaker:0|>[calm, measured storyteller voice] The ship had been silent for three days.<|speaker:1|>[low, gravelly, tired but in control] Status report.<|speaker:2|>[fast, nervous, stumbling over words] Uh, sir, so, the thing is, the reactor is, it is not, it is not great.<|speaker:1|>[slow, dangerously quiet] Define \"not great.\"<|speaker:2|>[voice breaking, close to panic] It is going to <emphasis>blow</emphasis>.",
Copy file name to clipboardExpand all lines: llms.txt
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,7 @@
42
42
## Product Guides
43
43
44
44
- [Text to Speech Guide](https://docs.fish.audio/developer-guide/core-features/text-to-speech.md): Convert text to natural-sounding speech with Fish Audio.
45
-
- [Drama 3](https://docs.fish.audio/features/text-to-speech/drama-3.md): Preview text-to-speech model (drama-3-preview) directed with plain-language directions in square brackets, sounds and pauses, paired tags for specific words, and multi-speaker dialogue.
45
+
- [Drama 3](https://docs.fish.audio/features/text-to-speech/drama-3.md): Text-to-speech model (drama-3) directed with plain-language directions in square brackets, sounds and pauses, paired tags for specific words, and multi-speaker dialogue.
46
46
- [Speech to Text Guide](https://docs.fish.audio/features/speech-to-text.md): Transcribe audio with transcribe-1-pro, including multi-speaker conversations with speaker turns, long recordings and inline emotion cues.
47
47
- [Voice Design Guide](https://docs.fish.audio/features/voice-design.md): Generate candidate voices from natural-language prompts.
48
48
- [Creating Voice Models](https://docs.fish.audio/developer-guide/core-features/creating-models.md): Learn how to create custom voice models with Fish Audio.
0 commit comments