Upscale 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/topaz/upscale/image", {
input: {
image_url: "https://storage.googleapis.com/falserverless/model_tests/codeformer/codeformer_poor_1.jpeg"
},
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/topaz/upscale/image", {
input: {
image_url: "https://storage.googleapis.com/falserverless/model_tests/codeformer/codeformer_poor_1.jpeg"
},
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/topaz/upscale/image", {
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/topaz/upscale/image", {
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 image to be upscaled
model ModelEnumModel to use for image enhancement, grouped by family. Precision — Standard V2 fits most photos, High Fidelity V2 preserves detail in professional shots, Low Resolution V2 recovers compressed sources, CGI targets art and rendered graphics, Text Refine keeps text and shapes crisp. Generative — Wonder 3 is Topaz's most advanced generative model, Redefine adds prompt-guided creative detail, Standard MAX maximizes quality, Recovery/Recovery V2 rebuild extreme low-resolution images. Default value: "Standard V2"
Possible enum values: Standard V2, High Fidelity V2, Low Resolution V2, CGI, Text Refine, Wonder 3, Wonder, Standard MAX, Redefine, Recovery V2, Recovery
upscale_factor floatFactor to upscale the image by (e.g. 2.0 doubles width and height) Default value: 2
crop_to_fill booleanoutput_format OutputFormatEnumOutput format of the upscaled image. Default value: "jpeg"
Possible enum values: jpeg, png
subject_detection SubjectDetectionEnumSubject detection mode for the image enhancement. Applies to standard enhance and Recovery V2 models. Default value: "All"
Possible enum values: All, Foreground, Background
face_enhancement booleanWhether to apply face enhancement to the image. Applies to standard enhance and Recovery V2 models. Default value: true
face_enhancement_creativity floatCreativity level for face enhancement. 0.0 means no creativity, 1.0 means maximum creativity. Ignored if face enhancement is disabled.
face_enhancement_strength floatStrength of the face enhancement. 0.0 means no enhancement, 1.0 means maximum enhancement. Ignored if face enhancement is disabled. Default value: 0.8
sharpen floatSharpening level (0.0-1.0). Applies to Standard V2, Low Resolution V2, CGI, High Fidelity V2, Text Refine, and Redefine models.
denoise floatDenoising level (0.0-1.0). Applies to Standard V2, Low Resolution V2, CGI, High Fidelity V2, Text Refine, and Redefine models.
fix_compression floatCompression artifact removal level (0.0-1.0). Applies to Standard V2, Low Resolution V2, High Fidelity V2, and Text Refine models.
strength floatEnhancement strength (0.01-1.0). Applies to Text Refine model only.
creativity integerCreativity level for generative upscaling (1-6). Higher values produce more creative/hallucinated details. Applies to Redefine model only.
texture integerTexture detail level for generative upscaling (1-5). Applies to Redefine model only.
prompt stringText prompt to guide generative upscaling (max 1024 chars). Applies to Redefine model only.
autoprompt booleanEnable automatic prompt generation for generative upscaling. Applies to Redefine model only.
detail floatDetail recovery level (0.0-1.0). Applies to Recovery V2 model only.
enhancement_strength EnumEnhancement strength for generative upscaling. Applies to Wonder 3 model only. When omitted, Topaz auto-configures it.
Possible enum values: low, medium, high
{
"image_url": "https://storage.googleapis.com/falserverless/model_tests/codeformer/codeformer_poor_1.jpeg",
"model": "Standard V2",
"upscale_factor": 2,
"output_format": "jpeg",
"subject_detection": "All",
"face_enhancement": true,
"face_enhancement_strength": 0.8
}The upscaled image.
{
"image": {
"url": "",
"content_type": "image/png",
"file_name": "z9RV14K95DvU.png",
"file_size": 4404019
}
}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.