▣ FILE CONVERSION · FILE MANIPULATION

Apply Headers and Footers on DOCX API

Hosted on ApyHub

What it does

DOCX Header Footer adds headers, footers, and optional table-of-contents support to a DOCX file. Send a DOCX by upload or by public URL, choose text or PNG images for the header and footer, and get back either a modified file or a downloadable URL.

Use header_text and footer_text when you want running labels such as CONFIDENTIAL or Page {page}. If you prefer branded documents, provide header_image or footer_image on upload, or header_image_url and footer_image_url for URL-based requests. You can also set header_alignment and footer_alignment to left, center, or right to control placement.

The service supports two input modes: file upload or publicly accessible DOCX URL. Depending on the endpoint, the output is either a binary DOCX download or an object containing a url to the generated document. That makes it useful for report generation, contract assembly, or internal document workflows where every file needs consistent branding and page labels.

If your document needs an index, set include_table_of_content to insert a table of contents at the beginning before the file is returned.

▣ ENDPOINT 01 / 04

POST

Add header/footer to DOCX

http://localhost:8080/apyhub/add-header-footer-to-docx/file/download

QUICKSTARTGUIDE

Quickstart

Upload a DOCX file and add a header or footer, then download the modified document.

curl -X POST "http://localhost:8080/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 response with the modified DOCX content.

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, adds the requested header/footer content to it, and returns the modified document as a downloadable file.

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	Allowed values: `left`, `center`, `right`. Default: `center`.
header_alignment	ENUM	No	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 download containing the modified document.

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

http://localhost:8080/apyhub/add-header-footer-to-docx/file/url

QUICKSTARTGUIDE

Quickstart

Upload a DOCX file and get back a link to the generated file with header and footer added.

curl -X POST "http://localhost:8080/apyhub/add-header-footer-to-docx/file/url" \
  -H "apy-token: $APY_TOKEN" \
  -F "file=@/path/to/document.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

Uploads a DOCX file, adds header and/or footer content to it, and returns a URL to the modified DOCX file.

Request Body

Parameter	Type	Mandatory	Description
file	String	Yes	DOCX file to process. Binary upload.
footer_text	String	No	Footer text to insert.
header_text	String	No	Header text to insert.
footer_image	String	No	Footer image to insert. Binary upload.
header_image	String	No	Header image to insert. Binary upload.
footer_alignment	ENUM	No	Footer alignment. Allowed values: `left`, `center`, `right`. Default: `center`.
header_alignment	ENUM	No	Header alignment. 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 URI of the generated DOCX file.

Parameter	Type	Mandatory	Description
url	String	Yes	URI of 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

http://localhost:8080/apyhub/add-header-footer-to-docx/url/download

QUICKSTARTGUIDE

Quickstart

Send a DOCX file URL with at least one header or footer value to generate the updated document.

curl -X POST "http://localhost:8080/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 a binary file download as 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.

About this endpoint

What it does

Adds a header and/or footer to a DOCX file fetched from a public URL, then returns the resulting document as a binary file. The request body must include the source DOCX URL and at least one header/footer content option.

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	Alignment for the footer. Allowed values: `left`, `center`, `right`. Default: `center`.
footer_image_url	String	No	Publicly accessible PNG image URL for the footer.
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.
include_table_of_content	Boolean	No	Whether to include a table of contents. 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

http://localhost:8080/apyhub/add-header-footer-to-docx/url/url

QUICKSTARTGUIDE

Quickstart

Create a DOCX with a header/footer by sending the source file URL and the text to add.

curl -X POST "http://localhost:8080/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 — the URL of the generated DOCX file.

{
  "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 to the generated DOCX file.

Request Body

Parameter	Type	Mandatory	Description
file_url	String	Yes	URL of the source DOCX file to process. Must be a URI.
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_alignment	ENUM	No	Alignment for the footer content. Allowed values: `left`, `center`, `right`. Default: `center`.
footer_image_url	String	No	URL of the image to place in the footer. Must be a URI.
header_alignment	ENUM	No	Alignment for the header content. Allowed values: `left`, `center`, `right`. Default: `center`.
header_image_url	String	No	URL of the image to place in the header. 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.

Parameter	Type	Mandatory	Description
url	String	No	URL of the generated DOCX file. 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.