Documents

Générer un document

POST/templates/{id}/generations

Crée un document immuable : la version enregistrée du modèle avec values appliqué. Répond 201 avec le document, y compris son Markdown, l’URL de sa page et l’état de son PDF. Le PDF commence à être produit sur nos serveurs dès que le document existe ; il est généralement prêt en quelques secondes.

Paramètres

Nom	Type	Description
`id`obligatoire	uuid	L’identifiant du modèle.
`values`	object	Clé du champ vers valeur ; clé du groupe vers un tableau d’objets d’instance. Voir Remplir les champs.
`title`	string	Un nom pour le document. Par défaut : le titre du modèle suivi de son numéro.

Requête

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

Réponse

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

L’en-tête Location porte l’URL de la page du document.
Si la même requête arrive de nouveau dans les 10 minutes, la réponse est le document déjà généré : HTTP 200 avec replayed: true au lieu de 201.
pdf_status commence à pending et passe à ready une fois le rendu terminé ; pdf_url est le point d’accès PDF ci-dessous.