comfyui-api

версия v1.0.0

Основные URL:

Аутентификация

Документация comfyui-api

GET /history

GET /history

Получить все исторические данные задач

Параметры запроса

Пример ответа

200 Ответ

{}

Результаты ответа

Структура данных ответа

GET /embeddings

GET /embeddings

Получить список

Пример ответа

200 Ответ

{}

Результаты ответа

Структура данных ответа

GET /history/{prompt_id}

GET /history/8b918008-751f-414c-9575-7174e841ceac

Получить исторические данные задачи (получить исторические данные по идентификатору задачи)

Пример ответа

Успешно

Результаты ответа

Структура данных ответа

GET /extensions

GET /extensions

Получить список файлов расширений> Пример ответа

200 Ответ

{}

Результаты ответа

Структура данных ответа

POST /upload/image

POST /upload/image

Интерфейс загрузки изображения

Тело запроса

image: string

Параметры запроса

Пример ответа

Успешно

{
  "name": "aaa (7).webp",
  "subfolder": "",
  "type": "input"
}

Результаты ответа

Возвращаемая структура данных

POST /upload/mask

POST /upload/mask

Интерфейс для загрузки маски изображения, обычно используется для локального перерисовывания

Тело запроса

image: string
type: input
subfolder: clipspace
original_ref: "{“filename”:”download.png”,”type”:”input”,”subfolder”:”clipspace”}"

Параметры запроса

{
  "filename": "download.png",
  "type": "input",
  "subfolder": "clipspace"
}
```> Пример ответа

> Успех

```json
{
  "name": "download.png",
  "subfolder": "clipspace",
  "type": "input"
}

Возвращаемые данные

Возвращаемая структура данных

GET /view

GET /view

Интерфейс для онлайн-просмотра изображения (загруженного изображения, исходного изображения, маски изображения, все через этот интерфейс просматриваются)

Параметры запроса

Пример ответа

Успех

"<img src=\"blob:file:///88efa21f-8f36-4540-aa34-436aa404ce3f\" alt=\"runapi прямое отображение изображения\" />"

Возвращаемые данные

Возвращаемая структура данных

POST /view_metadata/{folder_name}

POST /view_metadata/{folder_name}

none

Параметры запроса

200 Ответ

{}

Возвращаемые данные

Возвращаемая структура данных

GET /system_stats

GET /system_stats

Интерфейс для получения статистики системы

Возврат примера

Успех

{
  "system": {
    "os": "posix",
    "python_version": "3.10.12 (main, Jun 11 2023, 05:26:28) [GCC 11.4.0]",
    "embedded_python": false
  },
  "devices": [
    {
      "name": "cuda:0 NVIDIA GeForce RTX 2080 Ti : cudaMallocAsync",
      "type": "cuda",
      "index": 0,
      "vram_total": 23266590720,
      "vram_free": 13600655680,
      "torch_vram_total": 6811549696,
      "torch_vram_free": 26970432
    }
  ]
}

Возврат результата

Возврат структуры данных

GET /prompt

GET /prompt

Интерфейс для получения количества оставшихся задач в очереди сервера

Возврат примера

Успех

{
  "exec_info": {
    "queue_remaining": 1
  }
}

Возврат результата

Возврат структуры данных

POST /prompt

POST /prompt

Интерфейс для отправки задач на рисование, этот интерфейс только для отправки задач, возвращает информацию о задаче.> Тело параметры запросаjson { "client_id": "533ef3a3-39c0-4e39-9ced-37d290f371f8", "prompt": { "3": { "inputs": { "seed": 764714814161513, "steps": 26, "cfg": 5, "sampler_name": "dpmpp_3m_sde_gpu", "scheduler": "karras", "denoise": 1, "model": [ "40", 0 ], "positive": [ "49", 0 ], "negative": [ "6", 0 ], "latent_image": [ "5", 0 ] }, "class_type": "KSampler" }, "5": { "inputs": { "width": 1024, "height": 768, "batch_size": 1 }, "class_type": "EmptyLatentImage" }, "6": { "inputs": { "text": "", "clip": [ "40", 1 ] }, "class_type": "CLIPTextEncode" }, "8": { "inputs": { "samples": [ "3", 0 ], "vae": [ "40", 2 ] }, "class_type": "VAEDecode" }, "9": { "inputs": { "filename_prefix": "ComfyUI", "images": [ "8", 0 ] }, "class_type": "SaveImage" }, "13": { "inputs": { "clip_vision": [ "39", 0 ], "image": [ "34", 0 ] }, "class_type": "CLIPVisionEncode" }, "19": { "inputs": { "strength": 1, "noise_augmentation": 0, "conditioning": [ "42", 0 ], "clip_vision_output": [ "13", 0 ] }, "class_type": "unCLIPConditioning" }, "34": { "inputs": { "image": "clipspace/clipspace-mask-1645940.7000000002.png [input]", "choose file to upload": "image" }, "class_type": "LoadImage" }, "36": { "inputs": { "clip_vision": [ "39", 0 ], "image": [ "38", 0 ] }, "class_type": "CLIPVisionEncode" }, "37": { "inputs": { "strength": 0.75, "noise_augmentation": 0, "conditioning": [ "42", 0 ], "clip_vision_output": [ "13", 0 ] }, "class_type": "unCLIPConditioning" } } }json { "noise_augmentation": 0, "conditioning": [ "19", 0 ], "clip_vision_output": [ "36", 0 ] },

```markdown
"class_type": "unCLIPConditioning",
"38": {
  "inputs": {
    "image": "beijing1 (2).webp",
    "choose file to upload": "image"
  },
  "class_type": "LoadImage"
},
"39": {
  "inputs": {
    "clip_name": "clip_vision_g.safetensors"
  },
  "class_type": "CLIPVisionLoader"
},
"40": {
  "inputs": {
    "ckpt_name": "sd_xl_base_1.0.safetensors"
  },
  "class_type": "CheckpointLoaderSimple"
},
"42": {
  "inputs": {
    "conditioning": [
      "6",
      0
    ]
  },
  "class_type": "ConditioningZeroOut"
},
"43": {
  "inputs": {
    "safe": "enable"
  },
  "class_type": "HEDPreprocessor"
},
"44": {
  "inputs": {
    "safe": "enable",
    "image": [
      "34",
      0
    ]
  },
  "class_type": "HEDPreprocessor"
},
"45": {
  "inputs": {
    "images": [
      "44",
      0
    ]
  },
  "class_type": "PreviewImage"
},
"46": {
  "inputs": {
    "control_net_name": "control-lora-depth-rank256.safetensors"
  },
  "class_type": "ControlNetLoader"
},
"47": {
  "inputs": {
    "image": [
      "34",
      0
    ]
  },
  "class_type": "ScribblePreprocessor"
},
"48": {
  "inputs": {
    "images": [
      "47",
      0
    ]
  },
  "class_type": "PreviewImage"
},
"49": {
  "inputs": {
    "strength": 0.5,
    "conditioning": [
      "37",
      0
    ],
    "control_net": [
      "46",
      0
    ],
    "image": [
      "47",
      0
    ]
  },
  "class_type": "ControlNetApply"
}

### Параметры запроса|Имя|Положение|Тип|Обязательный|Описание| |---|---|---|---|---| |body|body|object| Нет |none|

Пример ответа

Успех

{
  "prompt_id": "352c1fc4-7382-4c4a-965f-583c4b126a1b",
  "number": 38,
  "node_errors": {}
}

Возвращаемые результаты

Возвращаемая структура данных

GET /object_info

GET /object_info

Получение информации о всех компонентах системы и доступных параметрах

Пример ответа

Успех

Возвращаемые результаты

Возвращаемая структура данных

GET /object_info/{node_class}

GET /object_info/KSampler

Получение параметров компонента системы по имени компонента

Пример ответа

Успех

Возвращаемые результаты

Возвращаемая структура данных

GET /queue

GET /queue

Получение подробной информации о задачах в очереди, выполняющихся и ожидающих

Пример ответа

Успех

Возвращаемые результаты

Возвращаемая структура данных

POST /queuePOST /queue

Удаление задачи из очереди/успешный запрос без возвращаемых данных

Body параметры запроса

{
  "delete": "string"
}

Параметры запроса

Пример ответа

200 Ответ

{}

Возвращаемые результаты

Возвращаемая структура данных

GET /interrupt

GET /interrupt

Отмена текущей задачи/не требуется никаких параметров

Пример ответа

200 Ответ

{}

Возвращаемые результаты

Возвращаемая структура данных

Модели данных