HTML to PDF API Documentation

# Use this endpoint to make a POST requests to the API
https://api.apiverve.com/v1/htmltopdf
                 

HTML to PDF is a simple tool for converting HTML to PDF. It returns the PDF file generated from the HTML.

To use this API, you need an API key. You can get one by creating an account on apiverve.com and visiting your dashboard.

Important: Ensure that this API is enabled from within your dashboard to use it in your application. If not, you may receive a 403 error

Most of our APIs are also available on and

{
  "status": "ok",
  "error": null,
  "data": {
    "marginLeft": "0.4in",
    "marginRight": "0.4in",
    "marginTop": "0.4in",
    "marginBottom": "0.4in",
    "landscape": false,
    "pdfName": "0edcc51a-3c6b-4eac-8761-b41a4919f7f4.pdf",
    "expires": 1725355755108,
    "downloadURL": "https://storage.googleapis.com/apiverve-helpers.appspot.com/htmltopdf/0edcc51a-3c6b-4eac-8761-b41a4919f7f4.pdf?GoogleAccessId=1089020767582-compute%40developer.gserviceaccount.com&Expires=1725355755&Signature=BBWhYzDCBXS%2FpRQrKgIAmt3%2F7gwO599vyNGOTXBdUtbONGpV7FNldgJnoIK6h3pip3%2FCDDaNoeuXJbC1wZ2ZamJ4qYc0S2TqivAN3wAMoPnfeKpenWEWLqvROHQJdCSwil43u7oB1FUCDRfzxGpPmgjGJBXgmBNwO1k%2BTNNEYxl2M3QHlAT%2BbVlGLlrRHWaRN6WWPKYhEMFQNcNA1djGTfBRReAbr%2FpX44QG9FnJFZ3wQg%2BS4Z8jTpnzXXVJBcIHJ0tVhzsj6HpLQmq43BRYsI7wmMeKNT5ooyYjDQGt%2BShKN4HNSddMKDxElpUSBXFhARoWQm0S8JJfX0aCzubttw%3D%3D"
  },
  "code": 200
}
                

Convert HTML to PDF

Token Usage: 5

Convert HTML content to a PDF file

REQUEST BODY JSON PARAMETERS

Field	Type	Description
html	string	(Required) The HTML content to convert to PDF. Ensure that the HTML is escaped properly
marginTop	double	The top margin of the PDF in inches (e.g., 0.5)
marginRight	double	The right margin of the PDF in inches (e.g., 0.5)
marginBottom	double	The bottom margin of the PDF in inches (e.g., 0.5)
marginLeft	double	The left margin of the PDF in inches (e.g., 0.5)

RESPONSE CONTENT TYPES

The HTML to PDF API supports the following response content types:

application/json, application/xml, application/yaml

You can specify the response content type by setting the Accept header in your request. If you don't specify a content type, the API will default to application/json.

Authentication

# Here is a curl example
curl \
-X POST https://api.apiverve.com/v1/htmltopdf \
-H 'x-api-key={{YOUR-API-KEY}}' \
-F 'auth=true' \
                

The HTML to PDF API uses an API Key to authenticate requests. You can view and manage your API key by visiting your dashboard.

Your API keys carry many privileges. To keep them from being abused, please do not share the keys on client-side code or Github etc. Keep them very secure.

To use any API, you must have it enabled from within your dashboard. Disabled APIs will fail to respond to your requests.

All requests made to the API must contain the header x-api-key in each of your requests. API requests without authentication will fail.

All API requests must also be made over secure HTTPS. Requests made over plain HTTP will fail.

Error Code	Meaning
401	Your request was made with invalid credentials. This error also appears when you don't pass the x-api-key header in your request.
403	Typically, this occurs when you are trying to access an API that you have not enabled.

Rate Limits

{
    "status": "error",
    "data": null,
    "error": "Rate limit exceeded. Please upgrade your subscription plan."
}
                

Each subscription has its own rate limit. Your limit is based on your subscription plan (free or paid). If you exceed your limits, don't worry. You can always upgrade or downgrade at any time.

When you reach your limit, the service will stop responding and typically return an HTTP 429 response status code. The error will also contain a details JSON.

The HTML to PDF API uses the following error code:

Error Code	Meaning
429	You have exceeded your rate limit and further requests will be denied until the next cycle.

Errors

For reference, the HTML to PDF API uses the following error codes:

Error Code	Meaning
Code	Message
200	The request was successful. The response will include the requested data.
400	The request was invalid. The response will include a message that explains the error.
401	The request was not authorized. Usually, this means that the API key is missing or invalid.
403	This means that the request was trying to access a resource that it does not have permission to access.
404	This means that the resource you are trying to access does not exist.
429	This means that you have reached the rate limit. The response will include a Retry-After header that indicates how many seconds you need to wait before making a new request.
500	This means that there was an error on the server side. We are alerted when this happens and we will work to fix it as soon as possible.