Documentation Index
Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt
Use this file to discover all available pages before exploring further.
本文では、音声リンクを入力することで自分の音色を作成できる Fish Voices Generation API の接続説明を紹介します。
申請プロセス
API を使用するには、まず Fish Voices Generation API の該当ページでサービスを申請する必要があります。ページに入ったら、「Acquire」ボタンをクリックします。以下の図のように：
まだログインまたは登録していない場合は、自動的にログインページにリダイレクトされ、登録とログインを促されます。ログインまたは登録後、現在のページに自動的に戻ります。
初回申請時には無料のクレジットが付与され、この API を無料で使用できます。
基本使用
まず、基本的な使用方法を理解します。音色の音声リンク voice_url を入力することで、処理された結果を得ることができます。具体的な内容は以下の通りです：
ここでは、Request Headers を設定しています。含まれる内容は：
accept：受け取りたいレスポンス結果の形式。ここでは application/json、つまり JSON 形式を記入します。authorization：API を呼び出すためのキー。申請後、直接ドロップダウンから選択できます。
また、Request Body を設定しています。含まれる内容は：
voice_url：アップロードした音色の音声リンク。title：その音色のタイトル情報。image_urls：その音色のカバー画像。description：その音色の説明情報。callback_url：結果をコールバックするための URL。
選択後、右側にも対応するコードが生成されていることがわかります。以下の図のように：
「Try」ボタンをクリックするとテストが行えます。上の図のように、以下の結果が得られました：
{
"success": true,
"task_id": "b01db503-dd9e-4f92-861a-344f14756217",
"trace_id": "8731a2f1-7736-4a47-98e7-da942f9346a7",
"data": {
"_id": "d5d21261512b4852b9ccd709facf93f3",
"type": "tts",
"title": "test",
"description": "test",
"cover_image": "coverimage/d5d21261512b4852b9ccd709facf93f3",
"train_mode": "fast",
"state": "trained",
"tags": [],
"samples": [
{
"title": "Default Sample",
"text": "長期の観察を通じて、サンゴ礁生態系の魚類は複雑な群れ行動パターンを持つことがわかりました。彼らは色の変化や特定の泳ぎ方を利用して情報を伝達し、この精密な非言語的コミュニケーションシステムは海洋生物の適応の知恵を示しています。",
"task_id": "4ae961828fc94c07b2103dc039a8466b",
"audio": "task/4ae961828fc94c07b2103dc039a8466b.mp3"
}
],
"created_at": "2025-09-21T07:29:41.058506Z",
"updated_at": "2025-09-21T07:29:41.057917Z",
"languages": [
"zh"
],
"visibility": "public",
"lock_visibility": false,
"default_text": "長期の観察を通じて、サンゴ礁生態系の魚類は複雑な群れ行動パターンを持つことがわかりました。彼らは色の変化や特定の泳ぎ方を利用して情報を伝達し、この精密な非言語的コミュニケーションシステムは海洋生物の適応の知恵を示しています。",
"like_count": 0,
"mark_count": 0,
"shared_count": 0,
"task_count": 0,
"unliked": false,
"liked": false,
"marked": false,
"author": {
"_id": "7ecad23df62a4174acd6a2a6cb5201ee",
"nickname": "Matthew Garcia",
"avatar": "avatars/7ecad23df62a4174acd6a2a6cb5201ee.jpg"
}
}
}
success、この時の音色作成タスクの状態。
data、音楽タスクの結果
_id、この時の音色生成タスクID。以降はこのIDを使用して音声のクローン作成を行います。title、音色のタイトル。image_url、音色のカバー情報。description、音色の説明情報。train_mode、この時の音色生成タスクで使用されたモード。tags、音色のスタイル。default_text、この時の音色生成タスクの音声テキスト情報。
満足のいく音色情報が得られたことがわかります。結果の data の _id に基づいて音声クローンタスクを行うだけです。
また、対応する接続コードを生成したい場合は、生成されたものを直接コピーできます。例えば CURL のコードは以下の通りです：
curl -X POST 'https://api.xhuoapi.ai/v1/fish/voices' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
"voice_url": "https://platform.r2.fish.audio/task/604133d7b3c7430385382470f67770e8.mp3",
"title": "test",
"description": "test"
}'
非同期コールバック
Fish Voices Generation API の生成には比較的長い時間がかかります。約 1-2 分かかります。API が長時間応答しない場合、HTTP リクエストは接続を維持し続け、追加のシステムリソースを消費するため、本 API では非同期コールバックのサポートも提供しています。
全体の流れは、クライアントがリクエストを発行する際に、追加で callback_url フィールドを指定します。クライアントが API リクエストを発行すると、API はすぐに結果を返し、現在のタスク ID を示す task_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": "9f626a13-96ec-4dec-8846-dc5aab7362a8"
}
https://webhook.site/4815f79f-a40f-4078-ac85-1cc126b6bb34 で生成タスクの結果を観察できます。以下の通りです：
内容は以下の通りです：
{
"success": true,
"task_id": "9f626a13-96ec-4dec-8846-dc5aab7362a8",
"trace_id": "3fcdea82-7c1c-4a0a-b8d8-f7616f722d8f",
"data": {
"_id": "fa75e7c3f02f42e79a6aa622b6cf075e",
"type": "tts",
"title": "test",
"description": "test",
"cover_image": "coverimage/fa75e7c3f02f42e79a6aa622b6cf075e",
"train_mode": "fast",
"state": "trained",
"tags": [],
"samples": [
{
"title": "Default Sample",
"text": "イルカはエコーロケーションシステムを使って海洋をナビゲートします。この正確な音波技術により、周囲の環境を探知し、食物を探し、危険を避けることができます。これは海洋生物の適応能力を示すだけでなく、自然の素晴らしいデザインを明らかにします。",
"task_id": "68cdda24d26e4794bae177e20da740db",
"audio": "task/68cdda24d26e4794bae177e20da740db.mp3"
}
],
"created_at": "2025-09-21T07:36:20.200865Z",
"updated_at": "2025-09-21T07:36:20.200353Z",
"languages": [
"zh"
],
"visibility": "public",
"lock_visibility": false,
"default_text": "イルカはエコーロケーションシステムを使って海洋をナビゲートします。この正確な音波技術により、周囲の環境を探知し、食物を探し、危険を避けることができます。これは海洋生物の適応能力を示すだけでなく、自然の素晴らしいデザインを明らかにします。",
"like_count": 0,
"mark_count": 0,
"shared_count": 0,
"task_count": 0,
"unliked": false,
"liked": false,
"marked": false,
"author": {
"_id": "7ecad23df62a4174acd6a2a6cb5201ee",
"nickname": "Matthew Garcia",
"avatar": "avatars/7ecad23df62a4174acd6a2a6cb5201ee.jpg"
}
}
}
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"
}
