> ## 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는 입력된 프롬프트를 통해 자신의 음색을 복제할 수 있습니다.
## 신청 절차
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는 즉시 결과를 반환하며, 여기에는 현재 작업 ID를 나타내는 `task_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`: 잘못된 요청, 누락되거나 잘못된 매개변수 때문일 수 있습니다.
* `400 api_not_implemented`: 잘못된 요청, 누락되거나 잘못된 매개변수 때문일 수 있습니다.
* `401 invalid_token`: 권한 없음, 잘못되었거나 누락된 인증 토큰입니다.
* `429 too_many_requests`: 너무 많은 요청, 비율 제한을 초과했습니다.
* `500 api_error`: 내부 서버 오류, 서버에서 문제가 발생했습니다.
### 오류 응답 예시
```json theme={null}
{
"success": false,
"error": {
"code": "api_error",
"message": "fetch failed"
},
"trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```
## 결론
본 문서를 통해 Fish Audios Generation API를 사용하여 입력 프롬프트를 통해 음성을 복제하는 방법을 이해하셨습니다. 본 문서가 귀하가 해당 API를 더 잘 연동하고 사용하는 데 도움이 되기를 바랍니다. 질문이 있으시면 언제든지 저희 기술 지원 팀에 문의해 주십시오.