認証

認証

Kitta Audio Open API リクエストはベアラー API キーを使用します。 API キーは、リクエストのアカウント、権限スコープ、クォータ、および請求コンテキストを識別します。

このプラットフォーム経由で Fish Audio モデルを利用する場合も、Kitta Audio アカウントで作成した API キーを使用してください。Kitta Audio のキーと Fish Audio 公式の 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 キーをサーバー側のシークレット マネージャーまたは暗号化された環境変数に保存します。プロセスの開始時にロードし、Kitta Audio と通信する HTTP クライアントにのみ渡します。バックグラウンド ワーカーを実行する場合は、ジョブ ペイロードにコピーするのではなく、デプロイ プラットフォームを通じて同じシークレットをワーカーに提供します。

チームメンバーが退職したとき、ビルドログに秘密が漏洩した可能性があるとき、または統合をステージングから運用環境に移行したときに、API キーをローテーションします。ローテーション後、最初に新しい API キーを展開し、トラフィックを確認してから、古い API キーを取り消します。

応答とエラーの処理

認証が失敗すると、リクエストが API レイヤーに到達すると、JSON エラーが返されます。

エラー応答から requestId をログに記録します。これにより、サポートは、API キーや生のペイロードの共有を要求することなく、正確なリクエストを見つけることができます。

請求とクレジット

認証自体はクレジットを消費しません。認証されたメディア エンドポイントは、エンドポイントに応じてクレジットを予約または消費する場合があります。したがって、有効な API キーは、生成リクエストが成功することを保証しません。アプリケーションはバランスエラーとクォータエラーを個別に処理する必要があります。