Comfy Router quickstart

From nothing to a generated image in about five minutes, in Python and TypeScript, against the Comfy Router.

Comfy Router lets you call partner models through https://api.comfy.org with one Comfy API key. Send the model’s input to POST /v2/models/{provider}/{model} and wait for the finished result. This example generates an image with bfl/flux-2-pro.

1. Create an API key

   Create a key in your Comfy workspace. In a Bash-compatible terminal, set:

   export COMFY_API_KEY="comfyui-..."
   

   Keep API keys on your server or in your local environment. These examples are for a terminal or server, not browser JavaScript.

2. Save a key for this request

   Generate this value once for this image. If you retry the same request, reuse it.

   export COMFY_REQUEST_KEY="$(uuidgen)"
   

   If uuidgen is unavailable, use another UUID generator. Use a new key when you start a new image.

3. Generate an image

   Choose your language and run the example. Image generation can take a few minutes.

   cURL

   curl --max-time 660 \
     https://api.comfy.org/v2/models/bfl/flux-2-pro \
     -H "X-API-Key: $COMFY_API_KEY" \
     -H "Idempotency-Key: $COMFY_REQUEST_KEY" \
     -H "Content-Type: application/json" \
     -d '{"prompt": "a red teapot on a windowsill, morning light"}'
   

   Both SDKs read COMFY_API_KEY from the environment.

4. Read and save the result

   For this model, the image URL is at result.sample in the response body. An abbreviated response looks like this; the URL below is illustrative:

   {
     "status": "Ready",
     "result": { "sample": "https://example.com/generated-image.jpeg" }
   }
   

   Open the returned URL or download it:

   curl --fail --location "PASTE_IMAGE_URL_HERE" --output teapot.jpg
   

   Download promptly. Router can rehost BFL assets on Comfy storage, but URLs expire and a replay does not renew them. A failed rehost can leave a shorter-lived provider URL. See result assets.

Choose a model

Browse the models available through Comfy Router, inspect their inputs, then replace the model ID in this example.