Attachments
Embeds external files directly inside the PDF container.
Common Use Case: This is essential for e-invoicing standards like ZUGFeRD / Factur-X, which require a human-readable PDF to carry a machine-readable XML invoice as an attachment.
POST/forms/pdfengines/embed
Headers
Gotenberg-Output-Filenamestring
The filename of the resulting file - Gotenberg automatically appends the file extension. Defaults to a random UUID filename.
Gotenberg-Tracestring
A custom request ID to identify the request in the logs; overrides the default UUID.
Form Files
filesfile[]required
PDF files to embed content into.
embedsfile[]required
Files to embed (e.g., .xml, .png, etc.).
Example Request
cURL
curl \
--request POST http://localhost:3000/forms/pdfengines/embed \
--form files=@/path/to/invoice.pdf \
--form embeds=@/path/to/factur-x.xml \
-o my.pdf
Responses
- 200 OK
- 400 Bad Request
- 503 Service Unavailable
The PDF file with embedded attachments.
Content-Disposition: attachment; filename={output-filename.pdf}
Content-Type: {content-type}
Content-Length: {content-length}
Gotenberg-Trace: {trace}
Body: {output-file}
The request had one ore more invalid form fields.
Content-Type: text/plain; charset=UTF-8
Gotenberg-Trace: {trace}
Body: {error}
The request did not complete within the configured maximum duration.
Content-Type: text/plain; charset=UTF-8
Gotenberg-Trace: {trace}
Body: Service Unavailable
