Skip to main content
Endpoint: POST https://fal.run/fal-ai/ideogram/v3 Endpoint ID: fal-ai/ideogram/v3

Try it in the Playground

Run this model interactively with your own prompts.

Quick Start

import fal_client

def on_queue_update(update):
    if isinstance(update, fal_client.InProgress):
        for log in update.logs:
           print(log["message"])

result = fal_client.subscribe(
    "fal-ai/ideogram/v3",
    arguments={
        "prompt": "The Bone Forest stretched across the horizon, its trees fashioned from the ossified remains of ancient leviathans that once swam through the sky. Shamans with antlers growing from their shoulders and eyes that revealed the true nature of any being they beheld conducted rituals to commune with the spirits that still inhabited the calcified grove. In sky writes \"Ideogram V3 in fal.ai\""
    },
    with_logs=True,
    on_queue_update=on_queue_update,
)
print(result)

Input Schema

image_urls
list<string>
A set of images to use as style references (maximum total size 10MB across all style references). The images should be in JPEG, PNG or WebP format
rendering_speed
RenderingSpeedEnum
default:"BALANCED"
The rendering speed to use. Default value: "BALANCED"Possible values: TURBO, BALANCED, QUALITY
color_palette
ColorPalette
A color palette for generation, must EITHER be specified via one of the presets (name) or explicitly via hexadecimal representations of the color with optional weights (members)
style_codes
list<string>
A list of 8 character hexadecimal codes representing the style of the image. Cannot be used in conjunction with style_reference_images or style
style
Enum
The style type to generate with. Cannot be used with style_codes.Possible values: AUTO, GENERAL, REALISTIC, DESIGN
expand_prompt
boolean
default:"true"
Determine if MagicPrompt should be used in generating the request or not. Default value: true
num_images
integer
default:"1"
Number of images to generate. Default value: 1Range: 1 to 8
seed
integer
Seed for the random number generator
sync_mode
boolean
default:"false"
If True, the media will be returned as a data URI and the output data won’t be available in the request history.
style_preset
Enum
Style preset for generation. The chosen style preset will guide the generation.Possible values: 80S_ILLUSTRATION, 90S_NOSTALGIA, ABSTRACT_ORGANIC, ANALOG_NOSTALGIA, ART_BRUT, ART_DECO, ART_POSTER, AURA, AVANT_GARDE, BAUHAUS, BLUEPRINT, BLURRY_MOTION, BRIGHT_ART, C4D_CARTOON, CHILDRENS_BOOK, COLLAGE, COLORING_BOOK_I, COLORING_BOOK_II, CUBISM, DARK_AURA, DOODLE, DOUBLE_EXPOSURE, DRAMATIC_CINEMA, EDITORIAL, EMOTIONAL_MINIMAL, ETHEREAL_PARTY, EXPIRED_FILM, FLAT_ART, FLAT_VECTOR, FOREST_REVERIE, GEO_MINIMALIST, GLASS_PRISM, GOLDEN_HOUR, GRAFFITI_I, GRAFFITI_II, HALFTONE_PRINT, HIGH_CONTRAST, HIPPIE_ERA, ICONIC, JAPANDI_FUSION, JAZZY, LONG_EXPOSURE, MAGAZINE_EDITORIAL, MINIMAL_ILLUSTRATION, MIXED_MEDIA, MONOCHROME, NIGHTLIFE, OIL_PAINTING, OLD_CARTOONS, PAINT_GESTURE, POP_ART, RETRO_ETCHING, RIVIERA_POP, SPOTLIGHT_80S, STYLIZED_RED, SURREAL_COLLAGE, TRAVEL_POSTER, VINTAGE_GEO, VINTAGE_POSTER, WATERCOLOR, WEIRD, WOODBLOCK_PRINT
prompt
string
required
image_size
ImageSize | Enum
default:"square_hd"
The resolution of the generated image Default value: square_hdPossible values: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9
negative_prompt
string
default:""
Description of what to exclude from an image. Descriptions in the prompt take precedence to descriptions in the negative prompt. Default value: ""

Output Schema

images
list<File>
required
seed
integer
required
Seed used for the random number generator

Input Example

{
  "rendering_speed": "BALANCED",
  "expand_prompt": true,
  "num_images": 1,
  "sync_mode": false,
  "prompt": "The Bone Forest stretched across the horizon, its trees fashioned from the ossified remains of ancient leviathans that once swam through the sky. Shamans with antlers growing from their shoulders and eyes that revealed the true nature of any being they beheld conducted rituals to commune with the spirits that still inhabited the calcified grove. In sky writes \"Ideogram V3 in fal.ai\"",
  "image_size": "square_hd",
  "negative_prompt": ""
}

Output Example

{
  "images": [
    {
      "url": "https://v3.fal.media/files/penguin/lHdRabS80guysb8Zw1kul_image.png"
    }
  ],
  "seed": 123456
}

Limitations

  • rendering_speed restricted to: TURBO, BALANCED, QUALITY
  • style restricted to: AUTO, GENERAL, REALISTIC, DESIGN
  • num_images range: 1 to 8
  • image_size restricted to: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9
  • rendering_speed restricted to: FLASH, TURBO, BALANCED, QUALITY
  • strength range: 0.01 to 1