Ideogram AI Ideogram V4.6 Edit API Documentation
Playground
Try it on WaveSpeedAI!Ideogram V4.6 Image Edit supports written editing instructions, reference images, optional masks and precision controls for product visuals, recoloring and creative variations. Available through the WaveSpeed REST API.
Features
Ideogram V4.6 Edit changes an existing image from a written instruction, with optional reference images and a mask. Use it to explore product variations, recoloring and campaign visuals.
Why Choose This?
- Prompt-based editing — Change objects, colors, materials, text and layout with natural language.
- Reference images — Up to four supporting images guide subjects, products or style.
- Masked edits — Use a mask to guide a local edit.
- High precision — Use
edit_precision=highfor focused edits. See Notes for output-size behavior. - Resolution options — Choose
1k,2kor4k; output dimensions depend on the editing mode.
Parameters
| Parameter | Required | Description |
|---|---|---|
| image | Yes | Public URL of the source image. |
| prompt | Yes | The edit to make (1–10000 characters). |
| reference_images | No | Up to 4 guidance images, or 3 with mask_url. |
| mask_url | No | Optional mask for a local edit. Use the same dimensions as the source image. |
| aspect_ratio | No | 1:1, 4:3, 3:4, 3:2, 2:3, 16:9 or 9:16. For regular edits without a mask, omit it to follow the source aspect ratio. Ignored with a mask or high precision. |
| resolution | No | 1k, 2k or 4k. Default: 1k. For mask-based or high-precision edits, see Notes. |
| edit_precision | No | regular or high. Default: regular. |
| quality | No | very_low, low, medium or high. Default: medium. very_low is available up to 2k. |
Pricing
| Quality | 1k / 2k | 4k |
|---|---|---|
| very_low | $0.008 | — |
| low | $0.03 | $0.06 |
| medium | $0.06 | $0.20 |
| high | $0.22 | $0.60 |
A default edit (1k, medium) costs $0.06 per image. Billing follows the selected quality and resolution tiers. Reference images, the mask and edit_precision do not add a separate fee.
Best Use Cases
- Product variations — New colors, materials and finishes on the same product.
- Brand recoloring — Explore campaign color palettes.
- Selective fixes — Repair or replace one area with a mask.
- Character variations — Use reference images to guide character appearance in new scenes.
Pro Tips
- Say what should change and what must stay the same.
- Use a mask or
edit_precision=highfor focused edits, then review the result for unintended changes. - Keep reference images closely related to the change you want.
Notes
very_lowquality supports1kand2k; chooselow,mediumorhighfor4k.- Supply up to four reference images without a mask, or up to three when using
mask_url. The source image is separate from these references. - With
mask_urloredit_precision=high, output dimensions follow the source rather thanaspect_ratio. Larger images may be resized; selecting4kdoes not enlarge a smaller source to 4K. The selected quality and resolution tiers still determine the price. - For very wide or tall source images, select a listed
aspect_ratiowhen using regular editing without a mask. - Review generated text, colors, subject details and areas outside the intended edit before using the result.
Related Models
- Ideogram V4.6 — Generate images from text, up to native 4K.
- Ideogram V4.5 Edit — The previous version.
Authentication
For authentication details, please refer to the Authentication Guide.
API Endpoints
Submit Task & Query Result
set -euo pipefail
export WAVESPEED_API_KEY="your-api-key"
REQUEST_BODY=$(cat <<'JSON'
{
"image": "https://interactive-examples.mdn.mozilla.net/media/cc0-images/painted-hand-298-332.jpg",
"prompt": "A cinematic ocean wave at sunrise, highly detailed",
"aspect_ratio": "1:1",
"resolution": "1k",
"edit_precision": "regular",
"quality": "medium"
}
JSON
)
# 1. Submit the prediction once. Never retry this request automatically:
# a retry after an unclear failure can create a second, billed task.
CHECK='The task may already exist. Check History or the predictions list before submitting again.'
if ! SUBMIT_RESPONSE=$(curl --silent --show-error --fail-with-body \
--connect-timeout 10 --max-time 60 \
-X POST "https://api.wavespeed.ai/api/v3/ideogram-ai/ideogram-v4.6/edit" \
-H "Authorization: Bearer ${WAVESPEED_API_KEY}" \
-H "Content-Type: application/json" \
-d "${REQUEST_BODY}"); then
printf 'Submit failed. %s\n' "${CHECK}" >&2
exit 1
fi
TASK=$(printf '%s' "${SUBMIT_RESPONSE}" | jq 'if type == "object" and has("data") then .data else . end')
PREDICTION_ID=$(printf '%s' "${TASK}" | jq -r '.id // empty')
if [ -z "${PREDICTION_ID}" ]; then
printf 'Submission response did not contain a prediction id. %s\n' "${CHECK}" >&2
exit 1
fi
RESULT_URL="https://api.wavespeed.ai/api/v3/predictions/${PREDICTION_ID}/result"
# 2. Poll until the prediction reaches a final status.
BODY_FILE=$(mktemp)
trap 'rm -f "${BODY_FILE}"' EXIT
while true; do
# Transient errors (429, 5xx) are retried, honoring Retry-After.
HTTP_CODE=$(curl --silent --show-error --fail-with-body \
--connect-timeout 10 --max-time 60 --retry 5 --retry-delay 2 \
--output "${BODY_FILE}" --write-out '%{http_code}' \
"${RESULT_URL}" \
-H "Authorization: Bearer ${WAVESPEED_API_KEY}" || true)
case "${HTTP_CODE}" in
2??) ;;
000|429|5??) # dropped connection or temporary error: keep polling
printf 'Task %s: HTTP %s, polling again in 10s\n' "${PREDICTION_ID}" "${HTTP_CODE}" >&2
sleep 10; continue ;;
*) printf 'Task %s: HTTP %s\n' "${PREDICTION_ID}" "${HTTP_CODE}" >&2
cat "${BODY_FILE}" >&2; exit 1 ;;
esac
RESULT=$(jq 'if type == "object" and has("data") then .data else . end' "${BODY_FILE}")
STATUS=$(printf '%s' "${RESULT}" | jq -r '.status // empty')
case "${STATUS}" in
completed) printf '%s\n' "${RESULT}" | jq '.outputs'; break ;;
failed|cancelled|timeout|deleted)
printf 'Task %s ended with status %s\n' "${PREDICTION_ID}" "${STATUS}" >&2
printf '%s\n' "${RESULT}" | jq . >&2; exit 1 ;;
*) sleep 2 ;;
esac
doneRetry temporary errors only while polling, never the submit request. Errors, retries and timeouts
Parameters
Task Submission Parameters
Request Parameters
| Parameter | Type | Required | Default | Range | Description |
|---|---|---|---|---|---|
| image | string | Yes | 1 ~ unlimited characters | Source image to edit. Supply a publicly accessible image URL. | |
| prompt | string | Yes | 1 ~ 10000 characters | Describe the changes to make to the source image. | |
| reference_images | array<string> | No | - | 0 ~ 4 items · each item: 1 ~ unlimited characters | Optional guidance images. Up to four without a mask, or three when mask_url is supplied. |
| mask_url | string | No | - | 1 ~ unlimited characters | Upload a mask image or provide its URL for a local edit. Use the same dimensions as the source image. |
| aspect_ratio | string | No | - | 1:1, 4:3, 3:4, 3:2, 2:3, 16:9, 9:16 | Output aspect ratio for regular edits without a mask. If omitted, it follows the source aspect ratio. Ignored with mask_url or edit_precision=high. |
| resolution | string | No | 1k | 1k, 2k, 4k | Select a resolution and price tier: 1k, 2k or 4k. With a mask or high precision, dimensions follow the source and larger images may be resized. Selecting 4k does not enlarge a smaller source. |
| edit_precision | string | No | regular | regular, high | Choose regular editing or high precision for focused changes. With high precision, dimensions follow the source and larger images may be resized. |
| quality | string | No | medium | very_low, low, medium, high | Quality and price tier. very_low is available up to 2k. |
Conditional constraints
- Not allowed:
reference_imageshas at least 4 items andmask_urlis provided. - Not allowed:
qualityisvery_lowandresolutionis4k.
Every model also accepts the global request options enable_sync_mode and enable_base64_output; see their pages for details.
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| code | integer | HTTP status code (e.g., 200 for success) |
| message | string | Status message (e.g., “success”) |
| data.id | string | Unique identifier for the prediction, Task Id |
| data.model | string | Model ID used for the prediction |
| data.outputs | array | Output values, usually URL strings; some models return text strings or structured result objects (empty when status is not completed) |
| data.urls | object | Object containing related API endpoints |
| data.status | string | Task status. completed is successful; failed, cancelled, timeout, and deleted are failure terminal statuses. |
| data.created_at | string | ISO timestamp of when the request was created (e.g., “2023-04-01T12:34:56.789Z”) |
| data.error | string | Error message (empty if no error occurred) |
| data.timings | object | Object containing timing details |
| data.timings.inference | integer | Inference time in milliseconds |
Result Request Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string | Yes | - | Task ID |
Result Response Parameters
| Parameter | Type | Description |
|---|---|---|
| code | integer | HTTP status code (e.g., 200 for success) |
| message | string | Status message (e.g., “success”) |
| data | object | The prediction data object containing all details |
| data.id | string | Unique identifier for the prediction |
| data.model | string | Model ID used for the prediction |
| data.outputs | array<string | object> | Array of generated outputs (empty when status is not completed). Items are usually URL strings, but may be text strings or structured result objects, depending on the model. |
| data.urls | object | Object containing related API endpoints |
| data.status | string | Status: completed is successful; failed, cancelled, timeout, and deleted are failure terminal statuses |
| data.created_at | string | ISO timestamp of when the request was created |
| data.error | string | Error message (empty if no error occurred) |
| data.timings | object | Object containing timing details |
| data.timings.inference | integer | Inference time in milliseconds |