PDFSpark API Documentation

curl -X POST "https://pdfspark.dev/api/v1/pdf/from-html" \
  -H "Content-Type: application/json" \
  -d '{
    "html": "<h1>Hello World</h1><p>Generated by PDFSpark</p>",
    "options": {
      "format": "A4",
      "margin": { "top": "20mm", "bottom": "20mm" }
    }
  }' \
  -o document.pdf

curl -X POST "https://pdfspark.dev/api/v1/pdf/from-url" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "options": {
      "format": "A4",
      "printBackground": true,
      "waitUntil": "networkidle"
    }
  }' \
  -o example.pdf

const pdf1 = btoa(await (await fetch('/api/v1/pdf/from-html', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ html: '<h1>Cover Page</h1>' })
})).text());

const pdf2 = btoa(await (await fetch('/api/v1/pdf/from-html', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ html: '<h1>Chapter 1</h1><p>Content...</p>' })
})).text());

const merged = await fetch('/api/v1/pdf/merge', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ pdfs: [pdf1, pdf2] })
});

const blob = await merged.blob();
// merged PDF with all pages from both documents

curl -X POST https://pdfspark.dev/api/v1/pdf/split \
  -H "Content-Type: application/json" \
  -d '{
    "pdf": "<base64-encoded-pdf>",
    "pages": "1-3,5"
  }' \
  --output extracted.pdf

curl -X POST https://pdfspark.dev/api/v1/pdf/info \
  -H "Content-Type: application/json" \
  -d '{
    "pdf": "<base64-encoded-pdf>"
  }'

{
  "pages": 3,
  "size": 45210,
  "metadata": {
    "title": "My Document",
    "author": "John Doe",
    "subject": "Example",
    "keywords": "pdf, test",
    "creator": "PDFSpark",
    "producer": "pdf-lib",
    "creationDate": "2026-01-15T10:30:00.000Z",
    "modificationDate": "2026-03-01T14:00:00.000Z"
  },
  "pageDimensions": [
    { "page": 1, "width": 595.28, "height": 841.89 },
    { "page": 2, "width": 595.28, "height": 841.89 },
    { "page": 3, "width": 841.89, "height": 595.28 }
  ],
  "processingDurationMs": 12
}

{
  "service": "PDFSpark",
  "version": "1.0.0",
  "status": "operational",
  "endpoints": [
    { "method": "POST", "path": "/api/v1/pdf/from-html" },
    { "method": "POST", "path": "/api/v1/pdf/from-url" },
    { "method": "POST", "path": "/api/v1/pdf/merge" },
    { "method": "POST", "path": "/api/v1/pdf/split" },
    { "method": "POST", "path": "/api/v1/pdf/info" },
    { "method": "GET", "path": "/api/v1/status" }
  ]
}

curl -X POST "https://pdfspark.dev/api/v1/pdf/from-url" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://app.example.com/dashboard",
    "options": {
      "headers": {
        "Authorization": "Bearer eyJhbGci...",
        "X-Custom-Header": "my-value"
      },
      "waitUntil": "networkidle"
    }
  }' \
  -o dashboard.pdf

curl -X POST "https://pdfspark.dev/api/v1/pdf/from-url" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://en.wikipedia.org/wiki/PDF",
    "options": {
      "emulateMediaType": "print",
      "format": "A4"
    }
  }' \
  -o article.pdf

curl -X POST "https://pdfspark.dev/api/v1/pdf/from-html" \
  -H "Content-Type: application/json" \
  -d '{
    "html": "<h1>Invoice #1234</h1><p>Total: $99.00</p>",
    "options": {
      "format": "A4",
      "metadata": {
        "title": "Invoice #1234",
        "author": "Acme Corp",
        "subject": "Monthly invoice for March 2026",
        "keywords": ["invoice", "acme", "march-2026"],
        "creator": "Acme Billing System"
      }
    }
  }' \
  -o invoice.pdf

curl -X POST "https://pdfspark.dev/api/v1/pdf/from-html" \
  -H "Content-Type: application/json" \
  -d '{
    "html": "<h1>Invoice #1234</h1><p>Total: $99.00</p>",
    "options": {
      "format": "A4",
      "watermark": {
        "text": "DRAFT",
        "fontSize": 72,
        "opacity": 0.15,
        "rotation": -45,
        "color": { "r": 1, "g": 0, "b": 0 }
      }
    }
  }' \
  -o draft-invoice.pdf

curl -X POST "https://pdfspark.dev/api/v1/pdf/from-html" \
  -H "Content-Type: application/json" \
  -d '{
    "html": "<h1>Quarterly Report</h1><p>Company results...</p>",
    "options": {
      "format": "A4",
      "imageWatermark": {
        "image": "<base64-encoded-png>",
        "type": "png",
        "opacity": 0.15,
        "scale": 0.3,
        "position": "bottom-right"
      }
    }
  }' \
  -o branded-report.pdf

curl -X POST "https://pdfspark.dev/api/v1/pdf/from-html" \
  -H "Content-Type: application/json" \
  -d '{
    "html": "<h1>Confidential Report</h1><p>Q1 Financial Summary</p>",
    "options": {
      "format": "A4",
      "password": {
        "userPassword": "secret123",
        "ownerPassword": "admin456",
        "algorithm": "AES-256",
        "permissions": {
          "printing": true,
          "copying": false,
          "modifying": false
        }
      }
    }
  }' \
  -o confidential-report.pdf

{
  "data": "JVBERi0xLjcK...",
  "filename": "invoice.pdf",
  "pages": 1,
  "size": 24576,
  "renderDurationMs": 320
}

curl -X POST "https://pdfspark.dev/api/v1/pdf/from-html" \
  -H "Content-Type: application/json" \
  -d '{
    "html": "<h1>Invoice #1234</h1><p>Total: $99.00</p>",
    "options": {
      "format": "A4",
      "filename": "invoice-1234.pdf",
      "responseFormat": "base64"
    }
  }'

{
  "error": "Missing HTML",
  "message": "Provide an \"html\" field in the request body"
}

# Convert HTML to PDF
curl -X POST "https://pdfspark.dev/api/v1/pdf/from-html" \
  -H "Content-Type: application/json" \
  -d '{"html": "<h1>Invoice #1234</h1><p>Total: $99.00</p>"}' \
  -o invoice.pdf

# Convert URL to PDF (landscape A3)
curl -X POST "https://pdfspark.dev/api/v1/pdf/from-url" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://github.com",
    "options": { "format": "A3", "landscape": true }
  }' \
  -o github.pdf

// Convert HTML to PDF
const response = await fetch('https://pdfspark.dev/api/v1/pdf/from-html', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    html: '<h1>Hello World</h1><p>From PDFSpark</p>',
    options: { format: 'A4', margin: { top: '20mm', bottom: '20mm' } }
  })
});

const blob = await response.blob();
const url = URL.createObjectURL(blob);
window.open(url); // or save with a download link

// Convert URL to PDF
const urlResponse = await fetch('https://pdfspark.dev/api/v1/pdf/from-url', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ url: 'https://example.com' })
});

const pdfBlob = await urlResponse.blob();
// Use pdfBlob as needed...

import requests

# Convert HTML to PDF
response = requests.post(
    'https://pdfspark.dev/api/v1/pdf/from-html',
    json={
        'html': '<h1>Invoice #1234</h1><p>Total: $99.00</p>',
        'options': {'format': 'A4', 'printBackground': True}
    }
)

with open('invoice.pdf', 'wb') as f:
    f.write(response.content)

# Convert URL to PDF
response = requests.post(
    'https://pdfspark.dev/api/v1/pdf/from-url',
    json={'url': 'https://example.com'}
)

with open('example.pdf', 'wb') as f:
    f.write(response.content)

{
  "mcpServers": {
    "pdfspark": {
      "command": "npx",
      "args": ["-y", "pdfspark-api"]
    }
  }
}