Fish Audio Docs
API 參考文字轉語音
返回主站

Fish Audio 相容 TTS

使用 fish.audio 風格的 POST /v1/tts 合約,搭配 Fish Audio API 金鑰接入 RikkaHub 等用戶端。

Fish Audio 相容 TTS

當客戶端硬編碼fish.audio POST /v1/tts 請求形狀時使用此端點。它將有效負載對應到 Fish Audio Open TTS 管道,同時在您的 Fish Audio 帳戶上保留 API 金鑰驗證、配額和計費。

對於本機 Open API 集成,首選 Sync HTTP。對於 OpenAI POST /v1/audio/speech 用戶端,請使用 OpenAI-相容於 TTS

端點

POST /v1/tts
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
model: s2.1-pro

完整網址:

https://fishaudio.org/v1/tts

如果第三方應用程式要求 Fish Audio API 基礎(例如 https://api.fish.audio),請將其設為 https://fishaudio.org 並將路徑保留為 /v1/tts

將 API 金鑰保留在用戶端的受保護憑證欄位中。為每個應用程式建立專用金鑰,以便您可以獨立監控或撤銷它。

## 要求

{
  "text": "Hello from Fish Audio.",
  "reference_id": "00a1b221-6137-4b73-ad62-b0cbce134167",
  "format": "mp3",
  "temperature": 0.7,
  "top_p": 0.7,
  "normalize": true,
  "prosody": {
    "speed": 1
  }
}
欄位/標題類型必填筆記
model 標頭字串沒有Fish.audio 引擎標籤,例如 s2.1-pros2.1-pro-flashs2-pro
text字串是的要合成的文字
reference_id字串是的Fish Audio 語音辨識;伺服器不會默默地選擇預設語音
format字串沒有mp3wavpcm;不支援的值(例如 opus)會回退到 mp3
prosody.speed數量沒有說話速度從0.52;頂級的speed也被接受
temperature數量沒有對應到 Fish Audio 穩定性 (0.51.5)
top_p數量沒有對應到 Fish Audio 相似性 (0.51.5)
normalize布林值沒有映射到文字規範化
chunk_length數量沒有因客戶端相容性而接受並被忽略
latency字串沒有因客戶端相容性而接受並被忽略

模型頭映射

model 標頭值Fish Audio 引擎型號 ID
s2.1-profishaudio-s21pro
s2.1-pro-freefishaudio-s21pro-free
s2.1-flashfishaudio-s21-flash
s2.1-pro-flashfishaudio-s21pro-flash
s2-profishaudio-s2pro
s1 / s1-minifishaudio-s1
speech-1.5 / 1.6fishaudio-s1

未知的標頭值將被忽略,並套用伺服器預設引擎。您也可以在標頭中傳送本機引擎 ID,例如 fishaudio-s21pro-flash

GET /api/open/v1/voices 取得語音 ID。如需快速連線測試,請使用公共系統語音00a1b221-6137-4b73-ad62-b0cbce134167

回覆

成功的請求返回二進位音訊:

HTTP/1.1 200 OK
Content-Type: audio/mpeg
X-OpenAPI-Quota-Remaining: 987988
X-OpenAPI-Credits-Used: 12

<binary audio data>

錯誤為 JSON,並與 Sync HTTP 共享身份驗證、配額和生成行為。

curl 範例

curl -X POST "https://fishaudio.org/v1/tts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "model: s2.1-pro" \
  -d '{
    "text": "Hello from Fish Audio.",
    "reference_id": "00a1b221-6137-4b73-ad62-b0cbce134167",
    "format": "mp3",
    "prosody": { "speed": 1 }
  }' \
  --output speech.mp3

連接RikkaHub

對於RikkaHub中的API金鑰、基本URL、型號和語音設置,請遵循專用的RikkaHub設定指南

錯誤

狀態意義行動
400無效文字、缺少 reference_id 或錯誤的 JSON重試之前更正請求
401API 金鑰遺失或無效檢查或更換整合金鑰
402API 配額不足在產生更多音訊之前新增配額
429請求速率超出限制使用指數退避重試
500TTS生成失敗僅在具有重複充電意識的情況下重試