flux/kontext-max/text-to-image

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

• flux/kontext-max/text-to-image

Model Overview

A new Flux model optimized for maximum image quality.

Model	Properties of Generated Images
flux/kontext-max/text-to-image	Format: JPEG, PNG Image size can't be set directly — only a preset aspect ratio can be chosen. Default aspect ratio and size: 1:1, 1024x1024

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

access-token

Body

application/json

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.

safety_tolerancestring · enumOptional

The safety tolerance level for the generated image. 1 being the most strict and 5 being the most permissive.

Default: 2Possible values:

output_formatstring · enumOptional

The format of the generated image.

Default: jpegPossible values:

aspect_ratiostring · enumOptional

The aspect ratio of the generated image.

Default: 16:9Possible values:

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.

Responses

201

Successfully generated image

application/json

post

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: 'flux/kontext-max/text-to-image',
      prompt: 'A T-Rex relaxing on a beach, lying on a sun lounger and wearing sunglasses.',
    }),
  });

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

main();

201

Successfully generated image

{
  "status": "text",
  "prompt": [
    "text"
  ],
  "model": "text",
  "model_owner": "text",
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "num_returns": 1,
  "args": {
    "model": "text",
    "prompt": "text",
    "n": 1,
    "steps": 1,
    "size": "text"
  },
  "subjobs": [],
  "output": {
    "choices": [
      {
        "image_base64": "text"
      }
    ]
  }
}

Quick Example

Let's generate an image of the specified size using a simple prompt.

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={
            "prompt": "A T-Rex relaxing on a beach, lying on a sun lounger and wearing sunglasses.",
            "model": "flux/kontext-max/text-to-image",
            "aspect_ratio": '21:9'
        }
    )

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

if __name__ == "__main__":
    main()

JS

async function main() {
  const response = await fetch('https://api.aimlapi.com/v1/images/generations', {
    method: 'POST',
    headers: {
      // Insert your AIML API Key instead of <YOUR_AIMLAPI_KEY>:
      'Authorization': 'Bearer <YOUR_AIMLAPI_KEY>',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      model: 'flux/kontext-max/text-to-image',
      prompt: 'A T-Rex relaxing on a beach, lying on a sun lounger and wearing sunglasses.',
      
      aspect_ratio: '21:9',
    }),
  });

  const data = await response.json();
  console.log(data);
}

main();

Response

{
  images: [
    {
      url: 'https://cdn.aimlapi.com/squirrel/files/monkey/zP2cXFuTA4Bd0GbZAAb8y_be6eb84f036744dcbb2e155296b96be1.jpg',
      width: 1568,
      height: 672,
      content_type: 'image/jpeg'
    }
  ],
  timings: {},
  seed: 1617845674,
  has_nsfw_concepts: [ false ],
  prompt: 'A T-Rex relaxing on a beach, lying on a sun lounger and wearing sunglasses.'
}

We obtained the following 1568x672 image by running this code example:

'A T-Rex relaxing on a beach, lying on a sun lounger and wearing sunglasses.'