ドキュメント

ドキュメントの生成

POST/templates/{id}/generations

不変のドキュメントを作成します。テンプレートの保存済みバージョンに values を適用したものです。Markdown、ページの URL、PDF の状態を含むドキュメントを 201 で返します。ドキュメントが存在した瞬間からこちらのサーバーで PDF の生成が始まり、通常は数秒で準備が整います。

パラメータ

名前	型	説明
`id`必須	uuid	テンプレートの ID。
`values`	object	プレースホルダーのキーには値、グループのキーにはインスタンスオブジェクトの配列。「プレースホルダーの入力」を参照してください。
`title`	string	ドキュメントの名前。既定はテンプレートのタイトルに番号を続けたものです。

リクエスト

curl -X POST https://usepaperclerk.com/api/v1/templates/4d1f0c2e-7b3a-4c1e-9d2f-1a2b3c4d5e6f/generations \
  -H "Authorization: Bearer pc_YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Invoice — Maple & Fern, September",
    "values": {
      "client_name": "Maple & Fern Ltd.",
      "payment_terms": "Net 15",
      "due_date": "10/15/2026",
      "line_items": [
        { "item": "Brand identity system", "quantity": "1", "amount": "4800" },
        { "item": "Brand guidelines document", "quantity": "1", "amount": "1200" }
      ]
    }
  }'

レスポンス

JSON

HTTP/1.1 201 Created
Location: https://usepaperclerk.com/app/generated/9b8e2f10-5c4d-4e3f-8a7b-6c5d4e3f2a1b

{
  "id": "9b8e2f10-5c4d-4e3f-8a7b-6c5d4e3f2a1b",
  "template_id": "4d1f0c2e-7b3a-4c1e-9d2f-1a2b3c4d5e6f",
  "title": "Invoice — Maple & Fern, September",
  "generation_number": 13,
  "source": "api",
  "source_version": 3,
  "created_at": "2026-09-12T14:02:11.480Z",
  "markdown": "# Invoice — Maple & Fern, September\n\nInvoice INV-0013 for Maple & Fern Ltd. …",
  "html": "<div class=\"doc-page\" …>…</div>",
  "html_truncated": false,
  "url": "https://usepaperclerk.com/app/generated/9b8e2f10-5c4d-4e3f-8a7b-6c5d4e3f2a1b",
  "pdf_status": "pending",
  "pdf_url": "https://usepaperclerk.com/api/v1/generations/9b8e2f10-5c4d-4e3f-8a7b-6c5d4e3f2a1b/pdf"
}

Location ヘッダーにドキュメントのページ URL が入ります。
同じリクエストが 10 分以内に再び届いた場合、応答はすでに生成されたドキュメントで、201 ではなく HTTP 200 と replayed: true になります。
pdf_status は pending から始まり、レンダリングが完了すると ready になります。pdf_url は下の PDF エンドポイントです。