pdf.watermark
Stamp a text watermark on every page.
POST /v1/pdf/watermark
| Input | one file, sent as multipart/form-data; the optional options part is a JSON object |
| Output | one PDF |
| Credits | 1 credit per 10 pages, rounded up to whole blocks of 10 pages, with a minimum of 1 credit |
| Limits | [size, page and time limits: no claim ID yet] |
| Reads or changes the document | returns a changed copy |
| Error statuses | 400, 413, 422, 500, 501, 504 (see Errors) |
Options
Section titled “Options”| Option | Type | Required | Default | Description |
|---|---|---|---|---|
background |
boolean | no | false |
Draw behind the page content instead of over it. Default false. |
color |
array of number | no | Colour as red, green, blue from 0 to 1. Default grey. | |
font_size |
number | no | 48 |
Font size in points. Default 48. |
opacity |
number | no | 0.30000001192092896 |
Opacity from 0 to 1. Default 0.3. |
password |
string | no | Password of an encrypted document. | |
rotation |
number | no | 45 |
Rotation in degrees, counter-clockwise. Default 45. |
text |
string | yes | The text, [limit: no claim ID yet]. |
Example
Section titled “Example”curl -sS -f -X POST "$PDFLUENT_API_URL/v1/pdf/watermark" \ -H "x-api-key: $PDFLUENT_API_KEY" \ -F 'options={"text":"DRAFT"}' \ -o result.pdfimport jsonimport os
import requests
options = {"text": "DRAFT"}
parts = [ ("file", ("structured.pdf", open("structured.pdf", "rb"))), ("options", (None, json.dumps(options))),]
response = requests.post( os.environ["PDFLUENT_API_URL"] + "/v1/pdf/watermark", headers={"x-api-key": os.environ["PDFLUENT_API_KEY"]}, files=parts,)response.raise_for_status()
with open("result.pdf", "wb") as out: out.write(response.content)import { openAsBlob } from 'node:fs';import { writeFile } from 'node:fs/promises';
const form = new FormData();form.append('file', await openAsBlob("structured.pdf"), "structured.pdf");form.append('options', JSON.stringify({"text":"DRAFT"}));
const response = await fetch(process.env.PDFLUENT_API_URL + "/v1/pdf/watermark", { method: 'POST', headers: { 'x-api-key': process.env.PDFLUENT_API_KEY }, body: form,});if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
await writeFile("result.pdf", Buffer.from(await response.arrayBuffer()));The key goes in the x-api-key header; see Authentication. Every response carries x-pdfluent-pages and x-pdfluent-credits.