Docs错误码

错误码 (Errors)

FindIP API 使用标准 HTTP 状态码,并返回包含错误详情的 JSON 响应。

错误响应结构

所有错误响应均遵循以下结构:

JSON
{
"detail": "可读的错误信息"
}

HTTP 状态码

成功

代码状态说明
200OK请求成功。
300Multiple Choices文档 ID 匹配多个专利。(参阅文档详情 API)

客户端错误

代码状态说明
400Bad Request请求格式错误。缺少必填字段(如 query)或参数类型/取值错误。
401Unauthorized缺少或无效的 API 密钥。请检查 Authorization 头。
403ForbiddenAPI 密钥有效但无此操作权限。
404Not Found请求的资源不存在(例如:不存在的文档 ID)。
429Too Many Requests已超过月度检索额度,或触发每分钟 60 次的速率限制。请升级套餐或等待下个结算周期重置。

服务器错误

代码状态说明
500Internal Server Error服务器发生未预期错误。请稍后重试。
503Service Unavailable服务器暂时不可用(维护或负载过高)。

常见错误场景

API 密钥缺失或错误

401 Unauthorized
{
"detail": "Invalid API key"
}

请确认请求中包含 Authorization: Bearer psk_live_xxx 头。

超过月度检索额度

429 Too Many Requests
{
"detail": "Monthly limit exceeded"
}

已达到月度检索额度。额度按结算日每月自动重置。详情查询、附图、编号查询不计入额度。请在使用量仪表盘查看当前状态。

缺少必填字段

400 Bad Request
{
"detail": "Field 'query' is required"
}

文档未找到

404 Not Found
{
"detail": "Document not found"
}

请检查 publication_id 的格式。必须使用包含国家代码的完整 ID(例如 US12261291B2,而非 12261291)。

错误处理最佳实践

  1. 解析响应 body 之前,务必先检查 HTTP 状态码。
  2. 遇到 429500 时,使用指数退避 (Exponential Backoff) 重试。
  3. 出于排错目的,记录完整错误响应日志。detail 字段包含定位原因的关键信息。
  4. 收到 300 Multiple Choices 时,将候选清单展示给用户以供选择。
  5. 设置合理的请求超时(检索 30 秒,其他端点建议 10 秒)。
FindIP | Semantic Patent Search