> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-codex-api-first-result.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.

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

## Quick start

Create a key in [your Comfy workspace](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`

<Tabs>
  <Tab title="Wait for the result">
    <CodeGroup>
      ```python Python theme={null}
      from comfy_sdk import Comfy

      # Reads COMFY_API_KEY from the environment.
      # The SDK automatically creates an idempotency key and reuses it for automatic retries.
      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)
      ```

      ```typescript TypeScript theme={null}
      import { comfy } from "@comfyorg/sdk";

      // Reads COMFY_API_KEY from the environment.
      // The SDK automatically creates an idempotency key and reuses it for automatic retries.
      const { data } = await comfy.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",
      });

      console.log(data);
      ```

      ```bash cURL theme={null}
      curl https://api.comfy.org/v2/models/beeble/switchx \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"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\"}"
      ```
    </CodeGroup>
  </Tab>

  <Tab title="Queue and collect later">
    <Note>
      Queued delivery is rolling out per workspace. Until yours is enabled, the submit route answers `403` with `X-Comfy-Error-Type: not_enabled`. Nothing about the request is wrong, and the same body works through the synchronous route in the meantime.
    </Note>

    The same body, sent to `POST https://api.comfy.org/v2/models/beeble/switchx/requests`. Router answers `201` with a `request_id` as soon as the run is admitted, and the result is collected once it is ready, from this process or another one. [Queued delivery](/development/comfy-router/queue) walks through status, cancellation and collection.

    <CodeGroup>
      ```python Python theme={null}
      from comfy_sdk import Comfy

      # Reads COMFY_API_KEY from the environment.
      # Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
      with Comfy() as client:
          handle = client.models.submit(
              "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("request_id:", handle.request_id)  # with the model ID, all another process needs

          # Poll until the request completes, waiting the Retry-After the server names.
          for update in handle.iter_events():
              print(update.status, update.queue_position)

          # The provider's own payload, the same value models.run() returns.
          # A request that failed or was cancelled raises the typed Router error here.
          result = handle.get()

      print(result)
      ```

      ```typescript TypeScript theme={null}
      import { comfy } from "@comfyorg/sdk";

      // Reads COMFY_API_KEY from the environment.
      // Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
      const handle = await comfy.models.submit("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",
      });
      console.log("requestId:", handle.requestId); // with the model ID, all another process needs

      // Poll until the request completes, waiting the Retry-After the server names.
      for await (const update of handle.events()) {
        console.log(update.status, update.queuePosition);
      }

      // The same result models.run() returns. A request that failed or was cancelled rejects here.
      const result = await handle.get();

      console.log(result.data);
      ```

      ```bash cURL theme={null}
      # 1. Submit. Router answers 201 with request_id, status_url, response_url and cancel_url.
      curl https://api.comfy.org/v2/models/beeble/switchx/requests \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"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\"}"

      # 2. Poll until status is COMPLETED, waiting the Retry-After seconds each response names.
      REQUEST_ID="<request_id from the 201 body>"
      curl -i https://api.comfy.org/v2/models/beeble/switchx/requests/$REQUEST_ID/status \
        -H "X-API-Key: $COMFY_API_KEY"

      # 3. Collect. 200 with the model's native output, 202 with the status body while it is still running.
      curl https://api.comfy.org/v2/models/beeble/switchx/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## 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

The SDKs create an `Idempotency-Key` and reuse it for automatic retries. For manual retries, reuse the original key. Router can hold the connection for up to 10 minutes.

When a request fails, Router sends an `X-Comfy-Error-Type` response header explaining why. 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/api">
    Model discovery, validation errors, retries, and billing.
  </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>