Autype icon

Autype

Interact with the Autype Developer API for document generation, PDF tools, and more

Actions42

Document Tool → Add Watermark

AI-generated

Summary

Applies a custom text watermark to specified or all pages of an uploaded PDF file.

Inputs

  • fileId (required) — The ID of the PDF file previously uploaded using the File resource.
  • text (required) — The text content to display in the watermark.
  • waitForCompletion — Whether to poll the API until the watermark job completes before returning results. Defaults to true.
  • downloadOutput — Whether to automatically download the watermarked PDF as binary data upon completion. Only available when Wait for Completion is true. Defaults to false.
  • watermarkOptions — Collection of optional parameters including text color (hex code), font size in points, opacity (0 to 1), rotation angle in degrees, and page ranges (e.g., '1,3-5').

Output shape

a JSON job status record, or binary PDF data

When 'Wait for Completion' and 'Download Output' are both enabled, the node returns the watermarked file as binary data. Otherwise, it returns a JSON object containing the tool job status and metadata.

Examples

Example 1: Watermark a PDF document and download the result directly

Set File ID to 'file_123', Watermark Text to 'CONFIDENTIAL', Wait for Completion to true, and Download Output to true.

Example 2: Apply a styled red watermark to selected pages

Set File ID to 'file_123', Watermark Text to 'DRAFT', and under Watermark Options set Pages to '1,3-5', Color to '#FF0000', Opacity to 0.5, and Rotation to -45.

Links

Discussion