maskstring
The mask URL to inpaint the image. MUST have the exact same dimensions (width and height) as the input image.
Ideogram 3.0 Edit
ideogram-ai/ideogram-v3/editIdeogram V3 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.
Try the model
Playground
Input
The prompt to fill the masked part of the image.
PNG, JPEG, WebP, or GIF · 20 MiB maximum
The image URL to generate an image from. MUST have the exact same dimensions (width and height) as the mask image.
This field is required.
Additional Settings More
Customize your input with more control.
PNG, JPEG, WebP, or GIF · 20 MiB maximum each
A set of images to use as style references (maximum total size 10MB across all style references). The images should be in JPEG, PNG or WebP format
PNG, JPEG, WebP, or GIF · 20 MiB maximum
The mask URL to inpaint the image. MUST have the exact same dimensions (width and height) as the input image.
The rendering speed to use. Allowed values: TURBO, BALANCED, QUALITY.
Seed for the random number generator
ResultExample
What would you like to do next?
Examples
Select an example to load its inputs and result into the playground.
- Open result ↗
Input
{ "image": "https://static.sandbase.ai/examples/fef92fd9-0a39-4571-841d-06952aa5e9c6/input/e6ec02d2-e595-4933-8819-321bf1c82b1a.png", "prompt": "black bag" }
Ideogram 3.0 Edit
Ideogram 3.0 edit: inpaint a masked region of an image from a prompt.
Fields
| Field | Type | Default | Notes |
|---|---|---|---|
prompt | string, required | — | Text instruction. |
image | image URL, required | — | Image to edit. JPEG, PNG, or WebP URL. |
images | image URL[] | — | Optional style references. |
mask | image URL | — | Area to edit. |
rendering_speed | TURBO / BALANCED / QUALITY | BALANCED | Sets the per-image rate. |
seed | integer | random | Fix it to compare prompt changes. |
Billing
Per image: $0.03 Turbo, $0.06 Balanced, $0.09 Quality.
| Speed | Price |
|---|---|
| TURBO | $0.03 |
| BALANCED | $0.06 |
| QUALITY | $0.09 |
Failed runs are not charged.
Prompting
- Quote all text that must appear.
Also on SandBase
Related: ideogram/4.5 (newer).
Start building
Send your first request
Submit this model through the SandBase Unified Run API.
# The quoted heredoc keeps Unicode and shell metacharacters unchanged.
result=$(curl --fail-with-body --silent \
-X POST "https://api.sandbase.ai/v1/run" \
-H "Authorization: Bearer $SANDBASE_API_KEY" \
-H "Content-Type: application/json" \
--data-binary @- <<'SANDBASE_JSON'
{
"model": "ideogram-ai/ideogram-v3/edit",
"mask": "https://static.sandbase.ai/examples/ideogram-ai/ideogram-v3/edit/input_mask_1.png",
"image": "https://static.sandbase.ai/examples/ideogram-ai/ideogram-v3/edit/output_url_0.png",
"prompt": "black bag",
"rendering_speed": "BALANCED"
}
SANDBASE_JSON
)
run_id=$(printf '%s' "$result" | jq -r .id)
for attempt in $(seq 1 120); do
status=$(printf '%s' "$result" | jq -r .status)
case "$status" in completed|failed|timeout) break ;; esac
sleep 2
result=$(curl --fail-with-body --silent \
-H "Authorization: Bearer $SANDBASE_API_KEY" \
"https://api.sandbase.ai/v1/run/$run_id")
done
status=$(printf '%s' "$result" | jq -r .status)
[ "$status" = completed ] || { echo "Generation ended: $status" >&2; exit 1; }
printf '%s\n' "$result"2. Authentication
Create a SandBase API key and set it in your server environment. All requests use Bearer authentication.
export SANDBASE_API_KEY="YOUR_API_KEY"Keep the key on your server. Do not expose it in browser code or commit it to a repository.
3. Queue
Submit a request
POST to /v1/run with this model ID and its inputs. The request example above includes submission and polling.
Fetch request status and result
Use the returned run ID to poll until the status is completed, failed or timeout. Read output only after completed.
curl "https://api.sandbase.ai/v1/run/$RUN_ID" \
-H "Authorization: Bearer $SANDBASE_API_KEY"4. Files
Hosted files
Pass a publicly accessible file URL in the model’s image, video or audio field. Supported formats and limits are shown beside each Playground input.
Uploading images
Use the upload or replace control on supported image fields in the Playground. Video URL fields accept a hosted driving video; they do not imply video-upload support.
5. Schema
Input
seedinteger
Seed for the random number generator
imagestringrequired
The image URL to generate an image from. MUST have the exact same dimensions (width and height) as the mask image.
imagesarray
A set of images to use as style references (maximum total size 10MB across all style references). The images should be in JPEG, PNG or WebP format
promptstringrequired
The prompt to fill the masked part of the image.
rendering_speedstring
The rendering speed to use.
Default: "BALANCED"
Possible values: "TURBO", "BALANCED", "QUALITY"
{
"model": "ideogram-ai/ideogram-v3/edit",
"mask": "https://static.sandbase.ai/examples/ideogram-ai/ideogram-v3/edit/input_mask_1.png",
"image": "https://static.sandbase.ai/examples/ideogram-ai/ideogram-v3/edit/output_url_0.png",
"prompt": "black bag",
"rendering_speed": "BALANCED"
}Output
A completed run exposes its result in output. The following is the model’s saved example, not a new generation.
[
{
"source": "Ideogram schema mirror",
"source_url": "https://developer.ideogram.ai/",
"url": "https://static.sandbase.ai/examples/fef92fd9-0a39-4571-841d-06952aa5e9c6/output/5ffb7ae6-c5f7-4ea5-8883-ec92c71a6572.png"
}
]