Remove Watermark API

Remove watermarks from a PDF.

Feature

The ComPDF Self-hosted accepts files and a request JSON string through multipart/form-data, forwards the parameters to the private PDF SDK, and streams the result file back on success.

Synchronous Request

Item	Value
Authentication	x-api-key: your_api_key_here
Request URL	POST http://localhost:8080/api/v1/process/pdf/watermark/remove
Content type	multipart/form-data
Success response	Result file stream

Request Parameters

Parameter	Type	Description	Required
file	File	Source PDF file.	Yes
request	String	JSON string containing the PDF SDK parameters below. If omitted, remaining non-file form-data fields are forwarded as the request object.	No

Request Object Parameters

Put the following fields in the request JSON string.

Parameter	Type	Purpose
pages	String or Number[]	Pages to process. Examples: 1, 1,3-5, [1,3,4,5], or all when supported.
mode	String	Remove watermark mode. The ComPDF Web sends tagged; the ComPDF Self-hosted switches to untagged when specific pages are provided.
password	String	Source PDF open password. Some routes remove it before forwarding when the SDK endpoint does not accept it directly.
outputFileName	String	Optional output filename. When present, it is used as the preferred download filename.

Request Example

curl -X POST "http://localhost:8080/api/v1/process/pdf/watermark/remove" \
  -H "x-api-key: your_api_key_here" \
  -F "[email protected]" \
  -F 'request={"pages":"1,3-5","mode":"tagged"}'

Response

On success, the API returns the processed file stream with Content-Type and Content-Disposition headers. On failure, ComPDF Self-hosted returns the normalized error response described in Definition of Error Codes, including type, code, errorCode, message, and traceId.