apyhub-logo

Convert HTML Content to PDF

50 atoms
Base tier

About

This API lets you submit html and convert that into a pdf file. You can use this API when you generate any HTML dynamically within your application and want to convert that into PDF file to share it with users on your platform.
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. So, converting HTML to PDF can ensure that information is shared in a consistent, secure, and easily accessible format, while maintaining its visual integrity.
Endpoint Selector
Output

API Playground

Documentation

html content: download pdf file
POST
https://api.apyhub.com/generate/html-content/pdf-file

Request example

1
curl --location --request POST 'https://api.apyhub.com/generate/html-content/pdf-file?output=test-sample.pdf&landscape=false' \
2
--header 'apy-token: {{token}}' \
3
--header 'Content-Type: application/json' \
4
--data-raw '{
5
"content":" <html> <body> <h1> Hello World </h1> </body> </html> "
6
}'
The method lets you pass an html file and returns the generated PDF file as a parameter.
Method: POST
Content Type: application/json
Query Parameter(s)
AttributeTypeMandatoryDescription
landscapeBooleanNoIndicates whether the pdf file needs to be generated in a landscape mode (default is false)
outputStringNoThe PDF file name for the converted html content. If no output attribute is provided, the default file name will be output.pdf
Request Body
AttributeTypeMandatoryDescription
contentStringYesThe source html content

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
200The request was successful.
400Request is invalid.
401Required authentication information is either missing or not valid for the resource.
500There was an error in processing this request.

Authentication

All 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 workspace settings (on the left side of the navbar) and go to applications.
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.