API リファレンス

#API リファレンス

Fish Audio Open API は、プロダクション オーディオ ワークフロー用のサーバー側インターフェイスです。 Web コンソールに依存せずに、製品でテキスト読み上げ、音声入力、音声管理、またはリップシンク自動化が必要な場合に使用します。

ベース URL:

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 を保持する必要があるため、重複した作業を作成せずにクライアントの再起動から回復できます。

互換性

従来のオープン API パスは互換性期間中も引き続き使用できますが、新しい統合では /api/open/v1 を使用する必要があります。移行ガイドには、既知のパスの置換とロールアウト順序がリストされています。

このドキュメントは意図的に独自の現在のパスを使用しています。グローバル サイトを統合する場合は、https://fishaudio.org/api/open/v1 の下のパスに従い、GET /api/openapi.json で新しいサーフェスを確認します。