Loading API documentation
Stream a text-to-image generation with user-supplied LoRA weights.
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("ideogram/v4/lora/stream", {
input: {
prompt: "A red panda perched on a mossy branch in a misty forest at sunrise"
},
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("ideogram/v4/lora/stream", {
input: {
prompt: "A red panda perched on a mossy branch in a misty forest at sunrise"
},
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("ideogram/v4/lora/stream", {
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("ideogram/v4/lora/stream", {
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* requiredThe prompt to generate an image from.
expansion_model ExpansionModelEnumWhich model expands the prompt. 'None' disables prompt expansion and skips its fee; 'Medium' is fast; 'Large' uses Ideogram's Magic Prompt for the highest quality. Default value: "Medium"
Possible enum values: None, Medium, Large
The resolution of the generated image. Default value: square_hd
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
}rendering_speed RenderingSpeedEnumThe rendering speed to use. Faster speeds use fewer denoising steps. Default value: "BALANCED"
Possible enum values: TURBO, BALANCED, QUALITY
acceleration AccelerationEnumThe acceleration level to use for the image generation. Default value: "none"
Possible enum values: none, low, regular, high
seed integerThe seed to use for generation. If not provided, a random seed will be used.
sync_mode booleanIf True, the image is returned as a data URI and is not stored.
enable_safety_checker booleanIf set to true, the safety checker will be enabled. Disabling it requires account authorization; unauthorized requests are always checked. Default value: true
output_format OutputFormatEnumThe format of the generated image. Default value: "jpeg"
Possible enum values: jpeg, png
List of LoRA weights to apply (maximum 3).
{
"prompt": "A red panda perched on a mossy branch in a misty forest at sunrise",
"expansion_model": "Large",
"image_size": "square_hd",
"rendering_speed": "BALANCED",
"acceleration": "none",
"enable_safety_checker": true,
"output_format": "jpeg",
"loras": []
}width integerThe width of the generated image. Default value: 512
height integerThe height of the generated image. Default value: 512
path string* requiredURL to an Ideogram V4 LoRA weights file (.safetensors).
scale floatScale factor for the LoRA weights. Default value: 1