> ## 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로 Ideogram V3 사용하기

> Comfy Router를 통해 ideogram/ideogram-v3를 호출합니다: endpoint, 요청 형태, 그리고 Router가 반환하는 응답을 다룹니다.

Ideogram에서 Comfy Router가 제공하는 `ideogram/ideogram-v3`에 대한 API Reference입니다.

## 빠른 시작

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

**모델 ID:** `ideogram/ideogram-v3`

**엔드포인트:** `POST https://api.comfy.org/v2/models/ideogram/ideogram-v3`

<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(
              "ideogram/ideogram-v3",
              {
                  "prompt": "A beautiful mountain landscape",
                  "rendering_speed": "TURBO",
              },
          )

      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("ideogram/ideogram-v3", {
        prompt: "A beautiful mountain landscape",
        rendering_speed: "TURBO",
      });

      console.log(data);
      ```

      ```bash cURL theme={null}
      curl https://api.comfy.org/v2/models/ideogram/ideogram-v3 \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"prompt\": \"A beautiful mountain landscape\", \"rendering_speed\": \"TURBO\"}"
      ```
    </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(
              "ideogram/ideogram-v3",
              {
                  "prompt": "A beautiful mountain landscape",
                  "rendering_speed": "TURBO",
              },
          )
          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("ideogram/ideogram-v3", {
        prompt: "A beautiful mountain landscape",
        rendering_speed: "TURBO",
      });
      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/ideogram/ideogram-v3/requests \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"prompt\": \"A beautiful mountain landscape\", \"rendering_speed\": \"TURBO\"}"

      # 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/ideogram/ideogram-v3/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/ideogram/ideogram-v3/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## 스키마

### 입력

<ParamField body="aspect_ratio" type="string">
  WxH 형식의 가로세로 비율
</ParamField>

<ParamField body="color_palette" type="object" />

<ParamField body="color_palette.members" type="object[]">
  선택적 가중치가 있는 명시적 색상
</ParamField>

<ParamField body="color_palette.members[].color" type="string">
  16진수 색상 코드
</ParamField>

<ParamField body="color_palette.members[].weight" type="number">
  색상의 선택적 가중치 (0-1)

  범위: `0` \~ `1`
</ParamField>

<ParamField body="color_palette.name" type="string">
  색상 팔레트의 이름
</ParamField>

<ParamField body="magic_prompt" type="string">
  매직 프롬프트 향상 기능을 활성화할지 여부

  가능한 값: `AUTO`, `ON`, `OFF`
</ParamField>

<ParamField body="negative_prompt" type="string">
  생성에서 피해야 할 내용을 지정하는 텍스트 프롬프트
</ParamField>

<ParamField body="num_images" type="integer">
  생성할 이미지 수

  범위: `1` \~ `…`
</ParamField>

<ParamField body="prompt" type="string" required>
  이미지 생성을 위한 텍스트 프롬프트
</ParamField>

<ParamField body="rendering_speed" type="string" required default="&#x22;DEFAULT&#x22;">
  생성 속도와 품질 사이의 균형을 제어하는 렌더링 속도 설정

  가능한 값: `DEFAULT`, `TURBO`, `QUALITY`
</ParamField>

<ParamField body="resolution" type="string">
  WxH 형식의 이미지 해상도
</ParamField>

<ParamField body="seed" type="integer">
  재현 가능한 생성을 위한 시드 값
</ParamField>

<ParamField body="style_codes" type="string[]">
  16진수 형식의 스타일 코드 배열
</ParamField>

<ParamField body="style_type" type="string" default="&#x22;GENERAL&#x22;">
  가능한 값: `AUTO`, `GENERAL`, `REALISTIC`, `DESIGN`, `FICTION`
</ParamField>

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

### 출력

<ResponseField name="created" type="string (date-time)">
  생성이 만들어진 시각의 타임스탬프.

  형식: `date-time`
</ResponseField>

<ResponseField name="data" type="object[]">
  생성된 이미지 정보의 배열.
</ResponseField>

<ResponseField name="data[].is_image_safe" type="boolean">
  이미지가 안전한 것으로 간주되는지 여부를 나타냅니다.
</ResponseField>

<ResponseField name="data[].prompt" type="string">
  이 이미지를 생성하는 데 사용된 프롬프트.
</ResponseField>

<ResponseField name="data[].resolution" type="string">
  생성된 이미지의 해상도 (예: '1024x1024').
</ResponseField>

<ResponseField name="data[].seed" type="integer">
  이 생성에 사용된 시드 값.
</ResponseField>

<ResponseField name="data[].style_type" type="string">
  생성에 사용된 스타일 유형 (예: 'REALISTIC', 'ANIME').
</ResponseField>

<ResponseField name="data[].url" type="string">
  생성된 이미지의 URL.
</ResponseField>

## 예시

### 입력

```json theme={null}
{
  "prompt": "A beautiful mountain landscape",
  "rendering_speed": "TURBO"
}
```

### 출력

```json theme={null}
{
  "created": "2026-01-01T00:00:00Z",
  "data": [
    {
      "is_image_safe": true,
      "prompt": "A poster for a jazz festival, bold typography, warm colours",
      "resolution": "1024x1024",
      "seed": 918273645,
      "style_type": "REALISTIC",
      "url": "https://example.invalid/ideogram/ideogram-v3/generated.png"
    }
  ]
}
```

## 배포 전 확인

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>