apyhub-logo
50 atoms
Base tier

About

Webpage to PDF conversion service lets you submit a URL and generate a PDF document for the submitted webpage.
This process offers several benefits that can make sharing, distributing, and accessing information easier and more efficient. One of the main benefits of converting a webpage to PDF is that it allows you to share and distribute information in a format that maintains the visual integrity of the original webpage. This means that the formatting, fonts, and layout of the content will remain the same, regardless of the device or software used to view it. Additionally, PDF files can be password-protected and encrypted, providing an added layer of security when sharing sensitive information.
Endpoint Selector
Output

API Playground

Documentation

webpage url: download pdf file
POST
https://api.apyhub.com/generate/webpage/pdf-file

Request example

1
curl --location --request POST 'https://api.apyhub.com/generate/webpage/pdf-file?output=test-sample.pdf&landscape=false&margin=0' \
2
--header 'apy-token: {{token}}' \
3
--header 'Content-Type: application/json' \
4
--data-raw '{
5
"url":"https://apyhub.com"
6
}'
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)
marginDecimalNoIndicates the margins for the converted webpage (recommended values between 0 to 1 & default is 0.1)
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
urlStringYesThe webpage url
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 url was empty or inaccessible
500If any unexpected error occurs while processing the 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.