vøiddo guidesAll Actors on Apify

HTML to image API: how to render HTML as PNG, JPG or WEBP (Python, cURL, no code)

Render an HTML snippet to a PNG, JPEG or WEBP image at any width, with retina scaling and transparent background. This guide shows the output fields, a working input, and Python, JavaScript and cURL code for the Actor v0iddo/html-to-image on Apify.

Open HTML to image API on Apify

What data you get

One row per result. Every row can be downloaded as JSON, CSV, Excel or HTML, or read through the API.

FieldLabelTypeExample
index#number0
file_urlFileURLhttps://api.apify.com/v2/key-value-stores/LCqVWrkEdfnbldvyA/records...
filenameFile nametextimage.png
mimeTypetextimage/png
bytesBytesnumber5844
creditsCreditsnumber3
msTime (ms)number2912
file_keytextresult-001-image.png
widthnumber600
heightnumber200
formattextpng
blocked_requestsnumber0
truncatedtrue/falsefalse

Input example

This is the input that is pre-filled on the Actor page. Change the values for your own run.

{
  "html": "<div style='font:700 48px sans-serif;padding:40px;background:#1fa37a;color:#fff'>Hello, v&oslash;iddo</div>",
  "width": 600,
  "height": 200
}
Input fieldTypeWhat it does
html (required)stringThe HTML document or fragment (UTF-8, up to 2 MB).
widthintegerViewport width in CSS px
heightintegerViewport height in CSS px; omit for a full-page image that fits the content
formatstringFile format of the result.
qualityintegerjpeg / webp quality
device_scale_factorstringPixel density (2 = retina) (a number)
transparentbooleanTransparent page background (png / webp only)
itemsarrayOptional. A list of input objects with the same fields as above; every object is processed in its own right and the top-level fields act as shared defaults.

Output sample

Real rows from a run of the Actor. Fields that name people are left out of the sample.

[
  {
    "index": 0,
    "file_url": "https://api.apify.com/v2/key-value-stores/LCqVWrkEdfnbldvyA/records/result-001-image.png?signature=1oigqCJ4fTNqCDYZNG0WA",
    "file_key": "result-001-image.png",
    "filename": "image.png",
    "mime": "image/png",
    "bytes": 5844,
    "width": 600,
    "height": 200,
    "format": "png",
    "blocked_requests": 0,
    "truncated": false,
    "credits": 3,
    "ms": 2912
  }
]

Code: Python, JavaScript and cURL

Get your API token in Apify Console under Settings, then Integrations. The Actor id is v0iddo/html-to-image.

Python (apify-client)

from apify_client import ApifyClient

client = ApifyClient("YOUR_APIFY_TOKEN")

run_input = {'html': "<div style='font:700 48px "
         "sans-serif;padding:40px;background:#1fa37a;color:#fff'>Hello, "
         'v&oslash;iddo</div>',
 'width': 600,
 'height': 200}

run = client.actor("v0iddo/html-to-image").call(run_input=run_input)
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

JavaScript (apify-client)

import { ApifyClient } from 'apify-client';

const client = new ApifyClient({ token: 'YOUR_APIFY_TOKEN' });

const input = {
  "html": "<div style='font:700 48px sans-serif;padding:40px;background:#1fa37a;color:#fff'>Hello, v&oslash;iddo</div>",
  "width": 600,
  "height": 200
};

const run = await client.actor('v0iddo/html-to-image').call(input);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
console.log(items);

cURL

curl -X POST "https://api.apify.com/v2/acts/v0iddo~html-to-image/run-sync-get-dataset-items" \
  -H "Authorization: Bearer YOUR_APIFY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"html": "<div style='\''font:700 48px sans-serif;padding:40px;background:#1fa37a;color:#fff'\''>Hello, v&oslash;iddo</div>", "width": 600, "height": 200}'

Price

$3.40 per 1,000 results. You pay per result row. There is no separate charge per run. Higher Apify plans pay less per result, down to $2.38 per 1,000. See the pricing tab for your plan. A new Apify account gets $5 of platform credit every month.

FAQ

What data does the HTML to image API return?

Each result is one row in an Apify dataset. Fields include index, file_url, filename, mime, bytes, credits, ms, file_key, and more. The table above shows every field with an example value.

How do I use the HTML to image API from Python?

Install the apify-client package, create a client with your Apify API token, call the Actor v0iddo/html-to-image with an input like the one above, and read the rows from the run's dataset. The Python snippet above does exactly that.

Can I use it without writing code?

Yes. Open the Actor page on Apify, fill in the input form (an example is already filled in), press Start, and download the results as JSON, CSV, Excel or HTML. You can also schedule runs there.

How much does it cost?

$3.40 per 1,000 results. You pay per result row. There is no separate charge per run. Higher Apify plans pay less per result, down to $2.38 per 1,000. A new Apify account gets $5 of platform credit every month.

How do I limit the number of results?

Set a maximum cost for a run in the run options on Apify, and the run stops when it is reached.

Can I send the results to Google Sheets, Make, Zapier or n8n?

Yes. Apify datasets connect to Google Sheets, Slack, Make, Zapier and n8n, and a webhook can call your own service when a run finishes. You can also export the dataset as JSON, CSV or Excel.

Open HTML to image API on Apify

Related guides