Skip to content
PDF/UA API

Quick Start

This guide gets a PDF out of the API in two steps: start the server, then send it some HTML.

Run the API

Section titled “Run the API”

The quickest way to run the API is the published Docker image, which bundles the JVM, the fonts, and everything else it needs. Start it and expose port 8080:

Terminal window
docker run -p 8080:8080 ghcr.io/bambamboole/pdf-ua-api:latest

The API is now listening on http://localhost:8080. By default it runs without authentication and with rate limiting enabled — see Authentication and Rate Limiting to change either.

Convert your first PDF

Section titled “Convert your first PDF”

Send a complete HTML document to POST /render/html. The response body is the binary PDF, so write it straight to a file with --output:

Terminal window
curl -X POST http://localhost:8080/render/html \
  -H "Content-Type: application/json" \
  -d '{"html":"<html lang=\"en\"><head><title>Hello</title></head><body><h1>Hello PDF</h1></body></html>"}' \
  --output output.pdf

Open output.pdf and you have an accessible PDF/A-3a document. Always include a lang attribute and a <title> — both are required for the accessibility tags to be generated.

PDF render endpoints return application/pdf by default. If you send Accept: application/json, the response is { validation, pdf } with the PDF base64-encoded; that mode cannot be combined with X-Upload-Url.

Next steps

Section titled “Next steps”