Watermark a PDF
POST/pdf/watermark
Draws a text or an image, centred, across every page of a PDF, into a new render (0.5 units
on live keys; Starter plan and above). A text runs diagonally by default, sized to span most
of the page; it is set in Noto Sans Bold, embedded in the file, which covers Latin, Greek and
Cyrillic letters, and a text with other characters answers 400 invalid_request. An image is
a PNG or JPEG of the workspace file library, at most 60 % of the page's width and height,
upright by default. Pass text or image, not both. Needs render:create.
Request
Responses
- 200
- 429
- default
Watermarked render.
rate_limited: the workspace's bucket of the plan's requests per second is empty (Free test keys also have 30 a minute). The problem names the bucket's limit and its window_seconds. Retry after Retry-After seconds.
Response Headers
Seconds until a request is let through again.
Size of the workspace's request bucket: the plan's requests per second. Free test keys are also held to 30 requests a minute, and the headers then describe whichever bucket is closer to empty.
Requests left in the bucket.
Seconds until the bucket is full again.
Error (RFC 9457 problem details).