RunningHub API

https://www.runninghub.ai/runninghub-api-doc-en
Admin
RunningHub API provides programmatic access to manage ComfyUI tasks, integrate AI applications, and...
Tokens:2,887
Snippets:16
Trust Score:7.4
Update:11 months ago
Show doc for...
Tokens:
Raw
### Start ComfyUI Task (Basic)

Source: https://www.runninghub.ai/runninghub-api-doc-en/index

Start a ComfyUI task with basic settings.

```APIDOC
## POST /comfyui/start_basic

### Description
Starts a ComfyUI task using basic configuration.

### Method
POST

### Endpoint
/comfyui/start_basic

### Parameters
#### Query Parameters
None

#### Request Body
- **workflow_id** (string) - Required - The ID of the ComfyUI workflow.
- **model_id** (string) - Required - The ID of the model to use.

### Request Example
```json
{
  "workflow_id": "workflow_abc",
  "model_id": "model_xyz"
}
```

### Response
#### Success Response (200)
- **task_id** (string) - The ID of the started ComfyUI task.

#### Response Example
```json
{
  "task_id": "comfyui_task_67890"
}
```
```

--------------------------------

### Get API Call Examples for AI Application

Source: https://www.runninghub.ai/runninghub-api-doc-en/index

Retrieve example API calls for a specific AI application.

```APIDOC
## GET /ai_app/examples

### Description
Provides example API calls and usage patterns for a given AI application.

### Method
GET

### Endpoint
/ai_app/examples

### Parameters
#### Query Parameters
- **app_id** (string) - Required - The ID of the AI application for which to retrieve examples.

#### Request Body
None

### Request Example
```
GET /ai_app/examples?app_id=ai_app_101
```

### Response
#### Success Response (200)
- **examples** (array of objects) - A list of example API calls and their descriptions.

#### Response Example
```json
{
  "examples": [
    {
      "description": "Basic text generation request.",
      "request": {
        "method": "POST",
        "endpoint": "/ai_app/start_task",
        "body": {
          "app_id": "ai_app_101",
          "input_data": {"prompt": "Hello world!"}
        }
      }
    }
  ]
}
```
```

--------------------------------

### Start ComfyUI Task (Advanced)

Source: https://www.runninghub.ai/runninghub-api-doc-en/index

Start a ComfyUI task with advanced settings, including workflow JSON.

```APIDOC
## POST /comfyui/start_advanced

### Description
Starts a ComfyUI task with advanced settings, allowing for custom workflow JSON.

### Method
POST

### Endpoint
/comfyui/start_advanced

### Parameters
#### Query Parameters
None

#### Request Body
- **workflow_json** (object) - Required - The JSON definition of the ComfyUI workflow.
- **model_id** (string) - Required - The ID of the model to use.

### Request Example
```json
{
  "workflow_json": {
    "nodes": [...],
    "links": [...]
  },
  "model_id": "model_xyz"
}
```

### Response
#### Success Response (200)
- **task_id** (string) - The ID of the started ComfyUI task.

#### Response Example
```json
{
  "task_id": "comfyui_task_abcde"
}
```
```

--------------------------------

### Start AI App Task

Source: https://www.runninghub.ai/runninghub-api-doc-en/index

Initiate a task for an AI application.

```APIDOC
## POST /ai_app/start_task

### Description
Initiates a task for a specific AI application.

### Method
POST

### Endpoint
/ai_app/start_task

### Parameters
#### Query Parameters
None

#### Request Body
- **app_id** (string) - Required - The ID of the AI application.
- **input_data** (object) - Required - The input data for the AI application task.

### Request Example
```json
{
  "app_id": "ai_app_101",
  "input_data": {
    "prompt": "Generate an image of a cat."
  }
}
```

### Response
#### Success Response (200)
- **task_id** (string) - The ID of the initiated AI application task.

#### Response Example
```json
{
  "task_id": "ai_app_task_fghij"
}
```
```

--------------------------------

### Get Workflow JSON

Source: https://www.runninghub.ai/runninghub-api-doc-en/index

Retrieve the JSON definition of a ComfyUI workflow.

```APIDOC
## POST /comfyui/get_workflow_json

### Description
Retrieves the JSON definition for a given ComfyUI workflow ID.

### Method
POST

### Endpoint
/comfyui/get_workflow_json

### Parameters
#### Query Parameters
None

#### Request Body
- **workflow_id** (string) - Required - The ID of the ComfyUI workflow.

### Request Example
```json
{
  "workflow_id": "workflow_abc"
}
```

### Response
#### Success Response (200)
- **workflow_json** (object) - The JSON definition of the workflow.

#### Response Example
```json
{
  "workflow_json": {
    "nodes": [...],
    "links": [...]
  }
}
```
```

--------------------------------

### Get Account Information

Source: https://www.runninghub.ai/runninghub-api-doc-en/index

Retrieve information about the current user's account.

```APIDOC
## POST /account/get_info

### Description
Retrieves account details for the authenticated user.

### Method
POST

### Endpoint
/account/get_info

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **user_id** (string) - The unique identifier for the user.
- **email** (string) - The user's email address.
- **plan** (string) - The user's current subscription plan.

#### Response Example
```json
{
  "user_id": "user_987",
  "email": "user@example.com",
  "plan": "premium"
}
```
```

--------------------------------

### Get Webhook Event Details

Source: https://www.runninghub.ai/runninghub-api-doc-en/index

Retrieve details for a specific webhook event.

```APIDOC
## POST /webhook/get_event_details

### Description
Retrieves detailed information about a specific webhook event.

### Method
POST

### Endpoint
/webhook/get_event_details

### Parameters
#### Query Parameters
None

#### Request Body
- **event_id** (string) - Required - The unique identifier for the webhook event.

### Request Example
```json
{
  "event_id": "wh_event_112233"
}
```

### Response
#### Success Response (200)
- **event_data** (object) - The detailed data associated with the webhook event.

#### Response Example
```json
{
  "event_data": {
    "type": "task_completed",
    "task_id": "task_12345",
    "timestamp": "2023-10-27T10:00:00Z"
  }
}
```
```

--------------------------------

### Quick Create - Initiate Task

Source: https://www.runninghub.ai/runninghub-api-doc-en/index

Initiate a quick create task.

```APIDOC
## POST /quick_create/initiate

### Description
Initiates a quick create task using specified parameters.

### Method
POST

### Endpoint
/quick_create/initiate

### Parameters
#### Query Parameters
None

#### Request Body
- **style** (string) - Required - The style to use for quick create.
- **parameters** (object) - Required - Parameters for the selected style.

### Request Example
```json
{
  "style": "style1",
  "parameters": {
    "paramA": "valueA"
  }
}
```

### Response
#### Success Response (200)
- **task_id** (string) - The ID of the initiated task.

#### Response Example
```json
{
  "task_id": "task_12345"
}
```
```

--------------------------------

### Quick Create - Model Library Style Parameter Data

Source: https://www.runninghub.ai/runninghub-api-doc-en/index

Obtain parameter data for model library style quick create.

```APIDOC
## POST /quick_create/model_library_style_parameters

### Description
Retrieves parameter data for quick create operations based on model library styles.

### Method
POST

### Endpoint
/quick_create/model_library_style_parameters

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **parameters** (object) - A dictionary containing style parameters.

#### Response Example
```json
{
  "parameters": {
    "style1": {
      "paramA": "valueA",
      "paramB": "valueB"
    },
    "style2": {
      "paramC": "valueC"
    }
  }
}
```
```

--------------------------------

### Upload Resource

Source: https://www.runninghub.ai/runninghub-api-doc-en/index

Upload various types of resources, including compressed packages.

```APIDOC
## POST /resource/upload

### Description
Uploads resources such as images, videos, audio files, and compressed packages.

### Method
POST

### Endpoint
/resource/upload

### Parameters
#### Query Parameters
None

#### Request Body
- **file** (file) - Required - The resource file to upload. Supports images, videos, audio, and compressed packages.

### Request Example
(This is a multipart/form-data request)
```
--boundary
Content-Disposition: form-data; name="file"; filename="my_image.png"
Content-Type: image/png

<binary data>
--boundary--
```

### Response
#### Success Response (200)
- **resource_url** (string) - The URL of the uploaded resource.

#### Response Example
```json
{
  "resource_url": "http://example.com/resources/my_image.png"
}
```
```

--------------------------------

### Upload Lora

Source: https://www.runninghub.ai/runninghub-api-doc-en/index

Upload Lora models.

```APIDOC
## POST /resource/upload_lora

### Description
Uploads Lora models for use with ComfyUI or other AI applications.

### Method
POST

### Endpoint
/resource/upload_lora

### Parameters
#### Query Parameters
None

#### Request Body
- **file** (file) - Required - The Lora model file (.safetensors or .ckpt).

### Request Example
(This is a multipart/form-data request)
```
--boundary
Content-Disposition: form-data; name="file"; filename="my_lora.safetensors"
Content-Type: application/octet-stream

<binary data>
--boundary--
```

### Response
#### Success Response (200)
- **lora_url** (string) - The URL of the uploaded Lora model.

#### Response Example
```json
{
  "lora_url": "http://example.com/lora/my_lora.safetensors"
}
```
```

--------------------------------

### Check Task Output

Source: https://www.runninghub.ai/runninghub-api-doc-en/index

Retrieve the output of a completed task.

```APIDOC
## POST /task/check_output

### Description
Retrieves the output generated by a completed task.

### Method
POST

### Endpoint
/task/check_output

### Parameters
#### Query Parameters
None

#### Request Body
- **task_id** (string) - Required - The ID of the task whose output is to be retrieved.

### Request Example
```json
{
  "task_id": "task_12345"
}
```

### Response
#### Success Response (200)
- **output** (any) - The output data from the task.

#### Response Example
```json
{
  "output": {
    "image_url": "http://example.com/image.png"
  }
}
```
```

--------------------------------

### Check Task Status

Source: https://www.runninghub.ai/runninghub-api-doc-en/index

Check the current status of a task.

```APIDOC
## POST /task/check_status

### Description
Checks the status of a specified task.

### Method
POST

### Endpoint
/task/check_status

### Parameters
#### Query Parameters
None

#### Request Body
- **task_id** (string) - Required - The ID of the task to check.

### Request Example
```json
{
  "task_id": "task_12345"
}
```

### Response
#### Success Response (200)
- **status** (string) - The current status of the task (e.g., "pending", "running", "completed", "failed").

#### Response Example
```json
{
  "status": "completed"
}
```
```

--------------------------------

### Resend Specific Webhook Event

Source: https://www.runninghub.ai/runninghub-api-doc-en/index

Resend a specific webhook event.

```APIDOC
## POST /webhook/resend_event

### Description
Resends a specific webhook event, useful for handling delivery failures.

### Method
POST

### Endpoint
/webhook/resend_event

### Parameters
#### Query Parameters
None

#### Request Body
- **event_id** (string) - Required - The unique identifier for the webhook event to resend.

### Request Example
```json
{
  "event_id": "wh_event_112233"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the event has been resent.

#### Response Example
```json
{
  "message": "Webhook event resent successfully."
}
```
```

--------------------------------

### Cancel ComfyUI Task

Source: https://www.runninghub.ai/runninghub-api-doc-en/index

Cancel a running ComfyUI task.

```APIDOC
## POST /comfyui/cancel_task

### Description
Cancels a ComfyUI task that is currently running.

### Method
POST

### Endpoint
/comfyui/cancel_task

### Parameters
#### Query Parameters
None

#### Request Body
- **task_id** (string) - Required - The ID of the ComfyUI task to cancel.

### Request Example
```json
{
  "task_id": "comfyui_task_abcde"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the task has been cancelled.

#### Response Example
```json
{
  "message": "ComfyUI task cancelled successfully."
}
```
```
Tokens:
Raw