製品・APIガイド
レスポンス
返される内容
生成が成功すると、常に同じオブジェクトが返されます。保存しておきたいのは2つのフィールドです。documentIdは保存期間中のファイルを識別し、pageCountは月間請求の基準になります。
レスポンス
{
"documentId": "doc_5bd26de32c324a4bb8cffad2c80edd01",
"jobId": "job_00b96f006b034258b00b650d724d0207",
"fileName": "invoice-doc_5bd26de32c324a4bb8cffad2c80edd01.pdf",
"format": "pdf",
"templateCode": "invoice",
"templateVersion": 5,
"templateVersionSource": "published",
"downloadUrl": "/api/v1/documents/doc_5bd2.../download/pdf",
"previewUrl": null,
"pageCount": 1,
"quotaRemaining": 4999,
"meteringBasis": "pdf-equivalent",
"createdAt": "2026-08-28T13:23:32+00:00"
}生成結果は非公開で、ダウンロードにはAPIキーが必要です。有効期限付きの顧客向けリンクを意図的に作成する場合のみ、プレビューエンドポイントを使用してください。
レスポンスヘッダー
各生成レスポンスのヘッダーにも計測値を含めるため、追加の呼び出しなしで利用枠を追跡できます。
X-PDFgine-Pages | このドキュメントのページ数 |
|---|---|
X-PDFgine-Job | 生成ジョブの識別子 |
X-PDFgine-Quota-Remaining | 処理後の残りページ数 |
X-PDFgine-Metering-Basis | 計測単位 |
各フィールドの説明
pdf、docx、htmlで返されるフィールドは同じで、fileNameのみが変わります。
| フィールド | 意味 |
|---|---|
documentId | 生成ファイルの識別子です。ダウンロード、ステータス確認、共有のすべてで使用するため、保存しておくべき値です。 |
downloadUrl | APIアドレスに対する相対パスで、同じキーで取得します。公開リンクではありません。 |
templateVersion | このファイルの生成に使われたテンプレートのバージョンです。保存しておけば、数か月後の再出力の根拠を説明できます。 |
templateVersionSource | 本番生成ではpublished、purposeがeditor-testの場合はdraftです。 |
pageCount | 生成したページ数です。利用枠は、この値で集計されます。 |
quotaRemaining | このレスポンス時点での、当月の残りページ数です。 |
meteringBasis | 課金上の1ページの意味です。pdf-equivalentは、docxやhtmlの出力を、PDFにした場合と同じページ数として計算します。 |
previewUrl | ドキュメントを共有した場合のみ設定され、それ以外はnullです。 |
よくある問題
- downloadUrlはパスです。APIアドレスとキーを指定せずにブラウザーに貼り付けると、ファイルではなく404または401が返されます。
- レスポンス全体ではなくdocumentIdを保存してください。プランで定められた保存期間を過ぎるとファイルは削除され、保存したURLは何も指さなくなります。
- quotaRemainingは、その時点のスナップショットであり、リアルタイムのカウンターではありません。同時に行った2つの呼び出しが、同じ数値を読み取る場合があります。
- pageCountはファイル数ではなく、課金単位です。10ページのドキュメントは、pdfでもdocxでも10ページ分を消費します。
- previewUrlがnullでも、共有失敗ではありません。この生成結果を共有していないことを示します。共有には別の呼び出しが必要です。