Ideogram v3 (Edit)

{
  "model_id": "fal-ai/ideogram/v3/edit",
  "prompt": "Add a breathtaking outdoor ballet performance to this plaza — a principal dancer in a white tutu performing an arabesque on a raised circular stage, surrounded by dozens of audience members in elegant evening wear holding candles, the architecture decorated with hanging lanterns and floral garlands, magical atmosphere",
  "mask_url": "your_mask_url",
  "reference_image_url": "https://example.com/reference_image"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://www.artemotion.ai/api/v1/models?id=fal-ai%2Fideogram%2Fv3%2Fedit",
  "title": "Ideogram v3 (Edit) generation request",
  "description": "Request body accepted by POST /api/v1/generate for fal-ai/ideogram/v3/edit.",
  "type": "object",
  "properties": {
    "model_id": {
      "type": "string",
      "const": "fal-ai/ideogram/v3/edit",
      "description": "ArtEmotion model identifier."
    },
    "extra": {
      "type": "object",
      "additionalProperties": true,
      "description": "Model-specific settings may also be nested here."
    },
    "max_credits": {
      "type": "number",
      "minimum": 1,
      "description": "Reject before submission if the estimated list price exceeds this cap."
    },
    "webhook_url": {
      "type": "string",
      "format": "uri",
      "maxLength": 2048
    },
    "webhook_secret": {
      "type": "string",
      "maxLength": 512
    },
    "folder_id": {
      "type": "string"
    },
    "prompt": {
      "type": "string"
    },
    "style_preset": {
      "title": "Style Preset",
      "description": "Style preset for generation. The chosen style preset will guide the generation.",
      "type": "string",
      "enum": [
        "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"
      ]
    },
    "expand_prompt": {
      "title": "Expand Prompt",
      "description": "Determine if MagicPrompt should be used in generating the request or not.",
      "default": true,
      "type": "boolean"
    },
    "mask_url": {
      "title": "Mask Url",
      "description": "Handled by the canvas mask editor.",
      "type": "string"
    },
    "color_palette": {
      "title": "Color Palette",
      "description": "A color palette preset to guide the colors of the generated image.",
      "type": "string",
      "enum": [
        "EMBER",
        "FRESH",
        "JUNGLE",
        "MAGIC",
        "MELON",
        "MOSAIC",
        "PASTEL",
        "ULTRAMARINE"
      ]
    },
    "style_codes": {
      "title": "Style Codes",
      "description": "List of 8-character hex style codes to guide the image style. Cannot be used with style_preset or image_urls.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "image_urls": {
      "title": "Style Reference Images",
      "description": "URLs of images to use as style references (max 10MB total, JPEG/PNG/WebP). Cannot be used with style_codes.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "seed": {
      "title": "Seed",
      "description": "Seed for the random number generator",
      "type": "integer"
    },
    "aspect_ratio": {
      "type": "string",
      "enum": [
        "1:1",
        "16:9",
        "9:16",
        "4:3",
        "3:4"
      ]
    },
    "resolution": {
      "type": "string",
      "enum": [
        "1024"
      ]
    },
    "quality": {
      "type": "string",
      "enum": [
        "low",
        "medium",
        "high"
      ]
    },
    "num_images": {
      "type": "integer",
      "minimum": 1,
      "maximum": 4
    },
    "reference_image_url": {
      "type": "string",
      "format": "uri"
    }
  },
  "required": [
    "model_id",
    "prompt",
    "mask_url",
    "reference_image_url"
  ],
  "additionalProperties": false
}