ComfyUI Node: Relay API Settings

Relay API Settings:

The RelayAPISettings node is designed to facilitate the configuration of API settings for various platforms, particularly focusing on sound generation tasks. This node allows you to specify essential parameters such as the API base URL, platform, model, and API format, ensuring that your requests are correctly routed and processed by the appropriate endpoints. By centralizing these settings, the node simplifies the process of managing API interactions, making it easier to switch between different models or platforms without needing to manually adjust each request. This is particularly beneficial for AI artists who may not have a deep technical background, as it abstracts the complexity of API configuration and provides a user-friendly interface for managing these settings.

Relay API Settings Input Parameters:

task_type

The task_type parameter specifies the type of task you are configuring the API for. In the context of this node, it is primarily set to "sound" to ensure compatibility with sound generation tasks. This parameter helps in routing the request to the correct API endpoint that handles sound-related tasks. The default value is "sound", and it is crucial to keep this setting unchanged unless you are certain of the task type you are working with.

platform

The platform parameter indicates the platform you are using for the API request. By default, this is set to "Suno", which is a platform known for handling sound generation tasks. This parameter ensures that the API request is compatible with the platform's requirements and capabilities. It is important to select the correct platform to avoid compatibility issues.

api_format

The api_format parameter defines the format of the API request. It determines how the request is structured and which endpoint it targets. The default value is "suno/submit", which is suitable for sound generation tasks on the Suno platform. Choosing the correct API format is essential for ensuring that the request is processed correctly by the API.

api_base

The api_base parameter specifies the base URL for the API. This is the root address where the API requests are sent. The default value is derived from a list of available API bases, and it is crucial to ensure that this URL is correct to establish a successful connection with the API.

model

The model parameter allows you to select the specific model you wish to use for the API request. This can be a predefined model or a custom model that you have added. The default model is selected from a list of available models, and choosing the right model is important for achieving the desired results from the API.

apikey

The apikey parameter is a string that contains your API key. This key is used to authenticate your requests with the API, ensuring that you have the necessary permissions to access the services. It is important to keep this key secure and to ensure that it is correctly entered to avoid authentication errors.

custom_api_base

The custom_api_base parameter allows you to specify a custom base URL for the API. This is useful if you need to connect to a different API endpoint that is not included in the default list. You can add a new URL by entering it here or remove an existing one by using the "delete:" command followed by the URL.

custom_model

The custom_model parameter lets you add or remove custom models for use with the API. You can specify a new model by entering its name or remove an existing one by using the "delete:" command followed by the model name. This flexibility allows you to tailor the API settings to your specific needs.

unique_id

The unique_id parameter is a hidden field that uniquely identifies the node instance. It is used internally to manage node settings and should not be modified by the user.

Relay API Settings Output Parameters:

info

The info parameter is a string that contains a JSON representation of the current API settings. This includes details such as the API key, base URL, model, platform, API format, and task type. This output is useful for verifying that the settings have been correctly configured and for debugging purposes if any issues arise.

Relay API Settings Usage Tips:

• Ensure that the task_type is set to "sound" to avoid compatibility issues with the API.
• Double-check the api_base and apikey to ensure they are correctly entered, as these are critical for establishing a successful connection with the API.
• Use the custom_api_base and custom_model parameters to tailor the API settings to your specific needs, especially if you are working with non-standard models or endpoints.

Relay API Settings Common Errors and Solutions:

Relay API Settings task_type must be sound.

• Explanation: This error occurs when the task_type is set to a value other than "sound".
• Solution: Ensure that the task_type parameter is set to "sound" to match the expected task type for this node.

Unsupported sound platform: <platform>

• Explanation: This error indicates that the specified platform is not supported for sound generation tasks.
• Solution: Verify that the platform parameter is set to "Suno", as this is the supported platform for sound tasks.

Unsupported sound api_format: <api_format>

• Explanation: This error occurs when the api_format is not recognized or supported for sound tasks.
• Solution: Ensure that the api_format is set to "suno/submit", which is the correct format for sound generation on the Suno platform.

API key not found. Please set via Relay API Settings node.

• Explanation: This error indicates that the API key is missing or not correctly set.
• Solution: Enter a valid API key in the apikey parameter to authenticate your requests with the API.