Hunyuan Image V3

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

• hunyuan/hunyuan-image-v3-text-to-image

Try in Playground

Model Overview

An advanced capabilities of Hunyuan Image 3.0 to generate compelling visuals that seamlessly enhance and communicate your written content.

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:

negative_promptstringOptional

The description of elements to avoid in the generated image.

Default: ""

image_sizeany ofOptional

The size of the generated image.

Default: square_hd

string · enumOptionalPossible values:

or

num_inference_stepsinteger · min: 1 · max: 50Optional

The number of inference steps to perform.

Default: 28

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.

Default: 7.5

enable_safety_checkerbooleanOptional

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

Default: true

sync_modebooleanOptional

If set to true, the function will wait for the image to be generated and uploaded before returning the response. This will increase the latency of the function but it allows you to get the image directly in the response without going through the CDN.

Default: false

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.

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

/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: 'hunyuan/hunyuan-image-v3-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

{
  "data": [
    {
      "url": "text",
      "b64_json": "text"
    }
  ]
}

Quick Example

Let's generate an image using a simple prompt.

Python

import requests
import json

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": "hunyuan/hunyuan-image-v3-text-to-image",
            "image_size": "landscape_16_9"
        }
    )

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

if __name__ == "__main__":
    main()

JS

Response

{
    "data": [
        {
            "url": "https://v3b.fal.media/files/b/lion/JdrvNguTlt29LmURRbKKN.png",
            "content_type": "image/png",
            "file_name": null,
            "file_size": null,
            "width": 1280,
            "height": 768
        }
    ],
    "meta": {
        "usage": {
            "tokens_used": 210000
        }
    }
}

We obtained the following 1280x768 image by running this code example:

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