Fish Audio 文档
API 文档

错误处理

Open API 错误格式、状态码和重试建议。

错误处理

请求到达 API 层后,错误通常返回 JSON。网络、CDN 或二进制传输中断可能没有相同的响应体,客户端需要同时处理 API 错误和传输错误。

{
  "code": "invalid_request",
  "message": "请求参数无效。",
  "requestId": "req_xxx"
}

状态码

状态码含义建议
400请求体、路径参数、查询参数或媒体 URL 无效修正请求后再提交
401API Key 缺失、无效、已撤销或账户不可用停止重试并更新凭据
402API 额度不足停止批次并提示充值
404当前 API Key 无权访问该资源检查账户和本地保存的 ID
409资源状态与当前操作冲突等待状态变化或解除依赖
422媒体可访问但无法处理更换输入媒体
429请求过于频繁使用指数退避重试
500服务端处理失败少量重试并记录 requestId

日志与重试

建议记录接口、HTTP 方法、状态码、coderequestId 和自己的业务任务 ID。异步请求还应记录 API 返回的任务 ID,用于恢复查询和核对计费。

可对 429 和部分 500 使用退避重试。不要直接重试 400401402。创建类请求如果没有收到响应,应先使用任务列表或任务详情确认原请求是否已被接受。

HTTP 状态码本身不能完整说明计费结果。处理客户账单问题时,应结合任务状态和最新的账户与余额进行核对。