An open API service indexing awesome lists of open source software.

https://github.com/Mattabyte/ComfyUI-SecureApiCall

A node that can be added to a ComfyUI workflow to call a secure API
https://github.com/Mattabyte/ComfyUI-SecureApiCall

Last synced: 3 months ago
JSON representation

A node that can be added to a ComfyUI workflow to call a secure API

Awesome Lists containing this project

README

        

# 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.

## 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.
```

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 `COMFYUI_SECUREAPICALL_`.

So setting $ENV.API_KEY will use the environment variable `COMFYUI_SECUREAPICALL_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.' 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).