▣ FILE MANIPULATION

Apply Watermark and Footers on PDF API

What it does

PDF Header Footer adds text or PNG images to the top and bottom of a PDF, then returns the modified file as a download link or a binary response.

Send a PDF as a file upload or a publicly accessible URL. You can add header_text or footer_text, and the footer text can include {page} as a placeholder for the page number. If you prefer branded output, provide header_image / footer_image for file uploads or header_image_url / footer_image_url for URL-based jobs. Header and footer alignment can be set to left, center, or right.

Use PDF Header Footer when you need to stamp internal documents with a confidentiality notice, add page numbers to reports, or apply consistent branding across exported PDFs. The service supports both upload-to-download and upload-to-S3 URL workflows, so you can fit it into batch processing as well as direct user-facing document tools.

The output is either a binary PDF or an object containing a url, depending on the endpoint you call.

▣ ENDPOINT 01 / 04

POST

Add header/footer to PDF (file upload → download)

https://api.eu.apyverse.com/apyhub/add-header-footer-to-pdf/file/download

QUICKSTART

GUIDE

Quickstart

Upload a PDF and add a simple header or footer, then download the modified file.

curl -X POST "https://api.eu.apyverse.com/apyhub/add-header-footer-to-pdf/file/download" \
  -H "apy-token: $APY_TOKEN" \
  -F "file=@/path/to/file.pdf" \
  -F "footer_text=Page {page}"

What you'll get back

Returns a binary file download.The response is the modified PDF content.

TRY ITLIVE · 200 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

About this endpoint

What it does

Uploads a PDF, adds the requested header and/or footer content, and returns the modified PDF as a binary file download. You can supply header/footer text, PNG images, or a combination of those options.

Request Body

Parameter	Type	Mandatory	Description
file	String	Yes	PDF file to modify.
output	String	No	Output filename stem (without extension). Defaults to `output`.
footer_text	String	No	Footer text. Use `{page}` as a placeholder for the page number.
header_text	String	No	Header text. At least one of `header_text`, `footer_text`, `header_image`, or `footer_image` is required.
footer_image	String	No	Footer image (PNG).
header_image	String	No	Header image (PNG).
footer_alignment	ENUM	No	Alignment for the footer. Allowed values: `left`, `center`, `right`. Default: `center`.
header_alignment	ENUM	No	Alignment for the header. Allowed values: `left`, `center`, `right`. Default: `center`.

Response

Returns a binary file containing the modified PDF. The output schema is a single binary string, so the success response is the downloaded PDF content itself.

Parameter	Type	Mandatory	Description
binary response	String	Yes	The modified PDF file returned as binary data.

Body

Name

Type

Description

bodyREQUIRED

object

—

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

▣ ENDPOINT 02 / 04

POST

Add header/footer to PDF (file upload → S3 URL)

https://api.eu.apyverse.com/apyhub/add-header-footer-to-pdf/file/url

QUICKSTART

GUIDE

Quickstart

Upload a PDF and add a simple header/footer, then get back a URL to the processed file.

curl -X POST "https://api.eu.apyverse.com/apyhub/add-header-footer-to-pdf/file/url" \
  -H "apy-token: $APY_TOKEN" \
  -F "file=@/path/to/file.pdf"

What you'll get back

Returns a JSON object with a url string field — a URI pointing to the generated PDF.

{
  "url": "https://s3.amazonaws.com/bucket/output.pdf"
}

TRY ITLIVE · 200 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

About this endpoint

What it does

Adds a header and/or footer to an uploaded PDF and returns the URL of the processed file. The request sends the source PDF as a file upload, along with optional header/footer text, images, and alignment settings.

Request Body

Parameter	Type	Mandatory	Description
file	String	Yes	PDF file to process. Binary upload.
footer_text	String	No	Text to place in the footer. Example: `Page {page}`.
header_text	String	No	Text to place in the header. Example: `CONFIDENTIAL`.
footer_image	String	No	Image to place in the footer. Binary upload.
header_image	String	No	Image to place in the header. Binary upload.
footer_alignment	ENUM	No	Alignment for the footer content. Allowed values: `left`, `center`, `right`. Default: `center`.
header_alignment	ENUM	No	Alignment for the header content. Allowed values: `left`, `center`, `right`. Default: `center`.

Response

Returns a JSON object with a url string field containing the URI of the generated PDF.

Parameter	Type	Mandatory	Description
url	String	Yes	URI of the output file. Example: `https://s3.amazonaws.com/bucket/output.pdf`.

Body

Name

Type

Description

bodyREQUIRED

object

—

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

▣ ENDPOINT 03 / 04

POST

Add header/footer to PDF (URL → download)

https://api.eu.apyverse.com/apyhub/add-header-footer-to-pdf/url/download

QUICKSTART

GUIDE

Quickstart

This sends a PDF URL and optional header/footer text to generate a PDF with added header/footer content.

curl -X POST "https://api.eu.apyverse.com/apyhub/add-header-footer-to-pdf/url/download" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "file_url": "https://assets.apyhub.com/samples/sample.pdf",
    "footer_text": "Page {page}"
  }'

What you'll get back

Returns the generated PDF as a binary response.

TRY ITLIVE · 200 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Converts a PDF from a publicly accessible URL by adding a header and/or footer, then returns the modified PDF as a binary file. The request must include file_url, and at least one of header_text, footer_text, header_image_url, or footer_image_url.

Request Body

Parameter	Type	Mandatory	Description
file_url	String	Yes	Publicly accessible PDF URL. Format: URI.
footer_text	String	No	Footer text. Use `{page}` for the page number.
header_text	String	No	Header text. At least one of `header_text`, `footer_text`, `header_image_url`, or `footer_image_url` is required.
footer_alignment	ENUM	No	Alignment for the footer. Allowed values: `left`, `center`, `right`. Default: `center`.
footer_image_url	String	No	Publicly accessible PNG image URL for the footer. Format: URI.
header_alignment	ENUM	No	Alignment for the header. Allowed values: `left`, `center`, `right`. Default: `center`.
header_image_url	String	No	Publicly accessible PNG image URL for the header. Format: URI.

Response

Returns a binary file containing the updated PDF. The output schema is a top-level binary string, so the success response is the PDF content itself rather than a JSON object.

Attribute	Type	Mandatory	Description
response body	Binary	Yes	The modified PDF file.

Body

Name

Type

Description

bodyREQUIRED

object

—

▣ ENDPOINT 04 / 04

POST

Add header/footer to PDF (URL → S3 URL)

https://api.eu.apyverse.com/apyhub/add-header-footer-to-pdf/url/url

QUICKSTART

GUIDE

Quickstart

Generate a PDF from a URL with optional header and footer text.

curl -X POST "https://api.eu.apyverse.com/apyhub/add-header-footer-to-pdf/url/url" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "file_url": "https://assets.apyhub.com/samples/sample.pdf",
    "header_text": "CONFIDENTIAL",
    "footer_text": "Page {page}"
  }'

What you'll get back

Returns a JSON object with a url string field — the downloadable URL of the generated PDF.

{
  "url": "https://s3.amazonaws.com/bucket/output.pdf"
}

TRY ITLIVE · 200 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Adds a header and/or footer to a PDF referenced by URL, then returns a URL to the processed PDF.

Request Body

Parameter	Type	Mandatory	Description
file_url	String	Yes	The source PDF URL to process. Must be a valid URI.
footer_text	String	No	Footer text to add.
header_text	String	No	Header text to add.
footer_alignment	ENUM	No	Alignment for the footer content. Allowed values: `left`, `center`, `right`. Default: `center`.
footer_image_url	String	No	Footer image URL to add. Must be a valid URI.
header_alignment	ENUM	No	Alignment for the header content. Allowed values: `left`, `center`, `right`. Default: `center`.
header_image_url	String	No	Header image URL to add. Must be a valid URI.

Response

Returns a JSON object with a url string field containing the URI of the generated PDF. The success response is a JSON object with one top-level field: url (String).

Parameter	Type	Mandatory	Description
url	String	No	The URL of the processed PDF file. Must be a valid URI.

Body

Name

Type

Description

bodyREQUIRED

object

—

▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.