Comfy Router quickstart

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.

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.

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.

Generate an image

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

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"}'

# Python 3.10+
# Install: python -m pip install "comfy-sdk>=0.1.9"
# Save as quickstart.py, then run: python quickstart.py

import os

from comfy_sdk import Comfy

# Comfy reads COMFY_API_KEY from the environment.
with Comfy() as client:
    result = client.models.run(
        "bfl/flux-2-pro",
        {"prompt": "a red teapot on a windowsill, morning light"},
        idempotency_key=os.environ["COMFY_REQUEST_KEY"],
        timeout=660.0,
    )

print("image:", result["result"]["sample"])

// Node.js 22+
// Install: npm install @comfyorg/sdk@^0.3.0 --save-dev tsx
// Save as quickstart.mts, then run: npx tsx quickstart.mts

import { comfy } from "@comfyorg/sdk";

// Comfy reads COMFY_API_KEY from the environment.
type FluxResult = { result: { sample: string } };
const idempotencyKey = process.env.COMFY_REQUEST_KEY;
if (!idempotencyKey) throw new Error("Set COMFY_REQUEST_KEY first.");

const result = await comfy.models.run<FluxResult>(
  "bfl/flux-2-pro",
  { prompt: "a red teapot on a windowsill, morning light" },
  { idempotencyKey, timeoutMs: 660_000 },
);
// Some models answer with the generated file itself rather than JSON.
if (result.kind !== "json") throw new Error("expected a JSON result");

console.log("image:", result.data.result.sample);

Both SDKs read COMFY_API_KEY from the environment.

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.

Queue instead of waiting

run holds the connection until the image is ready. To get a request_id back at once and collect the result later, from this process or another one, call submit instead (comfy-sdk and @comfyorg/sdk 0.3.0 or later), or send the same body to POST /v2/models/{provider}/{model}/requests over HTTP. Every model page has a Queue and collect later tab beside the synchronous snippet, and Queued delivery walks through status, cancellation and collection. Queued delivery is rolling out per workspace.

Choose a model

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

Develop with Comfy

Deploy ComfyUI

Run Workflows

Comfy Router

Comfy CLI

Specifications

Comfy Router quickstart

Queue instead of waiting

Choose a model

​Queue instead of waiting

​Choose a model

Queue instead of waiting

Choose a model