Loading API documentation
Depth To 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("speridlabs/iris-z/depth-to-image", {
input: {
depth_image_url: "https://v3b.fal.media/files/b/0ab2162d/EAn6KNdG-1qqxttNmLiGD.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"
});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("speridlabs/iris-z/depth-to-image", {
input: {
depth_image_url: "https://v3b.fal.media/files/b/0ab2162d/EAn6KNdG-1qqxttNmLiGD.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("speridlabs/iris-z/depth-to-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("speridlabs/iris-z/depth-to-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);Read more about file handling in our file upload guide.
depth_image_url string* requiredURL of the depth map to paint an image from.
depth_format DepthFormatEnumHow to read the depth map: depth (bright = far), disparity (bright = near), or colorized (the colored depth image returned by this model's depth endpoints). Default value: "colorized"
Possible enum values: depth, disparity, colorized
prompt stringThe prompt to generate an image from. Prompts are truncated to 512 text-encoder tokens. Leave empty for an unconditional image. Default value: ""
resolution ResolutionEnumOutput resolution tier; the depth map's aspect ratio is kept. Default value: "1024"
Possible enum values: 512, 1024
num_inference_steps integerThe number of inference steps to perform. Default value: 50
guidance_scale floatClassifier-free guidance scale. Defaults to the model's own value (3.5 for Iris-Z, 4.0 for Iris-Z small).
seed integerThe same seed, prompt and depth map given to the same version of the model will output the same image every time.
output_format OutputFormatEnumThe format of the generated image. Default value: "png"
Possible enum values: png, jpeg
enable_safety_checker booleanIf set to true, the safety checker will be enabled. Disabling it requires account authorization; unauthorized requests are always checked, and images flagged as unsafe are returned as black images. Default value: true
{
"depth_image_url": "https://v3b.fal.media/files/b/0ab2162d/EAn6KNdG-1qqxttNmLiGD.png",
"depth_format": "colorized",
"prompt": "the same street in winter, snow on the rooftops",
"resolution": "1024",
"num_inference_steps": 50,
"output_format": "png",
"enable_safety_checker": true
}The generated images.
seed integer* requiredThe seed used for generation.
Whether the generated images contain NSFW concepts.
prompt string* requiredThe prompt used for generation.
{
"images": [
{
"url": "",
"content_type": "image/png",
"file_name": "z9RV14K95DvU.png",
"file_size": 4404019,
"width": 1024,
"height": 1024
}
],
"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 in pixels.
height integerThe height of the image in pixels.