Guides
HTML to PDF API
Turn a saved HTML file into a PDF. Tool id html-to-pdf; runs on our servers through POST /tasks.
At a glance#
| Property | Value |
|---|---|
| Tool id | html-to-pdf |
| Accepts | .html, .htm |
| Files per task | At least 1; at most 50 on Pro, 200 on Business |
| Largest file | 500 MB on Pro, 500 MB on Business |
| Plan | Every plan with API access |
| Result |
Accepted MIME types: text/html.
Options#
Put options in data.options. Missing options take their defaults; a value outside the allowed range answers 400 (see Errors).
| Option | Type | Default | Allowed values | Required |
|---|---|---|---|---|
url | string | — | — Not available through the API: tasks always carry a file, and a web address cannot be combined with files. | No |
screen | string | "1280" | one of: 320, 768, 1280, 1440, 1920 | No |
pageSize | string | "a4" | one of: a4, a3, a5, letter | No |
orientation | string | "portrait" | one of: portrait, landscape | No |
margin | string | "small" | one of: none, small, big | No |
onePage | boolean | false | — | No |
blockAds | boolean | true | — | No |
removePopups | boolean | true | — | No |
Build a request#
Upload the file as files[] and the tool and options as a JSON string in data. Change the options below and the request follows; only values that differ from the defaults are sent. Set MACAAW_API_KEY to a sandbox key while you build (see Quickstart).
curl https://macaaw.com/public/v1/tasks \
-H "Authorization: API-Key $MACAAW_API_KEY" \
-F "files[]=@page.html;type=text/html" \
-F 'data={"tool":"html-to-pdf","options":{}}'201 Created
{
"id": "3f0c9a52-6d1e-4c8b-a1f4-0e7d2b9c8a11",
"tool": "html-to-pdf",
"status": "task.queued",
"state": "queued",
"error": null,
"input_size": 4831022,
"output_size": null,
"output_files": null,
"stats": null,
"sandbox": false,
"date_created": "2026-10-30T11:35:00.000000Z",
"date_completed": null,
"expires_at": null
}Then poll the task or wait for the task_completed webhook, and download the result. When a task produces several files, the download is a ZIP.
Sandbox tasks are free and never counted: they process at most 5 pages and their output is stamped. Live tasks count against your plan like tasks on the website.
Try it without code on the website: HTML to PDF.