Fish Audio Docs
API リファレンス
Back to site

プロフィール

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プロファイル サービスが失敗しましたバックオフを使用して少数回再試行します。