Dokument-zu-PDF-API#
Die Documents-to-PDF-Endpunkte konvertieren Office- und Dokumentdateien über eine einzige REST-API in hochwertige PDFs: Microsoft Word, Excel und PowerPoint, Apple iWork Pages und Numbers, OpenDocument-Formate sowie HTML und Markdown. Jeder Endpunkt akzeptiert einen multipart/form-data-Upload und konvertiert synchron; standardmäßig werden die rohen PDF-Bytes zurückgegeben, alternativ JSON-Metadaten mit einer presigned Download-URL. Office- und iWork-Formate werden serverseitig von LibreOffice gerendert, wobei Formatierung, Schriftarten und Layout des Dokuments erhalten bleiben, während HTML und Markdown mit WeasyPrint gerendert werden und über pdf_options benutzerdefinierte Seitengrößen, Ränder, Kopf- und Fußzeilen unterstützen.
Unterstützte Konvertierungen#
| Konvertierung | Endpunkt | Beschreibung |
|---|---|---|
| Beliebiges zu PDF | POST /v1/convert/anything-to-pdf |
Sammel-Endpunkt: akzeptiert 36 Dateiendungen (Office, iWork, OpenDocument, RTF, CSV, HTML, Markdown, Text, EPUB, Bilder, SVG, PDF) und liefert immer ein PDF. |
| Beliebiges zu Markdown | POST /v1/convert/anything-to-markdown |
Sammel-Endpunkt: akzeptiert 22 Dateiendungen und liefert immer eine UTF-8-Markdown-Datei. Kein OCR, Bild-Input ergibt daher 400. |
| HTML zu PDF | POST /v1/convert/html-to-pdf |
Rendert .html- oder .htm-Dateien mit WeasyPrint zu PDF; Seitengröße, Ränder, Ausrichtung, Kopf- und Fußzeilen werden über pdf_options gesteuert. |
| Markdown zu PDF | POST /v1/convert/markdown-to-pdf |
Konvertiert .md- oder .markdown-Dateien in gestylte PDFs mit Tabellen, syntaxhervorgehobenen Codeblöcken und einem optionalen [TOC]-Inhaltsverzeichnis. |
| Word zu PDF | POST /v1/convert/doc-to-pdf |
Konvertiert Microsoft-Word-Dokumente (.doc und .docx) mit LibreOffice in PDF und erhält dabei Schriftarten, Formatierung und Seitenlayout. |
| Excel zu PDF | POST /v1/convert/excel-to-pdf |
Konvertiert Microsoft-Excel-Tabellen (.xlsx und .xls) mit dem präzisen Rendering von LibreOffice in PDF. |
| PowerPoint zu PDF | POST /v1/convert/ppt-to-pdf |
Konvertiert Microsoft-PowerPoint-Präsentationen (.ppt und .pptx) in PDF und erhält dabei Folienformatierung und Schriftarten. |
| Pages zu PDF | POST /v1/convert/pages-to-pdf |
Konvertiert Apple-iWork-Pages-Dokumente (.pages) mit serverseitigem LibreOffice-Rendering in PDF. |
| Numbers zu PDF | POST /v1/convert/numbers-to-pdf |
Konvertiert Apple-iWork-Numbers-Tabellen (.numbers) in PDF, wobei Formatierung und Layout erhalten bleiben. |
| ODT zu PDF | POST /v1/convert/odt-to-pdf |
Konvertiert OpenDocument-Text-Dateien (.odt), das native Format von LibreOffice/OpenOffice Writer, in PDF. |
| ODS zu PDF | POST /v1/convert/ods-to-pdf |
Konvertiert OpenDocument-Spreadsheet-Dateien (.ods) aus LibreOffice oder OpenOffice Calc in PDF. |
| ODP zu PDF | POST /v1/convert/odp-to-pdf |
Konvertiert OpenDocument-Presentation-Dateien (.odp) aus LibreOffice oder OpenOffice Impress in PDF. |
| OTS zu PDF | POST /v1/convert/ots-to-pdf |
Konvertiert OpenDocument-Spreadsheet-Template-Dateien (.ots) mit LibreOffice-Rendering in PDF. |
Gemeinsame Konventionen#
- Authentifizierung: Jeder Endpunkt erfordert entweder einen privaten API-Schlüssel über den
X-API-Key-Header oder ein JWT eines öffentlichen Schlüssels überAuthorization: Bearer. Siehe Authentifizierung. - Request-Format: Alle Endpunkte akzeptieren
multipart/form-datamit dem Dokument im Feldfilesowie den optionalen Feldernoutput_filename,direct_downloadundpdf_options. Siehe Synchrone und asynchrone Jobs. - Synchrone Antworten: Konvertierungen laufen synchron und liefern standardmäßig die rohen PDF-Bytes (
application/pdf); setzen Siedirect_download=false, um stattdessen JSON-Metadaten mitpresigned_url,object_key,filename,file_sizeundconversion_time_secondszu erhalten. - PDF-Optionen: HTML und Markdown (gerendert mit WeasyPrint) unterstützen die vollen
pdf_optionseinschließlich Seitengröße, Rändern, Ausrichtung, Kopf- und Fußzeilen; die auf LibreOffice basierenden Office-Formate übernehmen das Seitenlayout aus dem Quelldokument und unterstützen nurgrayscale. Siehe Synchrone und asynchrone Jobs. - Fehler und Limits: Die Endpunkte teilen sich dieselbe Fehlersemantik:
400bei falschem Dateityp oder fehlgeschlagener Konvertierung,401bei fehlenden/ungültigen Zugangsdaten,402beim Erreichen des monatlichen Ops-Kontingents oder Speicherlimits und413, wenn die Datei das Größenlimit des Plans überschreitet. Siehe Fehlercodes.
Häufig gestellte Fragen#
Welche Dokumentformate kann ich mit der API in PDF konvertieren?#
Elf Eingabeformate werden unterstützt: HTML (.html, .htm), Markdown (.md, .markdown), Word (.doc, .docx), Excel (.xlsx, .xls), PowerPoint (.ppt, .pptx), Apple Pages (.pages), Apple Numbers (.numbers) sowie die OpenDocument-Formate .odt, .ods, .odp und .ots. Jedes hat seinen eigenen dedizierten POST /v1/convert/*-Endpunkt.
Kann ich Seitengröße, Ränder, Kopf- und Fußzeilen in der PDF-Ausgabe steuern?#
Nur bei den mit WeasyPrint gerenderten Endpunkten, also HTML zu PDF und Markdown zu PDF. Dort akzeptiert pdf_options die Angaben page_size, benutzerdefinierte Breite/Höhe in Millimetern, orientation, margins sowie header/footer mit Template-Variablen wie {{page}} und {{total_pages}}. Die auf LibreOffice basierenden Office-Endpunkte erhalten das eigene Seitenlayout des Quelldokuments und unterstützen nur die Option grayscale.
Wie erhalte ich eine Download-URL statt der rohen PDF-Bytes?#
Setzen Sie direct_download=false bei einem beliebigen Endpunkt. Statt des PDF-Bodys besteht die Antwort dann aus JSON-Metadaten mit einer presigned_url zum Herunterladen der Datei sowie object_key, filename, file_size und conversion_time_seconds.