Google Veo 3 & Veo 3 Fast Price Cut! 50%+ off
DocsBlogPricingEnterpriseCareersResearch Grants
Log-inSign-up

Hunyuan Image Text to Image

fal-ai/hunyuan-image/v2.1/text-to-image
Use the amazing capabilities of hunyuan image 2.1 to generate images that express the feelings of your text.
Inference
Commercial use
PlaygroundAPI

About

Generate Image

1. Calling the API#

Install the client#

The client provides a convenient way to interact with the model API.

npm install --save @fal-ai/client

Setup your API Key#

Set FAL_KEY as an environment variable in your runtime.

export FAL_KEY="YOUR_API_KEY"

Submit a request#

The client API handles the API submit protocol. It will handle the request status updates and return the result when the request is completed.

import { fal } from "@fal-ai/client";

const result = await fal.subscribe("fal-ai/hunyuan-image/v2.1/text-to-image", {
  input: {
    prompt: "A cute, cartoon-style anthropomorphic penguin plush toy, standing in a painting studio, wearing a red knitted scarf and beret."
  },
  logs: true,
  onQueueUpdate: (update) => {
    if (update.status === "IN_PROGRESS") {
      update.logs.map((log) => log.message).forEach(console.log);
    }
  },
});
console.log(result.data);
console.log(result.requestId);

2. Authentication#

The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.

API Key#

In case your app is running in an environment where you cannot set environment variables, you can set the API Key manually as a client configuration.
import { fal } from "@fal-ai/client";

fal.config({
  credentials: "YOUR_FAL_KEY"
});

3. Queue#

Submit a request#

The client API provides a convenient way to submit requests to the model.

import { fal } from "@fal-ai/client";

const { request_id } = await fal.queue.submit("fal-ai/hunyuan-image/v2.1/text-to-image", {
  input: {
    prompt: "A cute, cartoon-style anthropomorphic penguin plush toy, standing in a painting studio, wearing a red knitted scarf and beret."
  },
  webhookUrl: "https://optional.webhook.url/for/results",
});

Fetch request status#

You can fetch the status of a request to check if it is completed or still in progress.

import { fal } from "@fal-ai/client";

const status = await fal.queue.status("fal-ai/hunyuan-image/v2.1/text-to-image", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
  logs: true,
});

Get the result#

Once the request is completed, you can fetch the result. See the Output Schema for the expected result format.

import { fal } from "@fal-ai/client";

const result = await fal.queue.result("fal-ai/hunyuan-image/v2.1/text-to-image", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);

4. Files#

Some attributes in the API accept file URLs as input. Whenever that's the case you can pass your own URL or a Base64 data URI.

Data URI (base64)#

You can pass a Base64 data URI as a file input. The API will handle the file decoding for you. Keep in mind that for large files, this alternative although convenient can impact the request performance.

Hosted files (URL)#

You can also pass your own URLs as long as they are publicly accessible. Be aware that some hosts might block cross-site requests, rate-limit, or consider the request as a bot.

Uploading files#

We provide a convenient file storage that allows you to upload files and use them in your requests. You can upload files using the client API and use the returned URL in your requests.

import { fal } from "@fal-ai/client";

const file = new File(["Hello, World!"], "hello.txt", { type: "text/plain" });
const url = await fal.storage.upload(file);

Read more about file handling in our file upload guide.

5. Schema#

Input#

prompt string* required

The text prompt to generate an image from.

negative_prompt string

The negative prompt to guide the image generation away from certain concepts. Default value: ""

image_size ImageSizeEnum

The desired size of the generated image. Default value: "square_hd"

Possible enum values: square_hd, square, portrait_4_3, portrait_3_4, landscape_4_3, landscape_3_4, landscape_16_9, portrait_16_9

num_images integer

The number of images to generate. Default value: 1

num_inference_steps integer

Number of denoising steps. Default value: 28

guidance_scale float

Controls how much the model adheres to the prompt. Higher values mean stricter adherence. Default value: 3.5

seed integer

Random seed for reproducible results. If None, a random seed is used.

use_reprompt boolean

Enable prompt enhancement for potentially better results. Default value: true

use_refiner boolean

Enable the refiner model for improved image quality.

{
  "prompt": "A cute, cartoon-style anthropomorphic penguin plush toy, standing in a painting studio, wearing a red knitted scarf and beret.",
  "negative_prompt": "blurry, low quality, watermark, signature",
  "image_size": "square_hd",
  "num_images": 1,
  "num_inference_steps": 28,
  "guidance_scale": 3.5,
  "use_reprompt": true
}

Output#

images list<Image>* required

A list of the generated images.

seed integer* required

The base seed used for the generation process.

{
  "images": {
    "content_type": "image/png",
    "url": "https://v3.fal.media/files/zebra/WCrMfUTYp6mYCf6yRE3kw_generated_image_0.png"
  }
}

Other types#

Image#

url string* required

The URL where the file can be downloaded from.

content_type string

The mime type of the file.

file_name string

The name of the file. It will be auto-generated if not provided.

file_size integer

The size of the file in bytes.

file_data string

File data

width integer

The width of the image in pixels.

height integer

The height of the image in pixels.