Joyai Image Edit API Documentation

Joyai Image Edit API Documentation

Playground

JoyAI Image Edit transforms images based on text instructions, allowing you to modify backgrounds, adjust colors, add or remove elements, and more. Ready-to-use REST inference API, best performance, no cold starts, affordable pricing.

Features

JoyAI Image Edit transforms any photo with natural language instructions. Describe the change you want — alter styles, shift environments, add fantastical elements, change lighting or atmosphere — and the model applies a rich, imaginative edit while preserving the core structure of your original image.

Why Choose This?

• Creative, imagination-driven edits Goes beyond simple adjustments — transforms scenes, applies artistic styles, and reimagines environments with vivid, detailed results.

• Natural-language control Describe the transformation in plain text. The more descriptive your prompt, the richer the output.

• Preserves original structure Maintains the core composition, subject placement, and spatial layout of your source image while applying the requested transformation.

• Prompt Enhancer Built-in tool to automatically improve your edit descriptions for richer, more imaginative results.

Parameters

How to Use

1. Upload your image — provide the source photo via URL or drag-and-drop.
2. Write your prompt — describe the transformation you want in vivid detail. Use the Prompt Enhancer for richer results.
3. Submit — download your transformed image.

Pricing

Just $0.30 per image.

Best Use Cases

• Fantasy & world-building — Transform real environments into magical, surreal, or sci-fi scenes.
• Style transfer — Reimagine photos in watercolor, oil painting, neon, or any artistic style.
• Seasonal & atmospheric changes — Shift environments between seasons, times of day, or weather conditions.
• Creative content — Generate visually striking images for social media, storytelling, and artistic projects.
• Concept visualization — Quickly explore visual directions and alternative treatments of a scene.

Pro Tips

• The more descriptive your prompt, the richer the transformation — include specific colors, textures, lighting, and visual elements you want to see.
• Describe both what should change and what the overall mood or atmosphere should feel like.
• Use the Prompt Enhancer to expand a simple idea into a detailed, evocative edit instruction.

Notes

• Both prompt and image are required fields.
• Ensure image URLs are publicly accessible if using a link rather than a direct upload.
• Please ensure your content complies with WaveSpeed AI’s usage policies.

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"
}
JSON
)

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