AgentBodyAgentBody
ログイン

ドキュメント解析 API

BearerキーでPOST /v1/documents/parseを呼び出し、構造化JSONを取得——明確なエラーセマンティクスと5言語のサンプルコード付き。

  • 単一のRESTエンドポイント
  • シンプルな認証
  • 構造化JSONレスポンス
  • 予測可能なエラー
  • カーソルページネーション
  • べき等な再試行
ツールAPIAgent

リクエスト例

API ドキュメントを見る 完全な API リファレンス 
curl -X POST "https://api.agentbody.io/v1/documents/parse" \
  -H "Authorization: Bearer <YOUR_AGENTBODY_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"analysis_chart":"true","file_name":"YOUR_FILE_NAME","file_url":"YOUR_FILE_URL","merge_tables":"true","recognize_seal":"true","relevel_titles":"true","return_span_boxes":"true"}'

レスポンス例

OpenAPI 仕様に記載されたレスポンス。

Accepted document parse result reference.

{
  "document_id": "00000000-0000-4000-8000-000000000001",
  "get_path": "example_value",
  "pages": 1,
  "preview": "example_value"
}

機能特徴

ドキュメント解析 APIエンドポイントの技術的特性と統合方法。

単一のRESTエンドポイント

Bearer APIキーでPOST /v1/documents/parseを呼び出します。ドキュメント解析 APIは文書化されたJSONを返すため、SDKは不要で任意のHTTPクライアントで利用可能。

シンプルな認証

キーをBearerトークンとして渡します。必ずサーバー側で管理：ブラウザコード、公開リポジトリ、クライアントバンドルには含めません。

構造化JSONレスポンス

レスポンスのフィールド名は安定しており文書化されているため、パーサー、スプレッドシート、エージェントパイプラインがそのまま利用できます。

予測可能なエラー

400系はリクエストの修正、401はキーの確認、429はレート低下を意味します。一時的な5xxはバックオフ付きで安全に再試行できます。

カーソルページネーション

リスト型レスポンスにはnext_cursorとhas_moreが含まれます。cursorを変更せずそのまま渡して次ページを取得——カーソルの構築や改変はしません。

べき等な再試行

べき等キーを送信すると、繰り返しリクエストが保存済みレスポンスを再生し、二重の実行と課金を防ぎます。

使い方

ドキュメント解析 APIを6ステップで統合：キー、リクエスト、解析、エラー処理、ページネーション、監視。

01

APIキーを作成

AgentBodyアカウントを作成し、コンソールでキーを生成。サーバー環境やシークレットマネージャーに保存し、クライアントには決して送らない。

02

リクエストを構築

POST /v1/documents/parseに必須入力（リソース識別子）を付けて送信。このページのサンプルが5言語での正確な呼び出し方を示します。

03

レスポンスを解析

文書化されたJSONフィールドをアプリケーションに読み込み、製品に必要な分だけ保存します。

04

エラーを明示的に処理

400は入力修正、401はキー更新、5xxは指数バックオフで再試行。バリデーション失敗は最終的な回答であり、一時的な障害ではありません。

05

カーソルでページ送り

has_moreがtrueのとき、next_cursorを変更せず次のリクエストに渡し、必要な範囲を網羅します。

06

使用量を監視

コンソールで呼び出しとクレジットを追跡。使用量エンドポイントを使えば自社ダッシュボードにも消費を反映できます。

よくある質問

ドキュメント解析 APIとは何ですか？

認証付きRESTエンドポイント（POST /v1/documents/parse）で、構造化JSONを返します。1つのAgentBodyキーで他のすべてのエンドポイントも利用できます。

ドキュメント解析 APIの認証方法は？

Authorization: BearerヘッダーにAPIキーを渡します。キーはコンソールで作成・ローテーションし、サーバー側でのみ管理します。

ドキュメント解析 APIのレスポンスは？

成功時はフィールド名が安定した文書化済みJSONを返します。完全なリクエスト/レスポンス例はこのページとリンク先のドキュメントにあります。

ドキュメント解析 APIの料金は？

各呼び出しはアカウントのクレジットを消費します。価格はゲートウェイが管理しコンソールに表示——このページに固定数字は記載せず、コンソールが常に権威ある情報源です。

ドキュメント解析 APIはページネーションに対応していますか？

リストエンドポイントはnext_cursorとhas_moreを返し、cursorをそのまま渡して継続できます。詳細エンドポイントは単一オブジェクトを返し、ページネーションはありません。

エージェントはこのAPIを直接呼び出せますか？

はい。Agentタブのワンプロンプトインストールで公式AgentBodyスキルを入れれば、同じキーでこのエンドポイントも他のエンドポイントも呼び出せます。