Ideogram 3.0 Edit
Ideogram 3.0 Edit lets you inpaint images with surgical control. Upload an image, mask a region, then refine layout or text while the rest stays intact. Ideal for typography fixes, layout tweaks, brand updates, and production safe visual polish in existing assets.
API Options
Platform-level options for task execution and delivery.
-
taskType
string required value: imageInference -
Identifier for the type of task being performed
-
taskUUID
string required UUID v4 -
UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.
-
outputType
string default: URL -
Image output type.
Allowed values 3 values
-
outputFormat
string default: JPG -
Specifies the file format of the generated output. The available values depend on the task type and the specific model's capabilities.
- `JPG`: Best for photorealistic images with smaller file sizes (no transparency).
- `PNG`: Lossless compression, supports high quality and transparency (alpha channel).
- `WEBP`: Modern format providing superior compression and transparency support.
**Transparency**: If you are using features like background removal or LayerDiffuse that require transparency, you must select a format that supports an alpha channel (e.g., `PNG`, `WEBP`, `TIFF`). `JPG` does not support transparency.Allowed values 3 values
-
outputQuality
integer min: 20 max: 99 default: 95 -
Compression quality of the output. Higher values preserve quality but increase file size.
-
webhookURL
string URI -
Specifies a webhook URL where JSON responses will be sent via HTTP POST when generation tasks complete. For batch requests with multiple results, each completed item triggers a separate webhook call as it becomes available.
Learn more 1 resource
- Webhooks PLATFORM
- Webhooks
-
deliveryMethod
string default: sync -
Determines how the API delivers task results.
Allowed values 2 values
- Returns complete results directly in the API response.
- Returns an immediate acknowledgment with the task UUID. Poll for results using getResponse.
Learn more 1 resource
- Task Polling PLATFORM
-
uploadEndpoint
string URI -
Specifies a URL where the generated content will be automatically uploaded using the HTTP PUT method. The raw binary data of the media file is sent directly as the request body. For secure uploads to cloud storage, use presigned URLs that include temporary authentication credentials.
Common use cases:
- Cloud storage: Upload directly to S3 buckets, Google Cloud Storage, or Azure Blob Storage using presigned URLs.
- CDN integration: Upload to content delivery networks for immediate distribution.
// S3 presigned URL for secure upload https://your-bucket.s3.amazonaws.com/generated/content.mp4?X-Amz-Signature=abc123&X-Amz-Expires=3600 // Google Cloud Storage presigned URL https://storage.googleapis.com/your-bucket/content.jpg?X-Goog-Signature=xyz789 // Custom storage endpoint https://storage.example.com/uploads/generated-image.jpgThe content data will be sent as the request body to the specified URL when generation is complete.
-
safety
object -
Content safety checking configuration for image generation.
Properties 2 properties
-
safety»checkContentcheckContent
boolean default: false -
Enable or disable content safety checking. When enabled, defaults to
fastmode.
-
safety»modemode
string default: none -
Safety checking mode for image generation.
Allowed values 2 values
- Disables checking.
- Performs a single check.
-
-
ttl
integer min: 60 -
Time-to-live (TTL) in seconds for generated content. Only applies when
outputTypeisURL.
-
includeCost
boolean default: false -
Include task cost in the response.
-
numberResults
integer min: 1 max: 20 default: 1 -
Number of results to generate. Each result uses a different seed, producing variations of the same parameters.
Inputs
Input resources for the task (images, audio, etc). These must be nested inside the inputs object.
inputs object.-
inputs»seedImageseedImage
string required -
Image used as a starting point for the generation (UUID, URL, Data URI, or Base64).
Learn more 3 resources
-
inputs»maskImagemaskImage
string required -
Image used to specify which areas of the seed image should be edited (UUID, URL, Data URI, or Base64).
Learn more 1 resource
Generation Parameters
Core parameters for controlling the generated content.
-
model
string required value: ideogram:4@3 -
Identifier of the model to use for generation.
Learn more 3 resources
-
positivePrompt
string required min: 1 max: 2000 -
Text prompt describing elements to include in the generated output.
Learn more 2 resources
Provider Settings
Parameters specific to this model provider. These must be nested inside the providerSettings.ideogram object.
providerSettings.ideogram object.-
providerSettings»ideogram»characterReferenceImagescharacterReferenceImages
array of strings items: 1 -
Character reference images to preserve consistent facial and body traits across generations.
-
providerSettings»ideogram»characterReferenceImagesMaskcharacterReferenceImagesMask
array of strings items: 1 -
Mask images for character reference images. Must match the number of character reference images.
-
providerSettings»ideogram»magicPromptmagicPrompt
string default: AUTO -
Automatic prompt enhancement.
Allowed values 3 values
- Content-based enhancement.
- Always enhance.
- No enhancement.
-
providerSettings»ideogram»renderingSpeedrenderingSpeed
string default: DEFAULT -
Generation speed/quality tradeoff.
Allowed values 3 values
- Fastest generation.
- Balanced speed and quality.
- Best quality.
-
providerSettings»ideogram»styleCodestyleCode
string min: 8 max: 8 -
Predefined style code (8-char hex).
-
providerSettings»ideogram»stylePresetstylePreset
string -
Artistic style preset.
Allowed values 62 values
-
providerSettings»ideogram»styleReferenceImagesstyleReferenceImages
array of strings min items: 1max items: 4 -
Reference images for visual style transfer. The model extracts and applies the artistic style from these images.
-
providerSettings»ideogram»styleTypestyleType
string default: AUTO -
Visual style and rendering approach.
Allowed values 7 values
- Automatically selects the most appropriate style.
- Versatile style suitable for most content types.
- Photorealistic rendering with natural lighting and textures.
- Optimized for graphic design, logos, and typography.
- Three-dimensional rendering with depth and modeling effects.
- Anime/manga visual style.
- Stylized rendering for fictional and fantasy content.
Artisanal Bakery Window Signage
{
"taskType": "imageInference",
"taskUUID": "c34775f2-381c-4c0d-89bc-1d8e9bb0499b",
"model": "ideogram:4@3",
"positivePrompt": "Edit only the masked areas of this bakery storefront image. Replace the existing window text with elegant, readable hand-painted typography that says 'BRAMBLE & RYE' on the main glass and add a smaller refined line beneath it reading 'slow-baked breads • seasonal pastries'. Update the masked hanging placard to say 'OPEN 7AM–3PM'. Keep the rest of the photo unchanged: realistic reflections, pastry displays, brick texture, painted wood trim, sidewalk context, natural morning light, and authentic neighborhood character. The new lettering should feel premium, artisanal, and production-ready, with balanced spacing, excellent legibility, subtle gold-cream paint, and a tasteful contemporary storefront branding aesthetic.",
"providerSettings": {
"ideogram": {
"renderingSpeed": "QUALITY",
"magicPrompt": "OFF",
"styleType": "DESIGN",
"stylePreset": "EDITORIAL"
}
},
"inputs": {
"seedImage": "https://assets.runware.ai/assets/inputs/423d5aa9-443b-4c2b-83f1-3712e2d0270d.jpg",
"maskImage": "https://assets.runware.ai/assets/inputs/78428844-f4ae-40a5-b063-f57fd9b08167.jpg"
}
}{
"taskType": "imageInference",
"taskUUID": "c34775f2-381c-4c0d-89bc-1d8e9bb0499b",
"imageUUID": "23665695-77df-4fee-adfb-3493efe8c9d5",
"imageURL": "https://im.runware.ai/image/os/a13d12/ws/2/ii/23665695-77df-4fee-adfb-3493efe8c9d5.jpg",
"seed": 1425320281,
"cost": 0.09
}Retro Vending Machine Rebrand
{
"taskType": "imageInference",
"taskUUID": "c2e0416b-6cc1-4345-a8c1-31d473101eea",
"model": "ideogram:4@3",
"positivePrompt": "Replace only the masked vending machine branding area with a bold mid-century soda brand design reading 'FIZZROCKET' in crisp legible retro typography, cream and turquoise enamel lettering, small starburst accents, authentic printed product labels, slightly aged but clean commercial finish, perfectly integrated perspective, preserve all unmasked chrome surfaces, diner background, floor reflections, lighting, and camera framing",
"providerSettings": {
"ideogram": {
"renderingSpeed": "QUALITY",
"magicPrompt": "OFF",
"styleType": "DESIGN",
"stylePreset": "BAUHAUS"
}
},
"inputs": {
"seedImage": "https://assets.runware.ai/assets/inputs/b0ec5523-9d79-4973-a0dc-03be847d7ff7.jpg",
"maskImage": "https://assets.runware.ai/assets/inputs/68dfcc5a-b894-4546-9e42-fb7de460fb91.jpg"
}
}{
"taskType": "imageInference",
"taskUUID": "c2e0416b-6cc1-4345-a8c1-31d473101eea",
"imageUUID": "189f150a-9307-41e3-bacd-b61610714c0a",
"imageURL": "https://im.runware.ai/image/os/a12d13/ws/2/ii/189f150a-9307-41e3-bacd-b61610714c0a.jpg",
"seed": 1101883378,
"cost": 0.09
}Wayfinding Mural Typography Refresh
{
"taskType": "imageInference",
"taskUUID": "828afc8c-87fb-42dd-a5ce-5cf4cdfc702e",
"model": "ideogram:4@3",
"positivePrompt": "Edit only the masked area of the existing atrium wayfinding mural. Replace the outdated text block with refined environmental graphic design that reads exactly: \"NORTH HALL\", \"Studios 1-4\", \"Workshops\", \"Ticket Desk\". Add simple geometric arrow icons and a clean visual hierarchy, aligned to the wall perspective. Preserve the surrounding painted mural, wall texture, lighting, shadows, floor reflections, and architectural details unchanged. Sophisticated civic interior branding, highly legible typography, polished color palette of cobalt, cream, and terracotta, realistic integration.",
"providerSettings": {
"ideogram": {
"renderingSpeed": "QUALITY",
"magicPrompt": "OFF",
"styleType": "DESIGN",
"stylePreset": "BAUHAUS"
}
},
"inputs": {
"seedImage": "https://assets.runware.ai/assets/inputs/8de2e5e8-dd50-46dc-a5e3-4a8a33e429f0.jpg",
"maskImage": "https://assets.runware.ai/assets/inputs/63a93508-6e34-41ce-82a8-d387c3360b6e.jpg"
}
}{
"taskType": "imageInference",
"taskUUID": "828afc8c-87fb-42dd-a5ce-5cf4cdfc702e",
"imageUUID": "8e3de1f7-076c-4738-b119-77e1a7fb7d40",
"imageURL": "https://im.runware.ai/image/os/a13d12/ws/2/ii/8e3de1f7-076c-4738-b119-77e1a7fb7d40.jpg",
"seed": 1719207258,
"cost": 0.09
}Aquarium Kiosk Menu Revision
{
"taskType": "imageInference",
"taskUUID": "f1686893-e02a-4c87-9c9d-a1e5bceb700a",
"model": "ideogram:4@3",
"positivePrompt": "Edit only the masked hanging menu board area. Replace the cluttered old board with a refined contemporary café menu design that fits the aquarium interior. Use crisp legible typography, balanced spacing, soft sea-glass color accents, and realistic printed sign materials. Include the text: 'Drift Cafe' at the top, then sections 'COFFEE', 'SPARKLING', and 'BAKERY'. Under COFFEE: 'Espresso 4', 'Flat White 5', 'Cold Brew 5'. Under SPARKLING: 'Citrus Tonic 6', 'Ginger Lime 6'. Under BAKERY: 'Miso Biscuit 4', 'Pear Tart 5'. Keep perspective, lighting, shadows, and mounting consistent with the original scene. Preserve everything outside the mask unchanged.",
"providerSettings": {
"ideogram": {
"renderingSpeed": "QUALITY",
"magicPrompt": "OFF",
"styleType": "DESIGN",
"stylePreset": "MAGAZINE_EDITORIAL"
}
},
"inputs": {
"seedImage": "https://assets.runware.ai/assets/inputs/a68c7d4b-3570-4ed8-8ecd-b545479cf8e2.jpg",
"maskImage": "https://assets.runware.ai/assets/inputs/295882c1-7cc2-4720-be9b-b4e309aec1de.jpg"
}
}{
"taskType": "imageInference",
"taskUUID": "f1686893-e02a-4c87-9c9d-a1e5bceb700a",
"imageUUID": "f54f5c3f-5b63-4ef0-b745-503c0a8b83b2",
"imageURL": "https://im.runware.ai/image/os/a13d12/ws/2/ii/f54f5c3f-5b63-4ef0-b745-503c0a8b83b2.jpg",
"seed": 910758514,
"cost": 0.09
}