API 文档

openapi文件下载可以把这文件直接导入apifox中进行接口测试。

POST /prompt

Body 请求参数


{"client_id":"2321321321287858155188",
"prompt":{
  "3": {
    "inputs": {
      "seed": 226101232633582,
      "steps": 20,
      "cfg": 8,
      "sampler_name": "euler",
      "scheduler": "normal",
      "denoise": 1,
      "model": [
        "4",
        0
      ],
      "positive": [
        "6",
        0
      ],
      "negative": [
        "7",
        0
      ],
      "latent_image": [
        "5",
        0
      ]
    },
    "class_type": "KSampler",
    "_meta": {
      "title": "K采样器"
    }
  },
  "4": {
    "inputs": {
      "ckpt_name": "基础模型.safetensors"
    },
    "class_type": "CheckpointLoaderSimple",
    "_meta": {
      "title": "Checkpoint加载器（简易）"
    }
  },
  "5": {
    "inputs": {
      "width": 512,
      "height": 512,
      "batch_size": 1
    },
    "class_type": "EmptyLatentImage",
    "_meta": {
      "title": "空Latent图像"
    }
  },
  "6": {
    "inputs": {
      "text": "beautiful scenery nature glass bottle landscape, , purple galaxy bottle,",
      "clip": [
        "4",
        1
      ]
    },
    "class_type": "CLIPTextEncode",
    "_meta": {
      "title": "CLIP文本编码"
    }
  },
  "7": {
    "inputs": {
      "text": "text, watermark",
      "clip": [
        "4",
        1
      ]
    },
    "class_type": "CLIPTextEncode",
    "_meta": {
      "title": "CLIP文本编码"
    }
  },
  "8": {
    "inputs": {
      "samples": [
        "3",
        0
      ],
      "vae": [
        "4",
        2
      ]
    },
    "class_type": "VAEDecode",
    "_meta": {
      "title": "VAE解码"
    }
  },
  "9": {
    "inputs": {
      "filename_prefix": "ComfyUI",
      "images": [
        "8",
        0
      ]
    },
    "class_type": "SaveImage",
    "_meta": {
      "title": "保存图像"
    }
  }
}
}

请求参数

名称	位置	类型	必选	说明
body	body	object	yes	这里的client_id要和ws连接中的clientId一致(注意两个接口的参数名是不一样的！！！)

返回示例
200 Response


{
    "prompt_id": "fa770462-eaa7-402b-a564-5c3f4a5cd153",
    "number": 0,
    "node_errors": {}
}

api 网关

返回结果

状态码	状态码含义	说明	数据模型
200	OK	这里返回任务id	json

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» prompt_id	string	true	none	none
» number	integer	true	none	none
» node_errors	object	true	none	none

GET /models/{folder}

folder替换为你要查询的模型文件夹名，例如：/models/checkpoints

返回示例
200 Response


[
    "基础模型.safetensors"
]

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

GET /prompt

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

GET /history

Body 请求参数


{
  "prompt_id": "697a27ec-4aae-42df-af67-be07de631b0c"
}

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

GET /system_stats

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

GET /object_info

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

GET /view

请求参数

参数名	类型	描述
filename	string	生成的图像文件名
subfolder	string	文件夹
type	string	类型

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

GET /queue

返回示例

200 Response


{
    "queue_running": [],
    "queue_pending": []
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

GET /embeddings

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

GET /extensions

返回示例

200 Response


[
    "/extensions/core/maskEditorOld.js",
    "/extensions/core/groupNode.js",
    "/extensions/core/clipspace.js",
    "/extensions/core/groupNodeManage.js",
    "/extensions/core/widgetInputs.js",
    "/extensions/core/load3d/LoaderManager.js",
    "/extensions/core/load3d/ControlsManager.js",
    "/extensions/core/load3d/AnimationManager.js",
    "/extensions/core/load3d/CameraManager.js",
    "/extensions/core/load3d/NodeStorage.js",
    "/extensions/core/load3d/SceneManager.js",
    "/extensions/core/load3d/ModelManager.js",
    "/extensions/core/load3d/LightingManager.js",
    "/extensions/core/load3d/ModelExporter.js",
    "/extensions/core/load3d/PreviewManager.js",
    "/extensions/core/load3d/EventManager.js",
    "/extensions/core/load3d/ViewHelperManager.js"
]

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

GET /ws

请求参数

参数名	类型	描述
clientId	string	客户端ID(需要和请求任务的clientId 一致)

返回示例
200 Response


{"type": "status", "data": {"status": {"exec_info": {"queue_remaining": 0}}, "sid": "2f4c5fd3286747ff9d037eade6d36f7e"}}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline