変更履歴
バージョニング方針: 新しいフィールドと新しいエンドポイントは追加的であり、/api/v1/ プレフィックス配下では破壊的変更とはみなされません。既存フィールドの削除や意味の変更はv2になります。つまり、以下の各エントリは「新機能のお知らせ」であり、「統合が壊れる可能性のお知らせ」ではないとお考えください。
2026-09-26
- アドホックな
fieldsのformat_requirementが適用されるようになりました。POST /batches/{batch_name}/processをfields（template_idなし）で呼び出した場合、各フィールドのformat_requirementは抽出前に破棄され、ドキュメントに印刷された通りの値が返されていました。現在はモデルに渡され、ドキュメントのアップロード時に指定されたテンプレートよりも優先されます。保存済みテンプレートには影響ありません。Batches リファレンスをご覧ください。 POST /documentsは、50文字を超えるbatch_nameを400 invalid_parameterで拒否するようになりました。 以前はこのような名前は500エラーになるか、PDFアップロード時に誤解を招く「Failed to render PDF.」というエラーになっていました。
2026-09-14
PUT /templates/{id}/settingsを追加しました。テンプレートのグローバルなフォーマット要件とMulti-Page Merge設定（同じレコードに属する複数のアップロードページ — 複数ページのリースやホチキス止めされたレシートの束 — を1つの出力行にまとめるかどうか）を設定します。すべてのテンプレートエンドポイントが返すTemplateオブジェクトにも、global_format_requirementとすべてのmerge_*フィールドが含まれるようになりました。Templates & Fieldsリファレンスをご覧ください。GET /batches/{batch_name}/resultsが?merge=trueをサポートするようになりました。バッチの解決済みテンプレートのMulti-Page Merge設定があればそれを適用します — マージされたレコードに折り込まれるドキュメントには、通常のdocument_idに加えて新しいsource_document_idsフィールドが付与され、レスポンスにはトップレベルのmerge_activeフィールドが追加されます。デフォルトはfalseのままです：このエンドポイントはMulti-Page Mergeより前に存在するため、既存の統合では明示的にオプトインしない限り、アップロードされたドキュメントごとに1つのエントリが引き続き表示されます。include=bboxとは併用できません。GET /batches/{batch_name}/exportはこの変更前からマージを無条件に適用しており、影響を受けません。Batchesリファレンスをご覧ください。POST /batches/{batch_name}/processのクレジット計算でModel Tierが正しく反映されるようになりました。AdvancedまたはPremium（ドキュメントあたりStandardクレジットコストの3倍/6倍）が割り当てられたアカウントでは、処理時の控除と、キャンセルまたは失敗したドキュメントのその後の返金の両方にそのレートが一貫して適用されるようになりました — 以前は、返金が実行される時点でImageUpload行がすでに削除されていたドキュメントはStandardレートで返金される可能性があり、非Standardアカウントへの返金が不足していました。GET /account/usageの非Standardの控除/返金エントリには、単純な名前ではなくティア接尾辞付きのaction（deduction_advanced、deduction_premium）が付与されるようになりました。Model Tier自体は新しいものではなく、リクエストレベルで選択または上書きする方法もまだありません — このエントリは新しい機能ではなく、会計処理が正しく可視化されたことに関するものです。Account Settings & API BehaviorガイドとAccountリファレンスをご覧ください。
2026-08-04
- ポーリング統合のための
GET /eventsを追加しました。イベントフィードはbatch.completed、document.completed、document.failedイベントを 新しい順に返し、Zapierスタイルの重複排除用に安定したイベントIDを提供します。詳細は Webhooks リファレンスをご覧ください。
2026-07-22
POST /templatesでアカウントごとのテンプレート上限が30件に設定されました。上限に達すると、 別のテンプレート（ゼロからまたはプリセットから）を作成しようとすると400 template_limit_reachedが返されます — 先に既存のテンプレートを削除してください。この制限は以前は適用されていませんでした。詳細は Templates & Fieldsリファレンスをご覧ください。
2026-07-21
POST /documentsでWord（.docx）およびプレーンテキスト（.txt） ファイルが受け付けられるようになりました（画像とPDFのみだった以前から変更）。どちらもサーバー側でPDFに変換され、 ネイティブPDFアップロードとまったく同じページごとの分割に従います — 複数ページの.docxは ページごとに1つのDocumentを生成します（現在のPDFの動作と同じ）。レガシーバイナリ.doc形式はサポートされていません。 先に.docxとして保存してください。詳細はDocuments リファレンスをご覧ください。- アップロードごとのページ上限が30ページから50ページに引き上げられました。ネイティブPDFアップロードと サーバー側で変換される
.docx/.txtファイルの両方に適用されます。詳細は Documentsリファレンスをご覧ください。 GET /documents/{document_id}/imageで?size=thumbがサポートされました。 ページ画像の小さな事前生成バージョンを取得でき、リスト/グリッドビューでフル解像度のページよりも速く読み込めます。 そのドキュメントのサムネイルが生成されていない場合はフル画像にフォールバックします（エラーにはなりません）。詳細は Documents リファレンスをご覧ください。
2026-07-20
- バッチWebhooksは、バッチを再処理すると自動的に再アームされるようになりました。すでに通知済みのバッチにドキュメントを追加して
processを再度呼び出すと、新しい処理が完了した際に再度通知が届きます — Webhookを再PUTする必要はありません。Webhooks ガイドをご覧ください。現在、各処理の前にWebhookを再登録する回避策を取っている場合、その呼び出しは実際には何も再アームしていなかったため、停止しても問題ありません。 - BboxアノテーションジョブがWebhookイベントを配信するようになりました。bboxジョブが終了ステータスに達すると、ドキュメントのバッチWebhookで
document.bbox_completedイベントが発生します — 以前は登録に関係なく、bbox完了時に通知は一切生成されませんでした。Webhooks ガイドをご覧ください。 remaining_batch_capacityがPOST /documentsレスポンスに追加されました。GET /accountを別途呼び出さずに、プランの最大バッチサイズに達するまでこのバッチが受け入れられる追加ドキュメント数を確認できます。document.bbox_completedの配信は、batch.completedと同様にアトミックにクレームされるようになりました。行グループが別々のスレッドでほぼ同時に完了した場合、論理的には1つの完了であるにもかかわらず、2つの別々の配信が発生することがありましたが、これは解消されるはずです。これらのイベントをdata.group_batch_idで重複排除していた場合、その回避策を続けても問題ありません。
2026-07-16
- v1 APIがリリースされました。
table（構造化フィールド抽出）処理モード向けに、Documents、Batches、Templates & Fields、Webhooks、Accountリソースをカバーする/api/v1/が公開されました。API概要で使い始められます。