> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-stale2000-router-model-pages.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Use SwitchX with Comfy Router

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

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](https://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`

<CodeGroup>
  ```python Python theme={null}
  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)
  ```

  ```typescript TypeScript theme={null}
  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);
  ```

  ```bash cURL theme={null}
  # 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 '{}'
  ```
</CodeGroup>

## Schema

### Input

<ParamField body="alpha_mode" type="string" required>
  Alpha mode: auto, fill, custom, or select

  Possible values: `auto`, `fill`, `custom`, `select`
</ParamField>

<ParamField body="alpha_uri" type="string">
  URI of a custom alpha matte. Required when alpha\_mode is custom or select. Ignored for auto or fill.
</ParamField>

<ParamField body="callback_url" type="string">
  HTTPS URL for webhook notification on completion or failure.
</ParamField>

<ParamField body="generation_type" type="string" required>
  Output type: image or video

  Possible values: `image`, `video`
</ParamField>

<ParamField body="idempotency_key" type="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.
</ParamField>

<ParamField body="max_resolution" type="integer" default="1080">
  Maximum output resolution: 720 or 1080 (default: 1080).
</ParamField>

<ParamField body="prompt" type="string">
  Text description of desired output (max 2,000 chars). At least one of prompt or reference\_image\_uri is required.
</ParamField>

<ParamField body="reference_image_uri" type="string">
  URI of the reference image for style transfer. Accepts the same URI types as source\_uri.
</ParamField>

<ParamField body="source_uri" type="string" required>
  URI of the source image or video. Accepts beeble://uploads/\{id}/\{filename}, https URLs, or data:\{mime};base64 URIs (max 50 MB).
</ParamField>

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

<ResponseField name="alpha_mode" type="string">
  auto, fill, custom, or select
</ResponseField>

<ResponseField name="completed_at" type="string">
  ISO 8601 timestamp when the job completed or failed.
</ResponseField>

<ResponseField name="created_at" type="string">
  ISO 8601 timestamp when the job was created.
</ResponseField>

<ResponseField name="error" type="string">
  Error message (present when status is failed).
</ResponseField>

<ResponseField name="generation_type" type="string">
  image or video
</ResponseField>

<ResponseField name="id" type="string" required>
  Job identifier (swx\_...)
</ResponseField>

<ResponseField name="modified_at" type="string">
  ISO 8601 timestamp of the last status change.
</ResponseField>

<ResponseField name="output" type="object">
  Signed URLs for SwitchX job outputs.
</ResponseField>

<ResponseField name="output.alpha" type="string">
  Alpha matte URL.
</ResponseField>

<ResponseField name="output.render" type="string">
  Composited output URL.
</ResponseField>

<ResponseField name="output.source" type="string">
  Preprocessed source URL.
</ResponseField>

<ResponseField name="progress" type="integer">
  Progress percentage (0-100).
</ResponseField>

<ResponseField name="status" type="string" required>
  Current job status.

  Possible values: `in_queue`, `processing`, `completed`, `failed`
</ResponseField>

<ResponseField name="webhook" type="object">
  Webhook delivery status for a SwitchX job.
</ResponseField>

<ResponseField name="webhook.attempts" type="integer">
  Number of delivery attempts so far.
</ResponseField>

<ResponseField name="webhook.last_error" type="string">
  Error message from the last failed delivery attempt.
</ResponseField>

<ResponseField name="webhook.status" type="string">
  pending, delivered, or failed
</ResponseField>

## Examples

### Input

```json theme={null}
{
  "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

```json theme={null}
{
  "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](/development/comfy-router/reference#result-assets).

<CardGroup cols={3}>
  <Card title="Headers" icon="list" href="/development/comfy-router/headers">
    Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.
  </Card>

  <Card title="Using the Router API" icon="code" href="/development/comfy-router/models">
    Find models, inspect schemas, and retry safely.
  </Card>

  <Card title="Limitations" icon="triangle-exclamation" href="/development/comfy-router/limitations">
    What Router does not do today, and what to use instead.
  </Card>
</CardGroup>