Inpaint an image
ideogram_inpaintRepaint the masked area of an image with Ideogram 3.0 variants: provide the source image and a mask where black marks the region to regenerate.
Instructions
Repaint the masked part of an image (black in the mask = repaint) with Ideogram 3.0 or its character / custom-model variants. Needs the source and the mask, each a local file, a public https URL or an Ideogram asset. Results are saved to the output directory; ideogram_quote prices a call first (nothing is generated).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mask | No | Local mask image file or a public https URL, the same size as the source | |
| seed | No | Random seed for a reproducible result | |
| image | No | Local image file to work on, or a public https URL of one | |
| model | No | The model (default ideogram-3); each takes the fields of its variant below | |
| prompt | No | What to create or change, in natural language | |
| wait_s | No | Seconds to wait for the result (0-50, default 45). The job is accepted first; if it is still running when the wait ends, the result is its generation_id for ideogram_generation (never resubmitted, never billed twice). | |
| private | No | Keep the result out of Ideogram's public feed; true unless you set false (enterprise accounts are always private) | |
| num_images | No | How many images to make (each is billed) | |
| style_type | No | Visual style family | |
| style_codes | No | 8-character hexadecimal style codes | |
| magic_prompt | No | auto, on or off: let Ideogram rewrite the prompt | |
| style_preset | No | A named style preset; not with style codes or style references | |
| inline_images | No | true: each saved image is also returned as image content (base64; one over 3.75 MB, or past 10 MB in total, by path only), for a client without file access | |
| rendering_speed | No | turbo, default or quality: faster is cheaper | |
| custom_model_uri | No | A custom model you trained or were given access to | |
| mask_asset_identifier | No | An Ideogram asset to use as the mask | |
| image_asset_identifier | No | An Ideogram asset (an upload or an earlier result) instead of a local image | |
| style_reference_images | No | Local image files (or public https URLs) whose style the result follows | |
| character_reference_mask | No | Local grayscale mask (or a public https URL) of where the character is in its reference image | |
| character_reference_images | No | Local image files (or public https URLs) of the character to keep consistent | |
| enable_copyright_detection | No | Run Ideogram's copyright detection on the result (adds latency) | |
| style_reference_collection_id | No | A saved style collection to apply | |
| style_reference_asset_identifiers | No | Ideogram assets (uploads or earlier results) to use as style references | |
| character_reference_asset_identifiers | No | Ideogram assets to use as the character reference | |
| style_reference_collection_version_id | No | A version of the saved style collection |