X AI Grok Imagine Image V2.0 Edit API Documentation

X AI Grok Imagine Image V2.0 Edit API Documentation

Playground

xAI Grok Imagine Image V2.0 Edit transforms input images with text prompts, with configurable resolution and quality for precise image editing, visual refinements, creative variations, social content, marketing assets, and production workflows. Ready-to-use REST inference API, best performance, no coldstarts, affordable pricing.

Features

Grok Imagine Image V2.0 Edit transforms a source image with natural-language instructions. It is designed for prompt-guided image editing with configurable resolution and quality, making it suitable for creative iteration, visual refinement, and marketing asset updates.

Parameters

How to Use

1. Upload one source image in the images array (at most one).
2. Write a clear edit prompt describing what should change.
3. Choose the output resolution and quality tier.
4. Submit the request and retrieve the edited image URL.

Pricing

$0.06 per edit, regardless of the selected resolution and quality.

Billing Rules

• Each request accepts exactly one input image.
• The listed price already includes the input-image fee.

Best Use Cases

• Prompt-guided image editing — Transform an existing image with simple natural-language instructions.
• Style and visual changes — Adjust mood, color, composition, or overall style.
• Product and marketing updates — Refine product shots, campaign assets, and promotional visuals.
• Creative iteration — Explore multiple edit directions from the same source image.

Related Models

• Grok Imagine Image V2.0 Text-to-Image — Generate images from natural-language prompts.
• Grok Imagine Image V2.0 Edit — Edit images with text instructions.

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'
{
  "images": [
    "https://interactive-examples.mdn.mozilla.net/media/cc0-images/painted-hand-298-332.jpg"
  ],
  "prompt": "A cinematic ocean wave at sunrise, highly detailed",
  "resolution": "2k",
  "quality": "medium"
}
JSON
)

# 1. Submit the prediction.
SUBMIT_RESPONSE=$(curl --silent --show-error --fail-with-body \
  -X POST "https://api.wavespeed.ai/api/v3/x-ai/grok-imagine-image-v2.0/edit" \
  -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