Document Scanner

document-scanner

Use Document Scanner through the Zavilo SDK. Check input limits, parameters, output and supported modes below.

H · HeadlessI · InteractiveE · Embedded

Tool IDdocument-scanner

Version1

ExecutionCLIENT

WorkloadSTANDARD

ModesHeadless, Interactive, Embedded

Quick actions

Input files 1Output files 1

Result handling → Recipes → Integration examples → Playground →

Input

Accepted input contract for this Tool.

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

Parameters

Pass these values through request.options.

Parameter	Type	Required	Default	Allowed / Range	Description
`mode`	enum	Optional	`enhanced-color`	enhanced-color \| original-color \| grayscale \| black-white	Document scan style.
`deskew`	boolean	Optional	`true`	—	Automatically correct small residual document tilt.
`format`	enum	Optional	`jpg`	jpg \| png	Output image format.

Output

Result contract returned after successful processing.

Type	files
File count	1 – 1
MIME types	image/jpeg, image/png
Metadata	width, height, inputBytes, outputBytes, deskewAngle
ZIP archive	No

Basic usage

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

Headless

const result = await client.run("document-scanner", {
  file,
  options: { mode: "enhanced-color", deskew: true, format: "jpg" }
});
console.log(result.files, result.data, result.metadata);

Interactive

await client.open({
  tool: "document-scanner",
  input: { file },
  options: { mode: "enhanced-color", deskew: true, format: "jpg" },
  onComplete(result) { console.log(result.files, result.data, result.metadata); }
});

Embedded

await client.mount({ tool: "document-scanner", target: "#zavilo-tool", mode: "embedded" });

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