This Utility API lets you to add a header or footer to your existing PDF file.
You can provide the text or png image which can be set as header and footer to this utility and additionally, you can also control the font size (in case of text) and opacity of the header and footer.
Using this API, you can automate the process of adding headers and footers to multiple PDF files, which can save time and effort compared to doing it manually. Using an API to add header and footer to PDF files can offers other benefits also such as consistency, customization, error reduction, scalability, and integration with other applications or services. This can save time, reduce errors, and provide flexibility for branding and adding context to documents.
Currently we support more than 50 languages for text in this utility.
Supported Languages: Esperanto, English, Russian, Mandarin, Spanish, Portuguese, Italian, Bengali, French, German, Ukrainian, Georgian, Arabic, Hindi, Japanese, Hebrew, Yiddish, Polish, Javanese, Korean, Bokmal, Danish, Swedish, Finnish, Turkish, Dutch, Hungarian, Czech, Greek, Bulgarian, Belarusian, Marathi, Kannada, Romanian, Slovene, Croatian, Serbian, Macedonian, Lithuanian, Latvian, Estonian, Tamil, Vietnamese, Urdu, Thai, Gujarati, Uzbek, Punjabi, Azerbaijani, Indonesian, Telugu, Malayalam, Hausa, Oriya, Burmese, Bhojpuri, Maithili, Oromo, Kurdish, Malagasy, Saraiki, Nepali, Sinhalese, Khmer, Turkmen, Somali, Akan, Zulu, Haitian Creole, Africaans
input file: output file
|The name of the output file, defaults to
|The source pdf file
|Yes (if header_image not given)
|The text which you want to add as Header. If header_text and header_image both are present in the request then header_text will be applied.
|Yes (if footer_image not given)
|The text which you want to add as Footer. If footer_text and footer_image both are present in the request then footer_text will be applied.
|The level of transperancy for header you want to keep from 0 to 1, defaults to
|The level of transperancy for footer you want to keep from 0 to 1, defaults to
|The font size of Header text from 8 to 24, defaults to
|The font size of Footer text from 8 to 24, defaults to
|The alignment of the Header - can have the values 'left', 'right', or 'center', with the default being
|The alignment of the Footer - can have the values 'left', 'right', or 'center', with the default being
|Yes (if header_text not given)
|The png image file which you want to add as Header. If header_text and header_image both are present in the request then header_text will be applied.
|Yes (if footer_text not given)
|The png image file which you want to add as Footer. If footer_text and footer_image both are present in the request then footer_text will be applied.
|The size of the image header you want to set from 0.1 to 1, defaults to
|The size of the image footer you want to set from 0.1 to 1, defaults to
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:
|The request was successful.
|Invalid input - the pdf file is corrupt or the supported inputs are not provided.
|Required authentication information is either missing or not valid for the resource.
|If any unexpected error occurs while processing the request.
All requests to ApyHub services need to be authenticated, currently we support
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-tokenas the header parameter to pass the token.
- Use the
Authorizationheader to send the basic authentication credentials.
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.