flux-2-edit

This documentation is valid for the following list of our models:

• blackforestlabs/flux-2-edit

Try in Playground

Model Overview

A 4MP photorealistic, production-grade editor with advanced multi-reference control capabilities.

Setup your API Key

If you don’t have an API key for the AI/ML API yet, feel free to use our Quickstart guide.

API Schema

post

Body

application/json

modelstring · enumRequiredPossible values:

promptstring · max: 4000Required

The text prompt describing the content, style, or composition of the image to be generated.

image_urlsstring · uri[] · min: 1 · max: 3Required

List of URLs or local Base64 encoded images to edit.

image_sizeany ofOptionalDefault: landscape_4_3

or

string · enumOptional

The size of the generated image.

Possible values:

output_formatstring · enumOptional

The format of the generated image.

Default: pngPossible values:

enable_prompt_expansionbooleanOptional

If set to True, prompt will be upsampled with more details.

Default: true

guidance_scalenumber · max: 20Optional

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.

num_inference_stepsinteger · min: 4 · max: 50Optional

The number of inference steps to perform.

accelerationstring · enumOptional

The speed of the generation. The higher the speed, the faster the generation.

Default: regularPossible values:

seedinteger · min: 1Optional

The same seed and the same prompt given to the same version of the model will output the same image every time.

num_imagesnumber · min: 1 · max: 4Optional

The number of images to generate.

Default: 1

enable_safety_checkerbooleanOptional

If set to True, the safety checker will be enabled.

Default: true

Responses

200Success

application/json

post

/v1/images/generations

JavaScriptPythoncURLHTTP

async function main() {
  const response = await fetch('https://api.aimlapi.com/v1/images/generations', {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer <YOUR_AIMLAPI_KEY>',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      "model": "blackforestlabs/flux-2-edit",
      "prompt": "Combine the images so the T-Rex is wearing a business suit, sitting in a cozy small café, drinking from the mug. Blur the background slightly to create a bokeh effect.",
      "image_urls": [
        "https://raw.githubusercontent.com/aimlapi/api-docs/main/reference-files/t-rex.png",
        "https://raw.githubusercontent.com/aimlapi/api-docs/main/reference-files/blue-mug.jpg"
      ]
    }),
  });

  const data = await response.json();
  console.log(JSON.stringify(data, null, 2));
}

main();

200Success

{
  "data": [
    {
      "url": "https://cdn.aimlapi.com/generations/hedgehog/1749730923700-29fe35d2-4aef-4bc5-a911-6c39884d16a8.png",
      "b64_json": null
    }
  ],
  "meta": {
    "usage": {
      "tokens_used": 120000
    }
  }
}

Quick Example

Let's generate an image using two input images and a prompt that defines how they should be edited.

Python

import requests
import json  # for getting a structured output with indentation

def main():
    response = requests.post(
        "https://api.aimlapi.com/v1/images/generations",
        headers={
            # Insert your AIML API Key instead of <YOUR_AIMLAPI_KEY>:
            "Authorization": "Bearer <YOUR_AIMLAPI_KEY>",
            "Content-Type": "application/json",
        },
        json={
            "model": "blackforestlabs/flux-2-edit",
            "prompt": "Combine the images so the T-Rex is wearing a business suit, sitting in a cozy small café, drinking from the mug. Blur the background slightly to create a bokeh effect.",
            "image_urls": [
                "https://raw.githubusercontent.com/aimlapi/api-docs/main/reference-files/t-rex.png",
                "https://raw.githubusercontent.com/aimlapi/api-docs/main/reference-files/blue-mug.jpg"
            ],
            "guidance_scale": 19
        }
    )

    data = response.json()
    print(json.dumps(data, indent=2, ensure_ascii=False))

if __name__ == "__main__":
    main()

JS

Response

{
  "data": [
    {
      "url": "https://cdn.aimlapi.com/flamingo/files/b/0a847ab7/KtavVJcI8jz5cN49wXF0e.png"
    }
  ],
  "meta": {
    "usage": {
      "tokens_used": 75601
    }
  }
}

Reference Images	Generated Image
Image #1	"Combine the images so the T-Rex is wearing a business suit, sitting in a cozy small café, drinking from the mug. Blur the background slightly to create a bokeh effect."
Image #2