Ideogram AI Ideogram V2 API Documentation

Ideogram AI Ideogram V2 API Documentation

Playground

Ideogram v2 is an image model with state-of-the-art inpainting, strong prompt comprehension, and accurate in-image text rendering. Ready-to-use REST inference API, best performance, no coldstarts, affordable pricing.

Features

Ideogram V2 is a powerful text-to-image generation model renowned for its exceptional ability to render text within images. Generate stunning visuals with accurate, readable text — perfect for posters, logos, typography, and designs that require precise text integration.

Why It Stands Out

• Superior text rendering: Industry-leading accuracy for generating readable text within images.
• Multi-mode support: Works as text-to-image, image-to-image, and inpainting generator.
• Prompt Enhancer: Built-in AI-powered prompt optimization for better results.
• Style presets: Choose from various style options or let the model decide with Auto.
• Flexible aspect ratios: Multiple aspect ratio presets for different use cases.
• Inpainting support: Use mask images for precise, targeted image editing.

Parameters

Supported Aspect Ratios

How to Use

Text-to-Image:

1. Write a prompt describing the image you want. Use the Prompt Enhancer for AI-assisted optimization.
2. Select a style preset or use Auto.
3. Choose your desired aspect ratio.
4. Click Run and download your image.

Image-to-Image:

1. Upload a source image.
2. Write a prompt describing the transformation.
3. Adjust style and aspect ratio as needed.
4. Click Run and download your image.

Inpainting:

1. Upload a source image and a mask image.
2. White areas in the mask will be regenerated based on your prompt.
3. Write a prompt describing what should appear in the masked region.
4. Click Run and download your image.

Best Use Cases

• Typography & Posters — Create posters, banners, and designs with accurate, stylized text.
• Logo Design — Generate logo concepts with readable brand names.
• Product Mockups — Create realistic product images with custom text and branding.
• Social Media Graphics — Produce text-heavy visuals for posts and ads.
• Marketing Materials — Create promotional images with integrated messaging.
• Signage & Labels — Generate realistic signs, storefronts, and product labels.

Pricing

Pro Tips for Best Quality

• For text rendering, include the exact text in quotes within your prompt.
• Specify font style if desired (e.g., “bold sans-serif,” “elegant script,” “neon sign”).
• Use the inpainting feature with masks to edit specific areas while preserving the rest.
• Choose an appropriate style preset to match your creative vision.
• Select the right aspect ratio for your intended use.

Notes

• Ensure uploaded image URLs are publicly accessible.
• Processing time varies based on current queue load.
• Please ensure your prompts comply with content guidelines.

Features

https://docs.ideogram.ai/using-ideogram/ideogram-features

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",
  "style": "Auto",
  "aspect_ratio": "1:1"
}
JSON
)

# 1. Submit the prediction.
SUBMIT_RESPONSE=$(curl --silent --show-error --fail-with-body \
  -X POST "https://api.wavespeed.ai/api/v3/ideogram-ai/ideogram-v2" \
  -H "Authorization: Bearer ${WAVESPEED_API_KEY}" \
  -H "Content-Type: application/json" \
  -d "${REQUEST_BODY}")

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
' >&2
  exit 1
fi
RESULT_URL=$(printf '%s' "${TASK}" | jq -r '.urls.get // empty')
if [ -z "${RESULT_URL}" ]; then RESULT_URL="https://api.wavespeed.ai/api/v3/predictions/${PREDICTION_ID}/result"; fi

# 2. Poll until the prediction finishes.
while true; do
  RESPONSE=$(curl --silent --show-error --fail-with-body \
    "${RESULT_URL}" \
    -H "Authorization: Bearer ${WAVESPEED_API_KEY}")
  RESULT=$(printf '%s' "${RESPONSE}" | jq 'if type == "object" and has("data") then .data else . end')
  STATUS=$(printf '%s' "${RESULT}" | jq -r '.status // empty')

  case "${STATUS}" in
    completed) printf '%s\n' "${RESULT}" | jq '.outputs'; break ;;
    failed|cancelled|timeout) printf '%s\n' "${RESULT}" | jq . >&2; exit 1 ;;
    created|processing) sleep 2 ;;
    *) printf 'Unexpected status: %s
' "${STATUS}" >&2; exit 1 ;;
  esac
done

Parameters

Task Submission Parameters

Request Parameters

Response Parameters

Result Request Parameters

Result Response Parameters