Skip to documentation content
Developer Docs
API Reference

API Reference

Get one ComfyUI node info

Return the definition for one ComfyUI node class.

GET/v1/api/comfy/object-info/{className}
Try it out

Request example

bash
curl --request GET   --url "$NORDY_BASE_URL/v1/api/comfy/object-info/CheckpointLoaderSimple"   --header "api-key: $NORDY_API_KEY"

Success response200 OK

JSON
{
  "CheckpointLoaderSimple": {
    "input": {
      "required": {
        "ckpt_name": [
          ["dreamshaper_8.safetensors"]
        ]
      }
    },
    "output": ["MODEL", "CLIP", "VAE"],
    "name": "CheckpointLoaderSimple"
  }
}

Authentication

api-keystringrequired

Send the user API key in the api-key request header.

Parameters

If-None-Matchstringheaderoptional
If the response includes an ETag, send it in If-None-Match on the next request.
classNamestringpathrequired
URL-encoded ComfyUI node class name; . and .. are not accepted.

Success response

200 OK Returns an object keyed by the requested class, or {} when the class is not installed.

<className>objectresponseoptional
Input and output definitions for the ComfyUI node class.

Responses and errors

StatusCodeDescription
304—When conditional requests are supported and the ETag matches, no response body is returned.
400INVALID_INPUTclassName is not a valid single path segment.
400MULTIPLE_AUTH_CREDENTIALSSend only the api-key header, without login cookies.
401AUTHENTICATION_REQUIREDMissing or invalid API key.
403USER_SUSPENDED, PRO_SUBSCRIPTION_REQUIRED, INVALID_INPUTYour account is suspended, does not have an active Pro subscription, or is not permitted to use the API.
500INTERNAL_ERRORAn error occurred while processing the request.
502 / 504INTERNAL_ERRORThe service could not be reached or the request timed out.
Other—ComfyUI may return other status codes and response bodies.