Hunyuan Image 2.1 API Documentation
Playground
Try it on WaveSpeedAI!HunyuanImage-2.1 is an efficient diffusion text-to-image model producing high-resolution 2K images with detailed, photorealistic results. Ready-to-use REST inference API, best performance, no coldstarts, affordable pricing.
Features
Hunyuan Image 2.1 is a state-of-the-art text-to-image generation model from Tencent that transforms written descriptions into stunning, high-quality visuals. With flexible resolution control and multiple output formats, it delivers exceptional detail, composition, and artistic quality.
Why It Stands Out
- High-quality generation: Produces sharp, detailed images with excellent composition and visual appeal.
- Prompt Enhancer: Built-in AI-powered prompt optimization helps craft better descriptions for improved results.
- Flexible resolution: Customize width and height independently for any aspect ratio.
- Multiple output formats: Export as JPEG, PNG, or WebP based on your needs.
- Reproducibility: Use the seed parameter to recreate exact results or explore variations.
Parameters
| Parameter | Required | Description |
|---|---|---|
| prompt | Yes | Text description of the image you want to generate. |
| width | No | Output width in pixels (default: 1024). |
| height | No | Output height in pixels (default: 1024). |
| seed | No | Set for reproducibility; -1 for random. |
| output_format | No | Output format: jpeg, png, or webp (default: jpeg). |
How to Use
- Write a prompt describing the image you want. Use the Prompt Enhancer for AI-assisted optimization.
- Set dimensions — adjust width and height for your desired aspect ratio.
- Choose output format — select JPEG, PNG, or WebP.
- Set a seed (optional) for reproducible results.
- Click Run and download your image.
Best Use Cases
- Creative Art & Illustration — Generate unique artwork, concept art, and digital illustrations.
- Marketing & Social Media — Produce eye-catching visuals for campaigns and posts.
- Product Visualization — Create product mockups and lifestyle imagery.
- Poster & Print Design — Generate high-resolution artwork for posters, banners, and print materials.
- Design Prototyping — Quickly visualize ideas before committing to full production.
Pricing
| Output | Price |
|---|---|
| Per image | $0.025 |
Pro Tips for Best Quality
- Be descriptive in your prompt — include style, mood, lighting, composition, and specific details.
- Use style keywords like “cinematic,” “photorealistic,” “oil painting,” or “anime” to guide the aesthetic.
- Adjust aspect ratio to match your use case — vertical for posters, horizontal for banners, square for social media.
- Fix the seed when iterating to compare the effect of different prompt variations.
- Use PNG format for images requiring transparency or maximum quality.
Notes
- Processing time varies based on resolution and current queue load.
- Please ensure your prompts comply with content guidelines.
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",
"size": "1024*1024",
"output_format": "jpeg"
}
JSON
)
# 1. Submit the prediction.
SUBMIT_RESPONSE=$(curl --silent --show-error --fail-with-body \
-X POST "https://api.wavespeed.ai/api/v3/wavespeed-ai/hunyuan-image-2.1" \
-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="https://api.wavespeed.ai/api/v3/predictions/${PREDICTION_ID}/result"
# 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|deleted) printf '%s\n' "${RESULT}" | jq . >&2; exit 1 ;;
*) sleep 2 ;;
esac
doneParameters
Task Submission Parameters
Request Parameters
| Parameter | Type | Required | Default | Range | Description |
|---|---|---|---|---|---|
| prompt | string | Yes | - | The positive prompt for the generation. | |
| size | string | No | 1024*1024 | - | The size of the generated media in pixels (width*height). |
| seed | integer | No | - | - | The random seed to use for the generation. -1 means a random seed will be used. |
| output_format | string | No | jpeg | jpeg, png, webp | The format of the output image. |
| enable_sync_mode | boolean | No | false | - | If set to `true`, the request attempts to wait for the generated result and return outputs in the same response. If the result is not ready within the sync wait window, the API can return a timeout body while the task continues processing. This option is only available via the API and is supported only by some models. |
| enable_base64_output | boolean | No | false | - | If set to `true`, the prediction's `output` strings are returned as **naked base64** (no `data:<mime>;base64,` prefix). When `false` (default), outputs are returned as URLs pointing to our CDN. |
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 |