The ComfyUI repository ships openapi.yaml: can I generate a client from it for my local server, or does it describe something else?
openapi.yaml at the pin is a union spec that describes more than the local server.py. Of its 79 operations, 20 match a server.py decorator; 59 do not (assets, workflows, settings, billing, tasks, /health for a GKE ingress, etc.). It documents authenticated, cloud-style semantics (402/403/429 statuses, ApiKeyAuth/BearerAuth, 'authenticated user' scoping) and omits client_id and prompt_id from PromptRequest, which the local /prompt reads and the official examples send. It also says /api/interrupt cannot target a job, but the local handler accepts a prompt_id. A generated client should be treated as a draft: verify each call against server.py and prefer /api/jobs over the deprecated history routes only where the local server implements them.
Structured fields
{
"citations": [
{
"url": "https://github.com/Comfy-Org/ComfyUI/blob/1a82e6d01f395b43275c77acd289af1eb7090bb9/openapi.yaml",
"note": "L3128-L3143 /api/interrupt; L5369-L5375 /health; L5481 security; PromptRequest L1045-L1070; head"
},
{
"url": "https://github.com/Comfy-Org/ComfyUI/blob/1a82e6d01f395b43275c77acd289af1eb7090bb9/server.py",
"note": "L3128-L3143 /api/interrupt; L5369-L5375 /health; L5481 security; PromptRequest L1045-L1070; head"
},
{
"url": "https://github.com/Comfy-Org/ComfyUI/blob/1a82e6d01f395b43275c77acd289af1eb7090bb9/comfy/cli_args.py",
"note": "L3128-L3143 /api/interrupt; L5369-L5375 /health; L5481 security; PromptRequest L1045-L1070; head"
}
]
}Evidence claims
- [sourced_fact] openapi.yaml at the pin is a union spec that describes more than the local server.py. Of its 79 operations, 20 match a server.py decorator; 59 do not (assets, workflows, settings, billing, tasks, /health for a GKE ingress, etc.). It documents authenticated, cloud-style semantics (402/403/429 statuses, ApiKeyAuth/BearerAuth, 'authenticated user' scoping) and omits client_id and prompt_id from PromptRequest, which the local /prompt reads and the official examples send. It also says /api/interrupt cannot target a job, but the local handler accepts a prompt_id. A generated client should be treated as a draft: verify each call against server.py and prefer /api/jobs over the deprecated history routes only where the local server implements them. · locator: L3128-L3143 /api/interrupt; L5369-L5375 /health; L5481 security; PromptRequest L1045-L1070; head source
Rights
| component | license | hosting | redistribution | modification | training | Evidence and notes |
|---|---|---|---|---|---|---|
| documentation | unknown | permitted | permitted | unknown | unknown | Applies to this original summary only, not to the cited sources. |
Linked records
- cites → https://github.com/Comfy-Org/ComfyUI/blob/1a82e6d01f395b43275c77acd289af1eb7090bb9/comfy/cli_args.py
- cites → https://github.com/Comfy-Org/ComfyUI/blob/1a82e6d01f395b43275c77acd289af1eb7090bb9/openapi.yaml
- cites → https://github.com/Comfy-Org/ComfyUI/blob/1a82e6d01f395b43275c77acd289af1eb7090bb9/server.py