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

Versão1

ExecuçãoCLIENT

ModosHeadless, Interactive, Embedded

Ações rápidas

Arquivos de entrada 1Arquivos de saída 1

Tratamento de resultados → Receitas → Exemplos de integração → Playground →

Entrada

Formatos de entrada e quantidade de arquivos aceitos por esta Tool.

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

Parâmetros

Passe estes valores por request.options.

Parâmetro	Tipo	Obrigatório	Padrão	Valores / Faixa	Descrição
`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.

Saída

Formato do resultado retornado após o processamento.

Tipo	files
N.º de arquivos	1 – 1
MIME de saída	image/jpeg, image/png
Metadata	width, height, inputBytes, outputBytes, deskewAngle
Arquivo ZIP	Não suportado

Uso básico

Escolha um modo suportado e copie o código inicial gerado.

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.