API 참조

Fish Audio Open API는 프로덕션 오디오 워크플로를 위한 서버측 인터페이스입니다. 웹 콘솔에 의존하지 않고 제품에 텍스트 음성 변환, 음성 텍스트 변환, 음성 관리 또는 립싱크 자동화가 필요한 경우 이 기능을 사용하세요.

기본 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를 유지해야 중복 작업을 만들지 않고도 클라이언트 다시 시작에서 복구할 수 있습니다.

호환성

기존 Open API 경로는 호환성 기간 동안 계속 사용할 수 있지만 새로운 통합에서는 /api/open/v1를 사용해야 합니다. 마이그레이션 가이드에는 알려진 경로 교체 및 출시 순서가 나열되어 있습니다.

해외 문서는 의도적으로 자체 현재 경로를 사용합니다. 글로벌 사이트를 통합하는 경우 https://fishaudio.org/api/open/v1 아래의 경로를 따르고 GET /api/openapi.json로 새 표면을 확인합니다.