メインコンテンツへスキップ
本文では、Fish Audios Generation API 接続説明を紹介します。これは、入力プロンプトを通じて自分の音色をクローンすることができます。

申請プロセス

APIを使用するには、まず Fish Audios Generation API の該当ページでサービスを申請する必要があります。ページに入ったら、「Acquire」ボタンをクリックします。以下の図のように: まだログインまたは登録していない場合は、自動的にログインページにリダイレクトされ、登録とログインを促されます。ログインまたは登録後、現在のページに自動的に戻ります。 初回申請時には無料のクレジットが付与され、このAPIを無料で使用できます。

基本使用

まず、基本的な使用方法を理解します。プロンプト prompt、クローンアクション action、音色ID voice_id、およびモデル model を入力することで、処理された結果を得ることができます。まず、action フィールドを簡単に渡す必要があり、その値は generate です。次に、モデル model を入力する必要があります。現在、主に fish-tts モデルがあります。具体的な内容は以下の通りです:

ここでは、リクエストヘッダーを設定しています。これには以下が含まれます:
  • accept:受け取りたいレスポンス結果の形式。ここでは application/json、つまりJSON形式を記入します。
  • authorization:APIを呼び出すためのキー。申請後、直接ドロップダウンから選択できます。
また、リクエストボディを設定しています。これには以下が含まれます:
  • model:音声をクローンするためのモデル。主に fish-tts モデルがあります。
  • action:今回の音声クローンタスクのアクション。
  • prompt:クローンするプロンプト。
  • voice_id:音色IDに基づいてクローンします。
  • callback_url:結果をコールバックするURL。
選択後、右側にも対応するコードが生成されていることがわかります。以下の図のように:

「Try」ボタンをクリックするとテストが行えます。上の図のように、以下の結果が得られました:
{
  "success": true,
  "task_id": "5872ab00-3cf4-4040-a798-8510aaa16756",
  "trace_id": "5eda3694-448a-4b72-af33-2acb3851ffe1",
  "data": [
    {
      "audio_url": "https://platform.r2.fish.audio/task/8a72ff9840234006a9f74cb2fa04f978.mp3"
    }
  ]
}
返された結果には複数のフィールドがあり、以下のように説明されます:
  • success:この時点での音声クローンタスクの状態。
    • data:音声クローンタスクの結果
      • audio_url:この時点での音声クローンタスクの音声リンク結果。
満足のいく音声情報が得られたことがわかります。結果の data の音楽リンクアドレスに基づいてクローンされた音声を取得するだけです。 また、対応する接続コードを生成したい場合は、生成されたものを直接コピーできます。例えば、CURLのコードは以下の通りです:
curl -X POST 'https://api.acedata.cloud/fish/audios' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "action": "speech",
  "prompt": "a white siamese cat",
  "model": "fish-tts",
  "voice_id": "d7900c21663f485ab63ebdb7e5905036"
}'

非同期コールバック

Fish Audios Generation APIの生成には比較的長い時間がかかります。約1〜2分かかります。APIが長時間応答しない場合、HTTPリクエストは接続を維持し続け、追加のシステムリソースを消費します。そのため、本APIは非同期コールバックのサポートも提供しています。 全体の流れは次の通りです:クライアントがリクエストを発行する際に、追加で callback_url フィールドを指定します。クライアントがAPIリクエストを発行した後、APIはすぐに結果を返し、task_id フィールド情報を含み、現在のタスクIDを示します。タスクが完了すると、生成タスクの結果がPOST JSON形式でクライアントが指定した callback_url に送信され、その中にも task_id フィールドが含まれます。これにより、タスク結果をIDで関連付けることができます。 以下の例を通じて、具体的にどのように操作するかを理解しましょう。 まず、WebhookコールバックはHTTPリクエストを受信できるサービスです。開発者は自分が構築したHTTPサーバーのURLに置き換える必要があります。ここでは、デモのために公開のWebhookサンプルサイト https://webhook.site/ を使用します。このサイトを開くとWebhook URLが得られます。以下の図のように: このURLをコピーすればWebhookとして使用できます。このサンプルは https://webhook.site/4815f79f-a40f-4078-ac85-1cc126b6bb34 です。 次に、フィールド callback_url を上記のWebhook URLに設定し、対応するパラメータを入力します。具体的な内容は以下の図のように:

実行をクリックすると、すぐに結果が得られます。以下のように:
{
  "task_id": "2725a2d3-f87e-4905-9c53-9988d5a7b2f5"
}
少し待つと、https://webhook.site/4815f79f-a40f-4078-ac85-1cc126b6bb34 で生成タスクの結果を確認できます。以下の図のように: 内容は以下の通りです:
{
    "success": true,
    "task_id": "2725a2d3-f87e-4905-9c53-9988d5a7b2f5",
    "trace_id": "e2d308bc-4df8-4c69-9369-a60f3c54f2b3",
    "data": [
        {
            "audio_url": "https://platform.r2.fish.audio/task/b627c2f7d38a4083a837570ba6d0962f.mp3"
        }
    ]
}
結果には task_id フィールドがあり、他のフィールドは上記と似ています。このフィールドを通じてタスクの関連付けが可能です。

エラーハンドリング

APIを呼び出す際にエラーが発生した場合、APIは対応するエラーコードと情報を返します。例えば:
  • 400 token_mismatched:不正なリクエスト、パラメータが不足または無効な可能性があります。
  • 400 api_not_implemented:不正なリクエスト、パラメータが不足または無効な可能性があります。
  • 401 invalid_token:未認証、無効または不足している認証トークン。
  • 429 too_many_requests:リクエストが多すぎます、レート制限を超えました。
  • 500 api_error:内部サーバーエラー、サーバーで何かがうまくいきませんでした。

エラー応答の例

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

結論

この文書を通じて、Fish Audios Generation APIを使用して入力プロンプトを通じて音声をクローンする方法を理解したことでしょう。この文書が、APIの接続と使用をより良くする手助けとなることを願っています。ご不明な点がございましたら、いつでも当社の技術サポートチームにお問い合わせください。