Loading API documentation
Ideogram V46
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("ideogram/v4.6", {
input: {
prompt: "A colorful storefront with a sign reading hello"
},
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("ideogram/v4.6", {
input: {
prompt: "A colorful storefront with a sign reading hello"
},
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.6", {
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.6", {
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.
prompt string* requiredThe generation or editing prompt.
Output size. auto lets the model pick a size of about 2K. Named presets use standard fal dimensions. Explicit dimensions must be at least 256 per side, multiples of 32, at most 4096 per side, with an aspect ratio within 1:6 and 6:1. Outputs larger than 2048x2048 in area are billed at the 4K price. Default value: auto
Possible enum values: auto, square, square_hd, portrait_4_3, landscape_4_3, portrait_16_9, landscape_16_9
Note: For custom image sizes, you can pass the width and height as an object:
"image_size": {
"width": 1280,
"height": 720
}quality QualityEnumText-to-image quality. very_low renders at most 2K, so it rejects an explicit image_size larger than 2048x2048 in area. Default value: "medium"
Possible enum values: very_low, low, medium, high
background Enumtransparent returns an image with an alpha channel; opaque forces a solid background. Leave unset for the model default.
Possible enum values: transparent, opaque
enable_prompt_expansion booleanEnable partner prompt expansion. Default value: true
num_images integerNumber of images to generate. Default value: 1
seed integerRandom seed. Omit to choose automatically.
sync_mode booleanReturn image data directly in the response.
enable_safety_checker booleanAuthorized callers may set false to request relaxed screening. Default value: true
{
"prompt": "A colorful storefront with a sign reading hello",
"image_size": "auto",
"quality": "medium",
"enable_prompt_expansion": true,
"num_images": 1,
"enable_safety_checker": true
}seed integer* requiredSeed used for the random number generator
{
"images": [
{
"url": "https://v3.fal.media/files/penguin/lHdRabS80guysb8Zw1kul_image.png"
}
],
"seed": 123456
}width integerThe width of the generated image. Default value: 512
height integerThe height of the generated image. Default value: 512
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.