flux/kontext-pro/text-to-image

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

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

Model Overview

A new Flux model optimized for faster generation speed.

Model
Properties of Generated Images

flux/kontext-pro/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
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.

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
201Success

No content

post
POST /v1/images/generations HTTP/1.1
Host: api.aimlapi.com
Authorization: Bearer <YOUR_AIMLAPI_KEY>
Content-Type: application/json
Accept: */*
Content-Length: 169

{
  "model": "flux/kontext-pro/text-to-image",
  "guidance_scale": 1,
  "safety_tolerance": "2",
  "output_format": "jpeg",
  "aspect_ratio": "16:9",
  "prompt": "text",
  "num_images": 1,
  "seed": 1
}
201Success

No content

Quick Example

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

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-pro/text-to-image",
            "aspect_ratio": "21:9"   
        }
    )

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

if __name__ == "__main__":
    main()
Response
{
  "images": [
    {
      "url": "https://cdn.aimlapi.com/squirrel/files/koala/6e4yw7_YnA8tEe03QW8wW_5298e11de5a24f1f9cf4f277cbdd3316.jpg",
      "width": 1568,
      "height": 672,
      "content_type": "image/jpeg"
    }
  ],
  "timings": {},
  "seed": 2561481494,
  "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.'

Last updated

Was this helpful?