はじめに

エラー

ステータスにかかわらず、すべてのエラーは同じ形をしています。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	こちら側で問題が発生しました。再試行し、続く場合はご連絡ください。