Image Batch Saver:
ImageBatchSaver saves generated images and accompanying text to files, making it useful for organizing a series of renders or recording results from repeated workflow runs. It can create numbered filenames, save into chosen directories, write text beside images, and work with supported multi-frame formats. An append mode can add frames to an existing file, while frame-range controls can limit what is saved. It is a save-only node: it writes files rather than passing images or file paths to another node.
Image Batch Saver Input Parameters:
images
Optional IMAGE input containing the images to save. The node accepts an image or a list of images; it splits image tensors containing multiple batch items into individual images before saving. Each resulting image is paired, by position, with a filename prefix and output path. There is no default image. If you leave this input disconnected, the node can still write supplied text, but it does not create an image file.
contents
Optional STRING input for text to save alongside the images; this parameter is configured as an input connection. Each supplied text item is written as a UTF-8 .txt file with the same generated base filename as its corresponding image. Existing text at that filename is overwritten. If there are no images, the number of supplied content items determines how many save operations the node attempts. There is no default text.
output_path
Optional STRING specifying the destination directory. The default is an empty string, which uses the application's output directory; . and none also resolve to that directory. A relative path is joined to the output directory, while an absolute path is used directly. The node creates missing directories where it can. If you supply a list of paths, entries are paired with images in order, and the last entry is reused when the list is shorter.
filename_prefix
Optional STRING for the main part of each filename; the default is IMG. The node uses the prefix's basename and removes its final extension before building the filename, so this setting is not a way to choose the save directory or file format. If you supply a list of prefixes, entries are paired with images in order, and the last entry is reused when the list is shorter.
filename_delimiter
Optional STRING placed between filename components such as the prefix, suffix, and number. The default is _, producing names such as IMG_0001.png with the default numbering settings. No minimum or maximum length is specified.
filename_suffix
Optional STRING added after the prefix and before a number placed at the end. The default is an empty string, so no suffix is added. For example, a suffix of final produces IMG_final_0001.png with the other filename defaults. The node strips surrounding apostrophes and square brackets from this value before using it; no minimum or maximum length is specified.
extension
Optional format selector with the options png, jpg, jpeg, webp, bmp, tiff, and gif; the default is png. It determines the image file extension and format. If you enable append_frames with png, jpg, jpeg, or bmp, the node changes the image format to gif so it can save multiple frames. Text files, when supplied, always use .txt.
filename_number_padding
Optional INT setting for the minimum width of the filename number, filled with leading zeros. The default is 4, the minimum is 1, and the maximum is 9, in steps of 1. For example, a width of four displays the first number as 0001. This changes how the number looks, not the starting number; numbers can grow beyond the chosen width.
filename_number
Optional selector controlling where the automatic number appears. Options are off, start, and end; the default is end. start puts the number before the prefix, end puts it after the suffix or prefix, and off omits it. When numbering is enabled, the node scans matching filenames in the destination directory and uses one more than the highest number it finds, starting at 1 if none match. With off, saving again to the same filename can overwrite the existing file.
embeded_workflow
Optional BOOLEAN controlling whether the node attempts to include available prompt and workflow information in saved image metadata. The default is True; False saves without requesting that metadata. Metadata handling depends on the image format: the source uses EXIF for WebP and PNG-style metadata for several other save paths, while its multi-frame GIF save path does not add workflow metadata. Do not rely on this setting as a guarantee that every format will retain readable workflow information.
append_frames
Optional BOOLEAN for adding new frames to an existing image file with a matching base name. The default is False. When True, the node looks for an existing file, loads its frames, combines them with the new image or frames, and saves the combined result; it chooses the highest matching filename number when numbering is enabled. It keeps gif, tiff, and webp as selected, but switches other selected image formats to gif. Because it reloads and rewrites the accumulated file, a growing animation can still use substantial memory and take longer to save.
start_index
Optional INT setting intended to select the first frame to save, using 1-based positions. The default is 0, the minimum is 0, and the maximum is 999999, in steps of 1. 0 means start at the first frame; 1 also means the first frame, and 2 means the second. The selection is applied only when the image reaching the save step is a four-dimensional, multi-frame tensor. The node normally splits image batches into individual items earlier, so this control may not limit a standard IMAGE batch as you expect.
end_index
Optional INT setting intended to select the last frame to save, inclusively, using 1-based positions. The default is 0, the minimum is 0, and the maximum is 999999, in steps of 1. 0 means continue through the final frame; a positive value selects a final position. Like start_index, it applies only if a four-dimensional tensor reaches the save step, and may have no visible effect on a standard image batch that the node has already split.
Image Batch Saver Output Parameters:
There are no output parameters. ImageBatchSaver is an output node that writes files to disk and returns no images, text, or file paths through sockets.
Image Batch Saver Usage Tips:
- For separate, easy-to-find renders, leave
filename_numberatendand set a descriptivefilename_prefix. Check the destination directory when organizing multiple runs: the next number is based on matching filenames already present there. - Use
output_pathto organize projects. A relative value creates a destination under the application's output directory; use an absolute path only when you intend to save elsewhere and have permission to write there. - Connect
contentswhen you want a text note beside each image. Keepfilename_numberenabled if you want repeated runs to create new text filenames rather than overwrite an existing.txtfile. - For an accumulating animation, enable
append_framesand choosegif,webp, ortiffdeliberately. Review the saved result after a short test: the node reloads and rewrites existing frames, and selecting another format switches the appended image to GIF. - If you need to save only certain images from a standard batch, filter the batch before connecting it. The node splits batches into individual items before its
start_indexandend_indexfiltering step, so those settings are not a dependable batch selector. - If embedded workflow information matters, test the chosen format by inspecting a saved file. In particular, the multi-frame GIF path does not add workflow metadata even when
embeded_workflowisTrue.
Image Batch Saver Common Errors and Solutions:
Error saving file 1: ...
- Explanation: The node reports a problem for an individual save operation and continues its loop. The text after the colon gives the underlying cause; the number identifies the item it was processing.
- Solution: Read the full message and check that item's destination, filename settings, image, and text. Confirm that the destination exists or can be created, then run the workflow again.
Invalid extension: ...
- Explanation: The selected extension is not one of the formats accepted by the node. This validation happens before the per-file save loop.
- Solution: Choose
png,jpg,jpeg,webp,bmp,tiff, orgif.
filename_number_padding must be at least 1, got ...
- Explanation: The number-padding value is below the minimum the save method accepts.
- Solution: Set
filename_number_paddingto at least1; the node's input control specifies a maximum of9.
Error saving file 1: [Errno 13] Permission denied: ...
- Explanation: The node could not create a destination directory or write a file there.
- Solution: Choose a writable
output_path, check folder permissions, and make sure the target file is not locked by another application.
Error saving file 1: [Errno 2] No such file or directory: ...
- Explanation: A path used during saving could not be found or used as expected. This can occur if part of the requested destination or filename is invalid for your system.
- Solution: Try an empty
output_pathto save in the application's output directory, use a simple prefix and suffix, and check that the destination is available.
Error saving file 1: unknown file extension: ... or Error saving file 1: cannot write mode ...
- Explanation: The image library could not save the processed image using the requested format or image mode.
- Solution: Try
pngfor a single image orgiffor multiple frames. If the problem persists, inspect the image supplied to the node and try a conventional RGB or grayscale image.
Error processing tensor with shape ...: ... or Failed to save image: ..., fallback also failed: ...
- Explanation: The supplied image data could not be converted into a savable image. The node attempts a fallback conversion before reporting that it failed.
- Solution: Connect a valid
IMAGEoutput and, if possible, convert unusual image data to a standard image before saving. Check the subsequentError saving filemessage for the final failure.
Error loading image frames from ...: ...
- Explanation: With
append_framesenabled, the node found an existing file but could not read its frames. It then attempts to create a new output file rather than append those frames. - Solution: Check that the existing file opens normally and is not damaged. If you do not need its frames, move or rename it before saving again.
Error saving file 1: Sizes of tensors must match ...
- Explanation: In append mode, the existing frames and new frames must have compatible dimensions to be combined. Different image widths or heights can prevent that combination.
- Solution: Save frames at the same width and height throughout the animation, or start a new file when you change dimensions.
Warning: ... doesn't support multiple frames. Only first frame saved.
- Explanation: More than one frame reached the image writer, but the selected format's save path writes only the first frame. This is a warning rather than an indication that no file was saved.
- Solution: Select
gif,webp, ortiffwhen you need a multi-frame file, and inspect the result to confirm the frames were retained.
