Skip to main content
POST /2.0/docgen_batchesエンドポイントを使用すると、Box Doc Genテンプレートを入力データとして使用してドキュメントを生成できます。

前提条件

Box Doc Gen APIの使用を開始する前に、ガイドに記載されている手順に従って、PlatformアプリとBox Doc Genテンプレートを作成してください。

リクエストの送信

ドキュメント (複数可) を生成するには、POST /2.0/docgen_batchesエンドポイントを使用します。

パラメータ

コールを実行するには、以下のパラメータを渡す必要があります。必須のパラメータは太字で示されています。

ユースケース

Box Doc GenテンプレートとJSONデータを準備できたら、Box Doc Gen APIにドキュメント生成のリクエストを行うことができます。 コールのサンプルは次のようになります。
リクエストが処理されている間、document_generation_data配列の各エントリは個別のドキュメント生成ジョブとして処理され、そのジョブは、Box Doc Genによってドキュメント生成キューに追加されます。 生成されたドキュメントは、指定したフォルダに保存されます。
最終更新日 2026年4月15日