> ## Documentation Index
> Fetch the complete documentation index at: https://docs.comfy.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Comfy Router로 SwitchX 사용하기

> Comfy Router를 통해 beeble/switchx를 호출합니다. 엔드포인트, 요청 형태, 그리고 Router가 반환하는 응답을 설명합니다.

Beeble에서 제공하고 Comfy Router가 서비스하는 `beeble/switchx`의 API 레퍼런스입니다.

## 빠른 시작

[Comfy 워크스페이스](https://platform.comfy.org/profile/api-keys)에서 키를 생성하고 `COMFY_API_KEY`로 내보내세요. Python 및 TypeScript 스니펫은 Comfy SDK(`pip install comfy-sdk`, `npm install @comfyorg/sdk`)를 사용하며, cURL 스니펫은 동일한 호출을 원시 HTTP로 수행합니다.

**모델 ID:** `beeble/switchx`

**엔드포인트:** `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">
    <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>

## 스키마

### 입력

<ParamField body="alpha_mode" type="string" required>
  알파 모드: auto, fill, custom, select

  가능한 값: `auto`, `fill`, `custom`, `select`
</ParamField>

<ParamField body="alpha_uri" type="string">
  사용자 지정 알파 매트의 URI입니다. alpha\_mode가 custom 또는 select일 때 필수입니다. auto 또는 fill일 때는 무시됩니다.
</ParamField>

<ParamField body="callback_url" type="string">
  완료 또는 실패 시 webhook 알림을 받을 HTTPS URL입니다.
</ParamField>

<ParamField body="generation_type" type="string" required>
  출력 유형: 이미지 또는 비디오

  가능한 값: `image`, `video`
</ParamField>

<ParamField body="idempotency_key" type="string">
  안전한 재시도를 위한 멱등성 키입니다. 동일한 키를 가진 작업이 이미 계정에 존재하면 API는 복제를 생성하지 않고 기존 작업의 상태를 반환합니다.
</ParamField>

<ParamField body="max_resolution" type="integer" default="1080">
  최대 출력 해상도: 720 또는 1080 (기본값: 1080).
</ParamField>

<ParamField body="prompt" type="string">
  원하는 출력에 대한 텍스트 설명입니다(최대 2,000자). prompt 또는 reference\_image\_uri 중 최소 한 개가 필요합니다.
</ParamField>

<ParamField body="reference_image_uri" type="string">
  스타일 전송을 위한 참조 이미지의 URI입니다. source\_uri와 동일한 URI 유형을 허용합니다.
</ParamField>

<ParamField body="source_uri" type="string" required>
  소스 이미지 또는 비디오의 URI입니다. beeble://uploads/\{id}/\{filename}, https URL 또는 data:\{mime};base64 URI(최대 50 MB)를 허용합니다.
</ParamField>

`GET /v2/models/beeble/switchx/openapi.json`에서 Router가 제공하는 스키마에서 생성되었으며, 이는 요청이 공급자에게 도달하기 이전에 호출을 검증하는 데 사용하는 것과 동일한 문서입니다.

### 출력

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

<ResponseField name="completed_at" type="string">
  작업이 완료되거나 실패한 시점의 ISO 8601 타임스탬프입니다.
</ResponseField>

<ResponseField name="created_at" type="string">
  작업이 생성된 시점의 ISO 8601 타임스탬프입니다.
</ResponseField>

<ResponseField name="error" type="string">
  오류 메시지입니다(status가 failed일 때 표시됩니다).
</ResponseField>

<ResponseField name="generation_type" type="string">
  이미지 또는 비디오
</ResponseField>

<ResponseField name="id" type="string" required>
  작업 식별자(swx\_...)
</ResponseField>

<ResponseField name="modified_at" type="string">
  마지막 상태 변경 시점의 ISO 8601 타임스탬프입니다.
</ResponseField>

<ResponseField name="output" type="object">
  SwitchX 작업 출력에 대한 서명된 URL입니다.
</ResponseField>

<ResponseField name="output.alpha" type="string">
  알파 매트 URL입니다.
</ResponseField>

<ResponseField name="output.render" type="string">
  합성된 출력 URL입니다.
</ResponseField>

<ResponseField name="output.source" type="string">
  전처리된 소스 URL입니다.
</ResponseField>

<ResponseField name="progress" type="integer">
  진행률 백분율(0-100)입니다.
</ResponseField>

<ResponseField name="status" type="string" required>
  현재 작업 상태입니다.

  가능한 값: `in_queue`, `processing`, `completed`, `failed`
</ResponseField>

<ResponseField name="webhook" type="object">
  SwitchX 작업의 webhook 전송 상태입니다.
</ResponseField>

<ResponseField name="webhook.attempts" type="integer">
  지금까지의 전송 시도 횟수입니다.
</ResponseField>

<ResponseField name="webhook.last_error" type="string">
  마지막으로 실패한 전송 시도의 오류 메시지입니다.
</ResponseField>

<ResponseField name="webhook.status" type="string">
  대기 중, 전송됨 또는 실패
</ResponseField>

## 예제

### 입력

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

### 출력

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

## 배포 전 확인

SDK는 `Idempotency-Key`를 생성하고 자동 재시도에서 재사용합니다. 수동 재시도 시에는 원래 키를 재사용하세요. Router는 연결을 최대 10분간 유지할 수 있습니다.

요청이 실패하면 Router는 이유를 설명하는 `X-Comfy-Error-Type` 응답 헤더를 보냅니다. `422`는 Router가 프로바이더를 호출하기 전에 입력을 거부했음을 의미합니다. 생성된 에셋은 [결과 URL이 만료](/ko/development/comfy-router/reference#결과-에셋)될 수 있으므로 즉시 다운로드하세요.

<CardGroup cols={3}>
  <Card title="헤더" icon="list" href="/ko/development/comfy-router/quickstart">
    인증, 멱등성, 요청 ID, 오류 분류, 재시도 간격, 지출 한도.
  </Card>

  <Card title="Router API 사용" icon="code" href="/ko/development/comfy-router/quickstart">
    모델 검색, 유효성 검사 오류, 재시도, 과금.
  </Card>

  <Card title="제한 사항" icon="triangle-exclamation" href="/ko/development/comfy-router/limitations">
    Router가 현재 지원하지 않는 기능과 대체 방법.
  </Card>
</CardGroup>