Ideogram AI Ideogram V4.6 API Documentation
Playground
Try it on WaveSpeedAI!Ideogram V4.6 Text-to-Image generates images from written prompts with output up to 4K and optional transparent backgrounds for posters, packaging concepts, logos and other design work. Available through the WaveSpeed REST API.
Features
Ideogram V4.6 generates images from text, with output up to 4K and an optional transparent background. It is well suited to posters, packaging, advertising, logos, brand assets and any design where readable text matters.
Why Choose This?
- Typography-focused generation — Create concepts for headlines, labels, signs and packaging text.
- Native 4K — Choose
1k,2kor4k(4096 px on the long side). - Transparent background — Set
backgroundtotransparentfor a PNG with an alpha channel, ready for logos and stickers. - Color guidance — Describe a palette or include color values in the prompt.
- Four quality tiers —
very_low,low,mediumorhigh.
Parameters
| Parameter | Required | Description |
|---|---|---|
| prompt | Yes | Text description of the image to generate (1–10000 characters). |
| resolution | No | 1k, 2k or 4k. Default: 1k. |
| aspect_ratio | No | 1:1, 4:3, 3:4, 3:2, 2:3, 16:9 or 9:16. Default: 1:1. |
| quality | No | very_low, low, medium or high. Default: medium. very_low is available up to 2k. |
| background | No | opaque or transparent. Default: opaque. |
Pricing
| Quality | 1k / 2k | 4k |
|---|---|---|
| very_low | $0.008 | — |
| low | $0.03 | $0.06 |
| medium | $0.06 | $0.12 |
| high | $0.10 | $0.20 |
A default request (1k, medium) costs $0.06 per image. aspect_ratio and background do not change the price.
Best Use Cases
- Posters and advertising — Campaign visuals where the headline and hierarchy matter.
- Logos and stickers — Explore designs with transparent backgrounds.
- Packaging concepts — Product design concepts with typography and a specified color palette.
- Large-format output — Native 4K for print and hero images.
Pro Tips
- Put the exact text to render inside quotation marks.
- Name the desired colors or include hex values, then review the generated colors.
- Explore with
very_loworlow, then render the final athighor4k.
Notes
very_lowquality supports1kand2k; chooselow,mediumorhighfor4k.- Transparent output is provided as PNG. Use a viewer that supports transparency when checking the background.
- Review spelling, layout, colors and fine details before using the result, especially for text-heavy or branded designs.
Related Models
- Ideogram V4.6 Edit — Edit existing images with prompts, references and masks.
- Ideogram V4.5 — 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'
{
"prompt": "A cinematic ocean wave at sunrise, highly detailed",
"resolution": "1k",
"aspect_ratio": "1:1",
"quality": "medium",
"background": "opaque",
"enable_prompt_expansion": false
}
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" \
-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 |
|---|---|---|---|---|---|
| prompt | string | Yes | 1 ~ 10000 characters | Describe the subject, composition, and text to generate. | |
| resolution | string | No | 1k | 1k, 2k, 4k | Output size tier: 1k, 2k or native 4k (4096 px on the long side). |
| aspect_ratio | string | No | 1:1 | 1:1, 4:3, 3:4, 3:2, 2:3, 16:9, 9:16 | The aspect ratio of the generated image. Defaults to 1:1. |
| quality | string | No | medium | very_low, low, medium, high | Quality and price tier. very_low is available up to 2k. |
| background | string | No | opaque | opaque, transparent | Transparent returns a PNG with an alpha channel. |
| enable_prompt_expansion | boolean | No | false | - | - |
Conditional constraints
- 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 |