# HTML to PDF Converter (`rainminer/html-to-pdf-converter`) Actor
Convert raw HTML or web page URLs into downloadable PDF files using a real browser. Render CSS, images, tables, invoices, reports, and dynamic layouts, then save the generated PDF to the Apify Key-Value Store with dataset metadata.
- **URL**: https://apify.com/rainminer/html-to-pdf-converter.md
- **Developed by:** [rainminer](https://apify.com/rainminer) (community)
- **Categories:** Automation, Developer tools, AI
- **Stats:** 1 total users, 0 monthly users, 100.0% runs succeeded, NaN bookmarks
- **User rating**: No ratings yet
## Pricing
from $9.99 / 1,000 pdfs
This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.
Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event
## What's an Apify Actor?
Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".
## How to integrate an Actor?
If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.
In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):
```bash
npm install apify-client
```
In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):
```bash
pip install apify-client
```
In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):
````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash
In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).
If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).
For usage examples, see the [API](#api) section below.
For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).
# README
## HTML to PDF
Convert raw HTML or a public web page URL into a downloadable PDF with a temporary Playwright browser.
### What It Does
HTML to PDF renders your input in headless Chrome, generates a PDF with Playwright `page.pdf`, saves the file to the Apify Key-Value Store, and pushes one dataset item with the file name, storage key, PDF URL, byte size, source type, and page title when available.
Raw HTML is the primary input. If `html` is empty, the Actor loads `url` instead.
### Input
```json
{
"html": "InvoiceInvoice
",
"fileName": "invoice.pdf",
"format": "A4",
"printBackground": true,
"landscape": false,
"margin": {
"top": "0.4in",
"right": "0.4in",
"bottom": "0.4in",
"left": "0.4in"
},
"viewportWidth": 1280,
"viewportHeight": 720,
"waitForMillis": 0
}
````
Use `url` instead of `html` when you want to render a live page:
```json
{
"url": "https://example.com",
"fileName": "example.pdf"
}
```
### Output
The PDF is stored in the default Key-Value Store under `fileName`, defaulting to `output.pdf`.
Example dataset item:
```json
{
"fileName": "invoice.pdf",
"pdfUrl": "https://api.apify.com/v2/key-value-stores/{storeId}/records/invoice.pdf",
"key": "invoice.pdf",
"bytes": 18421,
"sourceType": "html",
"title": "Invoice"
}
```
### Notes
- `printBackground` defaults to `true` so CSS backgrounds are included.
- `format` defaults to `A4`.
- `waitForMillis` can delay PDF generation for client-side rendering, up to 60 seconds.
- File names are sanitized to valid Key-Value Store record keys and get a `.pdf` suffix if missing.
# Actor input Schema
## `html` (type: `string`):
Raw HTML to render into a PDF. If both HTML and URL are provided, HTML is used.
## `url` (type: `string`):
Optional page URL to render when HTML is not provided.
## `fileName` (type: `string`):
Key-Value Store record name for the generated PDF.
## `format` (type: `string`):
Paper format passed to Playwright page.pdf.
## `printBackground` (type: `boolean`):
Include CSS backgrounds in the PDF.
## `landscape` (type: `boolean`):
Render the PDF in landscape orientation.
## `margin` (type: `object`):
Optional PDF margins. Values can use units like px, in, cm, or mm.
## `viewportWidth` (type: `integer`):
Browser viewport width in pixels.
## `viewportHeight` (type: `integer`):
Browser viewport height in pixels.
## `waitForMillis` (type: `integer`):
Extra time to wait before generating the PDF, useful for client-side rendering.
## Actor input object example
```json
{
"html": "Example PDFHello from Apify
This HTML will be rendered as a PDF.
",
"url": "https://example.com",
"fileName": "output.pdf",
"format": "A4",
"printBackground": true,
"margin": {
"top": "0.4in",
"right": "0.4in",
"bottom": "0.4in",
"left": "0.4in"
},
"viewportWidth": 1280,
"viewportHeight": 720
}
```
# Actor output Schema
## `overview` (type: `string`):
No description
## `keyValueStore` (type: `string`):
No description
# API
You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.
## JavaScript example
```javascript
import { ApifyClient } from 'apify-client';
// Initialize the ApifyClient with your Apify API token
// Replace the '' with your token
const client = new ApifyClient({
token: '',
});
// Prepare Actor input
const input = {
"html": "Example PDFHello from Apify
This HTML will be rendered as a PDF.
",
"url": "https://example.com",
"fileName": "output.pdf",
"format": "A4",
"printBackground": true,
"landscape": false,
"margin": {
"top": "0.4in",
"right": "0.4in",
"bottom": "0.4in",
"left": "0.4in"
},
"viewportWidth": 1280,
"viewportHeight": 720,
"waitForMillis": 0
};
// Run the Actor and wait for it to finish
const run = await client.actor("rainminer/html-to-pdf-converter").call(input);
// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
console.dir(item);
});
// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs
```
## Python example
```python
from apify_client import ApifyClient
# Initialize the ApifyClient with your Apify API token
# Replace '' with your token.
client = ApifyClient("")
# Prepare the Actor input
run_input = {
"html": "Example PDFHello from Apify
This HTML will be rendered as a PDF.
",
"url": "https://example.com",
"fileName": "output.pdf",
"format": "A4",
"printBackground": True,
"landscape": False,
"margin": {
"top": "0.4in",
"right": "0.4in",
"bottom": "0.4in",
"left": "0.4in",
},
"viewportWidth": 1280,
"viewportHeight": 720,
"waitForMillis": 0,
}
# Run the Actor and wait for it to finish
run = client.actor("rainminer/html-to-pdf-converter").call(run_input=run_input)
# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
print(item)
# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start
```
## CLI example
```bash
echo '{
"html": "Example PDFHello from Apify
This HTML will be rendered as a PDF.
",
"url": "https://example.com",
"fileName": "output.pdf",
"format": "A4",
"printBackground": true,
"landscape": false,
"margin": {
"top": "0.4in",
"right": "0.4in",
"bottom": "0.4in",
"left": "0.4in"
},
"viewportWidth": 1280,
"viewportHeight": 720,
"waitForMillis": 0
}' |
apify call rainminer/html-to-pdf-converter --silent --output-dataset
```
## MCP server setup
```json
{
"mcpServers": {
"apify": {
"command": "npx",
"args": [
"mcp-remote",
"https://mcp.apify.com/?tools=rainminer/html-to-pdf-converter",
"--header",
"Authorization: Bearer "
]
}
}
}
```
## OpenAPI specification
```json
{
"openapi": "3.0.1",
"info": {
"title": "HTML to PDF Converter",
"description": "Convert raw HTML or web page URLs into downloadable PDF files using a real browser. Render CSS, images, tables, invoices, reports, and dynamic layouts, then save the generated PDF to the Apify Key-Value Store with dataset metadata.",
"version": "1.0",
"x-build-id": "doFXnPZopzPIbE3AF"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/rainminer~html-to-pdf-converter/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-rainminer-html-to-pdf-converter",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/acts/rainminer~html-to-pdf-converter/runs": {
"post": {
"operationId": "runs-sync-rainminer-html-to-pdf-converter",
"x-openai-isConsequential": false,
"summary": "Executes an Actor and returns information about the initiated run in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/runsResponseSchema"
}
}
}
}
}
}
},
"/acts/rainminer~html-to-pdf-converter/run-sync": {
"post": {
"operationId": "run-sync-rainminer-html-to-pdf-converter",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
}
},
"components": {
"schemas": {
"inputSchema": {
"type": "object",
"properties": {
"html": {
"title": "HTML",
"type": "string",
"description": "Raw HTML to render into a PDF. If both HTML and URL are provided, HTML is used."
},
"url": {
"title": "URL",
"type": "string",
"description": "Optional page URL to render when HTML is not provided."
},
"fileName": {
"title": "File name",
"type": "string",
"description": "Key-Value Store record name for the generated PDF."
},
"format": {
"title": "PDF format",
"enum": [
"Letter",
"Legal",
"Tabloid",
"Ledger",
"A0",
"A1",
"A2",
"A3",
"A4",
"A5",
"A6"
],
"type": "string",
"description": "Paper format passed to Playwright page.pdf."
},
"printBackground": {
"title": "Print background",
"type": "boolean",
"description": "Include CSS backgrounds in the PDF."
},
"landscape": {
"title": "Landscape",
"type": "boolean",
"description": "Render the PDF in landscape orientation."
},
"margin": {
"title": "Margin",
"type": "object",
"description": "Optional PDF margins. Values can use units like px, in, cm, or mm."
},
"viewportWidth": {
"title": "Viewport width",
"minimum": 320,
"maximum": 7680,
"type": "integer",
"description": "Browser viewport width in pixels."
},
"viewportHeight": {
"title": "Viewport height",
"minimum": 320,
"maximum": 7680,
"type": "integer",
"description": "Browser viewport height in pixels."
},
"waitForMillis": {
"title": "Wait after load",
"minimum": 0,
"maximum": 60000,
"type": "integer",
"description": "Extra time to wait before generating the PDF, useful for client-side rendering."
}
}
},
"runsResponseSchema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"actId": {
"type": "string"
},
"userId": {
"type": "string"
},
"startedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"finishedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"status": {
"type": "string",
"example": "READY"
},
"meta": {
"type": "object",
"properties": {
"origin": {
"type": "string",
"example": "API"
},
"userAgent": {
"type": "string"
}
}
},
"stats": {
"type": "object",
"properties": {
"inputBodyLen": {
"type": "integer",
"example": 2000
},
"rebootCount": {
"type": "integer",
"example": 0
},
"restartCount": {
"type": "integer",
"example": 0
},
"resurrectCount": {
"type": "integer",
"example": 0
},
"computeUnits": {
"type": "integer",
"example": 0
}
}
},
"options": {
"type": "object",
"properties": {
"build": {
"type": "string",
"example": "latest"
},
"timeoutSecs": {
"type": "integer",
"example": 300
},
"memoryMbytes": {
"type": "integer",
"example": 1024
},
"diskMbytes": {
"type": "integer",
"example": 2048
}
}
},
"buildId": {
"type": "string"
},
"defaultKeyValueStoreId": {
"type": "string"
},
"defaultDatasetId": {
"type": "string"
},
"defaultRequestQueueId": {
"type": "string"
},
"buildNumber": {
"type": "string",
"example": "1.0.0"
},
"containerUrl": {
"type": "string"
},
"usage": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "integer",
"example": 1
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
}
}
},
"usageTotalUsd": {
"type": "number",
"example": 0.00005
},
"usageUsd": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "number",
"example": 0.00005
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}
```