Antwort · PDFgine

Die Antwort

Jede erfolgreiche Erstellung antwortet mit demselben Objekt. Zwei Felder sollten Sie aufbewahren: documentId identifiziert die Datei während ihrer Aufbewahrung, und pageCount bildet die Grundlage der Monatsabrechnung.

Antwort

{
  "documentId": "doc_5bd26de32c324a4bb8cffad2c80edd01",
  "jobId": "job_00b96f006b034258b00b650d724d0207",
  "fileName": "invoice-doc_5bd26de32c324a4bb8cffad2c80edd01.pdf",
  "format": "pdf",
  "templateCode": "invoice",
  "templateVersion": 5,
  "templateVersionSource": "published",
  "downloadUrl": "/api/v1/documents/doc_5bd2.../download/pdf",
  "previewUrl": null,
  "pageCount": 1,
  "quotaRemaining": 4999,
  "meteringBasis": "pdf-equivalent",
  "createdAt": "2026-08-28T13:23:32+00:00"
}

Eine Erstellung bleibt privat und ihr Download erfordert Ihren API-Schlüssel. Verwenden Sie den Vorschauendpunkt nur, wenn Sie bewusst einen befristeten Kundenlink benötigen.

Antwortheader

Jede Erstellungsantwort wiederholt die Verbrauchswerte in ihren Headern. So verfolgen Sie das Kontingent ohne zusätzlichen Aufruf.

`X-PDFgine-Pages`	Seitenzahl dieses Dokuments
`X-PDFgine-Job`	Kennung des Erstellungsauftrags
`X-PDFgine-Quota-Remaining`	Verbleibende Seiten nach dem Vorgang
`X-PDFgine-Metering-Basis`	Messeinheit

Feld für Feld

Für pdf, docx und html werden dieselben Felder zurückgegeben; nur fileName ändert sich.

Feld	Bedeutung
`documentId`	Die Kennung der erstellten Datei. Downloads, Status und Freigaben verwenden sie. Dieser Wert sollte daher gespeichert werden.
`downloadUrl`	Relativ zur API-Adresse und mit demselben Schlüssel abgerufen. Es ist ein Pfad, kein öffentlicher Link.
`templateVersion`	Die Vorlagenversion, mit der diese Datei erstellt wurde. Bewahren Sie sie auf, um einen erneuten Ausdruck Monate später nachvollziehen zu können.
`templateVersionSource`	published bei einer Produktionserstellung, draft bei purpose editor-test.
`pageCount`	Anzahl erstellter Seiten; diese werden vom Kontingent gezählt.
`quotaRemaining`	Verbleibende Seiten im aktuellen Monat zum Zeitpunkt dieser Antwort.
`meteringBasis`	Bedeutung einer Seite für die Abrechnung. pdf-equivalent zählt docx- oder html-Ausgaben mit derselben Seitenzahl wie das entsprechende PDF.
`previewUrl`	Nur bei geteilten Dokumenten ausgefüllt; andernfalls null.

Häufige Fehler

downloadUrl ist ein Pfad. Ohne API-Adresse und Schlüssel in einen Browser eingefügt liefert er 404 oder 401 statt der Datei.
Speichern Sie documentId, nicht die gesamte Antwort. Dateien werden nach der tarifabhängigen Aufbewahrungszeit entfernt; eine gespeicherte URL zeigt dann ins Leere.
quotaRemaining ist eine Momentaufnahme, kein Live-Zähler. Zwei gleichzeitige Aufrufe können denselben Wert lesen.
pageCount ist die Abrechnungseinheit, nicht die Anzahl der Dateien. Ein zehnseitiges Dokument kostet zehn Seiten, ob als pdf oder docx.
previewUrl mit null bedeutet nicht, dass die Freigabe fehlgeschlagen ist. Diese Erstellung wurde nicht geteilt. Die Freigabe erfolgt mit einem separaten Aufruf.