Fish Audio Docs
API 參考
返回主站

輪廓

讀取並更新開放 API 帳戶資料和配額。

# 輪廓

使用設定檔端點檢查 API 金鑰擁有者的帳戶 ID、層級、積分和剩餘 API 配額。在大批次之前、重要作業之後以及操作檢查期間呼叫此端點。

取得個人資料

GET /api/open/v1/profile
Authorization: Bearer FISHAUDIO_API_KEY

### 要求

該請求不需要正文。

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

回覆

{
  "user_id": "user_123",
  "api_quota_remaining": 988000,
  "tier": "pro",
  "credits": 1200
}

將未知字段視為附加字段,並避免當回應獲得新帳戶或計費元資料時嚴格解析器失敗。

更新個人資料

POST /api/open/v1/profile
Authorization: Bearer FISHAUDIO_API_KEY
Content-Type: application/json
{
  "webhookUrl": "https://example.com/webhooks/fishspeech"
}

可更新字段由伺服器控制。未知欄位可能會被忽略或拒絕。將設定檔更新與媒體作業建立分開,以便設定檔驗證錯誤不會阻止不相關的生成工作。

計費和積分

設定檔端點是批次之前最安全的輕量級檢查。它可以顯示該帳戶是否有可能有足夠的積分或配額用於下一步操作,但它不是預訂系統。在您的支票和媒體請求之間,其他工作人員可能會消耗餘額。

對於關鍵工作流程,請使用批次 ID 儲存設定檔快照。如果作業後來因配額原因失敗,該快照可以幫助您區分先前存在的低餘額和另一個進程的並發使用情況。

錯誤

狀態意義行動
401API 金鑰無法驗證停止作業並重新整理伺服器端API金鑰
402帳戶有效,但相關操作的配額檢查失敗顯示計費或儲值狀態
500設定檔服務失敗透過退避重試少量次