快速入门

错误

无论状态码如何，每个错误都是同一种形状。code 稳定，可放心据此分支；message 说明出了什么问题，并在有帮助时说明应改发什么；detail 在存在时指出错误涉及的参数、头或值。

JSON

{
  "error": {
    "code": "unknown_placeholder",
    "message": "No placeholder is keyed \"client\". Keys of `values` must be placeholder KEYS (the template’s placeholders[].key, e.g. \"client_name\"), not the values currently filled in and not names read out of the text. Retry with keys taken from exactly this list: \"client_name\", \"payment_terms\", \"due_date\", \"invoice_number\", \"issue_date\", \"line_items\"."
  }
}

代码	状态	含义
`unauthorized`	401	没有 bearer 令牌，或令牌无效。
`validation`	400	某个查询参数、路径参数或请求体格式不正确。detail 会指出是哪一个。
`not_found`	404	没有这样的模板或文档，或该账户无法看到它。这两种情况有意不作区分。
`template_not_saved`	409	该模板尚无已保存的版本；只有已保存的模板才能生成。
`subscription_required`	402	该工作区没有生效的方案。所有者或管理员可以在账单页面选择一个；不会丢失任何内容。
`unknown_placeholder`	422	values 中的某个键不是此模板的占位符键。消息会列出有效的键。
`unknown_group_field`	422	实例对象中的某个键不是该组的字段键。消息会列出这些字段。
`invalid_option`	422	select 类型的占位符收到了不在其选项中的值。
`invalid_number`	422	数字类型的占位符收到了非数字的内容。
`invalid_values`	422	某个占位符收到了数组，或某个组收到了字符串。
`idempotency_in_flight`	409	同一请求仍在处理中。请稍后重试。
`payload_too_large`	413	请求体超过 1 MB。
`method_not_allowed`	405	此路径不支持该方法。Allow 头列出了支持的方法。
`pdf_render_failed`	500	无法渲染该文档的 PDF。再次请求会重试。
`internal`	500	我们这边出了问题。请重试；如果持续出现，请写信给我们。