PDFtmpl API

Public API for PDF generation from templates

Authentication

All API requests require authentication using an API key. Include your API key in the X-API-Key header with every request.

X-API-Key: your-api-key-here

API keys can be generated from the PDFtmpl application dashboard.

API Key Scope

API keys can be scoped to specific tags. When an API key has tags configured:

• Only templates with at least one matching tag can be accessed
• GET /templates returns only templates within the scope
• POST /pdf/generate returns 403 if the template is out of scope

API keys without tags have access to all templates.

Base URL

/api/v1

Endpoints

{
  "templateId": "abc123XYZ0",
  "data": {
    "customerName": "John Doe",
    "invoiceDate": "2025-01-15",
    "amount": "$1,500.00"
  }
}

{
  "id": 1,
  "status": "pending",
  "message": "PDF generation has been queued"
}

curl -X POST https://api.pdftmpl.com/api/v1/pdf/generate \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"templateId": "abc123XYZ0", "data": {"name": "John Doe"}}'

{
  "id": 1,
  "status": "completed",
  "pdfUrl": "https://api.pdftmpl.com/pdfs/abc123.pdf",
  "error": null,
  "createdAt": "2025-01-15T10:30:00Z",
  "completedAt": "2025-01-15T10:30:05Z"
}

curl https://api.pdftmpl.com/api/v1/pdf/1 \
  -H "X-API-Key: your-api-key"

{
  "templates": [
    {
      "id": "abc123XYZ0",
      "name": "Invoice Template",
      "description": "Standard invoice template",
      "width": 595,
      "height": 842,
      "tags": ["invoice", "ecommerce"],
      "createdAt": "2025-01-10T10:00:00.000Z",
      "updatedAt": "2025-01-15T14:30:00.000Z"
    }
  ]
}

curl https://api.pdftmpl.com/api/v1/templates \
  -H "X-API-Key: your-api-key"

# Filter by tag
curl "https://api.pdftmpl.com/api/v1/templates?tag=invoice" \
  -H "X-API-Key: your-api-key"

Webhooks

Webhooks allow you to receive automatic notifications when a PDF generation is completed. Instead of polling the API, you can configure webhook URLs that will receive a POST request with the generation result.

How it works

Webhooks are associated with tags. When a PDF is generated from a template:

1. The system checks the template's tags
2. It finds all your webhooks that have at least one matching tag
3. Each matching webhook receives a POST notification

Webhook Configuration

Webhooks are configured in the PDFtmpl application dashboard under Settings → Webhooks. Each webhook has:

Webhook Payload

When a PDF generation is completed, the following payload is sent via POST to each matching webhook URL:

{
  "event": "pdf.generated",
  "data": {
    "id": 1,
    "status": "completed",
    "pdfUrl": "https://api.pdftmpl.com/pdfs/abc123.pdf",
    "createdAt": "2025-01-15T10:30:00.000Z",
    "completedAt": "2025-01-15T10:30:05.000Z",
    "metadata": {
      "customerName": "John Doe",
      "invoiceDate": "2025-01-15"
    }
  }
}