Document Scanner

document-scanner

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

H · HeadlessI · InteractiveE · Embedded

ID Tooldocument-scanner

Version1

ExécutionCLIENT

ModesHeadless, Interactive, Embedded

Accès rapide

Fichiers d’entrée 1Fichiers de sortie 1

Gestion des résultats → Recettes → Exemples d’intégration → Playground →

Entrée

Formats d’entrée et nombre de fichiers acceptés par cette Tool.

Type d’entrée	file
Nombre de fichiers	1 – 1
MIME acceptés	image/jpeg, image/png, image/webp

Paramètres

Transmettez ces valeurs via request.options.

Paramètre	Type	Obligatoire	Par défaut	Valeurs / Plage	Description
`mode`	enum	Optionnel	`enhanced-color`	enhanced-color \| original-color \| grayscale \| black-white	Document scan style.
`deskew`	boolean	Optionnel	`true`	—	Automatically correct small residual document tilt.
`format`	enum	Optionnel	`jpg`	jpg \| png	Output image format.

Sortie

Format du résultat renvoyé après traitement.

Type	files
Nombre de fichiers	1 – 1
MIME de sortie	image/jpeg, image/png
Metadata	width, height, inputBytes, outputBytes, deskewAngle
Archive ZIP	Non pris en charge

Utilisation de base

Choisissez un mode pris en charge et copiez le code de démarrage généré.

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.