Loading API documentation
Generate Image
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientThe @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Install the new package and update your imports — see client setup.
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/ip-adapter-face-id", {
input: {
prompt: "Man cyberpunk, synthwave night city, futuristic, high quality, highly detailed, high resolution, sharp, hyper realistic, extremely detailed"
},
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/ip-adapter-face-id", {
input: {
prompt: "Man cyberpunk, synthwave night city, futuristic, high quality, highly detailed, high resolution, sharp, hyper realistic, extremely detailed"
},
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/ip-adapter-face-id", {
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/ip-adapter-face-id", {
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.
model_type ModelTypeEnumThe model type to use. 1_5 is the default and is recommended for most use cases. Default value: "1_5-v1"
Possible enum values: 1_5-v1, 1_5-v1-plus, 1_5-v2-plus, SDXL-v1, SDXL-v2-plus, 1_5-auraface-v1
prompt string* requiredThe prompt to use for generating the image. Be as descriptive as possible for best results.
face_image_url stringAn image of a face to match. If an image with a size of 640x640 is not provided, it will be scaled and cropped to that size.
face_images_data_url stringURL to zip archive with images of faces. The images embedding will be averaged to create a more accurate face id.
negative_prompt stringThe 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: "blurry, low resolution, bad, ugly, low quality, pixelated, interpolated, compression artifacts, noisey, grainy"
seed integerThe same seed and the same prompt given to the same version of Stable Diffusion will output the same image every time.
guidance_scale floatThe 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: 7.5
num_inference_steps integerThe number of inference steps to use for generating the image. The more steps
the better the image will be but it will also take longer to generate. Default value: 50
num_samples integerThe number of samples for face id. The more samples the better the image will
be but it will also take longer to generate. Default is 4. Default value: 4
width integerThe width of the generated image. Default value: 512
height integerThe height of the generated image. Default value: 512
face_id_det_size integerThe size of the face detection model. The higher the number the more accurate
the detection will be but it will also take longer to run. The higher the number the more
likely it will fail to find a face as well. Lower it if you are having trouble
finding a face in the image. Default value: 640
base_1_5_model_repo stringThe URL to the base 1.5 model. Default is SG161222/Realistic_Vision_V4.0_noVAE Default value: "SG161222/Realistic_Vision_V4.0_noVAE"
base_sdxl_model_repo stringThe URL to the base SDXL model. Default is SG161222/RealVisXL_V3.0 Default value: "SG161222/RealVisXL_V3.0"
enable_safety_checker booleanAuthorized callers may set false to request relaxed screening. Default value: true
{
"model_type": "1_5-v1",
"prompt": "Man cyberpunk, synthwave night city, futuristic, high quality, highly detailed, high resolution, sharp, hyper realistic, extremely detailed",
"face_image_url": "https://storage.googleapis.com/falserverless/model_tests/upscale/image%20(8).png",
"negative_prompt": "blurry, low resolution, bad, ugly, low quality, pixelated, interpolated, compression artifacts, noisey, grainy",
"seed": 42,
"guidance_scale": 7.5,
"num_inference_steps": 50,
"num_samples": 4,
"width": 512,
"height": 512,
"face_id_det_size": 640,
"base_1_5_model_repo": "SG161222/Realistic_Vision_V4.0_noVAE",
"base_sdxl_model_repo": "SG161222/RealVisXL_V3.0",
"enable_safety_checker": true
}The generated image file info.
seed integer* requiredSeed 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.
{
"image": {
"url": "",
"content_type": "image/png",
"file_name": "z9RV14K95DvU.png",
"file_size": 4404019,
"width": 1024,
"height": 1024
}
}url string* requiredThe URL where the file can be downloaded from.
content_type stringThe mime type of the file.
file_name stringThe name of the file. It will be auto-generated if not provided.
file_size integerThe size of the file in bytes.
width integerThe width of the image in pixels.
height integerThe height of the image in pixels.