flux/dev/image-to-image

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

  • flux/dev/image-to-image

Model Overview

A state-of-the-art image generation model that utilizes a 12 billion parameter rectified flow transformer architecture. It is designed to generate high-quality images from textual descriptions, making it a powerful tool for developers and creatives.

Model
Generated image properties

flux/dev/image-to-image

Format: PNG Fixed size: Matches the dimensions of the reference image.

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
Authorizations
Body
modelundefined · enumRequiredPossible values:
guidance_scalenumber · min: 1 · 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: 1 · max: 50Optional

The number of inference steps to perform.

enable_safety_checkerbooleanOptional

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

Default: true
promptstring · max: 4000Required

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

num_imagesnumber · min: 1 · max: 4Optional

The number of images to generate.

Default: 1
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.

image_urlstring · uriRequired

The URL of the reference image.

strengthnumberOptional

Determines how much the prompt influences the generated image.

Default: 0.95
Responses
201Success
post
POST /v1/images/generations HTTP/1.1
Host: api.aimlapi.com
Authorization: Bearer <YOUR_AIMLAPI_KEY>
Content-Type: application/json
Accept: */*
Content-Length: 197

{
  "model": "flux/dev/image-to-image",
  "guidance_scale": 1,
  "num_inference_steps": 1,
  "enable_safety_checker": true,
  "prompt": "text",
  "num_images": 1,
  "seed": 1,
  "image_url": "https://example.com",
  "strength": 0.95
}
201Success

No content

Quick Example

Let's generate a new image using the one from the flux/dev Quick Example as a reference — and make a simple change to it with a prompt.

import requests

# URL of the reference picture
img_url = "https://zovi0.github.io/public_misc/flux-dev-t-rex.png"

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={
            "prompt": "Add a bird to the foreground of the photo.",
            "model": "flux/dev/image-to-image",
            "image_url": img_url,
            "strength": 0.8
        }
    )

    # response.raise_for_status()
    data = response.json()

    print("Generation:", data)


if __name__ == "__main__":
    main()
Response
Generation: {'images': [{'url': 'https://cdn.aimlapi.com/eagle/files/lion/EyuGvQzlsBoVUB8qjV776.png', 'width': 1024, 'height': 768, 'content_type': 'image/png'}], 'timings': {'inference': 2.544010079000145}, 'seed': 2819715747, 'has_nsfw_concepts': [False], 'prompt': 'Add a bird to the foreground of the photo.'}
Reference Image
Generated Image

Last updated

Was this helpful?