快速入门

错误

出错时，API 会返回相应的 HTTP 状态码，响应体的 error 中包含 code 和 message。

请在程序中使用 code 进行判断。message 是帮助调试的英文文本，内容可能会变化。

错误格式404

{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}

缺少密钥401

{
  "error": {
    "code": "missing_api_key",
    "message": "Send your API key in the X-API-Key header or as Authorization: Bearer <key>."
  }
}

错误代码

状态	代码	何时出现
400	`key_in_query`	密钥是通过 URL 发送的（参数 `api_key`、`apikey`、`key` 或 `token`）。请改为通过请求头发送，并生成一个新密钥，因为旧密钥可能已被记录在日志中。
400	`invalid_parameter`	某个参数的值无效，例如 `per_page` 超过最大值。
401	`missing_api_key`	请求中没有携带密钥。
401	`invalid_api_key`	密钥不存在、已被撤销，或其所属用户已被停用。
404	`not_found`	端点不存在，或者项目不存在，或者项目属于该用户无权查看的组织。
404	`organization_not_found`	传入的 `organization` 不是该用户可以查看此类项目的组织。
405	`method_not_allowed`	API 仅接受 `GET`（以及 `HEAD`）请求。
429	`rate_limited`	已达到请求频率限制。请等待 `Retry-After` 中指定的秒数。
500	`server_error`	内部错误。请稍后重试；如果问题持续存在，请联系支持人员。

只有在收到 429（并等待 Retry-After 指定的时间）或 500 之后，才值得重新发送相同的请求。其他错误都需要修正请求或密钥。