API 參考
驗證
驗證 Fish Audio Open API 請求。
＃ 驗證
Fish Audio Open API 請求使用承載 API 金鑰。 API 金鑰標識請求的帳戶、權限範圍、配額和計費上下文。
Authorization: Bearer FISHAUDIO_API_KEY在您的帳戶中建立和管理 API 金鑰：
https://fishaudio.org/en/account?section=api請求規則
每個 Open API 請求必須包含 Authorization 標頭。 JSON 請求也應包含 Content-Type: application/json。多部分端點應該讓您的 HTTP 用戶端設定多部分邊界。
curl https://fishaudio.org/api/open/v1/profile \
-H "Authorization: Bearer FISHAUDIO_API_KEY"請勿從瀏覽器 JavaScript、行動應用程式、公共儲存庫、日誌、分析事件或客戶可見的錯誤訊息發送 API 金鑰。將 API 金鑰視為生產帳戶的密碼。
API 金鑰存儲
將 API 金鑰儲存在伺服器端秘密管理器或加密環境變數中。在進程啟動時載入它並僅將其傳遞給與 Fish Audio 通訊的 HTTP 用戶端。如果您執行後台工作人員，請透過部署平台為工作人員提供相同的秘密，而不是將其複製到作業負載中。
當團隊成員離開、建置日誌可能暴露秘密或將整合從暫存階段轉移到生產階段時，輪換 API 金鑰。輪調後，首先部署新的 API 金鑰，驗證流量，然後撤銷舊的 API 金鑰。
回應和錯誤處理
當請求到達 API 層時，驗證失敗會傳回 JSON 錯誤。
| 狀態 | 意義 | 行動 |
|---|---|---|
401 | API 金鑰遺失、格式錯誤、已撤銷或屬於已停用的帳號 | 停止重試並重新整理設定的API金鑰 |
402 | 積分或API額度不足 | 提示帳號擁有者充值或減少批次大小 |
429 | 請求受到速率限制 | 重試退避並盡可能保留原始作業 ID |
從錯誤回應中記錄 requestId。它可以讓支援人員找到確切的請求，而無需要求您共用 API 金鑰或原始有效負載。
計費和積分
身份驗證本身不消耗積分。經過身份驗證的媒體端點可以根據端點保留或消耗信用。因此，有效的 API 金鑰並不能保證產生請求會成功；您的應用程式應單獨處理餘額和配額錯誤。