ideogram_edit
Edit specific image areas with mask-based inpainting. Provide source image, mask (black=edit, white=keep), and prompt; output keeps source size.
Instructions
Edit specific areas of an image using mask-based inpainting. Requires source image, mask (black=edit, white=keep), and prompt; takes the style and character references, style codes, preset and palette (no exact resolution: inpaint keeps the source size).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mask | Yes | Local file path of the mask image (black = regions to edit, white = keep) | |
| seed | No | Reproducibility seed | |
| image | Yes | Local file path of the source image to edit | |
| prompt | Yes | Description of desired changes | |
| num_images | No | Number of variations (1-8, default: 1) | |
| style_type | No | Visual style (the API default is GENERAL when omitted) | |
| style_codes | No | 8-character hexadecimal style codes from Ideogram | |
| magic_prompt | No | Auto-enhance prompts (default: AUTO) | |
| style_preset | No | A named style preset as Ideogram lists them | |
| color_palette | No | A preset palette by name, or explicit colours with weights (not both) | |
| rendering_speed | No | Speed/quality tradeoff (default: DEFAULT) | |
| style_reference_images | No | Local image files whose style the result follows (up to 3, 25 MB each) | |
| character_reference_mask | No | Grayscale mask of the character reference (same dimensions); needs character_reference_image | |
| character_reference_image | No | Local image file of a character to keep consistent (one image; Ideogram bills character references at its own rate) |