Flux Kontext Pro
A state-of-the-art image editing model, Flux Kontext, which aims to provide comparable performance against the closed-source models like GPT-4o and Gemini2 Flash.
Features
FLUX.1 Kontext is a state-of-the-art image editing model by Black Forest Labs that lets you edit images using text prompts. It makes editing intuitive by understanding the relationship between visuals and language. You can make precise changes to objects, scenes, and layout — all without disrupting the composition.
FLUX.1 Kontext pro: Pioneer for fast iterative editing. The first model to build upon previous edits while maintaining characters, identities, styles and features consistent across scenes.
Key Features
- Context-Aware Editing: Intelligent understanding of image semantics for precise modifications that preserve natural aesthetics.
- Lightning Fast: Optimized neural architecture delivers professional results in seconds for real-time workflows.
- Precision Control: Granular control over transformations with intuitive parameters and fine-tuning capabilities.
- SOTA Quality: State-of-the-art results surpassing existing models across all quality benchmarks.
Use Cases
- Style Transfer: Convert photos to different art styles, like watercolor, oil painting and sketches.
- Object/Clothing Changes: Modify hairstyles, add accessories, change colors.
- Text Editing: Replace text in signs, posters, and labels.
- Background Swapping: Change environments while preserving subjects.
Authentication
For authentication details, please refer to the Authentication Guide.
API Endpoints
Submit Task & Query Result
# Submit the task
curl --location --request POST "https://api.wavespeed.ai/api/v3/wavespeed-ai/flux-kontext-pro" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer ${WAVESPEED_API_KEY}" \
--data-raw '{
"prompt": "A man eating noddles",
"image": "https://d2g64w682n9w0w.cloudfront.net/media/images/1748440196357654959_12gDAwup.webp",
"guidance_scale": 3.5,
"safety_tolerance": "2"
}'
# Get the result
curl --location --request GET "https://api.wavespeed.ai/api/v3/predictions/${requestId}/result" \
--header "Authorization: Bearer ${WAVESPEED_API_KEY}"
Parameters
Task Submission Parameters
Request Parameters
| Parameter | Type | Required | Default | Range | Description |
|---|---|---|---|---|---|
| prompt | string | Yes | A man eating noddles | - | The prompt to generate an image from. |
| image | string | Yes | https://d2g64w682n9w0w.cloudfront.net/media/images/1748440196357654959_12gDAwup.webp | - | The image to generate an image from. |
| seed | integer | No | - | -1 ~ 9999999999 | The same seed and the same prompt given to the same version of the model will output the same image every time. |
| guidance_scale | number | No | 3.5 | 1.0 ~ 10.0 | The CFG (Classifier Free Guidance) scale is a measure of how close you want the model to stick to your prompt when looking for a related image to show you. |
| safety_tolerance | string | No | 2 | - | The safety tolerance level for the generated image. 1 being the most strict and 5 being the most permissive. |
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 | Array of URLs to the generated content (empty when status is not completed) |
| data.urls | object | Object containing related API endpoints |
| data.urls.get | string | URL to retrieve the prediction result |
| data.has_nsfw_contents | array | Array of boolean values indicating NSFW detection for each output |
| data.status | string | Status of the task: created, processing, completed, or failed |
| 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 Query Parameters
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 | Array of URLs to the generated content (empty when status is not completed) |
| data.urls | object | Object containing related API endpoints |
| data.urls.get | string | URL to retrieve the prediction result |
| data.has_nsfw_contents | array | Array of boolean values indicating NSFW detection for each output |
| data.status | string | Status of the task: created, processing, completed, or failed |
| 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 |