ComfyUI Node: 😼> Save Image

😼> Save Image:

The Save Image node is designed to facilitate the saving of generated images in a structured and efficient manner. This node is particularly useful for AI artists who need to store their creations with associated metadata, such as prompts and additional information. By leveraging this node, you can ensure that your images are saved with consistent naming conventions and in designated directories, making it easier to organize and retrieve your work. The node also supports the inclusion of metadata, which can be crucial for tracking the creative process and for future reference. Overall, the Save Image node streamlines the image-saving workflow, allowing you to focus more on the creative aspects of your projects.

😼> Save Image Input Parameters:

images

This parameter expects a list of images that you want to save. Each image should be in a format that can be processed by the node, typically as a tensor or array. The images are the primary content that will be saved to disk.

filename_prefix

This is a string parameter that sets the prefix for the filenames of the saved images. By default, it is set to "ComfyUI". This prefix helps in organizing and identifying the saved images, especially when dealing with multiple batches or versions.

prompt

This optional parameter allows you to include the prompt used to generate the images. It is stored as metadata within the saved image file, which can be useful for future reference or for sharing the creative process with others.

extra_pnginfo

This optional parameter accepts additional metadata in the form of a dictionary. Each key-value pair in the dictionary is saved as part of the image's metadata, providing further context or information about the image.

😼> Save Image Output Parameters:

ui

This output parameter returns a dictionary containing information about the saved images. It includes details such as the filenames, subfolders, and types of the saved images. This information can be used to verify that the images were saved correctly and to locate them on disk.

😼> Save Image Usage Tips:

• Ensure that the images parameter contains valid image data in the correct format to avoid errors during the saving process.
• Use a meaningful filename_prefix to easily identify and organize your saved images, especially when working on multiple projects.
• Include relevant metadata using the prompt and extra_pnginfo parameters to provide context and additional information about the saved images, which can be useful for future reference or sharing.

😼> Save Image Common Errors and Solutions:

"Invalid image format"

• Explanation: This error occurs when the images provided are not in a format that the node can process.
• Solution: Ensure that the images are in a compatible format, such as a tensor or array, before passing them to the node.

"Failed to save image"

• Explanation: This error indicates that the node encountered an issue while trying to save the image to disk.
• Solution: Check the output directory permissions and ensure there is enough disk space. Also, verify that the filename prefix and other parameters are correctly set.

"Metadata saving disabled"

• Explanation: This error occurs if the node is configured to save metadata, but the global settings have metadata saving disabled.
• Solution: Enable metadata saving in the global settings or adjust the node's configuration to not include metadata.