ComfyUI Node: Image Save

Image Save:

The Image Save node is designed to facilitate the saving of images generated or processed within the ComfyUI environment. This node allows you to specify various parameters to customize the saving process, such as the output path, file name prefix, image format, and quality settings. By providing a flexible and user-friendly interface, the Image Save node ensures that your images are stored efficiently and according to your preferences. This node is particularly useful for AI artists who need to manage and organize their generated images systematically, ensuring that each image is saved with the desired attributes and in the correct location.

Image Save Input Parameters:

images

This parameter accepts the images you want to save. It is essential to provide the images in the correct format to ensure they are saved properly.

output_path

Specifies the directory where the images will be saved. If left empty, the default directory will be used. This parameter allows you to organize your saved images by directing them to specific folders.

filename_prefix

Defines the prefix for the saved image files. This helps in categorizing and identifying images easily. The default value is "ComfyUI".

filename_delimiter

Sets the delimiter used between different parts of the filename. The default value is an underscore (_), which helps in maintaining a clear and readable file naming convention.

extension

Determines the file format for the saved images. Options include png, jpg, and others. The default value is png, which is widely used for its lossless compression.

dpi

Specifies the dots per inch (DPI) for the saved images. This parameter affects the print quality of the images. The default value is 96.

quality

Sets the quality of the saved images, particularly for lossy formats like jpg. The value ranges from 1 to 100, with 100 being the highest quality. The default value is 100.

optimize_image

A boolean parameter that determines whether to optimize the image for size. The default value is true, which helps in reducing the file size without significant loss of quality.

lossless_webp

A boolean parameter that specifies whether to save WebP images in a lossless format. The default value is false.

prompt

An optional parameter to include a prompt or description with the saved image. This can be useful for documentation or reference purposes.

extra_pnginfo

Allows you to embed additional metadata into the saved PNG images. This can include information like creation date, author, or any other relevant data.

overwrite_mode

A boolean parameter that determines whether to overwrite existing files with the same name. The default value is false, which prevents accidental overwriting of files.

filename_number_padding

Specifies the number of digits to use for numbering files. This helps in maintaining a consistent file naming convention. The default value is 4.

filename_number_start

Defines the starting number for file numbering. This parameter is useful when you want to continue numbering from a specific point. The default value is false.

show_history

A boolean parameter that determines whether to show the history of saved images. The default value is false.

show_history_by_prefix

A boolean parameter that specifies whether to filter the history of saved images by the filename prefix. The default value is true.

embed_workflow

A boolean parameter that determines whether to embed the workflow information into the saved image. The default value is true.

show_previews

A boolean parameter that specifies whether to show previews of the saved images. The default value is true.

Image Save Output Parameters:

None

This node does not produce any direct output parameters. Its primary function is to save images to the specified location with the given parameters.

Image Save Usage Tips:

• Ensure that the output_path is correctly specified to avoid saving images in unintended locations.
• Use meaningful filename_prefix and filename_delimiter to keep your saved images organized and easily identifiable.
• Adjust the quality parameter according to your needs, especially when saving images in lossy formats like jpg.
• Enable optimize_image to reduce file size without compromising much on quality, which is useful for web usage.
• Utilize the extra_pnginfo parameter to embed useful metadata into your images for better documentation and reference.

Image Save Common Errors and Solutions:

The image specified_path doesn't exist!

• Explanation: This error occurs when the specified path for saving the image does not exist or is incorrect.
• Solution: Verify that the output_path is correct and that the directory exists. Create the directory if it does not exist.

The image image does not exist!

• Explanation: This error indicates that the image you are trying to save does not exist or is not correctly referenced.
• Solution: Ensure that the images parameter is correctly set and that the images are in the correct format and accessible.

Failed to save image due to invalid file format!

• Explanation: This error occurs when the specified file format is not supported or is incorrectly specified.
• Solution: Check the extension parameter to ensure it is set to a valid and supported file format like png or jpg.

Overwrite mode is disabled, and file already exists!

• Explanation: This error occurs when a file with the same name already exists, and the overwrite_mode is set to false.
• Solution: Either enable overwrite_mode to allow overwriting existing files or change the filename_prefix or filename_number_start to avoid conflicts.