Use SwitchX with Comfy Router

Use beeble/switchx with the Comfy Router API. Beeble provides the model; Router gives it the shared authentication and request route below.

Quick start

Create a key at platform.comfy.org/profile/api-keys and export it as COMFY_API_KEY. The Python and TypeScript snippets use the Comfy SDKs (pip install comfy-sdk, npm install @comfyorg/sdk); the cURL snippet is the same call over raw HTTP. Model ID: beeble/switchx Endpoint: POST https://api.comfy.org/v2/models/beeble/switchx

import uuid
from comfy_sdk import Comfy

# Reads COMFY_API_KEY from the environment. Save this key and reuse it if you
# retry this request after the SDK returns an error.
idempotency_key = str(uuid.uuid4())
with Comfy() as client:
    result = client.models.run(
        "beeble/switchx",
        {
            # Request fields are the provider's own — see Input below.
        },
        idempotency_key=idempotency_key,
    )

print(result)

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

// Reads COMFY_API_KEY from the environment. Save this key and reuse it if you
// retry this request after the SDK returns an error.
const idempotencyKey = crypto.randomUUID();
const { data } = await comfy.models.run("beeble/switchx", {
  // Request fields are the provider's own — see Input below.
}, { idempotencyKey });

console.log(data);

# Request fields are the provider's own — see Input below.
# Run this line once. Reuse ROUTER_REQUEST_KEY if you retry the curl command.
ROUTER_REQUEST_KEY=$(uuidgen)
curl https://api.comfy.org/v2/models/beeble/switchx \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $ROUTER_REQUEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Schema

Input

string

required

Alpha mode: auto, fill, custom, or selectPossible values: auto, fill, custom, select

string

URI of a custom alpha matte. Required when alpha_mode is custom or select. Ignored for auto or fill.

string

HTTPS URL for webhook notification on completion or failure.

string

required

Output type: image or videoPossible values: image, video

string

Idempotency key for safe retries. If a job with the same key already exists for your account, the API returns the existing job’s status instead of creating a duplicate.

integer

default:"1080"

Maximum output resolution: 720 or 1080 (default: 1080).

string

Text description of desired output (max 2,000 chars). At least one of prompt or reference_image_uri is required.

string

URI of the reference image for style transfer. Accepts the same URI types as source_uri.

string

required

URI of the source image or video. Accepts beeble://uploads/{id}/{filename}, https URLs, or data:{mime};base64 URIs (max 50 MB).

Generated from the schema Router serves at GET /v2/models/beeble/switchx/openapi.json, the same document it validates a call against before the request reaches the provider.

Output

string

auto, fill, custom, or select

string

ISO 8601 timestamp when the job completed or failed.

string

ISO 8601 timestamp when the job was created.

string

Error message (present when status is failed).

string

image or video

string

required

Job identifier (swx_…)

string

ISO 8601 timestamp of the last status change.

object

Signed URLs for SwitchX job outputs.

string

Alpha matte URL.

string

Composited output URL.

string

Preprocessed source URL.

integer

Progress percentage (0-100).

string

required

Current job status.Possible values: in_queue, processing, completed, failed

object

Webhook delivery status for a SwitchX job.

integer

Number of delivery attempts so far.

string

Error message from the last failed delivery attempt.

string

pending, delivered, or failed

Examples

Input

{
  "alpha_mode": "auto",
  "generation_type": "image",
  "max_resolution": 720,
  "prompt": "A cinematic product photo of a glass lamp on a marble table",
  "source_uri": "https://img.freepik.com/free-photo/portrait-woman_395237-33.jpg?w=740&q=80"
}

Output

{
  "alpha_mode": "auto",
  "completed_at": "2027-01-01T00:01:04Z",
  "created_at": "2027-01-01T00:00:00Z",
  "generation_type": "image",
  "id": "swx_1a2b3c4d5e6f7a8b",
  "modified_at": "2027-01-01T00:01:04Z",
  "output": {
    "alpha": "https://example.invalid/beeble/switchx/alpha.png",
    "render": "https://example.invalid/beeble/switchx/render.png",
    "source": "https://example.invalid/beeble/switchx/source.png"
  },
  "progress": 100,
  "status": "completed"
}

Before you ship

Save one Idempotency-Key for each call and reuse it for retries. Router can hold the connection for up to 10 minutes. The SDKs handle authentication; raw HTTP clients send the headers themselves. Use X-Comfy-Error-Type to classify a failure. A 422 means Router rejected the input before calling the provider. Download generated assets promptly because result URLs can expire.

Headers

Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.

Using the Router API

Find models, inspect schemas, and retry safely.

Limitations

What Router does not do today, and what to use instead.

Develop with Comfy

Deploy ComfyUI

Run Workflows

Comfy Router

Comfy CLI

Specifications

Use SwitchX with Comfy Router

Quick start

Schema

Input

Output

Examples

Input

Output

Before you ship

Headers

Using the Router API

Limitations

​Quick start

​Schema

​Input

​Output

​Examples

​Input

​Output

​Before you ship

Headers

Using the Router API

Limitations

Quick start

Schema

Input

Output

Examples

Input

Output

Before you ship