DocsBlogPricingEnterpriseCareersResearch Grants
Log-inSign-up

Leffa Pose Transfer Image to Image

fal-ai/leffa/pose-transfer
Leffa Pose Transfer is an endpoint for changing pose of an image with a reference image.
Inference
Commercial use
PlaygroundAPI

About

Leffa Predict Pt

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/leffa/pose-transfer", {
  input: {
    pose_image_url: "https://storage.googleapis.com/falserverless/model_tests/leffa/person_image.jpg",
    person_image_url: "https://storage.googleapis.com/falserverless/model_tests/leffa/pose_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);

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/leffa/pose-transfer", {
  input: {
    pose_image_url: "https://storage.googleapis.com/falserverless/model_tests/leffa/person_image.jpg",
    person_image_url: "https://storage.googleapis.com/falserverless/model_tests/leffa/pose_image.jpg"
  },
  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/leffa/pose-transfer", {
  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/leffa/pose-transfer", {
  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#

num_inference_steps integer

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

seed integer

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

guidance_scale float

The CFG (Classifier Free Guidance) scale is a measure of how close you want the model to stick to your input when generating the image. Default value: 2.5

sync_mode boolean

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.

enable_safety_checker boolean

If set to true, the safety checker will be enabled. Default value: true

output_format OutputFormatEnum

The format of the generated image. Default value: "png"

Possible enum values: jpeg, png

pose_image_url string* required

Url for the human image.

person_image_url string* required

Url to the garment image.

{
  "num_inference_steps": 50,
  "guidance_scale": 2.5,
  "enable_safety_checker": true,
  "output_format": "png",
  "pose_image_url": "https://storage.googleapis.com/falserverless/model_tests/leffa/person_image.jpg",
  "person_image_url": "https://storage.googleapis.com/falserverless/model_tests/leffa/pose_image.jpg"
}

Output#

image Image* required

The output image.

seed integer* required

The seed for the inference.

has_nsfw_concepts boolean* required

Whether the image contains NSFW concepts.

{
  "image": {
    "height": 1024,
    "content_type": "image/jpeg",
    "url": "https://fal.media/files/tiger/y6ZwaYdP9Q92FnsJcSbYz.png",
    "width": 768
  }
}

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.

Related Models