Face to Sticker

fal-ai/face-to-sticker
Inference
Research only

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/face-to-sticker", {
  input: {
    image_url: "https://storage.googleapis.com/falserverless/model_tests/face_to_sticker/elon.jpg",
    prompt: "a person"
  },
  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/face-to-sticker", { image_url: url });

Read more about file handling in our file upload guide.

4. Schema#

Input#

image_url*string

URL of the video.

prompt*string

The prompt to use for generating the image. Be as descriptive as possible for best results.

negative_promptstring

The negative prompt to use. Use it to address details that you don't want in the image. This could be colors, objects, scenery and even the small details (e.g. moustache, blurry, low resolution). Default value: ""

num_inference_stepsinteger

Increasing the amount of steps tells Stable Diffusion that it should take more steps to generate your final result which can increase the amount of detail in your image. Default value: 20

guidance_scalefloat

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.5

instant_id_strengthfloat

The strength of the instant ID. Default value: 0.7

ip_adapter_weightfloat

The weight of the IP adapter. Default value: 0.2

ip_adapter_noisefloat

The amount of noise to add to the IP adapter. Default value: 0.5

image_sizeImageSize | Enum

The size of the generated image. Default value: square_hd

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

upscaleboolean

Whether to upscale the image 2x.

upscale_stepsinteger

The number of steps to use for upscaling. Only used if upscale is true. Default value: 10

seedinteger

The same seed and the same prompt given to the same version of Stable Diffusion will output the same image every time.

enable_safety_checkerboolean

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

{
  "image_url": "https://storage.googleapis.com/falserverless/model_tests/face_to_sticker/elon.jpg",
  "prompt": "a person",
  "num_inference_steps": 20,
  "guidance_scale": 4.5,
  "instant_id_strength": 0.7,
  "ip_adapter_weight": 0.2,
  "ip_adapter_noise": 0.5,
  "image_size": "square_hd",
  "upscale_steps": 10,
  "enable_safety_checker": true
}

Output#

images*list<Image>

The generated images.

sticker_image*Image

The generated face sticker image.

sticker_image_background_removed*Image

The generated face sticker image with the background removed.

seed*integer

Seed used during the inference.

has_nsfw_concepts*Has Nsfw Concepts

Whether the generated images contain NSFW concepts. The key is the image type and the value is a boolean.

{
  "images": [
    {
      "file_size": 560358,
      "height": 1024,
      "file_name": "cd8bab71b946470099d5fa20c7eed440.png",
      "content_type": "image/PNG",
      "url": "https://storage.googleapis.com/falserverless/model_tests/face_to_sticker/elon_output_1.png",
      "width": 1024
    },
    {
      "file_size": 452906,
      "height": 1024,
      "file_name": "181ae8fa12534c6f9285a991b415d9a7.png",
      "content_type": "image/PNG",
      "url": "https://storage.googleapis.com/falserverless/model_tests/face_to_sticker/elon_output_2.png",
      "width": 1024
    }
  ],
  "sticker_image": {
    "file_size": 560358,
    "height": 1024,
    "file_name": "cd8bab71b946470099d5fa20c7eed440.png",
    "content_type": "image/PNG",
    "url": "https://storage.googleapis.com/falserverless/model_tests/face_to_sticker/elon_output_1.png",
    "width": 1024
  },
  "sticker_image_background_removed": {
    "file_size": 452906,
    "height": 1024,
    "file_name": "181ae8fa12534c6f9285a991b415d9a7.png",
    "content_type": "image/PNG",
    "url": "https://storage.googleapis.com/falserverless/model_tests/face_to_sticker/elon_output_2.png",
    "width": 1024
  },
  "seed": 3625437076,
  "has_nsfw_concepts": {
    "sticker_image": false,
    "sticker_image_background_removed": false
  }
}