flux/schnell

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

• flux/schnell

Model Overview

A state-of-the-art text-to-image generation model designed to create high-quality images from textual descriptions. With a robust architecture of 12 billion parameters, it leverages advanced techniques to produce images that rival those generated by leading closed-source models.

Model	Generated image properties
flux/schnell	Format: PNG Min size: 64x64 Max size: 1536x1536 Default size: 1024x768 For both height and width, the value must be a multiple of 32.

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:

image_sizeany ofOptionalDefault: landscape_4_3

or

string · enumOptional

The size of the generated image.

Possible values:

num_inference_stepsinteger · min: 1 · max: 12Optional

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.

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/schnell',
      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.

The minimum size is 64x64, and the minimum is 1536x1536. The width and height value must be a multiple of 32.

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": "flux/schnell",
            "prompt": "A T-Rex relaxing on a beach, lying on a sun lounger and wearing sunglasses.",
        }
    )

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

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

main();

Response

Generation: {'images': [{'url': 'https://cdn.aimlapi.com/eagle/files/lion/dSqd5BMP3pfaiKEnFXiiE.png', 'width': 1440, 'height': 512, 'content_type': 'image/png'}], 'timings': {'inference': 0.3458922009449452}, 'seed': 454423425, 'has_nsfw_concepts': [False], 'prompt': 'A T-Rex relaxing on a beach, lying on a sun lounger and wearing sunglasses.'}

We obtained the following 1440x512 image by running this code example:

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