Flux 3 Klein Image Distilled Edit API Documentation
Playground
Try it on WaveSpeedAI!FLUX 3 Klein Distilled Image Edit edits and composes images from up to 3 reference images and a text prompt, with 1K or 2K output. Ready-to-use REST inference API, best performance, no coldstarts, affordable pricing.
Features
FLUX 3 Klein Distilled Image Edit runs the fast, production-ready FLUX 3 Klein checkpoint from Black Forest Labs (5.6B open weights). Edit existing images, or combine up to 3 reference images, with a natural-language instruction.
Why Choose This?
-
Reference-guided editing
Pass1to3reference images; the first image sets the output shape unlessaspect_ratiois given. -
Multi-reference composition
Combine subjects and scenes from several images into one result. -
Text rendering
Clear, readable text inside generated images. -
Layout control with bounding boxes
Append a JSON list of boxes on a0to1000grid to place elements; in edits, refer to the n-th reference as<ref_image_n>. -
1K and 2K output
Choose1k(~1 megapixel) or2k(~4 megapixels) at 15 aspect ratios. -
Multiple output formats
Export asjpeg,png, orwebp. -
Seed control
Use a fixed seed to reproduce a result, or-1for random.
Parameters
| Parameter | Required | Description |
|---|---|---|
| prompt | Yes | Text prompt describing the desired edit. |
| images | Yes | Reference image URLs. Supports between 1 and 3 images. |
| resolution | No | Output resolution tier: 1k or 2k. Default: 1k. |
| aspect_ratio | No | Output aspect ratio. Default: follows the first reference image. |
| output_format | No | jpeg, png, or webp. Default: jpeg. |
| seed | No | Random seed. Use -1 for a random seed. |
Pricing
1k: $0.016 with one reference image, plus $0.005 for each additional reference image.2k: $0.064 with one reference image, plus $0.010 for each additional reference image.
How to Use
- Write a prompt — Describe the subject, composition, background, lighting, and style in full sentences.
- Add reference images — Provide
1to3image URLs inimages. - Choose resolution and aspect ratio (optional).
- Submit — Retrieve the finished image from the result.
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",
"images": [
"https://interactive-examples.mdn.mozilla.net/media/cc0-images/painted-hand-298-332.jpg"
],
"aspect_ratio": "1:1",
"resolution": "1k",
"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/flux-3-klein-image-distilled/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="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 edit instruction describing the desired result. To place or move elements with bounding boxes, refer to the n-th reference as <ref_image_n>. | |
| images | array<string> | Yes | - | 1 ~ 3 items | Reference images to edit from (1 to 3 URLs). The first image also sets the output aspect ratio unless aspect_ratio is given. |
| aspect_ratio | string | No | - | 1:1, 1:2, 2:1, 1:3, 3:1, 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9, 9:21, 21:9 | The output aspect ratio. Defaults to the first reference image. |
| resolution | string | No | 1k | 1k, 2k | Total output resolution tier: 1k (~1 megapixel) or 2k (~4 megapixels). |
| output_format | string | No | jpeg | jpeg, png, webp | The format of the output image. |
| seed | integer | No | - | - | The random seed to use for the generation. -1 means a random seed will be used. |
| 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 |