ComfyUI Node: CivitAI Downloader

CivitAI Downloader:

The CivitAI Downloader is a specialized node designed to facilitate the downloading of AI models from the CivitAI platform. This node is particularly beneficial for AI artists and developers who need to access and utilize various models for their creative projects. By providing a streamlined method to download models directly to a specified directory, the CivitAI Downloader simplifies the process of acquiring and managing AI models. It supports downloading using either a model ID or a direct URL, and can handle authentication tokens if required. This flexibility ensures that users can easily integrate the latest models into their workflows, enhancing their creative capabilities without the need for complex technical setups.

CivitAI Downloader Input Parameters:

save_dir

The save_dir parameter specifies the directory where the downloaded model will be saved. It is a required parameter and ensures that the model is stored in a location that is easily accessible for further use. The directory path is determined by the get_model_dirs() function, which provides a list of available directories. This parameter does not have a default value, as it is essential for the user to define where the model should be saved.

ignore

The ignore parameter is an optional boolean that determines whether the download process should be bypassed. By default, it is set to False, meaning the download will proceed unless explicitly instructed otherwise. This parameter is useful for scenarios where you might want to skip downloading under certain conditions, such as when a model is already available locally.

model_id

The model_id parameter is an optional string that identifies the specific model to be downloaded from CivitAI. It defaults to "360292", but you can specify any valid model ID to download a different model. This parameter is crucial when you do not have a direct URL but know the model's ID on the platform.

token_id

The token_id parameter is an optional string used for authentication purposes. It defaults to an empty string, indicating that no token is required by default. However, if the model download requires authentication, you must provide a valid token to access the model.

full_url

The full_url parameter is an optional string that allows you to specify the complete URL of the model to be downloaded. It defaults to an empty string, which means the URL will be constructed using the model_id if not provided. This parameter is particularly useful when you have a direct link to the model and want to bypass the need for a model ID.

CivitAI Downloader Output Parameters:

The CivitAI Downloader does not produce any output parameters. Its primary function is to download the specified model to the designated directory, and it does not return any data upon completion.

CivitAI Downloader Usage Tips:

• Ensure that the save_dir is correctly set to a directory where you have write permissions to avoid any file saving issues.
• Use the ignore parameter to skip downloads when you are testing or when the model is already available locally, saving time and bandwidth.
• If you have a direct URL to the model, use the full_url parameter to simplify the download process and avoid potential issues with incorrect model IDs.
• Keep your token_id secure and only use it when necessary to access restricted models.

CivitAI Downloader Common Errors and Solutions:

"Should have at least full_url or model_id for model download."

• Explanation: This error occurs when neither a full_url nor a model_id is provided, making it impossible to identify which model to download.
• Solution: Ensure that you provide either a valid model_id or a full_url to specify the model you wish to download.

"Failed to download the file."

• Explanation: This error indicates that the download process was unsuccessful, possibly due to network issues, incorrect URL, or authentication problems.
• Solution: Check your internet connection, verify that the model_id or full_url is correct, and ensure that the token_id is valid if required. Retry the download after addressing these issues.