ComfyUI Node: Export API

Export API:

The Export API node is designed to facilitate the export of models and data in a structured and efficient manner. This node is particularly useful for AI artists who need to save their work, including models and associated metadata, in a consistent format. By leveraging this node, you can ensure that your models are exported with a specific naming convention, which includes customizable filename prefixes, delimiters, and padding for numbering. Additionally, the node supports the inclusion of prompts and other metadata, making it easier to keep track of the context and parameters used during the creation process. This functionality is essential for maintaining an organized workflow and ensuring that all necessary information is preserved for future reference or sharing.

Export API Input Parameters:

output_path

The output_path parameter specifies the directory where the exported files will be saved. This is crucial for organizing your exported models and ensuring they are stored in a location that is easy to access and manage. If not provided, the default path will be used.

filename_prefix

The filename_prefix parameter allows you to define a custom prefix for the filenames of the exported files. This helps in categorizing and identifying files based on their purpose or content. The default value is "ComfyUI".

filename_number_padding

The filename_number_padding parameter determines the number of digits used for numbering the exported files. This is useful for maintaining a consistent and easily sortable file naming convention. The default value is 4.

filename_delimiter

The filename_delimiter parameter specifies the character used to separate different parts of the filename, such as the prefix and the number. This helps in creating readable and organized filenames. The default value is an underscore (_).

prompt

The prompt parameter allows you to include a text prompt or description that will be saved along with the exported files. This is useful for documenting the context or parameters used during the creation of the model.

save_prompt_api

The save_prompt_api parameter determines whether the prompt should be saved as part of the exported metadata. This is a boolean value, with "true" indicating that the prompt will be saved and "false" indicating that it will not. The default value is "true".

parse_text_tokens

The parse_text_tokens parameter specifies whether the text tokens in the prompt should be parsed and included in the metadata. This is useful for detailed documentation and analysis of the prompt. The default value is False.

Export API Output Parameters:

Exported Files

The primary output of the Export API node is the set of exported files, which include the model and associated metadata. These files are saved in the specified output path with the defined naming convention. The exported files are essential for preserving the work and ensuring that all necessary information is available for future use or sharing.

Export API Usage Tips:

• Ensure that the output_path is correctly specified to avoid saving files in unintended locations.
• Use meaningful filename_prefix values to categorize and easily identify your exported files.
• Adjust the filename_number_padding to match the expected number of exported files for better organization.
• Include detailed prompts using the prompt parameter to document the context and parameters used during model creation.
• Set save_prompt_api to "true" to ensure that the prompt is saved along with the exported files for future reference.

Export API Common Errors and Solutions:

"Invalid output path specified"

• Explanation: The specified output_path does not exist or is not accessible.
• Solution: Verify that the output_path is correct and that you have the necessary permissions to write to the directory.

"Filename prefix contains invalid characters"

• Explanation: The filename_prefix contains characters that are not allowed in filenames.
• Solution: Use only alphanumeric characters and underscores in the filename_prefix.

"Failed to save prompt metadata"

• Explanation: There was an issue saving the prompt metadata due to incorrect parameter settings.
• Solution: Ensure that the save_prompt_api parameter is set to "true" and that the prompt parameter contains valid text.

"Error parsing text tokens"

• Explanation: The parse_text_tokens parameter is set to True, but the prompt contains invalid or unrecognized tokens.
• Solution: Review the prompt text and ensure that it contains valid tokens, or set parse_text_tokens to False if token parsing is not required.