# PuLID Flux

> An endpoint for personalized image generation using Flux as per given description.


## Overview

- **Endpoint**: `https://fal.run/fal-ai/flux-pulid`
- **Model ID**: `fal-ai/flux-pulid`
- **Category**: image-to-image
- **Kind**: inference
**Tags**: personalization, style transfer



## Pricing

- **Price**: $0.0333 per megapixels

For more details, see [fal.ai pricing](https://fal.ai/pricing).

## API Information

This model can be used via our HTTP API or more conveniently via our client libraries.
See the input and output schema below, as well as the usage examples.


### Input Schema

The API accepts the following input parameters:


- **`prompt`** (`string`, _required_):
  The prompt to generate an image from.
  - Examples: "a woman holding sign with glowing green text 'PuLID for FLUX'"

- **`reference_image_url`** (`string`, _required_):
  URL of image to use for inpainting.
  - Examples: "https://storage.googleapis.com/falserverless/gallery/example_inputs_liuyifei.png"

- **`image_size`** (`ImageSize | Enum`, _optional_):
  The size of the generated image. Default value: `landscape_4_3`
  - Default: `"landscape_4_3"`
  - One of: ImageSize | Enum

- **`num_inference_steps`** (`integer`, _optional_):
  The number of inference steps to perform. Default value: `20`
  - Default: `20`
  - Range: `1` to `50`

- **`seed`** (`integer`, _optional_):
  The same seed and the same prompt given to the same version of the model
  will output the same image every time.

- **`guidance_scale`** (`float`, _optional_):
  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: `4`
  - Default: `4`
  - Range: `0` to `20`

- **`negative_prompt`** (`string`, _optional_):
  The prompt to generate an image from. Default value: `""`
  - Default: `""`
  - Examples: "bad quality, worst quality, text, signature, watermark, extra limbs"

- **`sync_mode`** (`boolean`, _optional_):
  If `True`, the media will be returned as a data URI and the output data won't be available in the request history.
  - Default: `false`

- **`start_step`** (`integer`, _optional_):
  The number of steps to start the CFG from.
  - Default: `0`
  - Range: `0` to `50`

- **`true_cfg`** (`float`, _optional_):
  The weight of the CFG loss. Default value: `1`
  - Default: `1`
  - Range: `1` to `10`

- **`id_weight`** (`float`, _optional_):
  The weight of the ID loss. Default value: `1`
  - Default: `1`
  - Range: `0` to `1`

- **`enable_safety_checker`** (`boolean`, _optional_):
  If set to true, the safety checker will be enabled. Default value: `true`
  - Default: `true`

- **`max_sequence_length`** (`MaxSequenceLengthEnum`, _optional_):
  The maximum sequence length for the model. Default value: `"128"`
  - Default: `"128"`
  - Options: `"128"`, `"256"`, `"512"`



**Required Parameters Example**:

```json
{
  "prompt": "a woman holding sign with glowing green text 'PuLID for FLUX'",
  "reference_image_url": "https://storage.googleapis.com/falserverless/gallery/example_inputs_liuyifei.png"
}
```

**Full Example**:

```json
{
  "prompt": "a woman holding sign with glowing green text 'PuLID for FLUX'",
  "reference_image_url": "https://storage.googleapis.com/falserverless/gallery/example_inputs_liuyifei.png",
  "image_size": "landscape_4_3",
  "num_inference_steps": 20,
  "guidance_scale": 4,
  "negative_prompt": "bad quality, worst quality, text, signature, watermark, extra limbs",
  "true_cfg": 1,
  "id_weight": 1,
  "enable_safety_checker": true,
  "max_sequence_length": "128"
}
```


### Output Schema

The API returns the following output format:

- **`images`** (`list<Image>`, _required_):
  The generated image files info.
  - Array of Image

- **`timings`** (`Timings`, _required_)

- **`seed`** (`integer`, _required_):
  Seed 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.

- **`has_nsfw_concepts`** (`list<boolean>`, _required_):
  Whether the generated images contain NSFW concepts.
  - Array of boolean

- **`prompt`** (`string`, _required_):
  The prompt used for generating the image.



**Example Response**:

```json
{
  "images": [
    {
      "url": "",
      "content_type": "image/jpeg"
    }
  ],
  "prompt": ""
}
```


## Usage Examples

### cURL

```bash
curl --request POST \
  --url https://fal.run/fal-ai/flux-pulid \
  --header "Authorization: Key $FAL_KEY" \
  --header "Content-Type: application/json" \
  --data '{
     "prompt": "a woman holding sign with glowing green text 'PuLID for FLUX'",
     "reference_image_url": "https://storage.googleapis.com/falserverless/gallery/example_inputs_liuyifei.png"
   }'
```

### Python

Ensure you have the Python client installed:

```bash
pip install fal-client
```

Then use the API client to make requests:

```python
import fal_client

def on_queue_update(update):
    if isinstance(update, fal_client.InProgress):
        for log in update.logs:
           print(log["message"])

result = fal_client.subscribe(
    "fal-ai/flux-pulid",
    arguments={
        "prompt": "a woman holding sign with glowing green text 'PuLID for FLUX'",
        "reference_image_url": "https://storage.googleapis.com/falserverless/gallery/example_inputs_liuyifei.png"
    },
    with_logs=True,
    on_queue_update=on_queue_update,
)
print(result)
```

### JavaScript

Ensure you have the JavaScript client installed:

```bash
npm install --save @fal-ai/client
```

Then use the API client to make requests:

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

const result = await fal.subscribe("fal-ai/flux-pulid", {
  input: {
    prompt: "a woman holding sign with glowing green text 'PuLID for FLUX'",
    reference_image_url: "https://storage.googleapis.com/falserverless/gallery/example_inputs_liuyifei.png"
  },
  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);
```


## Additional Resources

### Documentation

- [Model Playground](https://fal.ai/models/fal-ai/flux-pulid)
- [API Documentation](https://fal.ai/models/fal-ai/flux-pulid/api)
- [OpenAPI Schema](https://fal.ai/api/openapi/queue/openapi.json?endpoint_id=fal-ai/flux-pulid)

### fal.ai Platform

- [Platform Documentation](https://docs.fal.ai)
- [Python Client](https://docs.fal.ai/clients/python)
- [JavaScript Client](https://docs.fal.ai/clients/javascript)