입증
Fish Audio Open API 요청을 인증합니다.
인증
Fish Audio Open API 요청은 베어러 API 키를 사용합니다. API 키는 요청에 대한 계정, 권한 범위, 할당량 및 청구 컨텍스트를 식별합니다.
Authorization: Bearer FISHAUDIO_API_KEY계정에서 API 키를 생성하고 관리하세요.
https://fishaudio.org/en/account?section=api요청 규칙
모든 Open API 요청에는 Authorization 헤더가 포함되어야 합니다. JSON 요청에는 Content-Type: application/json도 포함되어야 합니다. 멀티파트 엔드포인트를 사용하면 HTTP 클라이언트가 멀티파트 경계를 설정할 수 있습니다.
curl https://fishaudio.org/api/open/v1/profile \
-H "Authorization: Bearer FISHAUDIO_API_KEY"브라우저 JavaScript, 모바일 앱, 공개 저장소, 로그, 분석 이벤트 또는 고객이 볼 수 있는 오류 메시지에서 API 키를 보내지 마십시오. API 키를 프로덕션 계정의 비밀번호처럼 취급하십시오.
API 키 저장소
API 키를 서버 측 비밀 관리자 또는 암호화된 환경 변수에 저장하세요. 프로세스 시작 시 이를 로드하고 Fish Audio와 통신하는 HTTP 클라이언트에만 전달합니다. 백그라운드 작업자를 실행하는 경우 작업 페이로드에 복사하는 대신 배포 플랫폼을 통해 작업자에게 동일한 암호를 제공하십시오.
팀 구성원이 떠날 때, 빌드 로그에 비밀이 노출되었을 때 또는 통합을 스테이징에서 프로덕션으로 이동할 때 API 키를 순환합니다. 교체 후 먼저 새 API 키를 배포하고 트래픽을 확인한 다음 이전 API 키를 취소합니다.
응답 및 오류 처리
요청이 API 계층에 도달하면 인증 실패로 인해 JSON 오류가 반환됩니다.
| 상태 | 의미 | 액션 |
|---|---|---|
401 | API 키가 누락되었거나, 형식이 잘못되었거나, 취소되었거나 비활성화된 계정에 속함 | 재시도를 중지하고 구성된 API 키 새로 고침 |
402 | 크레딧 또는 API 할당량이 부족합니다 | 계정 소유자에게 배치 크기를 충전하거나 줄이도록 요청 |
429 | 요청 속도가 제한되어 있습니다 | 백오프로 재시도하고 가능하면 원래 작업 ID를 유지하세요. |
오류 응답에서 requestId를 기록합니다. API 키나 원시 페이로드를 공유하도록 요청하지 않고도 지원팀에서 정확한 요청을 찾을 수 있습니다.
청구 및 크레딧
인증 자체에는 크레딧이 소모되지 않습니다. 인증된 미디어 엔드포인트는 엔드포인트에 따라 크레딧을 예약하거나 소비할 수 있습니다. 따라서 유효한 API 키는 생성 요청의 성공을 보장하지 않습니다. 애플리케이션은 잔액 및 할당량 오류를 별도로 처리해야 합니다.