StatusDocsPricingCommunity
Log-inSign-up

Virtual Try-On

fal-ai/cat-vton
Inference
Research only

About

Run

1. Calling the API#

Install the client#

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

npm install --save @fal-ai/serverless-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 * as fal from "@fal-ai/serverless-client";

const result = await fal.subscribe("fal-ai/cat-vton", {
  input: {
    human_image_url: "https://me99.in/wp-content/uploads/2023/03/Cotton-Full-Sleeve-Men-Shirt-For-Summer-1.jpg",
    garment_image_url: "https://assets.myntassets.com/h_720,q_90,w_540/v1/assets/images/28971488/2024/7/12/d6f2ce64-e7a7-4916-886d-9c3de51ad67c1720763522797-Eteenz-Girls-Tops-2961720763522438-1.jpg",
    cloth_type: "upper"
  },
  logs: true,
  onQueueUpdate: (update) => {
    if (update.status === "IN_PROGRESS") {
      update.logs.map((log) => log.message).forEach(console.log);
    }
  },
});

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 * as fal from "@fal-ai/serverless-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 * as fal from "@fal-ai/serverless-client";

const { request_id } = await fal.queue.submit("fal-ai/cat-vton", {
  input: {
    human_image_url: "https://me99.in/wp-content/uploads/2023/03/Cotton-Full-Sleeve-Men-Shirt-For-Summer-1.jpg",
    garment_image_url: "https://assets.myntassets.com/h_720,q_90,w_540/v1/assets/images/28971488/2024/7/12/d6f2ce64-e7a7-4916-886d-9c3de51ad67c1720763522797-Eteenz-Girls-Tops-2961720763522438-1.jpg",
    cloth_type: "upper"
  },
  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 * as fal from "@fal-ai/serverless-client";

const status = await fal.queue.status("fal-ai/cat-vton", {
  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 * as fal from "@fal-ai/serverless-client";

const result = await fal.queue.result("fal-ai/cat-vton", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});

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 * as fal from "@fal-ai/serverless-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#

human_image_url string* required

Url for the human image.

garment_image_url string* required

Url to the garment image.

cloth_type ClothTypeEnum* required

Type of the Cloth to be tried on.

Options: upper: Upper body cloth lower: Lower body cloth overall: Full body cloth inner: Inner cloth, like T-shirt inside a jacket outer: Outer cloth, like a jacket over a T-shirt

Possible enum values: upper, lower, overall, inner, outer

image_size ImageSize | Enum

The size of the generated image. Default value: portrait_4_3

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

num_inference_steps integer

The number of inference steps to perform. Default value: 30

guidance_scale float

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 value: 2.5

seed integer

The same seed and the same input given to the same version of the model will output the same image every time.

{
  "human_image_url": "https://me99.in/wp-content/uploads/2023/03/Cotton-Full-Sleeve-Men-Shirt-For-Summer-1.jpg",
  "garment_image_url": "https://assets.myntassets.com/h_720,q_90,w_540/v1/assets/images/28971488/2024/7/12/d6f2ce64-e7a7-4916-886d-9c3de51ad67c1720763522797-Eteenz-Girls-Tops-2961720763522438-1.jpg",
  "cloth_type": "upper",
  "image_size": "portrait_4_3",
  "num_inference_steps": 30,
  "guidance_scale": 2.5
}

Output#

image Image* required

The output image.

{
  "image": {
    "url": "",
    "content_type": "image/png",
    "file_name": "z9RV14K95DvU.png",
    "file_size": 4404019,
    "width": 1024,
    "height": 1024
  }
}

Other types#

ImageSize#

width integer

The width of the generated image. Default value: 512

height integer

The height of the generated image. Default value: 512

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.