API Reference

Programmatically generate PDFs using our simple REST API. All requests must include your API Key in the `Authorization` header.

Authorization: Bearer <YOUR_API_KEY>

Download PDF Binary

Generates a PDF from a template and returns the file binary directly. Perfect for fast, ephemeral generation.

POST/api/v1/generate

Parameters

templateId
string
Required
ID of the template to use
data
object
Optional
JSON object containing variables for the template

Request Body

{
  "templateId": "550e8400-e29b-41d4-a716-446655440000",
  "data": {
    "customerName": "Acme Corp",
    "items": [
      {
        "name": "Service A",
        "price": 100
      }
    ]
  }
}

Generate PDF Link

Generates a PDF and uploads it to storage, returning a temporary signed URL.

POST/api/v1/generateUrl

Parameters

templateId
string
Required
ID of the template to use
data
object
Optional
JSON object containing variables to inject
filename
string
Optional
Custom filename for the generated PDF

Request Body

{
  "templateId": "550e8400-e29b-41d4-a716-446655440000",
  "filename": "invoice_december.pdf",
  "data": {
    "name": "John Doe"
  }
}

Get Template Schema

Retrieves the JSON Schema for a template based on its variable configurations.

GET/api/v1/schema

Parameters

templateId
string
Required
ID of the template

List Templates

WIP

Retrieves a list of all templates available in your workspace.

GET/api/v1/templates

Parameters

limit
number
Optional
Max number of results
page
number
Optional
Page number

Usage Status

WIP

Monitor your credit usage and API limits.

GET/api/v1/usage/status