Image Tools
Compress Image
compress-image
Use Compress Image through the Zavilo SDK. Check input limits, parameters, output and supported modes below.
H · Headless
Quick actions
Input files 1Output files 1
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 |
|---|---|---|---|---|---|
format |
enum | Optional | auto |
auto | jpg | webp | Output format. auto uses WebP for WebP input and JPG for other supported inputs. |
quality |
number | Optional | 0.8 |
0.3 – 0.95 | Compression quality from 0.3 to 0.95. |
Output
Result contract returned after successful processing.
| Type | files |
|---|---|
| File count | 1 – 1 |
| MIME types | image/jpeg, image/webp |
| Metadata | width, height, inputBytes, outputBytes |
| ZIP archive | No |
Basic usage
Choose a supported integration mode and copy the generated starter code.
Headless
const result = await client.run("compress-image", {
file,
options: { format: "auto", quality: 0.8 }
});
console.log(result.files, result.data, result.metadata);
Embedded
await client.mount({ tool: "compress-image", target: "#zavilo-tool", mode: "embedded" });
This page is generated from the SDK Tool Definition used by the runtime.