> ## 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 Audios Generation API 對接說明
> Fish music generation 集成指南 - XHuoAPI
本文將介紹一種 Fish Audios Generation API 對接說明，它是可以透過輸入提示詞來克隆自己的音色。
## 申請流程
要使用 API，需要先到 [Fish Audios Generation API](https://api.xhuoapi.ai/documents/e681b715-54fd-4464-a59a-d7f14500e095) 對應頁面申請對應的服務，進入頁面之後，點擊「Acquire」按鈕，如圖所示：
如果你尚未登入或註冊，會自動跳轉到登入頁面邀請您來註冊和登入，登入註冊之後會自動返回當前頁面。
在首次申請時會有免費額度贈送，可以免費使用該 API。
## 基本使用
首先先了解下基本的使用方式，就是輸入提示詞 `prompt`、 克隆行為 `action`、音色ID `voice_id` 以及模型 `model`，便可獲得處理後的結果，首先需要簡單地傳遞一個 `action` 欄位，它的值為 `generate`，然後我們還需要輸入模型 `model`，目前主要有 `fish-tts` 模型，具體的內容如下：
可以看到這裡我們設定了 Request Headers，包括：
* `accept`：想要接收怎樣格式的響應結果，這裡填寫為 `application/json`，即 JSON 格式。
* `authorization`：調用 API 的密鑰，申請之後可以直接下拉選擇。
另外設定了 Request Body，包括：
* `model`：克隆聲音的模型，主要有 `fish-tts` 模型。
* `action`：此次聲音克隆任務的行為。
* `prompt`：需要克隆的提示詞。
* `voice_id`：根據音色ID來進行克隆。
* `callback_url`：需要回調結果的URL。
選擇之後，可以發現右側也生成了對應代碼，如圖所示：
點擊「Try」按鈕即可進行測試，如上圖所示，這裡我們就得到了如下結果：
```json theme={null}
{
"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 的代碼如下：
```shell theme={null}
curl -X POST 'https://api.xhuoapi.ai/v1/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/，打開該網站即可得到一個](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` 上觀察到生成任務的結果，如圖所示：
內容如下：
```json theme={null}
{
"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`：Bad request, possibly due to missing or invalid parameters.
* `400 api_not_implemented`：Bad request, possibly due to missing or invalid parameters.
* `401 invalid_token`：Unauthorized, invalid or missing authorization token.
* `429 too_many_requests`：Too many requests, you have exceeded the rate limit.
* `500 api_error`：Internal server error, something went wrong on the server.
### 錯誤響應示例
```json theme={null}
{
"success": false,
"error": {
"code": "api_error",
"message": "fetch failed"
},
"trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```
## 結論
通过本文档，您已经了解了如何使用 Fish Audios Generation API 可通过输入提示词来克隆声音。希望本文档能帮助您更好地对接和使用该 API。如有任何问题，请随时联系我们的技术支持团队。