Migrate to @fal-ai/client
The @fal-ai/serverless-client
package has been deprecated in favor of @fal-ai/client
. Please check the migration guide for more information.
fal-ai/face-to-sticker
Generate Image
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/client
@fal-ai/client
The @fal-ai/serverless-client
package has been deprecated in favor of @fal-ai/client
. Please check the migration guide for more information.
Set 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/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);
}
},
});
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"
});
When running code on the client-side (e.g. in a browser, mobile app or GUI applications), make sure to not expose your FAL_KEY
. Instead, use a server-side proxy to make requests to the API. For more information, check out our server-side integration guide.
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/face-to-sticker", {
input: {
image_url: "https://storage.googleapis.com/falserverless/model_tests/face_to_sticker/elon.jpg",
prompt: "a person"
},
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/face-to-sticker", {
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/face-to-sticker", {
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);
The client will auto-upload the file for you if you pass a binary object (e.g. File
, Data
).
Read more about file handling in our file upload guide.
image_url
string
* requiredURL of the video.
prompt
string
* requiredThe prompt to use for generating the image. Be as descriptive as possible for best results.
negative_prompt
string
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_steps
integer
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_scale
float
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_strength
float
The strength of the instant ID. Default value: 0.7
ip_adapter_weight
float
The weight of the IP adapter. Default value: 0.2
ip_adapter_noise
float
The amount of noise to add to the IP adapter. Default value: 0.5
The size of the generated image. Default value: square_hd
Possible enum values: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9
Note: For custom image sizes, you can pass the width
and height
as an object:
"image_size": {
"width": 1280,
"height": 720
}
upscale
boolean
Whether to upscale the image 2x.
upscale_steps
integer
The number of steps to use for upscaling. Only used if upscale
is true
. Default value: 10
seed
integer
The same seed and the same prompt given to the same version of Stable Diffusion will output the same image every time.
enable_safety_checker
boolean
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
}
The generated images.
The generated face sticker image.
The generated face sticker image with the background removed.
seed
integer
* requiredSeed used during the inference.
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
}
}
width
integer
The width of the generated image. Default value: 512
height
integer
The height of the generated image. Default value: 512
url
string
* requiredThe 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.