Introduction

Welcome to the RunningHub API, designed to facilitate the easy use of ComfyUI functionalities hosted on the RunningHub cloud.

Through this API, you can run various complex workflows in bulk and initiate tasks consecutively. As long as a workflow can run properly on the RunningHub platform, you can seamlessly integrate it into your product or flexibly apply it in any scenario requiring AI workflows.

Getting Started

Before using the RunningHub API, please ensure the following preparations are complete:

1. First, register as a user on the RunningHub website and activate the membership privileges. Currently, free users cannot access the RunningHub API.

2. Open a workflow and note the workflow ID in the address bar, as our API calls are based on this workflow ID.

3. For example, in the following URL(Sample workflow), the workflow ID is 1851826914200891393.

   

4. Make sure to run this flow manually and have it work properly, or you'll get an error when using the API.

1. Obtaining the API Key

RunningHub automatically generates a unique 32-character API Key for each user, serving as the sole identifier for your account.

To view your API Key, open the homepage at RunningHUB, log in to your account, and open the floating profile menu at the top right corner of the page. Keep your API Key secure and do not disclose it, as it will be needed in subsequent steps.

API Keys are divided into Enterprise and Consumer tiers (both use the same API integration method):

· Enterprise API KEY: To use the Shared API, you must first top up your account. API calls will deduct balance based on actual runtime. For detailed pricing, please refer to the website. Dedicated API access requires contacting our business team for activation.

· Consumer API KEY: Only users with a Personal membership or higher can call APIs using an API Key. Consumer API usage will consume RH Coins from your account at the same rate as running workflows on the website.

FAQ - Frequently Asked Questions

• How is billing calculated?

  The API does not have a separate billing system. Running a workflow via the API costs the same as running the same workflow on the website. The API only provides a different way to execute the workflow.

• I want to use the API concurrently and initiate multiple tasks simultaneously:

  The current API concurrency is tied to the membership privileges. A simple method to achieve multiple concurrent requests is to use multiple accounts and API keys, which can enable concurrency. Furthermore, multiple accounts can call the same WorkflowID. A straightforward implementation would be to configure multiple API keys into a scheduling resource pool to enable concurrent calls. If you are still unclear, you can send these questions to ChatGPT.

• What if a workflow has multiple save nodes? How does the API respond?

  The API will return multiple results, each corresponding to a save node, in an array under the data field.

• Return APIKEY_INVALID_NODE_INFO:

  The workflow ID called by the API must have successfully run at least once. Workflows that have never been manually executed successfully cannot be called by the API.

• How to upload and define images in a diagram: In the advanced workflow API call:

  The fieldValue is used to customize the image URL. However, please note that the node used in this example is "load image from URL," and the image URL is defined through the fieldValue. Therefore, to use this feature, you should first upload the image to a publicly accessible location, and then set the image URL in the fieldValue.