Flux Dev API Documentation
Playground
Try it on WaveSpeedAI!FLUX.1 [dev] is a 12-billion-parameter rectified-flow transformer for text-to-image generation. Ready-to-use REST inference API, best performance, no coldstarts, affordable pricing.
Features
Generate high-quality images with FLUX.1 [dev], a versatile and powerful image generation model. Whether you need text-to-image creation, image-to-image transformation, or precise inpainting — this model delivers stunning results with exceptional detail and prompt adherence.
Why It Stands Out
- Multi-mode generation: Supports text-to-image, image-to-image, and inpainting workflows in one model.
- High resolution output: Generate images up to 1024×1024 with sharp detail and clarity.
- Prompt Enhancer: Built-in AI-powered prompt optimization for better results.
- Flexible aspect ratios: Customize width and height independently for any format.
- Batch generation: Create multiple images in a single request.
- Reproducibility: Use the seed parameter to recreate exact results or explore variations.
- Multiple output formats: Export as JPEG or PNG based on your needs.
Pricing
| Output | Price |
|---|---|
| Per image | $0.012 |
Total cost = $0.012 × num_images
Parameters
| Parameter | Required | Description |
|---|---|---|
| prompt | Yes | Text description of the image you want to generate. |
| image | No | Source image for image-to-image or inpainting mode. |
| mask_image | No | Mask image for inpainting (white areas will be regenerated). |
| strength | No | How much to transform the source image (0.0–1.0, default: 0.8). |
| width | No | Output width in pixels (default: 1024). |
| height | No | Output height in pixels (default: 1024). |
| num_inference_steps | No | Quality/speed trade-off (default: 28). |
| seed | No | Set for reproducibility; -1 for random. |
| guidance_scale | No | Prompt adherence strength (default: 3.5). |
| num_images | No | Number of images to generate (default: 1). |
| output_format | No | Output format: jpeg or png (default: jpeg). |
| enable_base64_output | No | Return base64 string instead of URL (API only). |
| enable_sync_mode | No | Wait for result before returning response (API only). |
How to Use
Text-to-Image:
- Write a prompt describing the image you want. Use the Prompt Enhancer for AI-assisted optimization.
- Set width and height for your desired aspect ratio.
- Adjust guidance_scale and num_inference_steps as needed.
- Click Run and download your image.
Image-to-Image:
- Upload a source image.
- Write a prompt describing the transformation you want.
- Adjust the strength parameter — higher values allow more dramatic changes.
- Click Run and download your image.
Inpainting:
- Upload a source image and a mask image.
- White areas in the mask will be regenerated based on your prompt.
- Write a prompt describing what should appear in the masked region.
- Click Run and download your image.
Best Use Cases
- Creative Art & Illustration — Generate unique artwork, concept art, and digital illustrations.
- Product Visualization — Create product mockups and lifestyle imagery.
- Marketing & Social Media — Produce eye-catching visuals for campaigns and posts.
- Photo Editing & Enhancement — Transform or repair images with inpainting.
- Design Prototyping — Quickly visualize ideas before committing to full production.
Pro Tips for Best Quality
- Be descriptive in your prompt — include style, mood, lighting, composition, and specific details.
- For image-to-image, use lower strength (0.3–0.5) to preserve more of the original, higher (0.7–0.9) for dramatic changes.
- Use inpainting with precise masks for seamless object removal or replacement.
- Fix the seed when iterating to compare the effect of different parameters.
- Generate multiple images (num_images > 1) to explore variations quickly.
Notes
- If using image URLs, ensure they are publicly accessible.
- 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",
"strength": 0.8,
"size": "1024*1024",
"num_inference_steps": 28,
"guidance_scale": 3.5,
"num_images": 1,
"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/flux-dev" \
-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
doneRetry temporary errors only while polling, never the submit request. Errors, retries and timeouts
Parameters
Task Submission Parameters
Request Parameters
| Parameter | Type | Required | Default | Range | Description |
|---|---|---|---|---|---|
| prompt | string | Yes | - | The positive prompt for the generation. | |
| image | string | No | - | The image to generate an image from. | |
| mask_image | string | No | - | The mask image tells the model where to generate new pixels (white) and where to preserve the original image (black). It acts as a stencil or guide for targeted image editing. | |
| strength | number | No | 0.8 | 0 ~ 1 | Strength indicates extent to transform the reference image. |
| size | string | No | 1024*1024 | 256 ~ 1536 | The size of the generated media in pixels (width*height). |
| num_inference_steps | integer | No | 28 | 1 ~ 50 | The number of inference steps to perform. |
| seed | integer | No | - | - | The random seed to use for the generation. -1 means a random seed will be used. |
| guidance_scale | number | No | 3.5 | 1 ~ 20 | The guidance scale to use for the generation. |
| num_images | integer | No | 1 | 1 ~ 4 | The number of images to generate. |
| output_format | string | No | jpeg | jpeg, png, webp | The format of the output image. |
Every model also accepts the global request options enable_sync_mode and enable_base64_output; see their pages for details.
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 |