PDF from HTML (HTML to PDF)

Description: Convert HTML code snippet into full featured PDF. GET or POST request.

Status Errors

Code	Description
`200`	The request has succeeded
`400`	bad input parameters
`401`	unauthorized
`403`	not enough credits
`405`	Timeout error. To process large documents or files please use asynchronous mode ( set `async` parameter to true) and then check the status using `/job/check` endpoint. If file contains many pages then specify a page range using pages parameter. The number of pages of the document can be obtained using the endpoint `/pdf/info`

Example

Sample Request:

! Don’t forget to set x-api-key url param or http header param (preferred) to API key, get yours here

POST
{
	"name" : "result.pdf",
	"html" : "true",
	"url" : "https://bytescout-com.s3.amazonaws.com/files/demo-files/cloud-api/pdf-to-html/sample.html"
}

Available methods

[POST] /pdf/convert/from/html
[POST] /pdf/convert/from/html (with custom profiles and custom js to disable links)

[POST] /pdf/convert/from/html

Generate PDF from HTML input. You can also set the following params:

html required. Input HTML code to be converted. If you need to convert link or url to PDF then use /pdf/convert/from/url endpoint instead.
async optional. Set to true to run as async job in background (recommended for heavy documents).
margins optional. set to css style margins like 10px, 5mm, 5in for all sides or 5px 5px 5px 5px (the order of margins is top, right, bottom, left).
paperSize optional. Letter is set by default. Can be Letter, Legal, Tabloid, Ledger, A0, A1, A2, A3, A4, A5, A6 or a custom size. Custom size can be set in px (pixels), mm or in (inches) with width and height separated by space like this: 200 300, 200px 300px, 200mm 300mm, 20cm 30cm or 6in 8in.
orientation optional. set to Portrait or Landscape. Portrait by default.
printBackground optional. true by default. Set to false to disable printing of background.
DoNotWaitFullLoad optional. false by default. Set to true to skip waiting for full load (like full video load etc that may affect the total conversion time).
templateData optional string. String with JSON data to replace inside HTML. If this property has JSON code inside (note that it should be represented as escaped string) then the engine will process input HTML (or in URL) as Handlebars HTML template and will replace data in the template accordingly. For example: `` in HTML will be replaced with ACME Company if templateData is set to {invoice: {company: \"ACME Company\"}}.

Sample template: https://bytescout-com.s3-us-west-2.amazonaws.com/files/cloudapi-templates/template-invoice-1.html

Example input data for this template:

{
        "invoice": {
            "id": "0021",
            "date": "August 29, 2041",
            "dateDue": "September 29, 2041"
        },
        "issuer": {
            "name": "Sarah Connor",
            "company": "T-800 Research Lab",
            "address": "435 South La Fayette Park Place, Los Angeles, CA 90057",
            "website": "www.example.com",
            "email": "info@example.com"
        },
        "client": {
            "name": "Cyberdyne Systems",
            "company": "Cyberdyne Systems",
            "address": "18144 El Camino Real, Sunnyvale, California"
        }
}

Note: you should set templateData to the escaped version (use JSON.stringify(object) or similar). For a sample on using templates please check PDF from HTML Template set of samples below.

header optional. Set to HTML for header to be applied on every page at the header.
footer optional. Set to HTML for footer to be applied on every page at the bottom.

The header and footer params should contain valid HTML markup with the following classes used to inject printing values into them:

date: formatted print date title: document title url: document location pageNumber: current page number totalPages: total pages in the document

For example, the following markup will generate Page N of NN page numbering:

<span style='font-size:10px'>Page <span class='pageNumber'></span> of <span class='totalPages'></span>.</span>

Sample JSON for PDF generation with more advanced header and footer. Note that the top and bottom page margins are important because the page content may overlap the footer or header.

{
 "html": ""<!DOCTYPE html><html><head><meta charSet=\"utf-8\"/><style type=\"text/css\">body { font-family: \"Arial\" }</style></head><body><h1>Hello</h1></body></html>",
  "async": false,
  "encrypt": false,
  "name": "result.pdf",
  "margins": "40px 5px 40px 5px",
  "paperSize": "Letter",
  "orientation": "Portrait",
  "printBackground": true,
  "header": "<div style='width:100%'><span style='font-size:10px;margin-left:20px;width:50%;float:left'>LEFT SUBHEADER</span><span style='font-size:8px;width:30%;float:right'>RIGHT SUBHEADER</span></div>",
  "footer": "<div style='width:100%;text-align:right'><span style='font-size:10px;margin-right:20px'>Page <span class='pageNumber'></span> of <span class='totalPages'></span>.</span></div>"
}

profiles optional. Must be a String. You can set additional and extra options using this parameter that allows you to set custom configuration. See profiles samples for examples.

Description

Method: POST
URL: /v1/pdf/convert/from/html

Query parameters

No query parameters accepted.

Body payload

{
    "html": "<h1>Hello World!</h1><a href='https://pdf.co'>Go to PDF.co</a>",
    "name": "result.pdf",
    "margins": "5px 5px 5px 5px",
    "paperSize": "Letter",
    "orientation": "Portrait",
    "printBackground": true,
    "header": "",
    "footer": "",
    "async": false,
    "encrypt": false
}

Example responses

/pdf/convert/from/html

{
    "url": "https://pdf-temp-files.s3.amazonaws.com/97dc323f32794eae8fa6602f5bd981c1/result.pdf",
    "pageCount": 1,
    "error": false,
    "status": 200,
    "name": "result.pdf",
    "remainingCredits": 60646
}

/pdf/convert/from/html (with header and footer)

Code Snippets

CURL

curl --location --request POST 'https://api.pdf.co/v1/pdf/convert/from/html' \
--header 'x-api-key: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "html": "<h1>Hello World!</h1><a href='\''https://pdf.co'\''>Go to PDF.co</a>",
    "name": "result.pdf",
    "margins": "5px 5px 5px 5px",
    "paperSize": "Letter",
    "orientation": "Portrait",
    "printBackground": true,
    "header": "",
    "footer": "",
    "async": false,
    "encrypt": false
}'

JavaScript

var myHeaders = new Headers();
myHeaders.append("x-api-key", "");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
 "html": "<h1>Hello World!</h1><a href='https://pdf.co'>Go to PDF.co</a>",
 "name": "result.pdf",
 "margins": "5px 5px 5px 5px",
 "paperSize": "Letter",
 "orientation": "Portrait",
 "printBackground": true,
 "header": "",
 "footer": "",
 "async": false,
 "encrypt": false
});

var requestOptions = {
	method: 'POST',
	headers: myHeaders,
	body: raw,
	redirect: 'follow'
};

fetch("https://api.pdf.co/v1/pdf/convert/from/html", requestOptions)
	.then(response => response.text())
	.then(result => console.log(result))
	.catch(error => console.log('error', error));

NodeJs

var request = require('request');
var options = {
	'method': 'POST',
	'url': 'https://api.pdf.co/v1/pdf/convert/from/html',
	'headers': {
		'x-api-key': '',
		'Content-Type': 'application/json'
	},
	body: JSON.stringify({
	 "html": "<h1>Hello World!</h1><a href='https://pdf.co'>Go to PDF.co</a>",
	 "name": "result.pdf",
	 "margins": "5px 5px 5px 5px",
	 "paperSize": "Letter",
	 "orientation": "Portrait",
	 "printBackground": true,
	 "header": "",
	 "footer": "",
	 "async": false,
	 "encrypt": false
	})

};
request(options, function (error, response) {
	if (error) throw new Error(error);
	console.log(response.body);
});

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
	CURLOPT_URL => 'https://api.pdf.co/v1/pdf/convert/from/html',
	CURLOPT_RETURNTRANSFER => true,
	CURLOPT_ENCODING => '',
	CURLOPT_MAXREDIRS => 10,
	CURLOPT_TIMEOUT => 0,
	CURLOPT_FOLLOWLOCATION => true,
	CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	CURLOPT_CUSTOMREQUEST => 'POST',
	CURLOPT_POSTFIELDS =>'{
    "html": "<h1>Hello World!</h1><a href=\'https://pdf.co\'>Go to PDF.co</a>",
    "name": "result.pdf",
    "margins": "5px 5px 5px 5px",
    "paperSize": "Letter",
    "orientation": "Portrait",
    "printBackground": true,
    "header": "",
    "footer": "",
    "async": false,
    "encrypt": false
}',
	CURLOPT_HTTPHEADER => array(
		'x-api-key: ',
		'Content-Type: application/json'
	),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Java

import java.io.*;
import okhttp3.*;
public class main {
	public static void main(String []args) throws IOException{
		OkHttpClient client = new OkHttpClient().newBuilder()
			.build();
		MediaType mediaType = MediaType.parse("application/json");
		RequestBody body = RequestBody.create(mediaType, "{\n    \"html\": \"<h1>Hello World!</h1><a href='https://pdf.co'>Go to PDF.co</a>\",\n    \"name\": \"result.pdf\",\n    \"margins\": \"5px 5px 5px 5px\",\n    \"paperSize\": \"Letter\",\n    \"orientation\": \"Portrait\",\n    \"printBackground\": true,\n    \"header\": \"\",\n    \"footer\": \"\",\n    \"async\": false,\n    \"encrypt\": false\n}");
		Request request = new Request.Builder()
			.url("https://api.pdf.co/v1/pdf/convert/from/html")
			.method("POST", body)
			.addHeader("x-api-key", "")
			.addHeader("Content-Type", "application/json")
			.build();
		Response response = client.newCall(request).execute();
		System.out.println(response.body().string());
	}
}

C#

using System;
using RestSharp;
namespace HelloWorldApplication {
	class HelloWorld {
		static void Main(string[] args) {
			var client = new RestClient("https://api.pdf.co/v1/pdf/convert/from/html");
			client.Timeout = -1;
			var request = new RestRequest(Method.POST);
			request.AddHeader("x-api-key", "");
			request.AddHeader("Content-Type", "application/json");
			var body = @"{" + "\n" +
			@"    ""html"": ""<h1>Hello World!</h1><a href='https://pdf.co'>Go to PDF.co</a>""," + "\n" +
			@"    ""name"": ""result.pdf""," + "\n" +
			@"    ""margins"": ""5px 5px 5px 5px""," + "\n" +
			@"    ""paperSize"": ""Letter""," + "\n" +
			@"    ""orientation"": ""Portrait""," + "\n" +
			@"    ""printBackground"": true," + "\n" +
			@"    ""header"": """"," + "\n" +
			@"    ""footer"": """"," + "\n" +
			@"    ""async"": false," + "\n" +
			@"    ""encrypt"": false" + "\n" +
			@"}";
			request.AddParameter("application/json", body,  ParameterType.RequestBody);
			IRestResponse response = client.Execute(request);
			Console.WriteLine(response.Content);
		}
	}
}

Python

import requests
import json

url = "https://api.pdf.co/v1/pdf/convert/from/html"

payload = json.dumps({
 "html": "<h1>Hello World!</h1><a href='https://pdf.co'>Go to PDF.co</a>",
 "name": "result.pdf",
 "margins": "5px 5px 5px 5px",
 "paperSize": "Letter",
 "orientation": "Portrait",
 "printBackground": True,
 "header": "",
 "footer": "",
 "async": False,
 "encrypt": False
})
headers = {
	'x-api-key': '',
	'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Powershell

$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("x-api-key", "")
$headers.Add("Content-Type", "application/json")

$body = "{`n    `"html`": `"<h1>Hello World!</h1><a href='https://pdf.co'>Go to PDF.co</a>`",`n    `"name`": `"result.pdf`",`n    `"margins`": `"5px 5px 5px 5px`",`n    `"paperSize`": `"Letter`",`n    `"orientation`": `"Portrait`",`n    `"printBackground`": true,`n    `"header`": `"`",`n    `"footer`": `"`",`n    `"async`": false,`n    `"encrypt`": false`n}"

$response = Invoke-RestMethod 'https://api.pdf.co/v1/pdf/convert/from/html' -Method 'POST' -Headers $headers -Body $body
$response | ConvertTo-Json

[POST] /pdf/convert/from/html (with custom profiles and custom js to disable links)