ideogram-ai/ideogram-v2/edit

Name: Ideogram V2 Edit
Author: Ideogram

Ideogram V2 Edit by ideogram-ai - AI-powered image editing, style transfer, and transformation. Edit photos with natural language instructions, remove backgrounds, change styles, and enhance images effortlessly.

Input

Prompt(string)

The prompt to fill the masked part of the image.

Image URL or upload(string)

Upload

PNG, JPEG, WebP, or GIF · 20 MiB maximum

The image URL to generate an image from. Needs to match the dimensions of the mask.

This field is required.

Image URL or upload(string)

Upload

PNG, JPEG, WebP, or GIF · 20 MiB maximum

The mask URL to inpaint the image. Needs to match the dimensions of the input image.

Style(string)

The style of the generated image Allowed values: auto, general, realistic, design, render_3D, anime.

Seed(integer)

Seed for the random number generator

Idle

Example output — click Run to generate your own

Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/run

Model IDideogram-ai/ideogram-v2/edit

Input Schema

5 parameters · 2 required · 3 optional

Parameter	Type	Required	Description
`image`	string	Required	The image URL to generate an image from. Needs to match the dimensions of the mask.
`prompt`	string	Required	The prompt to fill the masked part of the image.
`mask`	string	Optional	The mask URL to inpaint the image. Needs to match the dimensions of the input image.
`seed`	integer	Optional	Seed for the random number generator
`style`	string	Optional	The style of the generated image · Options: auto, general, realistic, design, render_3D, anime · Default: "auto" autogeneralrealisticdesignrender_3Danime

Output Schema

Field	Type	Description
`id`	string	Unique identifier for the generation task
`status`	string	Task status: pending, running, completed, failed, timeout
`model`	string	Model used for the generation
`outputs`	array	Array of output items
`outputs[].url`	string	URL of the generated artifact
`outputs[].content_type`	string	MIME type (e.g. image/png, video/mp4)
`error`	object \| null	Error details if failed, null on success
`error.type`	string	Machine-readable error type code
`error.message`	string	Human-readable error description

Async Workflow

This model uses asynchronous execution. Submit a request and poll for the result.

Submit — POST to /v1/run, receive an id
Poll — GET /v1/run/{id} until status is completed, failed, or timeout
Retrieve — Read outputs from the completed response

Code Examples

Ready-to-run snippets

# Step 1: Submit
curl -X POST https://api.sandbase.ai/v1/run \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "model": "ideogram-ai/ideogram-v2/edit",
  "mask": "https://static.sandbase.ai/examples/ideogram-ai/ideogram-v2/edit/input_mask_1.jpeg",
  "image": "https://static.sandbase.ai/examples/ideogram-ai/ideogram-v2/edit/input_image_0.jpeg",
  "style": "auto",
  "prompt": "A knight in shining armour holding a greatshield with \"FAL\" on it"
}'

# Step 2: Poll result (replace <id>)
curl https://api.sandbase.ai/v1/run/<id> \
  -H "Authorization: Bearer YOUR_API_KEY"

← Back to Ideogram V2 Edit

API README

Ideogram V2 Edit

ideogram-ai/ideogram-v2/edit applies natural-language edits to a supplied image while preserving requested subjects, typography, and unaffected composition. Ideogram's editing workflow combines scene understanding with its typography and design strengths, making it useful for meaningful creative changes rather than only basic retouching. This combination makes the model a practical choice when the creative outcome depends on those qualities rather than on a generic media conversion.

For production work with ideogram-ai/ideogram-v2/edit, it suits copy updates, object changes, restyling, background revision, and campaign variations where the source artwork must remain the foundation. The result is most reliable when the source material and creative brief clearly describe the intended subject, progression, visual or sonic character, and the qualities that must remain unchanged.

Highlights

Masked semantic editing. Reconstructs a selected region from written direction while leaving the rest of the source image intact.

Typography-aware repair. Rewrites or repairs designed text inside the edited area with Ideogram's lettering strength.

Context-matched reconstruction. Blends new objects, textures, lighting, and edges naturally with the surrounding image.

Style-consistent revision. Applies realistic, illustrative, or design-oriented changes without losing the source artwork's visual language.

Pricing

Billing unit	Price
Per request	$0.08

When to Use

✅ Good fit	❌ Consider alternatives
The model's named workflow matches the source material and intended output	A different input modality or model route is required
A managed asynchronous result is suitable for the production pipeline	A synchronous, interactive editor is essential
The documented controls cover the required duration, framing, or format	The project needs controls outside this endpoint's schema
Creative iteration benefits from a repeatable request structure	Exact deterministic pixels, frames, geometry, or samples are mandatory
A finished downloadable media asset is the desired deliverable	Editable source layers or a native project file are required

Prompt Guide

For image-conditioned generation, state the intended result first, then add the subject or source treatment, progression, style, and delivery constraints. Keep one creative variable per phrase, use the documented field names for controls, and change one setting at a time when comparing results.

{
  "image": "https://static.sandbase.ai/examples/ideogram-ai/ideogram-v2/edit/input_image_0.jpeg",
  "prompt": "A knight in shining armour holding a greatshield with \"FAL\" on it"
}

Technical Specs

Spec	Value
Model ID	`ideogram-ai/ideogram-v2/edit`
Inputs	image, mask, prompt, seed, style
Required inputs	prompt, image
Output fields	content_type, url
Execution	Async (submit, then poll for result)