> ## 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 4.0 사용하기

> Comfy Router를 통해 HTTP로 Ideogram 4.0 이미지를 생성하기 위한 Python, TypeScript, cURL 스니펫과 요청 필드 및 결과 형태

Ideogram 4.0의 API 레퍼런스입니다. Ideogram 4.0은 Ideogram의 텍스트 기반 이미지 생성 모델로, 생성된 이미지 안에 읽을 수 있는 텍스트를 렌더링합니다.

## 빠른 시작

[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-v4`

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

<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-v4",
              {
                  "text_prompt": "a single red maple leaf on a plain white background, studio lighting",
                  "resolution": "1024x1024",
                  "rendering_speed": "DEFAULT",
              },
          )

      print("image:", result["data"][0]["url"])
      ```

      ```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.
      type Result = { data: { url: string }[] };
      const { data } = await comfy.models.run<Result>("ideogram/ideogram-v4", {
        text_prompt: "a single red maple leaf on a plain white background, studio lighting",
        resolution: "1024x1024",
        rendering_speed: "DEFAULT",
      });

      console.log("image:", data.data[0].url);
      ```

      ```bash cURL theme={null}
      curl https://api.comfy.org/v2/models/ideogram/ideogram-v4 \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"text_prompt\": \"a single red maple leaf on a plain white background, studio lighting\", \"resolution\": \"1024x1024\", \"rendering_speed\": \"DEFAULT\"}"
      ```
    </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-v4",
              {
                  "text_prompt": "a single red maple leaf on a plain white background, studio lighting",
                  "resolution": "1024x1024",
                  "rendering_speed": "DEFAULT",
              },
          )
          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("image:", result["data"][0]["url"])
      ```

      ```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.
      type Result = { data: { url: string }[] };
      const handle = await comfy.models.submit<Result>("ideogram/ideogram-v4", {
        text_prompt: "a single red maple leaf on a plain white background, studio lighting",
        resolution: "1024x1024",
        rendering_speed: "DEFAULT",
      });
      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();
      if (result.kind !== "json") throw new Error("expected a JSON result");

      console.log("image:", result.data.data[0].url);
      ```

      ```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-v4/requests \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"text_prompt\": \"a single red maple leaf on a plain white background, studio lighting\", \"resolution\": \"1024x1024\", \"rendering_speed\": \"DEFAULT\"}"

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

## 스키마

### 입력

<ParamField body="enable_copyright_detection" type="boolean">
  생성 후 저작권 감지(Hive 유사도 및 로고 검사)를 선택적으로 활성화합니다.
</ParamField>

<ParamField body="json_prompt" type="object">
  구조화된 V4 프롬프트입니다. Magic Prompt를 비활성화하며 직접 사용됩니다. text\_prompt 또는 json\_prompt 중 정확히 하나만 제공하세요.
</ParamField>

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

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

<ParamField body="resolution" type="string">
  WIDTHxHEIGHT 형식의 출력 해상도입니다. 생략하면 모델이 화면 비율을 선택합니다. 지원되는 2K 값: 2048x2048, 1440x2880, 2880x1440, 1664x2496, 2496x1664, 1792x2240, 2240x1792, 1440x2560, 2560x1440, 1600x2560, 2560x1600, 1728x2304, 2304x1728, 1296x3168, 3168x1296, 1152x2944, 2944x1152, 1248x3328, 3328x1248, 1280x3072, 3072x1280.
</ParamField>

<ParamField body="text_prompt" type="string">
  자연어 프롬프트입니다. Magic Prompt를 자동으로 활성화합니다. text\_prompt 또는 json\_prompt 중 정확히 하나만 제공하세요.
</ParamField>

Router가 `GET /v2/models/ideogram/ideogram-v4/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}
{
  "text_prompt": "a single red maple leaf on a plain white background, studio lighting",
  "resolution": "1024x1024",
  "rendering_speed": "DEFAULT"
}
```

### 출력

```json theme={null}
{
  "response_type": "url",
  "created": "2026-08-27T21:00:00Z",
  "data": [
    {
      "url": "https://.../image.png",
      "prompt": "a single red maple leaf on a plain white background, studio lighting",
      "resolution": "1024x1024",
      "seed": 1234567890,
      "is_image_safe": true
    }
  ]
}
```

URL은 임시입니다. 이미지를 보관해야 한다면 즉시 다운로드하세요.

## 배포 전 확인

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>
