▣ FILE CONVERSION · FILE MANIPULATION

Apply Headers and Footers on DOCX API

What it does

DOCX Header Footer adds headers, footers, and an optional table of contents to a DOCX file, then returns the modified document as a download or a hosted URL.

Send a DOCX file and choose whether to supply header text, footer text, a header image, a footer image, or a table of contents. You can also set header and footer alignment to left, center, or right. The service supports both file uploads and publicly accessible DOCX and PNG URLs, so you can work with local documents or documents already stored online.

Use DOCX Header Footer when you need to stamp generated reports with CONFIDENTIAL, add page numbers in the footer, brand a document with logos, or prepare a structured proposal with a table of contents at the front. The input is a DOCX file or URL plus the header and footer settings; the output is either a binary DOCX download or a JSON response containing a url.

It is a good fit for document automation pipelines that need consistent formatting across batches of reports, contracts, or internal handbooks without opening Word manually.

▣ ENDPOINT 01 / 04

POST

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

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

QUICKSTART

GUIDE

Quickstart

Upload a DOCX file and return the modified document as a downloadable binary response.

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

What you'll get back

Returns a binary file in the response body.

TRY ITLIVE · 100 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 DOCX file and returns a modified DOCX file with header and/or footer content applied. You can provide header/footer text, header/footer images, and optionally insert a table of contents at the beginning of the document.

Request Body

Parameter	Type	Mandatory	Description
file	String	Yes	DOCX file to modify.
output	String	No	Output filename stem (without extension). Defaults to `document`.
footer_text	String	No	Footer text.
header_text	String	No	Header text. At least one of `header_text`, `footer_text`, `header_image`, `footer_image`, or `include_table_of_content` 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`.
include_table_of_content	Boolean	No	Insert a table of contents at the beginning of the document. Default: `false`.

Response

Returns a binary file in the response body.

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 DOCX (file upload → S3 URL)

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

QUICKSTART

GUIDE

Quickstart

Upload a DOCX file and get back a URL for the generated document.

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

What you'll get back

Returns a JSON object with a url string field containing the output file URL.

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

TRY ITLIVE · 100 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 DOCX file and returns a JSON object containing a url for the generated DOCX file.

Request Body

Parameter	Type	Mandatory	Description
file	String	Yes	The DOCX file to process.
footer_text	String	No	Footer text to insert, such as `Page {page}`.
header_text	String	No	Header text to insert, such as `CONFIDENTIAL`.
footer_image	String	No	Footer image file.
header_image	String	No	Header image file.
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`.
include_table_of_content	Boolean	No	Whether to include a table of content. Default: `false`.

Response

Returns a JSON object with a url string field containing the S3 URL of the generated DOCX file.

Parameter	Type	Mandatory	Description
url	String	No	A URI pointing to the generated DOCX file.

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 DOCX (URL → download)

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

QUICKSTART

GUIDE

Quickstart

Create a DOCX file from a public document URL with a header or footer, then download the result.

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

What you'll get back

Returns the generated file as a binary response.

TRY ITLIVE · 100 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 DOCX file referenced by URL, then returns the updated document as a binary response.

Request Body

Parameter	Type	Mandatory	Description
file_url	String	Yes	Publicly accessible DOCX URL.
footer_text	String	No	Footer text.
header_text	String	No	Header text. At least one of `header_text`, `footer_text`, `header_image_url`, `footer_image_url`, or `include_table_of_content` is required.
footer_alignment	ENUM	No	Allowed values: `left`, `center`, `right`. Default: `center`.
footer_image_url	String	No	Publicly accessible PNG image URL for the footer.
header_alignment	ENUM	No	Allowed values: `left`, `center`, `right`. Default: `center`.
header_image_url	String	No	Publicly accessible PNG image URL for the header.
include_table_of_content	Boolean	No	Default: `false`.

Response

Returns a binary file response containing the updated DOCX document.

Body

Name

Type

Description

bodyREQUIRED

object

—

▣ ENDPOINT 04 / 04

POST

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

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

QUICKSTART

GUIDE

Quickstart

Send the DOCX file URL along with the header/footer text to generate a new document.

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

What you'll get back

Returns a JSON object with a url string field containing the download URL of the generated DOCX.

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

TRY ITLIVE · 100 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 DOCX file provided by URL, then returns a JSON object containing a URL for the generated DOCX file.

Request Body

Parameter	Type	Mandatory	Description
file_url	String	Yes	Source DOCX file URL. Must be a URI.
footer_text	String	No	Footer text to add. Example: `Page {page}`.
header_text	String	No	Header text to add. Example: `CONFIDENTIAL`.
footer_alignment	ENUM	No	Footer alignment. Allowed values: `left`, `center`, `right`. Default: `center`.
footer_image_url	String	No	Footer image URL. Must be a URI.
header_alignment	ENUM	No	Header alignment. Allowed values: `left`, `center`, `right`. Default: `center`.
header_image_url	String	No	Header image URL. Must be a URI.
include_table_of_content	Boolean	No	Whether to include a table of contents. Default: `false`.

Response

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

Attribute	Type	Mandatory	Description
url	String	No	Output DOCX file URL. Must be a 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.