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 de Tooldocument-scanner

Versión1

EjecuciónCLIENT

ModosHeadless, Interactive, Embedded

Acciones rápidas

Archivos de entrada 1Archivos de salida 1

Gestión de resultados → Recetas → Ejemplos de integración → Playground →

Entrada

Formatos de entrada y número de archivos admitidos por esta Tool.

Tipo de entrada	file
N.º de archivos	1 – 1
MIME admitidos	image/jpeg, image/png, image/webp

Parámetros

Pasa estos valores mediante request.options.

Parámetro	Tipo	Obligatorio	Predeterminado	Valores / Rango	Descripción
`mode`	enum	Opcional	`enhanced-color`	enhanced-color \| original-color \| grayscale \| black-white	Document scan style.
`deskew`	boolean	Opcional	`true`	—	Automatically correct small residual document tilt.
`format`	enum	Opcional	`jpg`	jpg \| png	Output image format.

Salida

Formato del resultado devuelto al completar el procesamiento.

Tipo	files
N.º de archivos	1 – 1
MIME de salida	image/jpeg, image/png
Metadata	width, height, inputBytes, outputBytes, deskewAngle
Archivo ZIP	No compatible

Uso básico

Elige un modo compatible y copia el código inicial generado.

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.