Loading API documentation
Generate Image
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientSet 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/clarity-upscaler", {
input: {
image_url: "https://storage.googleapis.com/falserverless/gallery/NOCA_Mick-Thompson.resized.resized.jpg"
},
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"
});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/clarity-upscaler", {
input: {
image_url: "https://storage.googleapis.com/falserverless/gallery/NOCA_Mick-Thompson.resized.resized.jpg"
},
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/clarity-upscaler", {
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/clarity-upscaler", {
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);Read more about file handling in our file upload guide.
image_url string* requiredThe URL of the image to upscale.
prompt stringThe prompt to use for generating the image. Be as descriptive as possible for best results. Default value: "masterpiece, best quality, highres"
upscale_factor floatThe upscale factor Default value: 2
negative_prompt stringThe negative prompt to use. Use it to address details that you don't want in the image. Default value: "(worst quality, low quality, normal quality:2)"
creativity floatThe creativity of the model. The higher the creativity, the more the model will deviate from the prompt.
Refers to the denoise strength of the sampling. Default value: 0.35
resemblance floatThe resemblance of the upscaled image to the original image. The higher the resemblance, the more the model will try to keep the original image.
Refers to the strength of the ControlNet. Default value: 0.6
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: 4
num_inference_steps integerThe number of inference steps to perform. Default value: 18
seed integerThe same seed and the same prompt given to the same version of Stable Diffusion will output the same image every time.
enable_safety_checker booleanIf set to false, the safety checker will be disabled. Default value: true
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.
{
"image_url": "https://storage.googleapis.com/falserverless/gallery/NOCA_Mick-Thompson.resized.resized.jpg",
"prompt": "masterpiece, best quality, highres",
"upscale_factor": 2,
"negative_prompt": "(worst quality, low quality, normal quality:2)",
"creativity": 0.35,
"resemblance": 0.6,
"guidance_scale": 4,
"num_inference_steps": 18,
"enable_safety_checker": true
}The URL of the generated image.
seed integer* requiredThe seed used to generate the image.
The timings of the different steps in the workflow.
{
"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.