Black Forest Labs Flux 3 Edit API Documentation
Playground
Try it on WaveSpeedAI!FLUX 3 Image Edit transforms and combines up to 10 input images using natural-language instructions, with flexible 1K / 2K / 4K output for multi-image composition, visual refinements, creative edits, marketing assets, and production workflows. Ready-to-use REST inference API, best performance, no coldstarts, affordable pricing.
Features
FLUX 3 Image Edit transforms and combines existing images using natural-language instructions. Provide between 1 and 10 input images, explain the role of each reference in the prompt, and generate a new composition at up to 4K resolution.
Use it for subject-guided edits, product compositions, style changes, typography, advertising creatives, and multi-reference workflows where elements from several images need to be combined into one result.
Why Choose This?
-
Multi-image editing
Combine up to10input images in a single generation. -
Reference-guided composition
Assign different roles to each image, such as taking a subject from one reference and placing it into the scene from another. -
Up to 4K output
Choose1K,2K, or4Kdepending on your quality and production requirements. -
Typography and layout control
Describe exact text, placement, hierarchy, and composition directly in the prompt. -
Flexible aspect ratios
Choose from a wide range of landscape, portrait, square, and ultrawide layouts. -
Prompt expansion
Enable automatic prompt expansion when additional interpretation is useful.
Parameters
| Parameter | Required | Description |
|---|---|---|
| prompt | Yes | Text instructions describing the edit or new composition. Refer to input images by their order, such as image 1, image 2, and so on. Must not be empty. |
| images | Yes | Between 1 and 10 input image URLs or data URIs. Each image must be at least 256 pixels per dimension and no larger than 4 megapixels. Input order matters. |
| aspect_ratio | No | Output aspect ratio: 21:9, 2:1, 16:9, 3:2, 7:5, 4:3, 5:4, 1:1, 4:5, 3:4, 5:7, 2:3, 9:16, or 1:2. Leave empty to follow the first input image’s aspect ratio. |
| resolution | No | Output resolution tier: 1k, 2k, or 4k. Default: 1k. |
| enable_prompt_expansion | No | Expand the prompt while preserving the intended content. Default: false. |
| output_format | No | Output image format: jpeg or png. Default: jpeg. |
How to Use
- Upload the source images — Provide between
1and10images in the order you want to reference them. - Write the edit instruction — Describe what should change and explain the role of each image.
- Choose aspect ratio optional — Select an output layout or leave it empty to follow the first input image.
- Choose resolution — Select
1k,2k, or4k. - Configure prompt expansion optional — Enable it when you want the prompt expanded automatically.
- Choose output format — Select
jpegorpng. - Submit — Generate and retrieve the edited image.
Pricing
Pricing is based only on the selected resolution.
| Resolution | Price per Image |
|---|---|
| 1K | $0.05 |
| 2K | $0.12 |
| 4K | $0.65 |
Best Use Cases
- Multi-reference compositions — Combine subjects, products, environments, or visual elements from several source images.
- Product imagery — Place products into new scenes or combine product references with campaign visuals.
- Advertising creatives — Build commercial concepts from multiple visual references.
- Subject-guided editing — Use one image to guide a person, object, or other subject in another composition.
- Style transformation — Change materials, lighting, colors, or overall visual direction.
- Typography and poster design — Modify or create compositions containing text and structured layouts.
- Editorial and social content — Produce new visuals from existing assets for publishing and social media.
Pro Tips
- Refer to each input clearly as
image 1,image 2, and so on. - Explain the role of every important reference instead of simply uploading multiple images without instructions.
- State both what should change and what should remain unchanged when precision matters.
- Put exact text that should appear in the output inside quotation marks.
- Describe where subjects, products, or text should appear in the final composition.
- Use
1kfor lower-cost iteration before moving to2kor4k. - Use fewer references when several images provide conflicting visual guidance.
- Choose
pngwhen you want to avoid additional JPEG compression.
Related Models
- FLUX 3 Text-to-Image — Generate images directly from text prompts with resolutions up to 4K.
- FLUX 3 Edit — Edit and combine up to ten input images with natural-language instructions.
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": "21:9",
"resolution": "1k",
"output_format": "jpeg",
"enable_prompt_expansion": false
}
JSON
)
# 1. Submit the prediction.
SUBMIT_RESPONSE=$(curl --silent --show-error --fail-with-body \
-X POST "https://api.wavespeed.ai/api/v3/black-forest-labs/flux-3/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 | - | Describe the changes. Refer to input images by their order, such as image 1 or image 2. | |
| images | array<string> | Yes | - | 1 ~ 10 items | Upload 1-10 input images in reference order. Each must be at least 256 pixels per dimension and at most 4 megapixels. Omit aspect_ratio to follow the first image. |
| aspect_ratio | string | No | - | 21:9, 2:1, 16:9, 3:2, 7:5, 4:3, 5:4, 1:1, 4:5, 3:4, 5:7, 2:3, 9:16, 1:2 | Optional output aspect ratio. Leave empty to match the first input image. |
| resolution | string | No | 1k | 1k, 2k, 4k | Output resolution tier. Higher tiers cost more; 4K can take several minutes. |
| output_format | string | No | jpeg | jpeg, png | The format of the generated image. |
| enable_prompt_expansion | boolean | No | false | - | Expand the prompt while preserving its intent and the roles of reference images. |
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 |