HTML to Image API

OnlineCredit Usage:15 per callRefreshed 1 month ago

avg: 1876ms|p50: 1707ms|p75: 1989ms|p90: 2326ms|p99: 3002ms

HTML to Image converts HTML code into high-quality images with customizable dimensions and formats including PNG, JPEG, and WebP.

The HTML to Image API provides reliable and fast access to html to image data through a simple REST interface. Built for developers who need consistent, high-quality results with minimal setup time.

To use HTML to Image, you need an API key. You can get one by creating a free account and visiting your dashboard.

Live Test HTML to Image API

POST Endpoint

URL

https://api.apiverve.com/v1/htmltoimage

Code Examples

Here are examples of how to call the HTML to Image API in different programming languages:

cURL Request

curl -X POST \
  "https://api.apiverve.com/v1/htmltoimage" \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "html": "<html><head><style>body { font-family: Arial; padding: 20px; } h1 { color: #333; }</style></head><body><h1>Hello World</h1><p>This is a sample HTML document converted to an image.</p></body></html>",
  "width": 800,
  "height": 600,
  "format": "png"
}'

JavaScript (Fetch API)

const response = await fetch('https://api.apiverve.com/v1/htmltoimage', {
  method: 'POST',
  headers: {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "html": "<html><head><style>body { font-family: Arial; padding: 20px; } h1 { color: #333; }</style></head><body><h1>Hello World</h1><p>This is a sample HTML document converted to an image.</p></body></html>",
    "width": 800,
    "height": 600,
    "format": "png"
})
});

const data = await response.json();
console.log(data);

Python (Requests)

import requests

headers = {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
}

payload = {
    "html": "<html><head><style>body { font-family: Arial; padding: 20px; } h1 { color: #333; }</style></head><body><h1>Hello World</h1><p>This is a sample HTML document converted to an image.</p></body></html>",
    "width": 800,
    "height": 600,
    "format": "png"
}

response = requests.post('https://api.apiverve.com/v1/htmltoimage', headers=headers, json=payload)

data = response.json()
print(data)

Node.js (Native HTTPS)

const https = require('https');
const url = require('url');

const options = {
  method: 'POST',
  headers: {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
  }
};

const postData = JSON.stringify({
  "html": "<html><head><style>body { font-family: Arial; padding: 20px; } h1 { color: #333; }</style></head><body><h1>Hello World</h1><p>This is a sample HTML document converted to an image.</p></body></html>",
  "width": 800,
  "height": 600,
  "format": "png"
});

const req = https.request('https://api.apiverve.com/v1/htmltoimage', options, (res) => {
  let data = '';
  res.on('data', (chunk) => data += chunk);
  res.on('end', () => console.log(JSON.parse(data)));
});

req.write(postData);
req.end();

PHP (cURL)

<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://api.apiverve.com/v1/htmltoimage');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'X-API-Key: your_api_key_here',
    'Content-Type: application/json'
]);

curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode({
    'html': '<html><head><style>body { font-family: Arial; padding: 20px; } h1 { color: #333; }</style></head><body><h1>Hello World</h1><p>This is a sample HTML document converted to an image.</p></body></html>',
    'width': 800,
    'height': 600,
    'format': 'png'
}));

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

$data = json_decode($response, true);
print_r($data);

?>

Go (net/http)

package main

import (
    "fmt"
    "io"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    payload := map[string]interface{}{
        "html": "<html><head><style>body { font-family: Arial; padding: 20px; } h1 { color: #333; }</style></head><body><h1>Hello World</h1><p>This is a sample HTML document converted to an image.</p></body></html>",
        "width": "800",
        "height": "600",
        "format": "png"
    }

    jsonPayload, _ := json.Marshal(payload)
    req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/htmltoimage", bytes.NewBuffer(jsonPayload))

    req.Header.Set("X-API-Key", "your_api_key_here")
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

Ruby (Net::HTTP)

require 'net/http'
require 'json'

uri = URI('https://api.apiverve.com/v1/htmltoimage')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

payload = {
  "html": "<html><head><style>body { font-family: Arial; padding: 20px; } h1 { color: #333; }</style></head><body><h1>Hello World</h1><p>This is a sample HTML document converted to an image.</p></body></html>",
  "width": 800,
  "height": 600,
  "format": "png"
}

request = Net::HTTP::Post.new(uri)
request['X-API-Key'] = 'your_api_key_here'
request['Content-Type'] = 'application/json'

request.body = payload.to_json

response = http.request(request)
puts JSON.pretty_generate(JSON.parse(response.body))

C# (HttpClient)

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("X-API-Key", "your_api_key_here");

        var jsonContent = @"{
        ""html"": ""<html><head><style>body { font-family: Arial; padding: 20px; } h1 { color: #333; }</style></head><body><h1>Hello World</h1><p>This is a sample HTML document converted to an image.</p></body></html>"",
        ""width"": 800,
        ""height"": 600,
        ""format"": ""png""
}";
        var content = new StringContent(jsonContent, Encoding.UTF8, "application/json");

        var response = await client.PostAsync("https://api.apiverve.com/v1/htmltoimage", content);
        response.EnsureSuccessStatusCode();

        var responseBody = await response.Content.ReadAsStringAsync();
        Console.WriteLine(responseBody);
    }
}

Authentication

The HTML to Image API requires authentication via API key. Include your API key in the request header:

Required Header

X-API-Key: your_api_key_here

Learn more about authentication →

Interactive API Playground

Test the HTML to Image API directly in your browser with live requests and responses.

Live Test HTML to Image APITry it free with instant results - no signup required

Parameters

The following parameters are available for the HTML to Image API:

Some HTML to Image parameters marked with Premium are available exclusively on paid plans.View pricing

Convert HTML to Image

Parameter	Type	Required	Description	Default	Example
`html`	string	`required`	HTML code to convert Length: `max: 500000 chars`	-	`<html><body><h1>Hello</h1></body></html>`
`width`Premium	integer	`optional`	Image width in pixels Range: `100 - 3840`	`1280`	`1280`
`height`Premium	integer	`optional`	Image height in pixels Range: `100 - 2160`	`800`	`800`
`format`Premium	string	`optional`	Output image format Supported values: `pngjpegjpgwebp`	`png`	`png`

Response

The HTML to Image API returns responses in JSON, XML, YAML, and CSV formats:

Example Responses

JSON Response

200 OK

{
  "status": "ok",
  "error": null,
  "data": {
    "imageName": "79c8416d-8096-4524-adea-a948eb69a21e.png",
    "format": ".png",
    "downloadURL": "https://storage.googleapis.com/apiverve/APIData/htmltoimage/79c8416d-8096-4524-adea-a948eb69a21e.png?GoogleAccessId=635500398038-compute%40developer.gserviceaccount.com&Expires=1766010253&Signature=JEtYi%2BDdd0thnSSDWLXWCAbxVJAt6gu8khy9B0UCZSM0uXYrHLv%2F07Ht97jN%2B%2BvzQg0yP0PVUzqwrfkoC4pNEUXLzdP743iCmBEsaQqtstK5OkZR0a%2F%2FSt6UmyxQ4eWCxS7DR2pY3yBYvslzzjlBgF9ASfymgzztwvpowPR7QttziwLMzJOX5aVgstMDfEuOthcCPwRsv8lVShYAQGBYk2ZVCxIQ8HrRi38VQlEG30w%2Fgh2Lo7Xd4%2FaAuvFyG3atL4PkScoemYeHNAws4EcdxDFY69jXpffs6BHrc2OQ7U9rCC7s6p1B%2BUT7ODFFheq432OXb%2BI2p3wfOGJB4dtoQQ%3D%3D",
    "expires": 1766010253596,
    "htmlLength": 197,
    "dimensions": {
      "width": 800,
      "height": 600
    }
  }
}

XML Response

200 OK

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
  <data>
    <imageName>79c8416d-8096-4524-adea-a948eb69a21e.png</imageName>
    <format>.png</format>
    <downloadURL>https://storage.googleapis.com/apiverve/APIData/htmltoimage/79c8416d-8096-4524-adea-a948eb69a21e.png?GoogleAccessId=635500398038-compute%40developer.gserviceaccount.com&amp;Expires=1766010253&amp;Signature=JEtYi%2BDdd0thnSSDWLXWCAbxVJAt6gu8khy9B0UCZSM0uXYrHLv%2F07Ht97jN%2B%2BvzQg0yP0PVUzqwrfkoC4pNEUXLzdP743iCmBEsaQqtstK5OkZR0a%2F%2FSt6UmyxQ4eWCxS7DR2pY3yBYvslzzjlBgF9ASfymgzztwvpowPR7QttziwLMzJOX5aVgstMDfEuOthcCPwRsv8lVShYAQGBYk2ZVCxIQ8HrRi38VQlEG30w%2Fgh2Lo7Xd4%2FaAuvFyG3atL4PkScoemYeHNAws4EcdxDFY69jXpffs6BHrc2OQ7U9rCC7s6p1B%2BUT7ODFFheq432OXb%2BI2p3wfOGJB4dtoQQ%3D%3D</downloadURL>
    <expires>1766010253596</expires>
    <htmlLength>197</htmlLength>
    <dimensions>
      <width>800</width>
      <height>600</height>
    </dimensions>
  </data>
</response>

YAML Response

200 OK

status: ok
error: null
data:
  imageName: 79c8416d-8096-4524-adea-a948eb69a21e.png
  format: .png
  downloadURL: >-
    https://storage.googleapis.com/apiverve/APIData/htmltoimage/79c8416d-8096-4524-adea-a948eb69a21e.png?GoogleAccessId=635500398038-compute%40developer.gserviceaccount.com&Expires=1766010253&Signature=JEtYi%2BDdd0thnSSDWLXWCAbxVJAt6gu8khy9B0UCZSM0uXYrHLv%2F07Ht97jN%2B%2BvzQg0yP0PVUzqwrfkoC4pNEUXLzdP743iCmBEsaQqtstK5OkZR0a%2F%2FSt6UmyxQ4eWCxS7DR2pY3yBYvslzzjlBgF9ASfymgzztwvpowPR7QttziwLMzJOX5aVgstMDfEuOthcCPwRsv8lVShYAQGBYk2ZVCxIQ8HrRi38VQlEG30w%2Fgh2Lo7Xd4%2FaAuvFyG3atL4PkScoemYeHNAws4EcdxDFY69jXpffs6BHrc2OQ7U9rCC7s6p1B%2BUT7ODFFheq432OXb%2BI2p3wfOGJB4dtoQQ%3D%3D
  expires: 1766010253596
  htmlLength: 197
  dimensions:
    width: 800
    height: 600

CSV Response

200 OK

key	value
imageName	79c8416d-8096-4524-adea-a948eb69a21e.png
format	.png
downloadURL	https://storage.googleapis.com/apiverve/APIData/htmltoimage/79c8416d-8096-4524-adea-a948eb69a21e.png?GoogleAccessId=635500398038-compute%40developer.gserviceaccount.com&Expires=1766010253&Signature=JEtYi%2BDdd0thnSSDWLXWCAbxVJAt6gu8khy9B0UCZSM0uXYrHLv%2F07Ht97jN%2B%2BvzQg0yP0PVUzqwrfkoC4pNEUXLzdP743iCmBEsaQqtstK5OkZR0a%2F%2FSt6UmyxQ4eWCxS7DR2pY3yBYvslzzjlBgF9ASfymgzztwvpowPR7QttziwLMzJOX5aVgstMDfEuOthcCPwRsv8lVShYAQGBYk2ZVCxIQ8HrRi38VQlEG30w%2Fgh2Lo7Xd4%2FaAuvFyG3atL4PkScoemYeHNAws4EcdxDFY69jXpffs6BHrc2OQ7U9rCC7s6p1B%2BUT7ODFFheq432OXb%2BI2p3wfOGJB4dtoQQ%3D%3D
expires	1766010253596
htmlLength	197
dimensions	{width:800,height:600}

Live Test HTML to Image API

Response Structure

All API responses follow a consistent structure with the following fields:

Field	Type	Description	Example
`status`	string	Indicates whether the request was successful ("ok") or failed ("error")	`ok`
`error`	string \| null	Contains error message if status is "error", otherwise null	`null`
`data`	object \| null	Contains the API response data if successful, otherwise null	`{...}`

Learn more about response formats →

Response Data Fields

When the request is successful, the data object contains the following fields:

Field	Type	Sample Value	Description
`imageName`	string	`"79c8416d-8096-4524-adea-a948eb69a21e.png"`	Unique identifier for generated image file
`format`	string	`".png"`	Output image format with file extension included
`downloadURL`	string	"https://storage.googleapis.com/apiverve/APIData/htmltoimage/79c8416d-8096-4524-adea-a948eb69a21e.png?GoogleAccessId=635500398038-compute%40developer.gserviceaccount.com&Expires=1766010253&Signature=JEtYi%2BDdd0thnSSDWLXWCAbxVJAt6gu8khy9B0UCZSM0uXYrHLv%2F07Ht97jN%2B%2BvzQg0yP0PVUzqwrfkoC4pNEUXLzdP743iCmBEsaQqtstK5OkZR0a%2F%2FSt6UmyxQ4eWCxS7DR2pY3yBYvslzzjlBgF9ASfymgzztwvpowPR7QttziwLMzJOX5aVgstMDfEuOthcCPwRsv8lVShYAQGBYk2ZVCxIQ8HrRi38VQlEG30w%2Fgh2Lo7Xd4%2FaAuvFyG3atL4PkScoemYeHNAws4EcdxDFY69jXpffs6BHrc2OQ7U9rCC7s6p1B%2BUT7ODFFheq432OXb%2BI2p3wfOGJB4dtoQQ%3D%3D"	Direct URL to download generated image file
`expires`	number	`1766010253596`	Unix timestamp when download link expires
`htmlLength`	number	`197`	Character count of input HTML content
`dimensions`	object	`{...}`	-
└ `width`	number	`800`	Generated image width in pixels
└ `height`	number	`600`	Generated image height in pixels

Headers

Required and optional headers for HTML to Image API requests:

Header Name	Required	Example Value	Description
`X-API-Key`	`required`	`your_api_key_here`	Your APIVerve API key. Found in your dashboard under API Keys.
`Accept`	`optional`	`application/json`	Specify response format: application/json (default), application/xml, or application/yaml
`User-Agent`	`optional`	`MyApp/1.0`	Identifies your application for analytics and debugging purposes
`X-Request-ID`	`optional`	`req_123456789`	Custom request identifier for tracking and debugging requests
`Cache-Control`	`optional`	`no-cache`	Control caching behavior for the request and response

Learn more about request headers →

GraphQL AccessALPHA

Access HTML to Image through GraphQL to combine it with other API calls in a single request. Query only the html to image data you need with precise field selection, and orchestrate complex data fetching workflows.

Test HTML to Image in the GraphQL Explorer to confirm availability and experiment with queries.

Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.

GraphQL Endpoint

POST https://api.apiverve.com/v1/graphql

GraphQL Query Example

query {
  htmltoimage(
    input: {
      html: "<html><head><style>body { font-family: Arial; padding: 20px; } h1 { color: #333; }</style></head><body><h1>Hello World</h1><p>This is a sample HTML document converted to an image.</p></body></html>"
      width: 800
      height: 600
      format: "png"
    }
  ) {
    imageName
    format
    downloadURL
    expires
    htmlLength
    dimensions {
      width
      height
    }
  }
}

Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.

Try in GraphQL Explorer GraphQL Documentation

CORS Support

The HTML to Image API supports Cross-Origin Resource Sharing (CORS) with wildcard configuration, allowing you to call HTML to Image directly from browser-based applications without proxy servers.

CORS Header	Value	Description
`Access-Control-Allow-Origin`	`*`	Accepts requests from any origin
`Access-Control-Allow-Methods`	`*`	Accepts any HTTP method
`Access-Control-Allow-Headers`	`*`	Accepts any request headers

Browser Usage: You can call HTML to Image directly from JavaScript running in the browser without encountering CORS errors. No proxy server or additional configuration needed.

Learn more about CORS support →

Rate Limiting

HTML to Image API requests are subject to rate limiting based on your subscription plan. These limits ensure fair usage and maintain service quality for all HTML to Image users.

Plan	Rate Limit	Description
Free	5 requests/min	Hard rate limit enforced - exceeding will return 429 errors
Starter	No Limit	Production ready - standard traffic priority
Pro	No Limit	Production ready - preferred traffic priority
Mega	No Limit	Production ready - highest traffic priority

Learn more about rate limiting →

Rate Limit Headers

When rate limits apply, each HTML to Image response includes headers to help you track your usage:

Header	Description
`X-RateLimit-Limit`	Maximum number of requests allowed per time window
`X-RateLimit-Remaining`	Number of requests remaining in the current window
`X-RateLimit-Reset`	Unix timestamp when the rate limit window resets

Handling Rate Limits

Free Plan: When you exceed your rate limit, HTML to Image returns a 429 Too Many Requests status code. Your application should implement appropriate backoff logic to handle this gracefully.

Paid Plans: No rate limiting or throttling applied. All paid plans (Starter, Pro, Mega) are production-ready.

Best Practices for HTML to Image:

Monitor the rate limit headers to track your HTML to Image usage (Free plan only)
Cache html to image responses where appropriate to reduce API calls
Upgrade to Pro or Mega for guaranteed no-throttle HTML to Image performance

Note: HTML to Image rate limits are separate from credit consumption. You may have credits remaining but still hit rate limits when using HTML to Image on Free tier.

Error Codes

The HTML to Image API uses standard HTTP status codes to indicate success or failure:

Code	Message	Description	Solution
`200`	`OK`	Request successful, data returned	No action needed - request was successful
`400`	`Bad Request`	Invalid request parameters or malformed request	Check required parameters and ensure values match expected formats
`401`	`Unauthorized`	Missing or invalid API key	Include x-api-key header with valid API key from dashboard
`403`	`Forbidden`	API key lacks permission or insufficient credits	Check credit balance in dashboard or upgrade plan
`429`	`Too Many Requests`	Rate limit exceeded (Free: 5 req/min)	Implement request throttling or upgrade to paid plan
`500`	`Internal Server Error`	Server error occurred	Retry request after a few seconds, contact support if persists
`503`	`Service Unavailable`	API temporarily unavailable	Wait and retry, check status page for maintenance updates

Learn more about error handling →

Need help? Contact support with your X-Request-ID for assistance.

Integrate HTML to Image with SDKs

Get started quickly with official HTML to Image SDKs for your preferred language. Each library handles authentication, request formatting, and error handling automatically.

Available for Node.js, Python, C#/.NET, and Android/Java. All SDKs are open source and regularly updated.

JitPack

Integrate HTML to Image with No-Code API Tools

Connect the HTML to Image API to your favorite automation platform without writing code. Build workflows that leverage html to image data across thousands of apps.

ZapierConnect HTML to Image to 6,000+ apps

MakeBuild visual html to image workflows

PipedreamCode-friendly html to image automation

n8nSelf-host your html to image workflows

Power AutomateUse HTML to Image in Microsoft 365

All platforms use your same API key to access HTML to Image. Visit our integrations hub for step-by-step setup guides.

Frequently Asked Questions

How do I get an API key for HTML to Image?

Sign up for a free account at dashboard.apiverve.com. Your API key will be automatically generated and available in your dashboard. The same key works for HTML to Image and all other APIVerve APIs. The free plan includes 1,000 credits plus a 500 credit bonus.

How many credits does HTML to Image cost?

Each successful HTML to Image API call consumes credits based on plan tier. Check the pricing section above for the exact credit cost. Failed requests and errors don't consume credits, so you only pay for successful html to image lookups.

Can I use HTML to Image in production?

The free plan is for testing and development only. For production use of HTML to Image, upgrade to a paid plan (Starter, Pro, or Mega) which includes commercial use rights, no attribution requirements, and guaranteed uptime SLAs. All paid plans are production-ready.

Can I use HTML to Image from a browser?

Yes! The HTML to Image API supports CORS with wildcard configuration, so you can call it directly from browser-based JavaScript without needing a proxy server. See the CORS section above for details.

What happens if I exceed my HTML to Image credit limit?

When you reach your monthly credit limit, HTML to Image API requests will return an error until you upgrade your plan or wait for the next billing cycle. You'll receive notifications at 80% and 95% usage to give you time to upgrade if needed.

What's Next?

Continue your journey with these recommended resources

Browse All APIs

Explore our complete catalog of APIs

Authentication Guide

Learn about API keys and security

Rate Limits

Understand usage limits and best practices

Was this page helpful?

HTML to Image API

POST Endpoint

Code Examples

Authentication

Interactive API Playground

Parameters

Convert HTML to Image

Response

Example Responses

Response Structure

Response Data Fields

Headers

GraphQL AccessALPHA

CORS Support

Rate Limiting

Rate Limit Headers

Handling Rate Limits

Error Codes

Integrate HTML to Image with SDKs

Integrate HTML to Image with No-Code API Tools

Frequently Asked Questions

People who used this also used...

XML to JSON

Words to Numbers

Website to Text

What's Next?

Browse All APIs

Authentication Guide

Rate Limits