Loading API documentation
Edit
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/hidream-o1-image/dev/edit", {
input: {
prompt: "A cinematic product photo of a ceramic mug on a marble counter, soft window light, shallow depth of field.",
reference_image_urls: ["https://storage.googleapis.com/falserverless/model_tests/hidream/woman.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);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/hidream-o1-image/dev/edit", {
input: {
prompt: "A cinematic product photo of a ceramic mug on a marble counter, soft window light, shallow depth of field.",
reference_image_urls: ["https://storage.googleapis.com/falserverless/model_tests/hidream/woman.png"]
},
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/hidream-o1-image/dev/edit", {
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/hidream-o1-image/dev/edit", {
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.
prompt string* requiredText prompt for image generation, editing, or subject-driven personalization.
Reference images for image editing or subject-driven personalization.
Requested output image size. Reference-image outputs use the nearest model-supported resolution up to about 2048x2048 pixels.
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
}num_inference_steps integerNumber of denoising steps. The dev model is distilled for 28 steps. Default value: 28
guidance_scale floatClassifier-free guidance scale. The dev model uses 0.0 by default.
seed integerRandom seed for reproducible generation.
num_images integerNumber of images to generate. Default value: 1
output_format OutputFormatEnumThe format of the generated image. Default value: "png"
Possible enum values: jpeg, png, webp
sync_mode booleanIf True, the media will be returned as a data URI and the output data won't be available in the request history.
enable_safety_checker booleanEnable the safety checker on generated images. Default value: true
keep_original_aspect booleanWhen exactly one reference image is provided, preserve its aspect ratio for the output image.
{
"prompt": "A cinematic product photo of a ceramic mug on a marble counter, soft window light, shallow depth of field.",
"reference_image_urls": [
"https://storage.googleapis.com/falserverless/model_tests/hidream/woman.png"
],
"image_size": {
"width": 2048,
"height": 2048
},
"num_inference_steps": 28,
"num_images": 1,
"output_format": "png",
"enable_safety_checker": true
}Generated images.
seed integer* requiredThe seed used for generation.
Whether each generated image was flagged by the safety checker.
prompt string* requiredThe prompt used for generation.
Generation timings.
{
"images": [
{
"url": "",
"content_type": "image/png",
"file_name": "z9RV14K95DvU.png",
"file_size": 4404019
}
],
"prompt": ""
}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
height integerThe height of the image
width integerThe width of the generated image. Default value: 512
height integerThe height of the generated image. Default value: 512