Batch Image Watermark

batch-image-watermark

Use Batch Image Watermark through the Zavilo SDK. Check input limits, parameters, output and supported modes below.

H · HeadlessI · InteractiveE · Embedded

Tool IDbatch-image-watermark

Version1

ExecutionCLIENT

WorkloadSTANDARD

ModesHeadless, Interactive, Embedded

Quick actions

Input files 1–30Output files 1–30

Result handling → Recipes → Integration examples → Playground →

Input

Accepted input contract for this Tool.

Kind	file
File count	1 – 30
Accepted MIME types	image/jpeg, image/png, image/webp

Parameters

Pass these values through request.options.

Parameter	Type	Required	Default	Allowed / Range	Description
`type`	enum	Optional	`text`	text \| image	Watermark type. For image type, pass input.data.watermarkFile as a File.
`text`	string	Optional	`© Your Brand`	—	Text watermark content.
`color`	string	Optional	`#ffffff`	—	Text watermark color.
`opacity`	number	Optional	`55`	5 – 100	Watermark opacity percentage.
`size`	number	Optional	`24`	5 – 60	Watermark width as percentage of source width.
`rotation`	number	Optional	`-30`	-180 – 180	Watermark rotation in degrees.
`margin`	number	Optional	`4`	0 – 15	Edge margin percentage.
`position`	enum	Optional	`bottom-right`	top-left \| top-center \| top-right \| middle-left \| center \| middle-right \| bottom-left \| bottom-center \| bottom-right	Watermark position.
`format`	enum	Optional	`jpg`	jpg \| png	Output format.
`quality`	number	Optional	`0.92`	0.6 – 1	JPG quality.

Output

Result contract returned after successful processing.

Type	files
File count	1 – 30
MIME types	image/jpeg, image/png
Metadata	inputBytes, outputBytes, outputCount
ZIP archive	Yes · threshold 2

Basic usage

Choose a supported integration mode and copy the generated starter code.

Headless

const result = await client.run("batch-image-watermark", {
  files: selectedFiles,
  options: { type: "text", text: "© Your Brand", color: "#ffffff", opacity: 55 }
});
console.log(result.files, result.data, result.metadata);

Interactive

await client.open({
  tool: "batch-image-watermark",
  input: { files: selectedFiles },
  options: { type: "text", text: "© Your Brand", color: "#ffffff", opacity: 55 },
  onComplete(result) { console.log(result.files, result.data, result.metadata); }
});

Embedded

await client.mount({ tool: "batch-image-watermark", target: "#zavilo-tool", mode: "embedded" });

This page is generated from the SDK Tool Definition used by the runtime.