HTML to PDF API

POST

Convert raw HTML markup into downloadable PDF documents.

HTML to PDF renders raw HTML markup into downloadable PDF files. Send your escaped HTML string to receive a signed download link, an expiration timestamp, and the generated document filename.

Try it — live request, no key required

Request

POSTapi.apiverve.com/v1/htmltopdf

Body

htmlstring

Verification

Format

No key required to try it. Get a key to use it in your app.

Example

{
  "status": "ok",
  "error": null,
  "data": {
    "marginLeft": "0.4in",
    "marginRight": "0.4in",
    "marginTop": "0.4in",
    "marginBottom": "0.4in",
    "landscape": false,
    "pdfName": "c064eacc-c29f-43a1-8375-a4b2562ea9d8.pdf",
    "expires": 1766096665366,
    "downloadURL": "https://storage.googleapis.com/apiverve-helpers.appspot.com/htmltopdf/c064eacc-c29f-43a1-8375-a4b2562ea9d8.pdf?GoogleAccessId=1089020767582-compute%40developer.gserviceaccount.com&Expires=1766096665&Signature=R%2Ft%2FXcR%2B8bXzCi5ztc01YeE%2Bbn1ZR%2BCyeoqgHpSB1z0LO3SetOSoWYVoon5IG4vUU9W30Rmw6owErorZal%2FHdgpmcPAYx3eTx5dPaD45tFSCgIfpRloi0DBLse%2Fzy4sb0k3XgweiHZUdZu3jKMi1HVDJa2j2ervAFfwDfxGHUDXH5wwFKqnv%2BIw%2Fu7MBsKMDCNMWYESE7Aicz6eL0Lxz8P6oazJX0akKlLDhkgKiIqF3VtjGIh36RzK4WGBpU36JFZ7SCZZGHNiHyt3%2FBdyjPRA8N1fky%2Bv%2BjR%2BTTlO9BpWcjImNJM6nvVfmICEfcbLqL2MvVldfPAFKyEv2zCrCLA%3D%3D"
  }
}

About the HTML to PDF API

HTML to PDF works by converting the HTML content provided into a PDF file. It uses advanced algorithms to convert the HTML content into a PDF file and returns the PDF file.

What people use it for

Billing Receipt Generation: SaaS billing engines convert rendered invoice templates into downloadable PDF links to attach to customer payment receipts.
Exporting Analytics Dashboards: When clients export quarterly business metrics, reporting portals turn dynamic table markup into formatted PDF documents for offline distribution.
Warehouse Packing Slips: Feed order summaries directly into PDF documents so distribution centers can fetch printable package inserts via temporary download URLs.
Archiving Legal Agreements: To store finalized contracts permanently, digital signature services convert signed HTML agreement summaries into dated PDF records.

Ways to call it

One endpoint, many ways in — REST with JSON, XML, YAML and CSV, plus GraphQL and an MCP interface for AI agents.

JSON: Default REST response
XML: Markup format
YAML: Human-readable
CSV: Tabular export
GraphQL: Query language
MCP: For AI agents

View all integrations →

Other ways to use HTML to PDF

Same data, same APIVerve account, same credit balance — one key works on all of them.

Give it to an AI agentConnect over MCP and your agent calls it as a native tool — Claude, Cursor, ChatGPT.on VerveKit

Questions.

Common questions about the HTML to PDF API.

Read the docs →

Which plan fits 2,500 PDF conversions a month?

The Starter plan easily covers this volume. At 20 credits per conversion, 2,500 documents consume 50,000 credits, which is one quarter of the Starter tier's monthly allowance. That works out to about $0.003 per conversion, or $3.00 per 1,000 documents. The Free plan includes 10 conversions each month for testing.

Are landscape orientation and custom margins available on the Free plan?

No, landscape orientation and margin controls require a paid plan. The Free plan produces documents using default portrait orientation and fixed margins. Upgrading to any paid tier, starting with Starter, unlocks the landscape option as well as top, bottom, left, and right margin adjustments.

Does the API return raw PDF binary data or a file link?

HTML to PDF returns a JSON response containing a signed download URL rather than raw binary data. Each conversion includes this URL alongside a unique filename identifier. You can fetch the file directly from the link to store it locally or serve it to your users.

How long does the generated PDF download link stay valid?

The download URL is temporary and comes with an expiration timestamp. The API response returns a Unix timestamp in the expires field that specifies exactly when the download link becomes invalid. You should download and persist the PDF file before that timestamp passes.

Does the HTML content require special formatting before sending?

Yes, your HTML string must be properly escaped inside the JSON payload. Unescaped quotes, unescaped line breaks, or invalid string formatting can prevent the request payload from parsing correctly.

Request parameters — POST /v1/htmltopdf

Sent as JSON in the request body. Premium parameters are accepted on every plan but only take effect on plans that include them. Anything not listed here is dropped rather than passed through.

Required

Parameter	Type	Example	Description
`html`Required	string	`<html><body><h1>Hello World</h1><p>This is a sample PDF document.</p></body></html>`	The HTML content to convert to PDF. Ensure that the HTML is escaped properly length 0-500000

Optional

Parameter	Type	Description
`marginTop`OptionalPremium	number	The top margin of the PDF in inches (e.g., 0.5) default 0.4
`marginRight`OptionalPremium	number	The right margin of the PDF in inches (e.g., 0.5) default 0.4
`marginBottom`OptionalPremium	number	The bottom margin of the PDF in inches (e.g., 0.5) default 0.4
`marginLeft`OptionalPremium	number	The left margin of the PDF in inches (e.g., 0.5) default 0.4
`landscape`OptionalPremium	boolean	Set to true for landscape orientation default false

Example request

curl -X POST "https://api.apiverve.com/v1/htmltopdf" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"html":"<!doctype html> <html>  <head> <title>This is the title of the webpage!</title> </head> <body> <p>This is an example paragraph. Anything in the <strong>body</strong> tag will appear on the page, just like this <strong>p</strong> tag and its contents.</p> </body> </html>","marginTop":0.4,"marginRight":0.4,"marginBottom":0.4,"marginLeft":0.4,"landscape":false}'

Authentication

Send your key in the x-api-key header. That is the only auth step — no token exchange, and no per-endpoint scope to configure.

Header	When	Value
`x-api-key`Required	Every request	Your API key. Header names are case-insensitive, so `X-API-Key` is the same header.
`Authorization`Alternate	Instead of the above	`Bearer <key>` — for clients that only expose bearer auth. Resolves to the same account and the same billing.
`content-type`Required	POST body	`application/json`

401 is the only auth verdict

A 401 means the key is missing, invalid or expired. A 403 means the key is valid but not permitted here — blocked by a key restriction or an IP allow-list. Running out of credits is a 429.

Response — POST /v1/htmltopdf

Every APIVerve endpoint returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape.

Sample response

{
  "status": "ok",
  "error": null,
  "data": {
    "marginLeft": "0.4in",
    "marginRight": "0.4in",
    "marginTop": "0.4in",
    "marginBottom": "0.4in",
    "landscape": false,
    "pdfName": "c064eacc-c29f-43a1-8375-a4b2562ea9d8.pdf",
    "expires": 1766096665366,
    "downloadURL": "https://storage.googleapis.com/apiverve-helpers.appspot.com/htmltopdf/c064eacc-c29f-43a1-8375-a4b2562ea9d8.pdf?GoogleAccessId=1089020767582-compute%40developer.gserviceaccount.com&Expires=1766096665&Signature=R%2Ft%2FXcR%2B8bXzCi5ztc01YeE%2Bbn1ZR%2BCyeoqgHpSB1z0LO3SetOSoWYVoon5IG4vUU9W30Rmw6owErorZal%2FHdgpmcPAYx3eTx5dPaD45tFSCgIfpRloi0DBLse%2Fzy4sb0k3XgweiHZUdZu3jKMi1HVDJa2j2ervAFfwDfxGHUDXH5wwFKqnv%2BIw%2Fu7MBsKMDCNMWYESE7Aicz6eL0Lxz8P6oazJX0akKlLDhkgKiIqF3VtjGIh36RzK4WGBpU36JFZ7SCZZGHNiHyt3%2FBdyjPRA8N1fky%2Bv%2BjR%2BTTlO9BpWcjImNJM6nvVfmICEfcbLqL2MvVldfPAFKyEv2zCrCLA%3D%3D"
  }
}

Response fields

Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.

Field	Type	Example	Description
`marginLeft`	string	`"0.4in"`	Left margin of the PDF in inches
`marginRight`	string	`"0.4in"`	Right margin of the PDF in inches
`marginTop`	string	`"0.4in"`	Top margin of the PDF in inches
`marginBottom`	string	`"0.4in"`	Bottom margin of the PDF in inches
`landscape`	boolean	`false`	Whether the PDF is in landscape orientation
`pdfName`	string	`"c064eacc-c29f-43a1-8375-a4b2562ea9d8.pdf"`	Unique identifier filename for the generated PDF
`expires`	number	`1766096665366`	Unix timestamp when the PDF download URL expires
`downloadURL`	string	`"https://storage.googleapis.com/apiverve-helpers.appspot.com/htmltopdf/c064eacc-c29f-43a1-8375-a4b2562ea9d8.pdf?GoogleAccessId=1089020767582…`	Signed URL to download the generated PDF file

Response headers

Every response carries your balance, so your own code always knows where it stands without polling anything. All four are exposed to browsers through CORS.

Header	What it carries
`x-api-remaining-credits`	Credits left in the current cycle
`x-api-credits-used`	Credits spent in the current cycle
`x-api-max-credits`	The allowance for the cycle
`x-api-version`	Version of the endpoint that answered

Errors

Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change.

Status	Meaning	What to do
`400`	Input was rejected	Read `error`; it names the parameter that has to change.
`401`	Key missing or invalid	Check the header name and the key value.
`403`	Key valid, but not permitted here	A key restriction or an IP allow-list — never a bad key.
`429`	Rate limited, or out of credits	Read `error` to tell them apart, then back off or top up.

What a call costs — 20 credits per call

Credits are shared across every APIVerve API — one balance, one key, one bill. Failed requests never count against it, so a rejected input costs nothing.

Plan	Per month	Credits	HTML to PDF calls	Per 1,000 calls
Free	Free	200	10	Free
Starter	$29.99	200,000	10,000	$3.00
Pro	$99.99	1,000,000	50,000	$2.00
Mega	$299.99	4,000,000	200,000	$1.50

Calls are what the credits buy at this API's rate — spend them here, on any of the other APIs, or across both. Nothing is reserved per endpoint.

Compare all pricing tiers →

Call it from cURL — POST /v1/htmltopdf

No SDK to install — this is a plain HTTPS call to /v1/htmltopdf with your key in the x-api-key header. Swap in a real key and it runs as-is.

cURL

1
2

curl "https://api.apiverve.com/v1/htmltopdf" \
  -H "x-api-key: YOUR_API_KEY"

Resources

GitHubapiverve/htmltopdf-apiSource, issues and the examples this page is built from.ReferenceHTML to PDF API docsEvery parameter, every response field, and the errors.ParametersWhat this call acceptsRequired and optional inputs, with example values.

Also published for

@apiverve/htmltopdfnpm apiverve-htmltopdfPyPI APIVerve.API.HTMLtoPDFNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from Node.js — POST /v1/htmltopdf

Install the Node.js SDK, then call the HTML to PDF API with your key. The client wraps the same HTTPS request, so anything it returns is what the endpoint returns.

Install — npm

npm install @apiverve/htmltopdf

Node.js

const res = await fetch("https://api.apiverve.com/v1/htmltopdf", {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const { data } = await res.json();
console.log(data);

Resources

npm@apiverve/htmltopdfThe published Node.js client, versioned and signed.GitHubapiverve/htmltopdf-apiSource, issues and the examples this page is built from.ReferenceHTML to PDF API docsEvery parameter, every response field, and the errors.ParametersWhat this call acceptsRequired and optional inputs, with example values.

Also published for

apiverve-htmltopdfPyPI APIVerve.API.HTMLtoPDFNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from Python — POST /v1/htmltopdf

Install the Python SDK, then call the HTML to PDF API with your key. The client wraps the same HTTPS request, so anything it returns is what the endpoint returns.

Install — PyPI

pip install apiverve-htmltopdf

Python

import requests

res = requests.get(
    "https://api.apiverve.com/v1/htmltopdf",
    headers={"x-api-key": "YOUR_API_KEY"},
)
print(res.json()["data"])

Resources

PyPIapiverve-htmltopdfThe published Python client, versioned and signed.GitHubapiverve/htmltopdf-apiSource, issues and the examples this page is built from.ReferenceHTML to PDF API docsEvery parameter, every response field, and the errors.ParametersWhat this call acceptsRequired and optional inputs, with example values.

Also published for

@apiverve/htmltopdfnpm APIVerve.API.HTMLtoPDFNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from C# / .NET — POST /v1/htmltopdf

Install the C# / .NET SDK, then call the HTML to PDF API with your key. The client wraps the same HTTPS request, so anything it returns is what the endpoint returns.

Install — NuGet

dotnet add package APIVerve.API.HTMLtoPDF

C# / .NET

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY");

var json = await client.GetStringAsync("https://api.apiverve.com/v1/htmltopdf");
Console.WriteLine(json);

Resources

NuGetAPIVerve.API.HTMLtoPDFThe published C# / .NET client, versioned and signed.GitHubapiverve/htmltopdf-apiSource, issues and the examples this page is built from.ReferenceHTML to PDF API docsEvery parameter, every response field, and the errors.ParametersWhat this call acceptsRequired and optional inputs, with example values.

Also published for

@apiverve/htmltopdfnpm apiverve-htmltopdfPyPI

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from Go — POST /v1/htmltopdf

No SDK to install — this is a plain HTTPS call to /v1/htmltopdf with your key in the x-api-key header. Swap in a real key and it runs as-is.

req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/htmltopdf", nil)
req.Header.Set("x-api-key", "YOUR_API_KEY")

res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))

Resources

Also published for

@apiverve/htmltopdfnpm apiverve-htmltopdfPyPI APIVerve.API.HTMLtoPDFNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from PHP — POST /v1/htmltopdf

No SDK to install — this is a plain HTTPS call to /v1/htmltopdf with your key in the x-api-key header. Swap in a real key and it runs as-is.

PHP

$ch = curl_init("https://api.apiverve.com/v1/htmltopdf");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ["x-api-key: YOUR_API_KEY"]);

$response = curl_exec($ch);
echo $response;

Resources

Also published for

@apiverve/htmltopdfnpm apiverve-htmltopdfPyPI APIVerve.API.HTMLtoPDFNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from Ruby — POST /v1/htmltopdf

No SDK to install — this is a plain HTTPS call to /v1/htmltopdf with your key in the x-api-key header. Swap in a real key and it runs as-is.

Ruby

require "net/http"

uri = URI("https://api.apiverve.com/v1/htmltopdf")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "YOUR_API_KEY"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

Resources

Also published for

@apiverve/htmltopdfnpm apiverve-htmltopdfPyPI APIVerve.API.HTMLtoPDFNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

All articles →

Generate PDFs from HTML with an APIConvert HTML to PDF programmatically. Tutorial covering invoices, reports, receipts, and certificates with code examples.Read

PDF Generation API: Invoices, Reports, DocumentsGenerate PDFs from HTML or Markdown. Perfect for invoices, receipts, reports, and any document you need to create programmatically.Read

Extract Clean Content from Any WebpageTurn messy web pages into clean Markdown. Perfect for content migration, archiving, AI training data, and building read-later tools.Read

HTML to PDF API

Try it — live request, no key required

About the HTML to PDF API

What people use it for

Ways to call it

Other ways to use HTML to PDF

Questions.

Request parameters — POST /v1/htmltopdf

Required

Optional

Authentication

Response — POST /v1/htmltopdf

Response fields

Response headers

Errors

What a call costs — 20 credits per call

Call it from cURL — POST /v1/htmltopdf

Resources

Also published for

Call it from Node.js — POST /v1/htmltopdf

Resources

Also published for

Call it from Python — POST /v1/htmltopdf

Resources

Also published for

Call it from C# / .NET — POST /v1/htmltopdf

Resources

Also published for

Call it from Go — POST /v1/htmltopdf

Resources

Also published for

Call it from PHP — POST /v1/htmltopdf

Resources

Also published for

Call it from Ruby — POST /v1/htmltopdf

Resources

Also published for

Zero-code embed — one snippet, no backend

Changelog — HTML to PDF API

Documents

Related articles

Ready to build with HTML to PDF? Start with 200 free credits — one key unlocks all 300+ APIs.

Explore the catalog