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

# IdeogramV3 - ComfyUI Built-in Node Documentation

> Complete documentation for the IdeogramV3 node in ComfyUI. Learn its inputs, outputs, parameters and usage.

> This documentation was AI-generated. If you find any errors or have suggestions for improvement, please feel free to contribute! [Edit on GitHub](https://github.com/Comfy-Org/embedded-docs/blob/main/comfyui_embedded_docs/docs/IdeogramV3/en.md)

The Ideogram V3 node generates images using the Ideogram V3 model. It supports both regular image generation from text prompts and image editing when both an image and mask are provided. The node offers various controls for aspect ratio, resolution, generation speed, and optional character reference images.

## Inputs

| Parameter             | Data Type | Required | Range                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | Description                                                                                                         |
| --------------------- | --------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| `prompt`              | STRING    | Yes      | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Prompt for the image generation or editing (default: empty)                                                         |
| `image`               | IMAGE     | No       | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Optional reference image for image editing                                                                          |
| `mask`                | MASK      | No       | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Optional mask for inpainting (white areas will be replaced)                                                         |
| `aspect_ratio`        | COMBO     | No       | "1:1"<br />"1:3"<br />"3:1"<br />"1:2"<br />"2:1"<br />"9:16"<br />"16:9"<br />"10:16"<br />"16:10"<br />"2:3"<br />"3:2"<br />"3:4"<br />"4:3"<br />"4:5"<br />"5:4"                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | The aspect ratio for image generation. Ignored if resolution is not set to Auto (default: "1:1")                    |
| `resolution`          | COMBO     | No       | "Auto"<br />"512x1536"<br />"576x1408"<br />"576x1472"<br />"576x1536"<br />"640x1344"<br />"640x1408"<br />"640x1472"<br />"640x1536"<br />"704x1152"<br />"704x1216"<br />"704x1280"<br />"704x1344"<br />"704x1408"<br />"704x1472"<br />"736x1312"<br />"768x1088"<br />"768x1216"<br />"768x1280"<br />"768x1344"<br />"800x1280"<br />"832x960"<br />"832x1024"<br />"832x1088"<br />"832x1152"<br />"832x1216"<br />"832x1248"<br />"864x1152"<br />"896x960"<br />"896x1024"<br />"896x1088"<br />"896x1120"<br />"896x1152"<br />"960x832"<br />"960x896"<br />"960x1024"<br />"960x1088"<br />"1024x832"<br />"1024x896"<br />"1024x960"<br />"1024x1024"<br />"1088x768"<br />"1088x832"<br />"1088x896"<br />"1088x960"<br />"1120x896"<br />"1152x704"<br />"1152x832"<br />"1152x864"<br />"1152x896"<br />"1216x704"<br />"1216x768"<br />"1216x832"<br />"1248x832"<br />"1280x704"<br />"1280x768"<br />"1280x800"<br />"1312x736"<br />"1344x640"<br />"1344x704"<br />"1344x768"<br />"1408x576"<br />"1408x640"<br />"1408x704"<br />"1472x576"<br />"1472x640"<br />"1472x704"<br />"1536x512"<br />"1536x576"<br />"1536x640" | The resolution for image generation. If not set to Auto, this overrides the aspect\_ratio setting (default: "Auto") |
| `magic_prompt_option` | COMBO     | No       | "AUTO"<br />"ON"<br />"OFF"                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Determine if MagicPrompt should be used in generation (default: "AUTO")                                             |
| `seed`                | INT       | No       | 0-2147483647                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Random seed for generation (default: 0)                                                                             |
| `num_images`          | INT       | No       | 1-8                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | Number of images to generate (default: 1)                                                                           |
| `rendering_speed`     | COMBO     | No       | "DEFAULT"<br />"TURBO"<br />"QUALITY"                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | Controls the trade-off between generation speed and quality (default: "DEFAULT")                                    |
| `character_image`     | IMAGE     | No       | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Image to use as character reference                                                                                 |
| `character_mask`      | MASK      | No       | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Optional mask for character reference image                                                                         |

**Parameter Constraints:**

* When both `image` and `mask` are provided, the node switches to editing mode
* If only one of `image` or `mask` is provided, an error will occur
* `character_mask` requires `character_image` to be present
* The `aspect_ratio` parameter is ignored when `resolution` is not set to "Auto"
* White areas in the mask will be replaced during inpainting
* Character mask and character image must be the same size

## Outputs

| Output Name | Data Type | Description                      |
| ----------- | --------- | -------------------------------- |
| `output`    | IMAGE     | The generated or edited image(s) |

***

**Source fingerprint (SHA-256):** `b3ddd489ee96b4b378ae432254d8e97bccafc20e38055b213c0ad3b7818cb4c0`