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
}
                

Token Usage: 5

Convert HTML content to a PDF file

REQUEST BODY JSON PARAMETERS

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.

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:

Errors

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