Dokumente

Das PDF abrufen

GET/generations/{id}/pdf

Das PDF des Dokuments, einmal auf unseren Servern erzeugt, als kurzlebige Download-URL. Ist noch nichts gespeichert, erzeugt der Aufruf es bei Bedarf und antwortet, sobald es fertig ist, meist innerhalb weniger Sekunden; läuft anderswo bereits ein Rendern, antwortet er 202, und Sie fragen kurz darauf erneut.

Parameter

Name	Typ	Beschreibung
`id`erforderlich	uuid	Die ID des Dokuments.
`download`	1	Macht die URL zu einem Anhang, der nach dem Dokument benannt ist.
`redirect`	1	Antwortet mit einem 302 zur URL statt mit JSON.

Anfrage

curl "https://usepaperclerk.com/api/v1/generations/9b8e2f10-5c4d-4e3f-8a7b-6c5d4e3f2a1b/pdf?download=1" \
  -H "Authorization: Bearer pc_YOUR_TOKEN"

Antwort

JSON

{
  "status": "ready",
  "url": "https://…/generation-pdfs/…/9b8e2f10-5c4d-4e3f-8a7b-6c5d4e3f2a1b.pdf?token=…",
  "pages": 2,
  "expires_in": 60
}

Die URL funktioniert nach expires_in Sekunden nicht mehr. Fordern Sie eine neue an, statt sie zu speichern.
Ein fehlgeschlagenes Rendern antwortet 500 mit pdf_render_failed; erneutes Anfordern versucht es noch einmal.