Hidream E1 Full API Documentation

Hidream E1 Full API Documentation

Playground

HiDream-E1 Full is an image editing model built on HiDream-I1 that delivers high-quality, content-aware edits and refinements. Ready-to-use REST inference API, best performance, no coldstarts, affordable pricing.

Features

HiDream E1 Full is a prompt-based image editing model for high-quality, identity-preserving edits from a single input image. Upload an image, describe the change you want (e.g., wardrobe, accessories, color tweaks, minor scene adjustments), and the model applies the edit while keeping the subject and overall composition stable. It’s ideal for practical photo edits and fast creative variations without rebuilding the entire image.

Key capabilities

• Single-image, prompt-driven editing with strong subject preservation
• Reliable for wardrobe and accessory changes (clothes, glasses, hats, etc.)
• Maintains composition and lighting consistency for natural-looking results
• Seed control for reproducible variations
• Supports URL output or BASE64 output (API only)

Use cases

• Outfit edits for portraits (change sweater color/style, add/remove accessories)
• E-commerce variations (multiple product colorways or styling options)
• Quick retouch-like changes (minor background tweaks, prop swaps)
• Marketing creatives: generate multiple variants from one hero photo
• Rapid iteration: try different looks by changing prompt or seed

Pricing

Inputs

• image (required): source image to edit
• prompt (required): edit instruction (what to change)

Parameters

• prompt: what to change (be explicit about what to keep)
• image: input image (upload or URL)
• seed: random seed (-1 for random; fixed for reproducible results)
• output_format: output format (e.g., jpeg)
• enable_base64_output: return BASE64 instead of URL (API only)

Prompting guide

For clean results, specify both the change and the constraints:

Template: Keep the same person, pose, and background. Change [target edit]. Keep lighting natural and consistent.

Example prompts

• Keep the same person and pose. Change the outfit to a light gray sweater and add gold thin-rimmed glasses. Keep the background and lighting unchanged.
• Keep identity and composition. Replace the jacket with a black leather jacket, keep realistic fabric texture and natural shadows.
• Keep the subject unchanged. Remove the object on the table and keep the scene lighting consistent.

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",
  "image": "https://interactive-examples.mdn.mozilla.net/media/cc0-images/painted-hand-298-332.jpg",
  "output_format": "jpeg"
}
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/wavespeed-ai/hidream-e1-full" \
  -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
done

Parameters

Task Submission Parameters

Request Parameters

Every model also accepts the global request options enable_sync_mode and enable_base64_output; see their pages for details.

Response Parameters

Result Request Parameters

Result Response Parameters