这些示例使用 Python 标准库和
websocket-client 包（pip install websocket-client）。底层 API 协议与语言无关 — 请参阅 Cloud API 参考 了解 TypeScript 和 curl 版本。方法一：提交即忘（仅 HTTP）
源码：basic_api_example.py
最简单的方式：提交工作流，不等待结果。适用于提交后稍后检查输出的场景。
"""basic_api_example.py — 仅通过 HTTP 提交工作流。"""
import json
from urllib import request
SERVER_ADDRESS = "127.0.0.1:8188"
def queue_prompt(prompt):
p = {"prompt": prompt}
data = json.dumps(p).encode("utf-8")
req = request.Request(
f"http://{SERVER_ADDRESS}/prompt", data=data
)
request.urlopen(req)
if __name__ == "__main__":
# 加载 API 格式导出的工作流
prompt_text = """{
"3": {
"class_type": "KSampler",
"inputs": {
"cfg": 8, "denoise": 1,
"latent_image": ["5", 0],
"model": ["4", 0],
"negative": ["7", 0],
"positive": ["6", 0],
"sampler_name": "euler",
"scheduler": "normal",
"seed": 8566257, "steps": 20
}
},
"4": {
"class_type": "CheckpointLoaderSimple",
"inputs": {"ckpt_name": "v1-5-pruned-emaonly.safetensors"}
},
"5": {
"class_type": "EmptyLatentImage",
"inputs": {"batch_size": 1, "height": 512, "width": 512}
},
"6": {
"class_type": "CLIPTextEncode",
"inputs": {"clip": ["4", 1], "text": "masterpiece best quality man"}
},
"7": {
"class_type": "CLIPTextEncode",
"inputs": {"clip": ["4", 1], "text": "bad hands"}
},
"8": {
"class_type": "VAEDecode",
"inputs": {"samples": ["3", 0], "vae": ["4", 2]}
},
"9": {
"class_type": "SaveImage",
"inputs": {"filename_prefix": "ComfyUI", "images": ["8", 0]}
}
}"""
prompt = json.loads(prompt_text)
# 提交前修改输入
prompt["3"]["inputs"]["seed"] = 5
prompt["6"]["inputs"]["text"] = "masterpiece best quality man"
queue_prompt(prompt)
print("Prompt submitted successfully.")
此方法使用
SaveImage 节点，图片会保存到服务器磁盘。要获取图片，需要调用 GET /view?filename=...。方法二：WebSocket + History（监控执行完成）
源码：websockets_api_example.py
使用 WebSocket 等待执行完成，然后通过 /history 端点获取结果。这是大多数场景的推荐方式。
"""websockets_api_example.py — 通过 WebSocket 监控执行，通过 /history 下载。"""
import websocket # pip install websocket-client
import uuid
import json
import urllib.request
import urllib.parse
SERVER_ADDRESS = "127.0.0.1:8188"
client_id = str(uuid.uuid4())
def queue_prompt(prompt, prompt_id):
p = {"prompt": prompt, "client_id": client_id, "prompt_id": prompt_id}
data = json.dumps(p).encode("utf-8")
req = urllib.request.Request(
f"http://{SERVER_ADDRESS}/prompt", data=data
)
urllib.request.urlopen(req)
def get_image(filename, subfolder, folder_type):
params = urllib.parse.urlencode({
"filename": filename,
"subfolder": subfolder,
"type": folder_type,
})
with urllib.request.urlopen(
f"http://{SERVER_ADDRESS}/view?{params}"
) as response:
return response.read()
def get_history(prompt_id):
with urllib.request.urlopen(
f"http://{SERVER_ADDRESS}/history/{prompt_id}"
) as response:
return json.loads(response.read())
def get_images(ws, prompt):
prompt_id = str(uuid.uuid4())
queue_prompt(prompt, prompt_id)
while True:
out = ws.recv()
if isinstance(out, str):
message = json.loads(out)
if message["type"] == "executing":
data = message["data"]
if data["node"] is None and data["prompt_id"] == prompt_id:
break # 执行完成
# 二进制帧是预览图片 — 此处跳过
continue
history = get_history(prompt_id)[prompt_id]
output_images = {}
for node_id in history["outputs"]:
node_output = history["outputs"][node_id]
images_output = []
if "images" in node_output:
for image in node_output["images"]:
image_data = get_image(
image["filename"], image["subfolder"], image["type"]
)
images_output.append(image_data)
output_images[node_id] = images_output
return output_images
if __name__ == "__main__":
prompt_text = """{
"3": { ... }, "4": { ... }, "5": { ... },
"6": { ... }, "7": { ... }, "8": { ... },
"9": { "class_type": "SaveImage", "inputs": { ... } }
}"""
prompt = json.loads(prompt_text)
prompt["3"]["inputs"]["seed"] = 5
prompt["6"]["inputs"]["text"] = "masterpiece best quality man"
ws = websocket.WebSocket()
ws.connect(f"ws://{SERVER_ADDRESS}/ws?clientId={client_id}")
images = get_images(ws, prompt)
ws.close()
print(f"Got {len(images)} output node(s) with images.")
# 显示图片（需要 Pillow）：
# for node_id in images:
# for image_data in images[node_id]:
# from PIL import Image
# import io
# img = Image.open(io.BytesIO(image_data))
# img.show()
WebSocket 二进制帧中的生成过程预览图片可以解码用于实时预览（二进制格式参见服务器消息页面）。
方法三：WebSocket 配合 SaveImageWebsocket（实时获取图片）
源码：websockets_api_example_ws_images.py
如果不想将图片保存到磁盘，可以使用 SaveImageWebsocket 节点。图片会通过 WebSocket 二进制帧直接传送。
"""websockets_api_example_ws_images.py — 通过 WebSocket 直接接收图片。"""
import websocket # pip install websocket-client
import uuid
import json
import urllib.request
import urllib.parse
SERVER_ADDRESS = "127.0.0.1:8188"
client_id = str(uuid.uuid4())
def queue_prompt(prompt):
p = {"prompt": prompt, "client_id": client_id}
data = json.dumps(p).encode("utf-8")
req = urllib.request.Request(
f"http://{SERVER_ADDRESS}/prompt", data=data
)
return json.loads(urllib.request.urlopen(req).read())
def get_images(ws, prompt):
prompt_id = queue_prompt(prompt)["prompt_id"]
output_images = {}
current_node = ""
while True:
out = ws.recv()
if isinstance(out, str):
message = json.loads(out)
if message["type"] == "executing":
data = message["data"]
if data["prompt_id"] == prompt_id:
if data["node"] is None:
break # 执行完成
current_node = data["node"]
else:
# 二进制帧 — SaveImageWebsocket 的图片数据
if current_node == "save_image_websocket_node":
images_output = output_images.get(current_node, [])
# 前 8 字节是类型/元数据，剩余是图片数据
images_output.append(out[8:])
output_images[current_node] = images_output
return output_images
if __name__ == "__main__":
prompt_text = """{
"3": { "class_type": "KSampler", "inputs": { ... } },
...
"save_image_websocket_node": {
"class_type": "SaveImageWebsocket",
"inputs": {"images": ["8", 0]}
}
}"""
prompt = json.loads(prompt_text)
prompt["3"]["inputs"]["seed"] = 5
ws = websocket.WebSocket()
ws.connect(f"ws://{SERVER_ADDRESS}/ws?clientId={client_id}")
images = get_images(ws, prompt)
ws.close()
print(f"Received {len(images)} image(s) via WebSocket.")
# 显示（需要 Pillow）：
# for image_data in images.get("save_image_websocket_node", []):
# from PIL import Image
# import io
# img = Image.open(io.BytesIO(image_data))
# img.show()
工作流必须使用
class_type: "SaveImageWebsocket"（内置节点）代替普通的 SaveImage 节点。应该用哪种方法？
方法一：仅 HTTP
发送即忘。 适用于不需要立即获取输出，或稍后检查结果即可的场景。
方法二：WebSocket + History
推荐。 等待完成，然后下载结果。简单性和可靠性之间最佳平衡。
方法三：SaveImageWebsocket
实时图片。 适用于需要图片不写磁盘直接送达的交互式应用。