Tài liệu

Tạo tài liệu

POST/templates/{id}/generations

Tạo một tài liệu bất biến: phiên bản đã lưu của mẫu với values được áp dụng. Trả về 201 cùng tài liệu, gồm Markdown, URL trang và trạng thái PDF của nó. PDF bắt đầu được kết xuất trên máy chủ của chúng tôi ngay khi tài liệu tồn tại; thường sẵn sàng trong vài giây.

Tham số

Tên	Kiểu	Mô tả
`id`bắt buộc	uuid	Id của mẫu.
`values`	object	Khóa trường ứng với giá trị; khóa nhóm ứng với mảng đối tượng bản ghi. Xem Điền các trường.
`title`	string	Tên cho tài liệu. Mặc định: tiêu đề mẫu kèm theo số thứ tự.

Yêu cầu

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" }
      ]
    }
  }'

Phản hồi

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"
}

Header Location mang URL trang của tài liệu.
Nếu cùng một yêu cầu lại đến trong vòng 10 phút, câu trả lời là tài liệu đã được tạo: HTTP 200 với replayed: true thay vì 201.
pdf_status bắt đầu ở pending và chuyển sang ready khi kết xuất xong; pdf_url là điểm cuối PDF bên dưới.