Save Image — Reference
Write the current processing instance to a server folder.
Write the current processing instance to a server folder.
Before you begin
Section titled “Before you begin”- A supported image-processing runtime and a disposable test image. Load the named processing instance before effect, transform or Save steps.
Save Image
Section titled “Save Image”Write the current processing instance to a server folder.
Settings
Section titled “Settings”| Setting | Meaning |
|---|---|
| Name | Names the returned size or saved-path result for later server steps. |
| Image | Select the named Load Image instance available earlier in this action. It is not a filename or an App Connect page component. |
| Format | The output encoding: Auto, WebP, AVIF, JPEG, PNG or GIF. Auto uses the filename extension. Verify backend codec availability and match the template extension to an explicit format. |
| Quality | The encoding-quality value, with runtime default 75. It applies to supported lossy encoders, not uniformly to every format. Compare file size and visual artifacts in the actual output. |
| Path | The server destination folder. Do not put the full output filename here; use Template for the name. |
| Template | The output filename template, default {name}{ext}. For example, {name}-thumb.webp with WebP explicitly matches filename and encoding. Use the returned saved path if collision handling changes the name. |
| Background | The background used by the Node.js JPEG flattening path for transparent pixels. The installed PHP module does not pass this option through its explicit JPEG save call in the same way; verify transparency conversion on that target. |
| Overwrite | Allows replacing an existing output file when enabled. Default off; collision handling can choose a unique filename. |
| Create Path | Creates a missing output directory when enabled. Runtime default on. When off, the destination must already exist. |
| Output | Includes the named returned result in the action response. Default off. Most processing effects mutate an instance instead of returning a new public file result. |
Worked example
Section titled “Worked example”After Load and Resize, select the image instance, set a dedicated output folder, choose WebP and use Template {name}-thumb.webp. Save and inspect both the returned path and the actual image dimensions/format.
Check the result
Section titled “Check the result”Path is a folder and Template supplies the filename. Use a template extension matching an explicit Format: Node.js normalizes the extension, but PHP can keep the supplied name while writing the chosen encoding. With Overwrite off, use the returned path because a collision can create a suffixed name.
Load, transform and save
Section titled “Load, transform and save”Image Processor operations run on the server. For transformations, use a named Load Image, apply the intended operations to that instance, and Save it to a deliberate path. A page image component will not automatically update just because an in-memory server instance changed. Return or persist the saved path and update the page’s source as needed.
Check your result
Section titled “Check your result”You can configure the selected image operation and inspect a saved result for the intended dimensions or visual effect.