API概要

ImageToTable.aiのv1 APIは、請求書、領収書、銀行取引明細書、注文書などの実在する書類の写真、スキャン、PDFから構造化データを抽出し、JSONで返します。このページでは、これらのドキュメントの基礎となる4つのリソースを紹介します。

核となる概念

4つのリソースがAPIの全範囲をカバーしています。リファレンスセクションのすべてのエンドポイントは、これらのいずれかを操作します。

• ドキュメント — 処理された1ページを表します。画像をアップロードするか、PDFページをアップロードすることで作成されます（複数ページのPDFをアップロードすると、ページごとに複数のドキュメントが生成されます。詳細はドキュメントリファレンスを参照）。ドキュメントはステータスライフサイクル（queued → processing → succeeded / failed / canceled）を経て進行します。詳細は非同期タスクモデルガイドで説明しています。
• バッチ — 一緒にアップロードおよび処理されるドキュメントの名前付きグループです。各ドキュメントは、batch_name（ユーザーが指定するか、アップロード時にAPIが自動生成する文字列）で識別される、1つのバッチに属します。処理の開始、ステータスの確認、結果の取得はバッチレベルで行います。
• テンプレート — 毎回抽出したいフィールドのセットを保存して再利用できるものです（例：invoice_number、vendor_name、total_amountを含む「仕入先請求書」テンプレート）。テンプレートを使用すると、process呼び出しのたびに同じフィールドを再宣言する手間が省けます。
• フィールド — ドキュメントから抽出したい単一の名前付きの値です（請求書番号、日付、明細金額など）。フィールドはテンプレート上に配置するか、テンプレートを作成せずに単一のprocess呼び出しでインラインで1回限り宣言することもできます。

各要素の関係

バッチに1つ以上のファイルをアップロードすると、各アップロードがドキュメントになります。その後、バッチの処理を開始し、取得したいフィールドをAPIに指定します。保存済みのテンプレートを指定するか、リクエスト本文にフィールドを直接列挙します。どちらも指定しない場合、APIは適切な列を自動的に推論します。処理が完了したら、バッチの結果を取得します。各ドキュメントには、フィールド名をキーとするline_itemsオブジェクトの配列が含まれています。

JSONが基本形式です

JSONは、すべてのエンドポイントで完全にサポートされている標準のレスポンス形式です。Excel（.xlsx）およびWord（.docx）へのエクスポートは、同じデータに対する便利なダウンロード機能として存在します（バッチリファレンスを参照）。これらは別のデータモデルではなく、API連携はJSON形式に基づいて構築する必要があります。

認証とアクセス

すべてのv1リクエストは、Authorization: Bearer <key>として送信されるAPIキーで認証されます。同じブラウザからログインしている場合でも、セッションクッキーによるフォールバックはありません。v1 APIは有料プラン（Basic以上、Growth以上のチームを含む）で利用可能です。無料プランのアカウントにはplan_requiredエラーが返されます。APIキーの確認場所については、環境設定を参照してください。

次のステップ

最初の呼び出しを行う準備はできましたか？クイックスタートでは、キーの取得、ドキュメントのアップロード、処理の開始、結果の取得までを約5分で説明しています。全エンドポイントの一覧は、APIリファレンスを参照してください。AIコーディングアシスタントを使用して連携する場合は、OpenAPI 3.1仕様を直接指定してください。これはすべてのリファレンスページの背後にある同じスキーマであり、機械可読な形式で一貫しています。