Use SwitchX with Comfy Router

Call beeble/switchx through Comfy Router: endpoint, request shape and the response Router returns.

API Reference for beeble/switchx, served by Comfy Router from Beeble.

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

Python

from comfy_sdk import Comfy

# Reads COMFY_API_KEY from the environment. Each call sends a fresh
# Idempotency-Key and waits up to 10 minutes for the finished result.
with Comfy() as client:
    result = client.models.run(
        "beeble/switchx",
        {
            "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",
        },
    )

print(result)

Schema

Input

alpha_mode · string · required

Alpha mode: auto, fill, custom, or select

Possible values: auto, fill, custom, select

alpha_uri · string

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

callback_url · string

HTTPS URL for webhook notification on completion or failure.

generation_type · string · required

Output type: image or video

Possible values: image, video

idempotency_key · 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.

max_resolution · integer · default: "1080"

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

prompt · string

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

reference_image_uri · string

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

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

alpha_mode · string

auto, fill, custom, or select

completed_at · string

ISO 8601 timestamp when the job completed or failed.

created_at · string

ISO 8601 timestamp when the job was created.

error · string

Error message (present when status is failed).

generation_type · string

image or video

id · string · required

Job identifier (swx_…)

modified_at · string

ISO 8601 timestamp of the last status change.

output · object

Signed URLs for SwitchX job outputs.

output.alpha · string

Alpha matte URL.

output.render · string

Composited output URL.

output.source · string

Preprocessed source URL.

progress · integer

Progress percentage (0-100).

status · string · required

Current job status.

Possible values: in_queue, processing, completed, failed

webhook · object

Webhook delivery status for a SwitchX job.

webhook.attempts · integer

Number of delivery attempts so far.

webhook.last_error · string

Error message from the last failed delivery attempt.

webhook.status · 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

The snippets above are the shortest working call. Three things are the same for every model and are documented once on the Comfy Router headers page: send an Idempotency-Key on every paid call and reuse it when you retry, expect the connection to be held up to Router’s 10 minute deadline, and keep X-Comfy-Request-Id from every response. The SDKs do all three for you; the cURL tab does none of them. On failure, X-Comfy-Error-Type names the bucket, and a 422 means the body failed the model’s schema and was never billed.

Headers

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

Quick Start

Typed error handling in Python and TypeScript, reading the 422, walking the catalog.

Limitations

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