Stirling PDF icon

Stirling PDF

Merged API: Stirling PDF - Processing API + Stirling PDF - Management API + Stirling PDF - System API

Actions260

Security → Add Watermark

AI-generated

Summary

Add a watermark (either text or image) to a PDF file provided as binary input or identified by a File ID, customizing properties like font size, rotation, opacity, spacers, color, and optionally converting the watermarked PDF to an image.

Inputs

  • Input Binary Field Name (File Input) — Name of the binary property containing the input PDF file data.
  • File Id — Identifier of a server-side PDF file to watermark, used instead of binary input if available.
  • Watermark Type (required) — Selects whether to apply a text or image watermark.
  • Watermark Text — Text used as the watermark when Watermark Type is text.
  • Input Binary Field Name (Watermark Image) — Name of the binary property containing the watermark image data.
  • Alphabet — Alphabet type applied to the watermark text, e.g., Roman, Arabic, Japanese.
  • Font Size — Font size for the watermark text.
  • Rotation — Rotation angle in degrees for the watermark.
  • Opacity — Opacity level of the watermark, from 0.0 (transparent) to 1.0 (opaque).
  • Width Spacer — Horizontal spacing between watermark elements.
  • Height Spacer — Vertical spacing between watermark elements.
  • Custom Color — Color applied to the watermark (hex code).
  • Convert P D F To Image (required) — Boolean to determine if the resulting watermarked PDF should be converted to an image.

Output shape

a binary PDF file or an image if conversion is enabled

Outputs the watermarked file; if Convert PDF To Image is true, output is an image representation of the PDF; otherwise, it is a watermarked PDF binary.

Links

Discussion