Dokumente

Ein Dokument erzeugen

POST/templates/{id}/generations

Erzeugt ein unveränderliches Dokument: die gespeicherte Version der Vorlage mit angewendeten values. Antwortet 201 mit dem Dokument, einschließlich seines Markdown, der URL seiner Seite und dem Stand seines PDFs. Das PDF wird auf unseren Servern erzeugt, sobald das Dokument existiert; es ist meist innerhalb von Sekunden fertig.

Parameter

Name	Typ	Beschreibung
`id`erforderlich	uuid	Die ID der Vorlage.
`values`	object	Platzhalter-Schlüssel zu Wert; Gruppen-Schlüssel zu einem Array von Instanzobjekten. Siehe Platzhalter ausfüllen.
`title`	string	Ein Name für das Dokument. Standard: der Titel der Vorlage gefolgt von seiner Nummer.

Anfrage

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

Antwort

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

Der Location-Header trägt die URL der Dokumentseite.
Trifft dieselbe Anfrage innerhalb von 10 Minuten erneut ein, ist die Antwort das bereits erzeugte Dokument: HTTP 200 mit replayed: true statt 201.
pdf_status beginnt mit pending und wird ready, sobald das Rendern abgeschlossen ist; pdf_url ist der PDF-Endpunkt unten.