{"id":26053427,"url":"https://github.com/lts8989/comfyui-go-sdk","last_synced_at":"2026-05-15T01:32:46.741Z","repository":{"id":280774441,"uuid":"943006178","full_name":"lts8989/comfyui-go-sdk","owner":"lts8989","description":"Library for using ComfyUI structures in Go programs and client for ComfyUI REST API and websocket.","archived":false,"fork":false,"pushed_at":"2025-03-10T02:59:07.000Z","size":12,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-14T14:52:39.531Z","etag":null,"topics":["api","comfyui","golang","websocket"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lts8989.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-03-05T03:01:18.000Z","updated_at":"2025-09-04T09:50:53.000Z","dependencies_parsed_at":"2025-10-13T02:35:01.038Z","dependency_job_id":"03c11978-b9a0-48ed-ae25-fcb484645f97","html_url":"https://github.com/lts8989/comfyui-go-sdk","commit_stats":null,"previous_names":["lts8989/sd_sdk","lts8989/comfyui-go-sdk"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/lts8989/comfyui-go-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lts8989%2Fcomfyui-go-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lts8989%2Fcomfyui-go-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lts8989%2Fcomfyui-go-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lts8989%2Fcomfyui-go-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lts8989","download_url":"https://codeload.github.com/lts8989/comfyui-go-sdk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lts8989%2Fcomfyui-go-sdk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33050220,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-13T13:14:54.681Z","status":"online","status_checked_at":"2026-05-14T02:00:06.663Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","comfyui","golang","websocket"],"created_at":"2025-03-08T07:28:26.377Z","updated_at":"2026-05-15T01:32:46.701Z","avatar_url":"https://github.com/lts8989.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ComfyUI SDK\n\nComfyUI SDK 是 [ComfyUI](https://github.com/comfyanonymous/ComfyUI) 服务的开发工具包，旨在为开发者提供一套完整的工具和接口，以便快速构建和扩展\n`ComfyUI` 的功能。\n\n## 主要功能\n\n绘图任务下发、任务执行结果查询，任务图片下载，以及接收任务进度推送。\n\n## 提前准备\n\n可访问的 `ComfyUI` 服务，记下域名，后面要用到。\n\n## 初始化\n\n* 调用 Setup 方法初始化参数。\n\n| 参数名          | 类型     | 默认值 | 说明                                                |\n|--------------|--------|-----|---------------------------------------------------|\n| domain       | string |     | ComfyUI 的域名，需要带有协议，http or https 。                |\n| clientId     | string |     | 客户端id，当前服务的唯一标识符。websocket，只会接收当前服务下发的任务通知。       |\n| pingSec      | uint   | 30  | 单位（秒）。心跳间隔时间，用于维持当前服务与 ComfyUI 服务的websocket 连接状态。 |\n| reconnectSec | uint   | 5   | 单位（秒）。如果 websocket 与 ComfyUI 服务断开链接，重连时间间隔。       |\n\n* 调用 [log.go](log/log.go) 文件中的 `InitLogger` 方法初始化日志模块，默认使用 `fmt` 输出。\n## 实现的 HTTP 接口\n\n都在 [sdk.go](sdk/sdk.go) 文件中\n\n### 绘图任务下发\n\n* Prompt\n\n**请求参数**\n\n| 参数名        | 类型     | 说明                     |\n|------------|--------|------------------------|\n| promptByte | []byte | ComfyUI 的流程图，json格式字符串 |\n\n**返回值**\n\n| 属性名       | 类型     | 说明   |\n|-----------|--------|------|\n| PromptId  | string | 任务id |\n| Error     | struct | 错误相关 |\n| Type      | string | 错误类型 |\n| Message   | string | 错误信息 |        \n| Details   | string | 错误详情 |\n| ExtraInfo | any    | 扩展信息 |\n\nComfyUI 的流程图请在web中调试无误后导出，见下图。\n\n![](asdfasdf)\n\n### 查询任务执行结果\n\n* History\n\n**请求参数**\n\n| 参数名      | 类型     | 默认值 | 说明                |\n|----------|--------|-----|-------------------|\n| promptId | string |     | 任务id，Prompt接口的返回值 |\n\n**返回值**\n\n返回值为数组，每个 item 的属性如下\n\n| 属性名       | 类型     | 说明   |\n|-----------|--------|------|\n| Filename  | string | 文件名  |\n| Subfolder | string | 子文件夹 |\n| Type      | string | 类型   |\n\n### 获取图片\n\n* View\n\n**请求参数**\n\n与 History 方法的返回值一致\n\n| 参数名       | 类型     | 默认值 | 说明   |\n|-----------|--------|-----|------|\n| Filename  | string |     | 文件名  |\n| Subfolder | string |     | 子文件夹 |\n| Type      | string |     | 类型   |\n\n**返回值**\n\n返回值为图片的字节流\n\n### 服务状态\n\n* GetSystemStats\n\n获取 ComfyUI 服务相关信息，可用于ComfyUI 服务探活。\n\n**返回值**\n\n| 属性名            | 类型       | 说明             |\n|----------------|----------|----------------|\n| System         | struct   | 系统参数           |\n| OS             | string   | 操作系统           |\n| RamTotal       | int64    | 内存总量           |\n| RamFree        | int64    | 内存剩余           |\n| ComfyuiVersion | string   | ComfyUI版本号     |        \n| PythonVersion  | string   | Python版本号      |\n| PytorchVersion | string   | PyTorch版本号     |\n| EmbeddedPython | bool     | 是否嵌入Python环境   |\n| Argv           | []string | ComfyUI版本号启动参数 |\n| Devices        | struct   | 显卡参数           |\n| Name           | string   | 名称             |\n| Type           | string   | 类型             |\n| Index          | int      | 索引             |\n| VramTotal      | int64    | 显存总量           |\n| VramFree       | int64    | 显存剩余           |\n| TorchVramTotal | int64    |                |    \n| TorchVramFree  | int64    |                |\n\n## websocket 接口\n\n`ConnectToWebSocket` 方法允许客户端通过 `WebSocket` 连接到服务器。此方接收任务执行实时更新的消息。请自定义\n`model.ReceivedMsgFun` 方法用于接收 `ComfyUI` 发来的消息。\n\n接收消息对象结构如下\n\n| 属性名         | 类型       | 说明                                                                    |\n|-------------|----------|-----------------------------------------------------------------------|\n| Type        | string   | 任务状态。execution_start、executing、executed。只有这3种状态有价值，其他状态都表示任务正在执行中或无效。 |\n| Data        | struct   |                                                                       |\n| Node        | string   | 服务器node编号                                                             |\n| DisplayNode | string   | node名称                                                                |\n| Output      | struct   |                                                                       |\n| images      | []struct | 执行完成时，返回图像结果列表，与 History 接口返回值一致                                      |\n| Filename    | string   | 文件名                                                                   |\n| Subfolder   | string   | 子文件夹                                                                  |\n| Type        | string   | 类型                                                                    |\n| PromptID    | string   | 任务id                                                                  |\n\n`websocket` 连接每30s会 `ping` 一次 `ComfyUI` 服务，如果断开连接，每 5s 尝试重连。如果因为 `websocket`\n断开连接导致错过了任务的执行结果的推送，可以调用 `History` 接口获取任务执行状态以及结果。\n\n## 示例项目\n\n[ComfyUI API](https://github.com/lts8989/sd_api)\n\n## 安装\n\n    go get github.com/lts8989/sd_sdk\n\n## ps\n\n* 方法名、参数和返回值的属性名保持与 `ComfyUI` 的接口一致。\n* 项目大部分代码使用 `LLM` 生成","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flts8989%2Fcomfyui-go-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flts8989%2Fcomfyui-go-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flts8989%2Fcomfyui-go-sdk/lists"}