apyhub-logo

Convert HTML to PDF API

100 atoms
Base tier

About

This Utility API lets you upload and convert an HTML file to a pdf document.
With this API, you can quickly and accurately transform any HTML file into a PDF with minimal loss to the formatting. PDF files can be easily shared via email, file sharing services, or web downloads, and they can be viewed using various PDF readers, such as Adobe Acrobat or Preview. This makes it easier to distribute information to a wider audience, including those who may not have access to the original HTML content or the software used to create it.
Select API Endpoints
Input
Output

API Playground

API Documentation

upload html file: download pdf file
POST
https://api.apyhub.com/convert/html-file/pdf-file

Request example

1
curl --location --request POST 'https://api.apyhub.com/convert/html-file/pdf-file?output=test-sample.pdf&landscape=false' \
2
--header 'apy-token: {{token}}' \
3
--form 'file=@"test.html"'
Method: POST
Content Type: multipart/form-data
Query Parameter(s)
AttributeTypeMandatoryDescription
landscapeBooleanNoIndicates whether the input html file should be converted in a landscape mode (default is false)
outputStringNoThe PDF file name for the converted html file. If no output attribute is provided, the default file name will be output.pdf
Request Body
AttributeTypeMandatoryDescription
fileFileYesThe source word document in html format
Sample Response
A successful request returns the PDF file in the output parameter specified. If the request fails, the response contains an error code and a message to help determine what went wrong.

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
200The request was successful.
401Required authentication information is either missing or not valid for the resource.
400Invalid input - the files are empty or the files are corrupt
500If any unexpected error occurs while processing the request

Authentication

All API requests to ApyHub services need to be authenticated. Currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
"error": {
3
"code": 105,
4
"message": "Invalid URL"
5
}
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.