API Documentation

Everything you need to integrate our powerful HTML to PDF conversion service

Getting Started

Authentication

Authenticate your requests by including your API key in the header of each request.

Endpoints

Use our simple endpoints to convert your HTML and receive a PDF in return.

Authentication

Include your API key in the header of each request:

            
Authorization: Bearer YOUR_API_KEY

Endpoints

Generate PDF

POST /api/pdf/generate

Convert HTML5 to PDF. Each successful generation consumes 1 credit, unless you are using the test mode.

Request Body (JSON)

Properties:

html

Your HTML content as a string. Can be a full HTML document or partial HTML.
Note: please see below for more information on supported resources.

options

Configuration object to customize the PDF output. All options are optional.
default: see below

test

Set to true to use the test mode. This will not consume a credit. The generated PDF will contain sample watermarks.
default: false


{
    html: "<html><body><h1>Hello, World!</h1></body></html>",
    options: {
        scale: 0.75,
        margin: {
            top: "0.5in",
            right: "0.65in",
            bottom: "0.5in",
            left: "0.65in"
        },
        format: "Letter",
        printBackground: true,
        height: "11in",
        width: "8.5in",
        omitBackground: false,
        preferCSSPageSize: false
    },
    test: false
}

Supported Resources:

Please note that while we support external resources, retrieval will affect rendering time, and may result in timeouts depending on network conditions. For CSS specifically, we recommend using inline styles. JavaScript is not supported.

Sample JSON Response:

{
  "pdf": "base64EncodedPDFString..."
}

Returns a base64 encoded string of the generated PDF.

Important Notes:

Each successful non-test PDF generation consumes 1 credit
Users receive an email warning when credits reach their configured warning level
Any options not in the allowed list will be silently filtered out. If the option cannot be filtered, the API will return an exception.

Options Reference

scalenumberdefault: 0.75

Scale of the webpage rendering. Accepts values between 0.1 and 2.

marginobjectdefault: see below

Page margins in inches in, millimeters mm, pixels px or centimeters cm.

top: "0.5in"

right: "0.65in"

bottom: "0.5in"

left: "0.65in"

formatstringdefault: "Letter"

Paper format. Available values:

Letter Legal Tabloid Ledger A0 A1 A2 A3 A4 A5 A6

printBackgroundbooleandefault: true

Whether to print CSS backgrounds.

heightstringdefault: none

Page height. Accepts values with units (in, cm, mm, px).

widthstringdefault: none

Page width. Accepts values with units (in, cm, mm, px).

preferCSSPageSizebooleandefault: false

Give priority to page size declared in CSS @page rules.

Code Examples

Here are examples of how to use our API to convert HTML5 to PDF in different programming languages:

curl -X POST \
  'https://www.pdfy.online/api/pdf/generate' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "html": "<html><body><h1>Hello World</h1></body></html>",
    "options": {
      "format": "Letter",
      "scale": 0.75
    }
  }' | jq -r '.pdf' | base64 -d > output.pdf

import axios from 'axios';
import fs from 'fs';

const generatePDF = async () => {
  try {
    const response = await axios.post('https://www.pdfy.online/api/pdf/generate', {
      html: '<html><body><h1>Hello World</h1></body></html>',
      options: {
        format: 'Letter',
        scale: 0.75
      }
    }, {
      headers: {
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json'
      }
    });

    const pdfBase64 = response.data.pdf;
    const pdfBuffer = Buffer.from(pdfBase64, 'base64');

    // Save to file
    fs.writeFileSync('output.pdf', pdfBuffer);
    console.log('PDF saved to output.pdf');
  } catch (error) {
    console.error('Error generating PDF:', error);
  }
}

<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://www.pdfy.online/api/pdf/generate',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_API_KEY',
        'Content-Type: application/json'
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'html' => '<html><body><h1>Hello World</h1></body></html>',
        'options' => [
            'format' => 'Letter',
            'scale' => 0.75
        ]
    ])
]);

$response = curl_exec($curl);
$pdf_base64 = json_decode($response)->pdf;

// Decode base64 and save to file
$pdf_content = base64_decode($pdf_base64);
file_put_contents('output.pdf', $pdf_content);

curl_close($curl);
echo "PDF saved to output.pdf\n";

import requests
import json
import base64

url = 'https://www.pdfy.online/api/pdf/generate'
headers = {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
}
data = {
    'html': '<html><body><h1>Hello World</h1></body></html>',
    'options': {
        'format': 'Letter',
        'scale': 0.75
    }
}

response = requests.post(url, headers=headers, json=data)
pdf_base64 = response.json()['pdf']

# Decode base64 and save to file
pdf_content = base64.b64decode(pdf_base64)
with open('output.pdf', 'wb') as f:
    f.write(pdf_content)

print('PDF saved to output.pdf')

require 'net/http'
require 'uri'
require 'json'
require 'base64'

uri = URI('https://www.pdfy.online/api/pdf/generate')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = {
  html: '<html><body><h1>Hello World</h1></body></html>',
  options: {
    format: 'Letter',
    scale: 0.75
  }
}.to_json

response = http.request(request)
pdf_base64 = JSON.parse(response.body)['pdf']

# Decode base64 and save to file
pdf_content = Base64.decode64(pdf_base64)
File.binwrite('output.pdf', pdf_content)

puts 'PDF saved to output.pdf'

Note:

Remember to replace 'YOUR_API_KEY' with your actual API key in the examples above. The response will contain a base64 encoded PDF string that you'll need to decode to get the actual PDF file.

Response Codes

200 OK

The request was successful

400 Bad Request

The request was invalid or cannot be served

401 Unauthorized

You have not included an API key or your API key is invalid

402 Insufficient Credits

Your account is out of credits

403 Invalid PDF Options

The PDF options you supplied are invalid

500 Internal Server Error

The server encountered an unexpected condition

Need Help?

Our support team is always ready to assist you with any questions or issues.

Contact Support