ComfyUI Node: Relay API Notice

Relay API Notice:

The RelayAPINotice node serves as an informational guide within the Relay API framework, providing crucial instructions and guidelines for correctly utilizing various API endpoints. Its primary purpose is to ensure that users select the appropriate endpoint names when working with different models, such as images, videos, sounds, and text. This node is particularly beneficial for users who need to integrate models into their workflows by offering clear directions on how to add or remove models and base URLs. By presenting a structured message, it helps users avoid common pitfalls and ensures smooth interaction with the API, ultimately enhancing the efficiency and effectiveness of their tasks.

Relay API Notice Input Parameters:

message

The message parameter is a string input that contains the default instructional message provided by the RelayAPINotice node. This message is designed to be multiline and offers detailed guidance on selecting the correct API endpoints for different types of media, such as images, videos, sounds, and text. It also includes instructions on how to add or remove models and base URLs. The default value is a comprehensive message that users can refer to for ensuring proper API usage. This parameter is crucial as it directly impacts the user's understanding and execution of tasks involving the Relay API.

Relay API Notice Output Parameters:

None

The RelayAPINotice node does not produce any output parameters. Its primary function is to display an informational message to the user, guiding them on how to correctly use the Relay API endpoints and manage models and base URLs.

Relay API Notice Usage Tips:

• Ensure you read and understand the entire message provided by the RelayAPINotice node to correctly configure your API endpoints and model settings.
• Regularly update the message content if there are changes in the API documentation or endpoint configurations to maintain accuracy and relevance.

Relay API Notice Common Errors and Solutions:

Incorrect Endpoint Name

• Explanation: Using an incorrect endpoint name can lead to failed API requests or unexpected results.
• Solution: Refer to the RelayAPINotice message to verify the correct endpoint name for the specific model or task you are working with.

Model or Base URL Not Found

• Explanation: If a model or base URL is not recognized, it may not have been added correctly.
• Solution: Follow the instructions in the RelayAPINotice message to add the model name in custom_model or the base URL in custom_api_base. Use the delete:xxxx command to remove any incorrect entries.