API 參考

Fish Audio Open API 是用於製作音訊工作流程的伺服器端介面。當您的產品需要文字轉語音、語音轉文字、語音管理或口型同步自動化而不依賴 Web 控制台時，可以使用它。

基本網址：

https://fishaudio.org/api/open/v1

驗證：

Authorization: Bearer FISHAUDIO_API_KEY

機器可讀的架構：

GET /api/openapi.json

當前的公共表面

請求模型

所有請求都應從您的伺服器發出。瀏覽器用戶端和行動應用程式應先呼叫您自己的後端，然後您的後端使用 API 鍵呼叫 Open API。

curl https://fishaudio.org/api/open/v1/profile \
  -H "Authorization: Bearer FISHAUDIO_API_KEY"

對於大多數端點使用 JSON。當啟用的提供者需要參考音訊時，語音建立可以使用多部分錶單資料。當您請求直接音訊而不是快取的元資料時，同步 TTS 使用二進位音訊回應。

回應模型

成功的回應是特定於端點的。非同步端點傳回應用程式應輪詢的作業或任務對象，直到達到終端狀態。同步媒體端點可能會傳回二進位資料或 JSON 元數據，具體取決於請求選項。

錯誤使用 JSON 主體：

{
  "code": "invalid_request",
  "message": "The request payload is invalid.",
  "requestId": "req_xxx"
}

當 requestId 存在時記錄它。這是支援人員追蹤失敗請求的最快方法。

計費和積分

開放API呼叫根據終端和啟用的型號消耗帳戶積分或API配額。有些端點在接受任務時收費；其他人則在媒體產生成功時收費。您的整合應顯示清晰的重試狀態，並且不應假設每個失敗的請求都會消耗積分。

對於平衡敏感的工作流程，請在開始大批量之前和重要作業完成之後呼叫設定檔。長時間運行的作業也應該保留返回的任務 ID，以便您可以從客戶端重新啟動中恢復，而不會建立重複的工作。

相容性

舊版 Open API 路徑在相容性視窗期間仍然可用，但新整合應使用 /api/open/v1。遷移指南列出了已知的路徑替換和部署順序。

API 文件有意使用他們自己當前的路徑。如果您要整合全球站點，請遵循 https://fishaudio.org/api/open/v1 下的路徑並使用 GET /api/openapi.json 確認新表面。