Sign in

Nodes Browser

ComfyDeploy: How ComfyUI Secure API Call works in ComfyUI?

What is ComfyUI Secure API Call?

This package provides custom nodes to ComfyUI to POST data to a secure API.

How to install it in ComfyDeploy?

Head over to the machine page

  1. Click on the "Create a new machine" button
  2. Select the Edit build steps
  3. Add a new step -> Custom Node
  4. Search for ComfyUI Secure API Call and select it
  5. Close the build step dialig and then click on the "Save" button to rebuild the machine

ComfyUI Secure API Call

This package provides custom nodes to ComfyUI to POST data to a secure API.

Secure API Call

Send a JSON message to the specified URL. Supports basic api key authentication.

<img src="assets/apicall_node.jpg" width="400"/>

A Note on Security

This package is designed to be used in a secure environment. It is not recommended to use this package in a public environment.

99.99% of the time, you should use the prefix:

$ENV.<Some_Variable_Name>

to access the environment variables for the api_url and api_auth fields. This keeps your secrets out of the metadata of the output.

This will only work if the environment variable is prefixed with CSAPI_.

So setting $ENV.API_KEY will use the environment variable CSAPI_API_KEY.

##WARNING IF YOU DON'T USE ENVIRONMENT VARIABLES IN THIS NODE, THIS WILL SPILL SECRETS IN THE METADATA.

You must ensure that the metadata is not attached to any outputs, as some nodes will not respect the --disable-metadata flag and will attach their own metadata.

In the event that you need to use the metadata, you absolutely must use the prefix '$ENV.<Some_Variable_Name>' in any fields you want to keep secret.

Installation

  1. Download the package from the ComfyUI extensions tab.
  2. Install the package.
  3. Add the Secure API Call node to your ComfyUI workflow.
  4. Configure the node with the URL, API key, and any other necessary parameters.
  5. Run the workflow and check the output (especially the metadata, it should be empty).