# workflow_api

ComfyUI Workflow API Documentation

### 🚀 Quick Start

##### Run with Docker:

    docker run -d --name workflow_api -p 8188:8188 -v /home/ubuntu/webflow-demo/ComfyUI/models:/app/ComfyUI/models --gpus all instructdesign-flow:latest

##### Access the UI:

Open your browser and navigate to: http://localhost:8188

### 📝 API Parameters

Name | Type | Required | Default | Description | Constraints
--- | --- | --- | --- | --- | ---
`vaeloader_vae_name` | string | Optional | `ae.safetensors` | VAELoader vae_name | -
`saveimage_filename_prefix` | string | Optional | `ComfyUI` | SaveImage filename_prefix | -
`unetloader_unet_name` | string | Optional | `flux1-kontext-dev.safetensors` | UNETLoader unet_name | -
`unetloader_weight_dtype` | string | Optional | `default` | UNETLoader weight_dtype | -
`loraloader_lora_name` | string | Optional | `flux_kontext_lora_v4_consolidated_000010000.safetensors` | LoraLoader lora_name | -
`loraloader_strength_model` | number | Optional | `1.0000000000000002` | LoraLoader strength_model | -
`loraloader_strength_clip` | number | Optional | `1.0000000000000002` | LoraLoader strength_clip | -
`seed` | integer | Optional | `993480294246291` | KSampler seed | -
`steps` | integer | Optional | `20` | KSampler steps | Min: 1 Max: 1000
`cfg` | integer | Optional | `1` | KSampler cfg | Min: 1.0 Max: 30.0
`sampler_name` | string | Optional | `er_sde` | KSampler sampler_name | Values: euler, euler_ancestral, heun, dpm_2, dpm_2_ancestral, lms, dpm_fast, dpm_adaptive, dpmpp_2s_ancestral, dpmpp_sde, dpmpp_2m, dpmpp_3m_sde, ddim, uni_pc
`scheduler` | string | Optional | `kl_optimal` | KSampler scheduler | Values: normal, karras, exponential, sgm_uniform, simple, ddim_uniform
`denoise` | integer | Optional | `1` | KSampler denoise | -
`prompt` | string | Required | - | CLIPTextEncode text | -
`image` | file | Optional | `Screenshot 2025-09-22 at 13.19.59.png` | LoadImage image | -
`loadimage_upload` | string | Optional | `image` | LoadImage upload | -

### 📦 Dependencies

##### Required Models:

- loras: flux_kontext_lora_v4_consolidated_000010000.safetensors
- vaes: ae.safetensors

##### Custom Nodes:

- ComfyUI: https://github.com/comfyanonymous/ComfyUI

### 💻 API Example

##### Python Example:

    import requests
    import json

    # API endpoint
    url = "http://localhost:8188/api/prompt"

    # Prepare the request
    payload = {
        "prompt": "Your prompt text here",
        "width": 1152,
        "height": 1152,
        # Add other parameters as needed
    }

    # Send request
    response = requests.post(url, json=payload)

    if response.status_code == 200:
        result = response.json()
        print(f"Prompt ID: {result['prompt_id']}")
    else:
        print(f"Error: {response.status_code}")

### 🐳 Docker Details

Image: `instructdesign-flow:latest`

Exposed Port: 8188

Models Volume: `/home/ubuntu/webflow-demo/ComfyUI/models:/app/ComfyUI/models`

GPU Support: Enabled (requires NVIDIA Docker runtime)

Generated by ComfyUI Workflow to Docker Translator