FLUX Virtual Try-On [pro] API.
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientSet FAL_KEY as an environment variable in your runtime.
export FAL_KEY="YOUR_API_KEY"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/flux-pro/v1/vto", {
input: {
prompt: "A natural front-facing studio shot. The t-shirt is worn tucked in.",
human_image_url: "https://storage.googleapis.com/falserverless/model_tests/leffa/person_image.jpg",
garment_image_url: "https://storage.googleapis.com/falserverless/model_tests/leffa/tshirt_image.jpg"
},
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);The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.
import { fal } from "@fal-ai/client";
fal.config({
credentials: "YOUR_FAL_KEY"
});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/flux-pro/v1/vto", {
input: {
prompt: "A natural front-facing studio shot. The t-shirt is worn tucked in.",
human_image_url: "https://storage.googleapis.com/falserverless/model_tests/leffa/person_image.jpg",
garment_image_url: "https://storage.googleapis.com/falserverless/model_tests/leffa/tshirt_image.jpg"
},
webhookUrl: "https://optional.webhook.url/for/results",
});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/flux-pro/v1/vto", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
logs: true,
});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/flux-pro/v1/vto", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);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.
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.
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.
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.
prompt string* requiredNatural-language styling instructions describing how the garment should be worn on the person (e.g. tucked in, layered, sleeves rolled up).
human_image_url string* requiredThe URL of the person image that the garment will be applied onto. The output keeps this image's aspect ratio. Maximum 2 megapixels; recommended under 1 MP.
garment_image_url string* requiredThe URL of the garment reference image. Maximum 1 megapixel; recommended around 0.5 MP. Multiple garments must be merged into a single composite image before submission.
seed integerThe same seed and the same input will output the same image every time. If not provided, a random seed is used.
sync_mode booleanIf True, the media will be returned as a data URI and the output data won't be available in the request history.
output_format OutputFormatEnumThe format of the generated image. Default value: "jpeg"
Possible enum values: jpeg, png
enable_safety_checker booleanAuthorized callers may set false to request relaxed screening. Default value: true
{
"prompt": "A natural front-facing studio shot. The t-shirt is worn tucked in.",
"human_image_url": "https://storage.googleapis.com/falserverless/model_tests/leffa/person_image.jpg",
"garment_image_url": "https://storage.googleapis.com/falserverless/model_tests/leffa/tshirt_image.jpg",
"output_format": "jpeg",
"enable_safety_checker": true
}The generated image files info.
seed integer* requiredSeed of the generated Image. It will be the same value of the one passed in the input or the randomly generated that was used in case none was passed.
Whether the generated images contain NSFW concepts.
prompt string* requiredThe prompt used for generating the image.
{
"images": [
{
"url": "",
"content_type": "image/jpeg"
}
],
"prompt": ""
}url string* requiredwidth integer* requiredheight integer* requiredcontent_type stringDefault value: "image/jpeg"