APIとWebhook

文書のアップロードと読み取りはREST APIを通じて利用できます。アカウント、フォルダー、ラベル、および接続の管理はアプリ内に残ります。

キー

設定 → 開発者向けで作成します。キーは一度のみ表示され、作成時に表示されます。その後は、そのハッシュのみが保存されるため、再表示されません。失われたキーは再発行されず、新しいキーが作成され、古いキーは削除されます。5つのキーを持つことができ、それぞれ最大2年間の有効期限があります。

新しいキーごとに、アカウントの所有者にメールが届き、キーが失効する2週間前にも同様の通知が送られます。詳細はメール通知を参照してください。

キーはX-API-Keyヘッダーで送信されます。

APIの機能

ExcelおよびPDFの結果はBase64形式で提供されます。結果が不要な場合は、includeResult=falseを送信し、サーバーでの変換を省略できます。

OpenAPI形式のインターフェースの説明は/api/docsで確認できます；このリンクはキー設定にあります。説明は稼働中のコードから生成されるため、APIの機能に一致しています。

API文書の確認

送信前の確認は、デフォルトでキーが設定された文書にも適用されます：文書はアプリ内で確認を待機し、その後にWebhookが送信されます。画面の前に誰もいない統合を構築している場合は、設定 → 送信前の確認でAPIチャネルを削除するか、確認を無効にしてください。

MCP

AIエージェント用に、サーバーMCPは/api/mcpで同じキーで利用可能です。文書の読み取りと検索は可能ですが、アップロードはできません；アップロードはエージェントが自分で実行するコマンドとして返されます。

Webhook

状態をポーリングする代わりに、完了時に結果を送信させてください。アドレスは設定 → 開発者向けでアカウント全体に設定するか、単一のアップロードでtargetWebhookUrlパラメーターを使用して設定します。設定内のボタンをクリックするとテストメッセージが送信されます。

POSTリクエストがJSON形式で送信されます：文書の識別子、ファイル名、形式、および目的の形式での結果。文書が確認を通過するか、再処理されると、Webhookが再度送信され、修正フラグ（IsCorrection）が付与されます。

メッセージには署名がありません。自分の秘密トークンをアドレスに追加して送信者を確認してください。プライベートネットワークのアドレスは拒否されます。

Webhookがすべての試行の後でも届かない場合は、約4時間半後にメールが送信されます。単一の不具合の間に一度だけ通知され、以降の失敗はアクティビティに表示されます。また、Webhookアドレスが他の誰かによって変更された場合にもメールが届きます。

配信に失敗した場合は、増加する遅延で再試行され、約4時間半で11回の試行が行われます。各試行はアクティビティに記録され、あなたの側の応答も含まれます；文書の出力には配信結果のアイコンが表示されます。

制限

APIには分あたりの呼び出し数に対する固有の上限はありません；アップロードはクレジット、プランによるファイルサイズ、1文書あたり20ページによって制限されます。拒否は400エラーと理由を示すコードで通知されます。サーバーMCPは1秒間に10回のクエリに制限されています。