API 참조
오류
공통 Open API 오류 모양 및 상태 코드입니다.
오류
요청이 API 계층에 도달하면 공개 API 오류는 JSON 응답 본문을 사용합니다. 네트워크 오류, CDN 오류 및 바이너리 응답 중단은 정확한 형태가 아닐 수 있으므로 클라이언트는 구조화된 API 오류와 전송 오류를 모두 처리해야 합니다.
모든 엔드포인트는 동일한 전달자 인증 컨텍스트를 사용합니다.
Authorization: Bearer FISHAUDIO_API_KEY{
"code": "invalid_request",
"message": "The request payload is invalid.",
"requestId": "req_xxx"
}상태 코드
| 상태 | 의미 | 일반적인 조치 |
|---|---|---|
400 | 잘못된 요청 본문, 경로 매개변수, 쿼리 매개변수 또는 미디어 URL | 재시도하기 전에 요청을 수정하세요 |
401 | API 키 누락, 잘못된 형식, 해지 또는 비활성화됨 | 재시도 중지 및 자격 증명 새로 고침 |
402 | 부족한 크레딧, API 할당량 또는 공급자 할당 | 일괄 처리를 중지하고 청구 상태 표시 |
404 | 인증된 계정의 리소스 ID를 알 수 없습니다 | 로컬 기록 새로 고침 |
409 | 리소스가 작업과 충돌하는 상태입니다. | 종속성을 기다리거나 제거 |
422 | 미디어가 승인되었지만 처리할 수 없습니다 | 다른 입력 미디어 요청 |
429 | 속도 제한이 초과되었습니다 | 지수 백오프로 재시도 |
500 | 서버 오류 | 몇 번 다시 시도하고 requestId |
요청 로깅
엔드포인트, HTTP 메소드, 상태, code, requestId 및 자체 내부 작업 ID를 기록하십시오. 개인 정보 보호 정책 및 지원 워크플로에서 명시적으로 허용하지 않는 한 전달자 API 키, 전체 사용자 텍스트 또는 개인 미디어 URL을 기록하지 마십시오.
비동기 엔드포인트의 경우 로그에 API 작업 ID와 내부 데이터베이스 ID를 모두 포함합니다. 따라서 중복 작업을 생성하지 않고도 재시도를 조정할 수 있습니다.
청구 및 크레딧
모든 오류가 동일한 청구 의미를 갖는 것은 아닙니다. 검증 실패는 일반적으로 미디어 작업이 시작되기 전에 발생합니다. 작업이 승인된 후 처리 실패가 발생할 수 있습니다. 사용자가 청구하는 질문의 경우 HTTP 상태만으로 비용을 추론하는 대신 작업 상태를 새로운 프로필 읽기와 비교하세요.
재시도 정책
백오프를 사용하여 429 및 일부 500 응답을 재시도하세요. 400, 401 또는 402를 맹목적으로 재시도하지 마세요. 요청, 자격 증명 또는 청구 변경이 필요한 경우. 엔드포인트를 생성하려면 후속 작업을 다시 시도하기 전에 반환된 ID를 유지하세요.