PuLID

fal-ai/pulid
Inference
Commercial use

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/pulid", {
  input: {
    reference_images: [{
      image_url: "https://fal.media/files/monkey/CxgWoVIo1BklMncNKpqWB.webp"
    }, {
      image_url: "https://fal.media/files/kangaroo/ffgpzpvs4j9BE_B5ol6a1.webp"
    }, {
      image_url: "https://fal.media/files/rabbit/glcNYPonhV1_klj_xWhPy.webp"
    }, {
      image_url: "https://fal.media/files/rabbit/E4gKiWRvPH4efX24GfhHE.jpeg"
    }],
    prompt: "portrait, impressionist painting, loose brushwork, vibrant color, light and shadow play"
  },
  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. 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";

// Upload a file (you can get a file reference from an input element or a drag-and-drop event)
const file = new File(["Hello, World!"], "hello.txt", { type: "text/plain" });
const url = await fal.storage.upload(file);

// Use the URL in your request
const result = await fal.subscribe("fal-ai/pulid", { image_url: url });

Read more about file handling in our file upload guide.

4. Schema#

Input#

reference_images*list<ReferenceFace>

List of reference faces, ideally 4 images.

prompt*string

Prompt to generate the face from

negative_promptstring

Negative prompt to generate the face from Default value: "flaws in the eyes, flaws in the face, flaws, lowres, non-HDRi, low quality, worst quality,artifacts noise, text, watermark, glitch, deformed, mutated, ugly, disfigured, hands, low resolution, partially rendered objects, deformed or partially rendered eyes, deformed, deformed eyeballs, cross-eyed,blurry"

num_imagesinteger

Number of images to generate Default value: 1

guidance_scalefloat

Guidance scale Default value: 1.2

num_inference_stepsinteger

Number of steps to take Default value: 4

seedinteger

Random seed for reproducibility

image_sizeImageSize | Enum

Size of the generated image Default value: [object Object]

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

id_scalefloat

ID scale Default value: 0.8

modeModeEnum

Mode of generation Default value: "fidelity"

Possible values: "fidelity", "extreme style"

id_mixboolean

if you want to mix two ID image, please turn this on, otherwise, turn this off

{
  "reference_images": [
    {
      "image_url": "https://fal.media/files/monkey/CxgWoVIo1BklMncNKpqWB.webp"
    },
    {
      "image_url": "https://fal.media/files/kangaroo/ffgpzpvs4j9BE_B5ol6a1.webp"
    },
    {
      "image_url": "https://fal.media/files/rabbit/glcNYPonhV1_klj_xWhPy.webp"
    },
    {
      "image_url": "https://fal.media/files/rabbit/E4gKiWRvPH4efX24GfhHE.jpeg"
    }
  ],
  "prompt": "portrait, impressionist painting, loose brushwork, vibrant color, light and shadow play",
  "negative_prompt": "flaws in the eyes, flaws in the face, flaws, lowres, non-HDRi, low quality, worst quality,artifacts noise, text, watermark, glitch, deformed, mutated, ugly, disfigured, hands, low resolution, partially rendered objects,  deformed or partially rendered eyes, deformed, deformed eyeballs, cross-eyed,blurry",
  "num_images": 1,
  "guidance_scale": 1.2,
  "num_inference_steps": 4,
  "image_size": {
    "height": 1024,
    "width": 768
  },
  "id_scale": 0.8,
  "mode": "fidelity"
}

Output#

images*list<Image>

List of generated images

seed*integer

Random seed used for reproducibility

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