Skip to main content
Glama

Generate images

ideogram_generate

Create images from text prompts using Ideogram's API models and save results to the output directory.

Instructions

Create images from a text prompt with any image model Ideogram's API sells: Ideogram 4.5, 4.0 and 3.0 (with transparent, character and custom-model variants), 2a and 2.0, GPT Image, Nano Banana, P-Image, Z-Image, or auto. Each model takes its own fields (one variant per model in this schema). Default model: ideogram-3. Results are saved to the output directory; ideogram_quote prices a call first (nothing is generated).

Input Schema

NameRequiredDescriptionDefault
maskNoLocal mask image file or a public https URL, the same size as the source
seedNoRandom seed for a reproducible result
sizeNoOutput size: "auto", "source" (needs source images) or WIDTHxHEIGHT
modelNoThe model (default ideogram-3); each takes the fields of its variant below
imagesNoLocal source image files or public https URLs (the first is the one edited)
promptNoWhat to create or change, in natural language
wait_sNoSeconds to wait for the result (0-50, default 45). The job is accepted first; if it is still running when the wait ends, the result is its generation_id for ideogram_generation (never resubmitted, never billed twice).
privateNoKeep the result out of Ideogram's public feed; true unless you set false (enterprise accounts are always private)
qualityNovery_low, low, medium or high: higher costs more
num_imagesNoHow many images to make (each is billed)
resolutionNoExact output size WIDTHxHEIGHT from the model's list; not with aspect_ratio
style_typeNoVisual style family
style_codesNo8-character hexadecimal style codes
aspect_ratioNoOutput aspect ratio such as 16x9; not with resolution
magic_promptNoauto, on or off: let Ideogram rewrite the prompt
style_presetNoA named style preset; not with style codes or style references
color_paletteNoA preset palette by name, or explicit hex colours with weights
inline_imagesNotrue: each saved image is also returned as image content (base64; one over 3.75 MB, or past 10 MB in total, by path only), for a client without file access
upscale_factorNox2, x4 or x8
negative_promptNoWhat to keep out of the image
rendering_speedNoturbo, default or quality: faster is cheaper
resolution_tierNoThe output resolution tier
custom_model_uriNoA custom model you trained or were given access to
style_reference_imagesNoLocal image files (or public https URLs) whose style the result follows
image_asset_identifiersNoIdeogram assets instead of local source images
character_reference_maskNoLocal grayscale mask (or a public https URL) of where the character is in its reference image
character_reference_imagesNoLocal image files (or public https URLs) of the character to keep consistent
enable_copyright_detectionNoRun Ideogram's copyright detection on the result (adds latency)
style_reference_collection_idNoA saved style collection to apply
style_reference_asset_identifiersNoIdeogram assets (uploads or earlier results) to use as style references
character_reference_asset_identifiersNoIdeogram assets to use as the character reference
style_reference_collection_version_idNoA version of the saved style collection

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed74 schema fields changedv2.5.0
    • changedInput schema / additionalProperties
      Previous value: -falseNew value: +{}
    • addedInput schema / definitions
      Added value: +{
      +  "__schema0": {
      +    "properties": {
      +      "asset_id": {
      +        "type": "string"
      +      },
      +      "asset_type": {
      +        "enum": [
      +          "ASSET",
      +          "CANVAS_ASSET",
      +          "LAYERED_ASSET",
      +          "RESPONSE",
      +          "UPLOAD"
      +        ],
      +        "type": "string"
      +      },
      +      "collection_id": {
      +        "maxLength": 22,
      +        "minLength": 22,
      +        "pattern": "^[A-Za-z0-9_-]{22}$",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "asset_id",
      +      "asset_type"
      +    ],
      +    "type": "object"
      +  },
      +  "__schema10": {
      +    "enum": [
      +      "512x1536",
      +      "576x1408",
      +      "576x1472",
      +      "576x1536",
      +      "640x1344",
      +      "640x1408",
      +      "640x1472",
      +      "640x1536",
      +      "704x1152",
      +      "704x1216",
      +      "704x1280",
      +      "704x1344",
      +      "704x1408",
      +      "704x1472",
      +      "736x1312",
      +      "768x1088",
      +      "768x1216",
      +      "768x1280",
      +      "768x1344",
      +      "800x1280",
      +      "832x960",
      +      "832x1024",
      +      "832x1088",
      +      "832x1152",
      +      "832x1216",
      +      "832x1248",
      +      "864x1152",
      +      "896x960",
      +      "896x1024",
      +      "896x1088",
      +      "896x1120",
      +      "896x1152",
      +      "960x832",
      +      "960x896",
      +      "960x1024",
      +      "960x1088",
      +      "1024x832",
      +      "1024x896",
      +      "1024x960",
      +      "1024x1024",
      +      "1088x768",
      +      "1088x832",
      +      "1088x896",
      +      "1088x960",
      +      "1120x896",
      +      "1152x704",
      +      "1152x832",
      +      "1152x864",
      +      "1152x896",
      +      "1216x704",
      +      "1216x768",
      +      "1216x832",
      +      "1248x832",
      +      "1280x704",
      +      "1280x768",
      +      "1280x800",
      +      "1312x736",
      +      "1344x640",
      +      "1344x704",
      +      "1344x768",
      +      "1408x576",
      +      "1408x640",
      +      "1408x704",
      +      "1472x576",
      +      "1472x640",
      +      "1472x704",
      +      "1536x512",
      +      "1536x576",
      +      "1536x640"
      +    ],
      +    "type": "string"
      +  },
      +  "__schema11": {
      +    "pattern": "^[0-9a-fA-F]{8}$",
      +    "type": "string"
      +  },
      +  "__schema12": {
      +    "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"
      +    ],
      +    "type": "string"
      +  },
      +  "__schema17": {
      +    "enum": [
      +      "2048x2048",
      +      "1440x2880",
      +      "2880x1440",
      +      "1664x2496",
      +      "2496x1664",
      +      "1792x2240",
      +      "2240x1792",
      +      "1440x2560",
      +      "2560x1440",
      +      "1600x2560",
      +      "2560x1600",
      +      "1728x2304",
      +      "2304x1728",
      +      "1296x3168",
      +      "3168x1296",
      +      "1152x2944",
      +      "2944x1152",
      +      "1248x3328",
      +      "3328x1248",
      +      "1280x3072",
      +      "3072x1280",
      +      "1024x3072",
      +      "3072x1024",
      +      "1024x1024",
      +      "896x1120",
      +      "1120x896",
      +      "864x1152",
      +      "1152x864",
      +      "832x1248",
      +      "1248x832",
      +      "800x1280",
      +      "1280x800",
      +      "720x1280",
      +      "1280x720",
      +      "720x1440",
      +      "1440x720",
      +      "512x1536",
      +      "1536x512"
      +    ],
      +    "type": "string"
      +  },
      +  "__schema19": {
      +    "properties": {
      +      "custom_model_uri": {
      +        "maxLength": 512,
      +        "minLength": 1,
      +        "pattern": "^model\\/[^\\/]+\\/version\\/[^\\/]+$",
      +        "type": "string"
      +      },
      +      "weight": {
      +        "default": 1,
      +        "exclusiveMinimum": 0,
      +        "type": "number"
      +      }
      +    },
      +    "required": [
      +      "custom_model_uri"
      +    ],
      +    "type": "object"
      +  },
      +  "__schema2": {
      +    "enum": [
      +      "auto",
      +      "on",
      +      "off"
      +    ],
      +    "type": "string"
      +  },
      +  "__schema6": {
      +    "enum": [
      +      "auto",
      +      "1x3",
      +      "3x1",
      +      "1x2",
      +      "2x1",
      +      "9x16",
      +      "16x9",
      +      "10x16",
      +      "16x10",
      +      "2x3",
      +      "3x2",
      +      "3x4",
      +      "4x3",
      +      "4x5",
      +      "5x4",
      +      "1x1"
      +    ],
      +    "type": "string"
      +  },
      +  "__schema7": {
      +    "enum": [
      +      "auto",
      +      "general",
      +      "realistic",
      +      "design",
      +      "render_3d",
      +      "anime"
      +    ],
      +    "type": "string"
      +  },
      +  "__schema8": {
      +    "anyOf": [
      +      {
      +        "properties": {
      +          "name": {
      +            "enum": [
      +              "ember",
      +              "fresh",
      +              "jungle",
      +              "magic",
      +              "melon",
      +              "mosaic",
      +              "pastel",
      +              "ultramarine"
      +            ],
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "name"
      +        ],
      +        "type": "object"
      +      },
      +      {
      +        "properties": {
      +          "members": {
      +            "items": {
      +              "$ref": "#/definitions/__schema9"
      +            },
      +            "maxItems": 8,
      +            "minItems": 1,
      +            "type": "array"
      +          }
      +        },
      +        "required": [
      +          "members"
      +        ],
      +        "type": "object"
      +      }
      +    ]
      +  },
      +  "__schema9": {
      +    "properties": {
      +      "color_hex": {
      +        "pattern": "^#(?:[0-9a-fA-F]{3}){1,2}$",
      +        "type": "string"
      +      },
      +      "color_weight": {
      +        "maximum": 1,
      +        "minimum": 0.05,
      +        "type": "number"
      +      }
      +    },
      +    "required": [
      +      "color_hex"
      +    ],
      +    "type": "object"
      +  },
      +  "shared0": {
      +    "items": {
      +      "$ref": "#/definitions/__schema0"
      +    },
      +    "maxItems": 10,
      +    "minItems": 1,
      +    "type": "array"
      +  },
      +  "shared1": {
      +    "maxLength": 10000,
      +    "type": "string"
      +  },
      +  "shared10": {
      +    "items": {
      +      "$ref": "#/definitions/__schema11"
      +    },
      +    "type": "array"
      +  },
      +  "shared11": {
      +    "maxLength": 512,
      +    "minLength": 1,
      +    "pattern": "^model\\/[^\\/]+\\/version\\/[^\\/]+$",
      +    "type": "string"
      +  },
      +  "shared12": {
      +    "enum": [
      +      "turbo",
      +      "default",
      +      "quality"
      +    ],
      +    "type": "string"
      +  },
      +  "shared13": {
      +    "default": "1K",
      +    "enum": [
      +      "1K",
      +      "2K",
      +      "4K"
      +    ],
      +    "type": "string"
      +  },
      +  "shared14": {
      +    "anyOf": [
      +      {
      +        "maximum": 9007199254740991,
      +        "minimum": -9007199254740991,
      +        "type": "integer"
      +      },
      +      {
      +        "type": "null"
      +      }
      +    ]
      +  },
      +  "shared2": {
      +    "default": 1,
      +    "maximum": 8,
      +    "minimum": 1,
      +    "type": "integer"
      +  },
      +  "shared3": {
      +    "maxLength": 10000,
      +    "minLength": 1,
      +    "type": "string"
      +  },
      +  "shared4": {
      +    "maximum": 2147483647,
      +    "minimum": 0,
      +    "type": "integer"
      +  },
      +  "shared5": {
      +    "items": {
      +      "$ref": "#/definitions/__schema0"
      +    },
      +    "maxItems": 16,
      +    "minItems": 1,
      +    "type": "array"
      +  },
      +  "shared7": {
      +    "default": "auto",
      +    "enum": [
      +      "auto",
      +      "transparent",
      +      "opaque"
      +    ],
      +    "type": "string"
      +  },
      +  "shared8": {
      +    "default": "auto",
      +    "enum": [
      +      "auto",
      +      "low",
      +      "medium",
      +      "high"
      +    ],
      +    "type": "string"
      +  },
      +  "shared9": {
      +    "default": "default",
      +    "enum": [
      +      "turbo",
      +      "default",
      +      "quality"
      +    ],
      +    "type": "string"
      +  }
      +}
    • addedInput schema / oneOf
      Added value: +[
      +  {
      +    "properties": {
      +      "aspect_ratio": {
      +        "default": "auto",
      +        "pattern": "^(auto|[1-9][0-9]{0,4}x[1-9][0-9]{0,4})$",
      +        "type": "string"
      +      },
      +      "category_id": {
      +        "maxLength": 22,
      +        "minLength": 22,
      +        "pattern": "^[A-Za-z0-9_-]{22}$",
      +        "type": "string"
      +      },
      +      "image_asset_identifiers": {
      +        "$ref": "#/definitions/shared0"
      +      },
      +      "images": {
      +        "items": {
      +          "type": "string"
      +        },
      +        "maxItems": 10,
      +        "type": "array"
      +      },
      +      "magic_prompt": {
      +        "$ref": "#/definitions/__schema2"
      +      },
      +      "model": {
      +        "const": "auto",
      +        "type": "string"
      +      },
      +      "negative_prompt": {
      +        "$ref": "#/definitions/shared1"
      +      },
      +      "num_images": {
      +        "$ref": "#/definitions/shared2"
      +      },
      +      "private": {
      +        "type": "boolean"
      +      },
      +      "prompt": {
      +        "$ref": "#/definitions/shared3"
      +      },
      +      "resolution": {
      +        "pattern": "^[1-9][0-9]{1,4}x[1-9][0-9]{1,4}$",
      +        "type": "string"
      +      },
      +      "resolution_tier": {
      +        "enum": [
      +          "1k",
      +          "2k",
      +          "4k"
      +        ],
      +        "type": "string"
      +      },
      +      "seed": {
      +        "$ref": "#/definitions/shared4"
      +      },
      +      "style_reference_asset_identifiers": {
      +        "$ref": "#/definitions/shared0"
      +      }
      +    },
      +    "required": [
      +      "model",
      +      "prompt"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "aspect_ratio": {
      +        "type": "string"
      +      },
      +      "image_asset_identifiers": {
      +        "$ref": "#/definitions/shared5"
      +      },
      +      "images": {
      +        "items": {
      +          "type": "string"
      +        },
      +        "maxItems": 16,
      +        "type": "array"
      +      },
      +      "model": {
      +        "const": "gpt-image-2",
      +        "type": "string"
      +      },
      +      "num_images": {
      +        "$ref": "#/definitions/shared2"
      +      },
      +      "private": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "prompt": {
      +        "$ref": "#/definitions/shared3"
      +      },
      +      "resolution": {
      +        "type": "string"
      +      },
      +      "seed": {
      +        "$ref": "#/definitions/shared4"
      +      }
      +    },
      +    "required": [
      +      "model",
      +      "prompt"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "aspect_ratio": {
      +        "type": "string"
      +      },
      +      "background": {
      +        "$ref": "#/definitions/shared7"
      +      },
      +      "image_asset_identifiers": {
      +        "$ref": "#/definitions/shared5"
      +      },
      +      "images": {
      +        "items": {
      +          "type": "string"
      +        },
      +        "maxItems": 16,
      +        "type": "array"
      +      },
      +      "mask": {
      +        "type": "string"
      +      },
      +      "model": {
      +        "const": "gpt-image-2-5-flare",
      +        "type": "string"
      +      },
      +      "num_images": {
      +        "$ref": "#/definitions/shared2"
      +      },
      +      "private": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "prompt": {
      +        "$ref": "#/definitions/shared3"
      +      },
      +      "quality": {
      +        "$ref": "#/definitions/shared8"
      +      },
      +      "resolution": {
      +        "type": "string"
      +      },
      +      "seed": {
      +        "$ref": "#/definitions/shared4"
      +      }
      +    },
      +    "required": [
      +      "model",
      +      "prompt"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "aspect_ratio": {
      +        "type": "string"
      +      },
      +      "background": {
      +        "$ref": "#/definitions/shared7"
      +      },
      +      "image_asset_identifiers": {
      +        "$ref": "#/definitions/shared5"
      +      },
      +      "images": {
      +        "items": {
      +          "type": "string"
      +        },
      +        "maxItems": 16,
      +        "type": "array"
      +      },
      +      "mask": {
      +        "type": "string"
      +      },
      +      "model": {
      +        "const": "gpt-image-2-5-sunburst",
      +        "type": "string"
      +      },
      +      "num_images": {
      +        "$ref": "#/definitions/shared2"
      +      },
      +      "private": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "prompt": {
      +        "$ref": "#/definitions/shared3"
      +      },
      +      "quality": {
      +        "$ref": "#/definitions/shared8"
      +      },
      +      "resolution": {
      +        "type": "string"
      +      },
      +      "seed": {
      +        "$ref": "#/definitions/shared4"
      +      }
      +    },
      +    "required": [
      +      "model",
      +      "prompt"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "aspect_ratio": {
      +        "$ref": "#/definitions/__schema6"
      +      },
      +      "enable_copyright_detection": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "magic_prompt": {
      +        "$ref": "#/definitions/__schema2"
      +      },
      +      "model": {
      +        "const": "ideogram-2",
      +        "type": "string"
      +      },
      +      "negative_prompt": {
      +        "$ref": "#/definitions/shared1"
      +      },
      +      "num_images": {
      +        "$ref": "#/definitions/shared2"
      +      },
      +      "private": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "prompt": {
      +        "$ref": "#/definitions/shared3"
      +      },
      +      "rendering_speed": {
      +        "$ref": "#/definitions/shared9"
      +      },
      +      "seed": {
      +        "$ref": "#/definitions/shared4"
      +      },
      +      "style_type": {
      +        "$ref": "#/definitions/__schema7"
      +      }
      +    },
      +    "required": [
      +      "model",
      +      "prompt"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "aspect_ratio": {
      +        "$ref": "#/definitions/__schema6"
      +      },
      +      "enable_copyright_detection": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "magic_prompt": {
      +        "$ref": "#/definitions/__schema2"
      +      },
      +      "model": {
      +        "const": "ideogram-2a",
      +        "type": "string"
      +      },
      +      "num_images": {
      +        "$ref": "#/definitions/shared2"
      +      },
      +      "private": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "prompt": {
      +        "$ref": "#/definitions/shared3"
      +      },
      +      "rendering_speed": {
      +        "$ref": "#/definitions/shared9"
      +      },
      +      "seed": {
      +        "$ref": "#/definitions/shared4"
      +      },
      +      "style_type": {
      +        "$ref": "#/definitions/__schema7"
      +      }
      +    },
      +    "required": [
      +      "model",
      +      "prompt"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "aspect_ratio": {
      +        "$ref": "#/definitions/__schema6"
      +      },
      +      "color_palette": {
      +        "$ref": "#/definitions/__schema8"
      +      },
      +      "enable_copyright_detection": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "magic_prompt": {
      +        "$ref": "#/definitions/__schema2"
      +      },
      +      "model": {
      +        "const": "ideogram-3",
      +        "type": "string"
      +      },
      +      "negative_prompt": {
      +        "$ref": "#/definitions/shared1"
      +      },
      +      "num_images": {
      +        "$ref": "#/definitions/shared2"
      +      },
      +      "private": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "prompt": {
      +        "$ref": "#/definitions/shared3"
      +      },
      +      "rendering_speed": {
      +        "$ref": "#/definitions/shared9"
      +      },
      +      "resolution": {
      +        "$ref": "#/definitions/__schema10"
      +      },
      +      "seed": {
      +        "$ref": "#/definitions/shared4"
      +      },
      +      "style_codes": {
      +        "$ref": "#/definitions/shared10"
      +      },
      +      "style_preset": {
      +        "$ref": "#/definitions/__schema12"
      +      },
      +      "style_reference_asset_identifiers": {
      +        "$ref": "#/definitions/shared0"
      +      },
      +      "style_reference_collection_id": {
      +        "type": "string"
      +      },
      +      "style_reference_collection_version_id": {
      +        "type": "string"
      +      },
      +      "style_reference_images": {
      +        "items": {
      +          "type": "string"
      +        },
      +        "maxItems": 10,
      +        "type": "array"
      +      },
      +      "style_type": {
      +        "default": "general",
      +        "enum": [
      +          "auto",
      +          "general",
      +          "realistic",
      +          "design",
      +          "custom",
      +          "fiction",
      +          "stylized"
      +        ],
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "prompt"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "aspect_ratio": {
      +        "$ref": "#/definitions/__schema6"
      +      },
      +      "character_reference_asset_identifiers": {
      +        "additionalItems": false,
      +        "items": [
      +          {
      +            "$ref": "#/definitions/__schema0"
      +          }
      +        ],
      +        "maxItems": 1,
      +        "minItems": 1,
      +        "type": "array"
      +      },
      +      "character_reference_collection_id": {
      +        "type": "string"
      +      },
      +      "character_reference_collection_version_id": {
      +        "type": "string"
      +      },
      +      "character_reference_images": {
      +        "items": {
      +          "type": "string"
      +        },
      +        "maxItems": 1,
      +        "type": "array"
      +      },
      +      "character_reference_mask": {
      +        "type": "string"
      +      },
      +      "enable_copyright_detection": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "magic_prompt": {
      +        "$ref": "#/definitions/__schema2"
      +      },
      +      "model": {
      +        "const": "ideogram-3-character",
      +        "type": "string"
      +      },
      +      "negative_prompt": {
      +        "$ref": "#/definitions/shared1"
      +      },
      +      "num_images": {
      +        "$ref": "#/definitions/shared2"
      +      },
      +      "private": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "prompt": {
      +        "$ref": "#/definitions/shared3"
      +      },
      +      "rendering_speed": {
      +        "$ref": "#/definitions/shared9"
      +      },
      +      "resolution": {
      +        "$ref": "#/definitions/__schema10"
      +      },
      +      "seed": {
      +        "$ref": "#/definitions/shared4"
      +      },
      +      "style_reference_asset_identifiers": {
      +        "$ref": "#/definitions/shared0"
      +      },
      +      "style_reference_collection_id": {
      +        "type": "string"
      +      },
      +      "style_reference_collection_version_id": {
      +        "type": "string"
      +      },
      +      "style_reference_images": {
      +        "items": {
      +          "type": "string"
      +        },
      +        "maxItems": 10,
      +        "type": "array"
      +      },
      +      "style_type": {
      +        "default": "auto",
      +        "enum": [
      +          "auto",
      +          "realistic",
      +          "fiction"
      +        ],
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "model",
      +      "prompt"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "aspect_ratio": {
      +        "$ref": "#/definitions/__schema6"
      +      },
      +      "color_palette": {
      +        "$ref": "#/definitions/__schema8"
      +      },
      +      "custom_model_uri": {
      +        "$ref": "#/definitions/shared11"
      +      },
      +      "enable_copyright_detection": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "magic_prompt": {
      +        "$ref": "#/definitions/__schema2"
      +      },
      +      "model": {
      +        "const": "ideogram-3-custom-model",
      +        "type": "string"
      +      },
      +      "negative_prompt": {
      +        "$ref": "#/definitions/shared1"
      +      },
      +      "num_images": {
      +        "$ref": "#/definitions/shared2"
      +      },
      +      "private": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "prompt": {
      +        "$ref": "#/definitions/shared3"
      +      },
      +      "rendering_speed": {
      +        "$ref": "#/definitions/shared12"
      +      },
      +      "resolution": {
      +        "$ref": "#/definitions/__schema10"
      +      },
      +      "seed": {
      +        "$ref": "#/definitions/shared4"
      +      },
      +      "style_codes": {
      +        "$ref": "#/definitions/shared10"
      +      },
      +      "style_preset": {
      +        "$ref": "#/definitions/__schema12"
      +      },
      +      "style_reference_asset_identifiers": {
      +        "$ref": "#/definitions/shared0"
      +      },
      +      "style_reference_images": {
      +        "items": {
      +          "type": "string"
      +        },
      +        "maxItems": 10,
      +        "type": "array"
      +      }
      +    },
      +    "required": [
      +      "model",
      +      "custom_model_uri",
      +      "prompt"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "aspect_ratio": {
      +        "$ref": "#/definitions/__schema6"
      +      },
      +      "enable_copyright_detection": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "magic_prompt": {
      +        "$ref": "#/definitions/__schema2"
      +      },
      +      "model": {
      +        "const": "ideogram-3-transparent",
      +        "type": "string"
      +      },
      +      "negative_prompt": {
      +        "$ref": "#/definitions/shared1"
      +      },
      +      "num_images": {
      +        "$ref": "#/definitions/shared2"
      +      },
      +      "private": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "prompt": {
      +        "$ref": "#/definitions/shared3"
      +      },
      +      "rendering_speed": {
      +        "$ref": "#/definitions/shared9"
      +      },
      +      "seed": {
      +        "$ref": "#/definitions/shared4"
      +      },
      +      "upscale_factor": {
      +        "default": "x1",
      +        "enum": [
      +          "x1",
      +          "x2",
      +          "x4"
      +        ],
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "model",
      +      "prompt"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "enable_copyright_detection": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "magic_prompt": {
      +        "$ref": "#/definitions/__schema2"
      +      },
      +      "model": {
      +        "const": "ideogram-4",
      +        "type": "string"
      +      },
      +      "num_images": {
      +        "$ref": "#/definitions/shared2"
      +      },
      +      "private": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "prompt": {
      +        "$ref": "#/definitions/shared3"
      +      },
      +      "rendering_speed": {
      +        "$ref": "#/definitions/shared9"
      +      },
      +      "resolution": {
      +        "$ref": "#/definitions/__schema17"
      +      },
      +      "seed": {
      +        "$ref": "#/definitions/shared4"
      +      }
      +    },
      +    "required": [
      +      "model",
      +      "prompt"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "enable_copyright_detection": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "image_asset_identifiers": {
      +        "items": {
      +          "$ref": "#/definitions/__schema0"
      +        },
      +        "maxItems": 5,
      +        "minItems": 1,
      +        "type": "array"
      +      },
      +      "images": {
      +        "items": {
      +          "type": "string"
      +        },
      +        "maxItems": 5,
      +        "type": "array"
      +      },
      +      "magic_prompt": {
      +        "$ref": "#/definitions/__schema2"
      +      },
      +      "mask": {
      +        "type": "string"
      +      },
      +      "model": {
      +        "const": "ideogram-4-5",
      +        "type": "string"
      +      },
      +      "num_images": {
      +        "$ref": "#/definitions/shared2"
      +      },
      +      "private": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "prompt": {
      +        "$ref": "#/definitions/shared3"
      +      },
      +      "quality": {
      +        "enum": [
      +          "very_low",
      +          "low",
      +          "medium",
      +          "high"
      +        ],
      +        "type": "string"
      +      },
      +      "seed": {
      +        "$ref": "#/definitions/shared4"
      +      },
      +      "size": {
      +        "default": "auto",
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      }
      +    },
      +    "required": [
      +      "model",
      +      "prompt"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "custom_model_uri": {
      +        "$ref": "#/definitions/shared11"
      +      },
      +      "enable_copyright_detection": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "magic_prompt": {
      +        "$ref": "#/definitions/__schema2"
      +      },
      +      "model": {
      +        "const": "ideogram-4-custom-model",
      +        "type": "string"
      +      },
      +      "num_images": {
      +        "$ref": "#/definitions/shared2"
      +      },
      +      "private": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "prompt": {
      +        "$ref": "#/definitions/shared3"
      +      },
      +      "rendering_speed": {
      +        "$ref": "#/definitions/shared12"
      +      },
      +      "resolution": {
      +        "$ref": "#/definitions/__schema17"
      +      },
      +      "seed": {
      +        "$ref": "#/definitions/shared4"
      +      },
      +      "stacked_custom_models": {
      +        "items": {
      +          "$ref": "#/definitions/__schema19"
      +        },
      +        "maxItems": 4,
      +        "minItems": 1,
      +        "type": "array"
      +      }
      +    },
      +    "required": [
      +      "model",
      +      "custom_model_uri",
      +      "prompt"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "aspect_ratio": {
      +        "default": "auto",
      +        "enum": [
      +          "auto",
      +          "1x4",
      +          "1x3",
      +          "1x2",
      +          "9x16",
      +          "10x16",
      +          "2x3",
      +          "3x4",
      +          "4x5",
      +          "1x1",
      +          "5x4",
      +          "4x3",
      +          "3x2",
      +          "16x10",
      +          "16x9",
      +          "2x1",
      +          "3x1",
      +          "4x1"
      +        ],
      +        "type": "string"
      +      },
      +      "enable_copyright_detection": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "magic_prompt": {
      +        "$ref": "#/definitions/__schema2"
      +      },
      +      "model": {
      +        "const": "ideogram-4-transparent",
      +        "type": "string"
      +      },
      +      "num_images": {
      +        "$ref": "#/definitions/shared2"
      +      },
      +      "output_resolution": {
      +        "default": "1k",
      +        "enum": [
      +          "1k",
      +          "2k",
      +          "4k",
      +          "8k"
      +        ],
      +        "type": "string"
      +      },
      +      "private": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "prompt": {
      +        "$ref": "#/definitions/shared3"
      +      },
      +      "rendering_speed": {
      +        "$ref": "#/definitions/shared9"
      +      },
      +      "seed": {
      +        "$ref": "#/definitions/shared4"
      +      }
      +    },
      +    "required": [
      +      "model",
      +      "prompt"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "aspect_ratio": {
      +        "default": "auto",
      +        "enum": [
      +          "auto",
      +          "1:1",
      +          "3:2",
      +          "2:3",
      +          "4:3",
      +          "3:4",
      +          "5:4",
      +          "4:5",
      +          "16:9",
      +          "9:16",
      +          "21:9",
      +          "4:1",
      +          "1:4",
      +          "8:1",
      +          "1:8"
      +        ],
      +        "type": "string"
      +      },
      +      "image_asset_identifiers": {
      +        "$ref": "#/definitions/shared0"
      +      },
      +      "images": {
      +        "items": {
      +          "type": "string"
      +        },
      +        "maxItems": 10,
      +        "type": "array"
      +      },
      +      "model": {
      +        "const": "nano-banana-2",
      +        "type": "string"
      +      },
      +      "num_images": {
      +        "$ref": "#/definitions/shared2"
      +      },
      +      "private": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "prompt": {
      +        "$ref": "#/definitions/shared3"
      +      },
      +      "resolution_tier": {
      +        "$ref": "#/definitions/shared13"
      +      },
      +      "seed": {
      +        "$ref": "#/definitions/shared4"
      +      }
      +    },
      +    "required": [
      +      "model",
      +      "prompt"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "aspect_ratio": {
      +        "default": "auto",
      +        "enum": [
      +          "auto",
      +          "1:1",
      +          "3:2",
      +          "2:3",
      +          "4:3",
      +          "3:4",
      +          "5:4",
      +          "4:5",
      +          "16:9",
      +          "9:16",
      +          "21:9"
      +        ],
      +        "type": "string"
      +      },
      +      "image_asset_identifiers": {
      +        "$ref": "#/definitions/shared0"
      +      },
      +      "images": {
      +        "items": {
      +          "type": "string"
      +        },
      +        "maxItems": 10,
      +        "type": "array"
      +      },
      +      "model": {
      +        "const": "nano-banana-pro",
      +        "type": "string"
      +      },
      +      "num_images": {
      +        "$ref": "#/definitions/shared2"
      +      },
      +      "private": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "prompt": {
      +        "$ref": "#/definitions/shared3"
      +      },
      +      "resolution_tier": {
      +        "$ref": "#/definitions/shared13"
      +      },
      +      "seed": {
      +        "$ref": "#/definitions/shared4"
      +      }
      +    },
      +    "required": [
      +      "model",
      +      "prompt"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "aspect_ratio": {
      +        "enum": [
      +          "1x3",
      +          "3x1",
      +          "1x2",
      +          "2x1",
      +          "9x16",
      +          "16x9",
      +          "10x16",
      +          "16x10",
      +          "2x3",
      +          "3x2",
      +          "3x4",
      +          "4x3",
      +          "4x5",
      +          "5x4",
      +          "1x1"
      +        ],
      +        "type": "string"
      +      },
      +      "custom_height": {
      +        "$ref": "#/definitions/shared14"
      +      },
      +      "custom_width": {
      +        "$ref": "#/definitions/shared14"
      +      },
      +      "enable_copyright_detection": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "magic_prompt": {
      +        "$ref": "#/definitions/__schema2"
      +      },
      +      "model": {
      +        "const": "p-image-ideogram",
      +        "type": "string"
      +      },
      +      "num_images": {
      +        "$ref": "#/definitions/shared2"
      +      },
      +      "private": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "prompt": {
      +        "$ref": "#/definitions/shared3"
      +      },
      +      "quality": {
      +        "enum": [
      +          "very_low",
      +          "low",
      +          "medium",
      +          "high",
      +          "very_high"
      +        ],
      +        "type": "string"
      +      },
      +      "resolution": {
      +        "enum": [
      +          "1k",
      +          "2k"
      +        ],
      +        "type": "string"
      +      },
      +      "seed": {
      +        "$ref": "#/definitions/shared4"
      +      }
      +    },
      +    "required": [
      +      "model",
      +      "prompt"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "model": {
      +        "const": "z-image",
      +        "type": "string"
      +      },
      +      "num_images": {
      +        "$ref": "#/definitions/shared2"
      +      },
      +      "num_inference_steps": {
      +        "anyOf": [
      +          {
      +            "maximum": 128,
      +            "minimum": 1,
      +            "type": "integer"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "private": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "prompt": {
      +        "$ref": "#/definitions/shared3"
      +      },
      +      "resolution": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "seed": {
      +        "$ref": "#/definitions/shared4"
      +      }
      +    },
      +    "required": [
      +      "model",
      +      "prompt"
      +    ],
      +    "type": "object"
      +  }
      +]
    • changedInput schema / properties / aspect_ratio / description
      Previous value: -"Output aspect ratio (default: 1x1)"New value: +"Output aspect ratio such as 16x9; not with resolution"
    • removedInput schema / properties / aspect_ratio / enum
      Removed value: -[
      -  "1x1",
      -  "16x9",
      -  "9x16",
      -  "4x3",
      -  "3x4",
      -  "3x2",
      -  "2x3",
      -  "4x5",
      -  "5x4",
      -  "1x2",
      -  "2x1",
      -  "1x3",
      -  "3x1",
      -  "10x16",
      -  "16x10"
      -]
    • removedInput schema / properties / aspect_ratio / type
      Removed value: -"string"
    • addedInput schema / properties / character_reference_asset_identifiers
      Added value: +{
      +  "description": "Ideogram assets to use as the character reference"
      +}
    • removedInput schema / properties / character_reference_image
      Removed value: -{
      -  "description": "Local image file of a character to keep consistent (one image; Ideogram bills character references at its own rate)",
      -  "minLength": 1,
      -  "type": "string"
      -}
    • addedInput schema / properties / character_reference_images
      Added value: +{
      +  "description": "Local image files (or public https URLs) of the character to keep consistent"
      +}
    • changedInput schema / properties / character_reference_mask / description
      Previous value: -"Grayscale mask of the character reference (same dimensions); needs character_reference_image"New value: +"Local grayscale mask (or a public https URL) of where the character is in its reference image"
    • removedInput schema / properties / character_reference_mask / minLength
      Removed value: -1
    • removedInput schema / properties / character_reference_mask / type
      Removed value: -"string"
    • removedInput schema / properties / color_palette / anyOf
      Removed value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "name": {
      -        "description": "A preset palette",
      -        "enum": [
      -          "EMBER",
      -          "FRESH",
      -          "JUNGLE",
      -          "MAGIC",
      -          "MELON",
      -          "MOSAIC",
      -          "PASTEL",
      -          "ULTRAMARINE"
      -        ],
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "name"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "members": {
      -        "description": "Explicit colours, most dominant first",
      -        "items": {
      -          "additionalProperties": false,
      -          "properties": {
      -            "color_hex": {
      -              "description": "The colour, #RRGGBB",
      -              "pattern": "^#[0-9A-Fa-f]{6}$",
      -              "type": "string"
      -            },
      -            "color_weight": {
      -              "description": "Its share of the palette (0.05-1)",
      -              "maximum": 1,
      -              "minimum": 0.05,
      -              "type": "number"
      -            }
      -          },
      -          "required": [
      -            "color_hex"
      -          ],
      -          "type": "object"
      -        },
      -        "maxItems": 10,
      -        "minItems": 1,
      -        "type": "array"
      -      }
      -    },
      -    "required": [
      -      "members"
      -    ],
      -    "type": "object"
      -  }
      -]
    • changedInput schema / properties / color_palette / description
      Previous value: -"A preset palette by name, or explicit colours with weights (not both)"New value: +"A preset palette by name, or explicit hex colours with weights"
    • changedInput schema / properties / custom_model_uri / description
      Previous value: -"A custom (trained) model: model/<name>/version/<version>"New value: +"A custom model you trained or were given access to"
    • removedInput schema / properties / custom_model_uri / pattern
      Removed value: -"^model\\/[^/\\s]+\\/version\\/[^/\\s]+$"
    • removedInput schema / properties / custom_model_uri / type
      Removed value: -"string"
    • changedInput schema / properties / enable_copyright_detection / description
      Previous value: -"true runs Ideogram's copyright detection on this request; false leaves the organisation setting in force (it cannot switch an organisation-wide detection off)"New value: +"Run Ideogram's copyright detection on the result (adds latency)"
    • removedInput schema / properties / enable_copyright_detection / type
      Removed value: -"boolean"
    • addedInput schema / properties / image_asset_identifiers
      Added value: +{
      +  "description": "Ideogram assets instead of local source images"
      +}
    • addedInput schema / properties / images
      Added value: +{
      +  "description": "Local source image files or public https URLs (the first is the one edited)"
      +}
    • addedInput schema / properties / inline_images
      Added value: +{
      +  "description": "true: each saved image is also returned as image content (base64; one over 3.75 MB, or past 10 MB in total, by path only), for a client without file access",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / magic_prompt / description
      Previous value: -"Auto-enhance prompts (default: AUTO)"New value: +"auto, on or off: let Ideogram rewrite the prompt"
    • removedInput schema / properties / magic_prompt / enum
      Removed value: -[
      -  "AUTO",
      -  "ON",
      -  "OFF"
      -]
    • removedInput schema / properties / magic_prompt / type
      Removed value: -"string"
    • addedInput schema / properties / mask
      Added value: +{
      +  "description": "Local mask image file or a public https URL, the same size as the source"
      +}
    • changedInput schema / properties / model / description
      Previous value: -"Ideogram model: 3.0 (default; every parameter below) or 4.0 (text prompt, resolution, rendering_speed except FLASH, enable_copyright_detection — the other parameters are refused)"New value: +"The model (default ideogram-3); each takes the fields of its variant below"
    • changedInput schema / properties / model / enum
      Previous value: -[
      -  "3.0",
      -  "4.0"
      -]New value: +[
      +  "auto",
      +  "gpt-image-2",
      +  "gpt-image-2-5-flare",
      +  "gpt-image-2-5-sunburst",
      +  "ideogram-2",
      +  "ideogram-2a",
      +  "ideogram-3",
      +  "ideogram-3-character",
      +  "ideogram-3-custom-model",
      +  "ideogram-3-transparent",
      +  "ideogram-4",
      +  "ideogram-4-5",
      +  "ideogram-4-custom-model",
      +  "ideogram-4-transparent",
      +  "nano-banana-2",
      +  "nano-banana-pro",
      +  "p-image-ideogram",
      +  "z-image"
      +]
    • changedInput schema / properties / negative_prompt / description
      Previous value: -"What to exclude from the generated image"New value: +"What to keep out of the image"
    • removedInput schema / properties / negative_prompt / type
      Removed value: -"string"
    • changedInput schema / properties / num_images / description
      Previous value: -"Number of images to generate (1-8, default: 1)"New value: +"How many images to make (each is billed)"
    • removedInput schema / properties / num_images / maximum
      Removed value: -8
    • removedInput schema / properties / num_images / minimum
      Removed value: -1
    • removedInput schema / properties / num_images / type
      Removed value: -"integer"
    • addedInput schema / properties / private
      Added value: +{
      +  "description": "Keep the result out of Ideogram's public feed; true unless you set false (enterprise accounts are always private)"
      +}
    • changedInput schema / properties / prompt / description
      Previous value: -"Image description (1-10,000 characters)"New value: +"What to create or change, in natural language"
    • removedInput schema / properties / prompt / maxLength
      Removed value: -10000
    • removedInput schema / properties / prompt / minLength
      Removed value: -1
    • removedInput schema / properties / prompt / type
      Removed value: -"string"
    • addedInput schema / properties / quality
      Added value: +{
      +  "description": "very_low, low, medium or high: higher costs more"
      +}
    • changedInput schema / properties / rendering_speed / description
      Previous value: -"Speed/quality tradeoff. FLASH=fastest, QUALITY=best (default: DEFAULT)"New value: +"turbo, default or quality: faster is cheaper"
    • removedInput schema / properties / rendering_speed / enum
      Removed value: -[
      -  "FLASH",
      -  "TURBO",
      -  "DEFAULT",
      -  "QUALITY"
      -]
    • removedInput schema / properties / rendering_speed / type
      Removed value: -"string"
    • removedInput schema / properties / resolution / anyOf
      Removed value: -[
      -  {
      -    "enum": [
      -      "512x1536",
      -      "576x1408",
      -      "576x1472",
      -      "576x1536",
      -      "640x1344",
      -      "640x1408",
      -      "640x1472",
      -      "640x1536",
      -      "704x1152",
      -      "704x1216",
      -      "704x1280",
      -      "704x1344",
      -      "704x1408",
      -      "704x1472",
      -      "736x1312",
      -      "768x1088",
      -      "768x1216",
      -      "768x1280",
      -      "768x1344",
      -      "800x1280",
      -      "832x960",
      -      "832x1024",
      -      "832x1088",
      -      "832x1152",
      -      "832x1216",
      -      "832x1248",
      -      "864x1152",
      -      "896x960",
      -      "896x1024",
      -      "896x1088",
      -      "896x1120",
      -      "896x1152",
      -      "960x832",
      -      "960x896",
      -      "960x1024",
      -      "960x1088",
      -      "1024x832",
      -      "1024x896",
      -      "1024x960",
      -      "1024x1024",
      -      "1088x768",
      -      "1088x832",
      -      "1088x896",
      -      "1088x960",
      -      "1120x896",
      -      "1152x704",
      -      "1152x832",
      -      "1152x864",
      -      "1152x896",
      -      "1216x704",
      -      "1216x768",
      -      "1216x832",
      -      "1248x832",
      -      "1280x704",
      -      "1280x768",
      -      "1280x800",
      -      "1312x736",
      -      "1344x640",
      -      "1344x704",
      -      "1344x768",
      -      "1408x576",
      -      "1408x640",
      -      "1408x704",
      -      "1472x576",
      -      "1472x640",
      -      "1472x704",
      -      "1536x512",
      -      "1536x576",
      -      "1536x640"
      -    ],
      -    "type": "string"
      -  },
      -  {
      -    "pattern": "^\\d{3,4}x\\d{3,4}$",
      -    "type": "string"
      -  }
      -]
    • changedInput schema / properties / resolution / description
      Previous value: -"Exact output resolution: one of Ideogram 3.0's 69 sizes, or any WIDTHxHEIGHT for model 4.0; not with aspect_ratio"New value: +"Exact output size WIDTHxHEIGHT from the model's list; not with aspect_ratio"
    • addedInput schema / properties / resolution_tier
      Added value: +{
      +  "description": "The output resolution tier"
      +}
    • changedInput schema / properties / seed / description
      Previous value: -"Reproducibility seed (0-2,147,483,647)"New value: +"Random seed for a reproducible result"
    • removedInput schema / properties / seed / maximum
      Removed value: -2147483647
    • removedInput schema / properties / seed / minimum
      Removed value: -0
    • removedInput schema / properties / seed / type
      Removed value: -"integer"
    • addedInput schema / properties / size
      Added value: +{
      +  "description": "Output size: \"auto\", \"source\" (needs source images) or WIDTHxHEIGHT"
      +}
    • changedInput schema / properties / style_codes / description
      Previous value: -"8-character hexadecimal style codes from Ideogram"New value: +"8-character hexadecimal style codes"
    • removedInput schema / properties / style_codes / items
      Removed value: -{
      -  "pattern": "^[0-9A-Fa-f]{8}$",
      -  "type": "string"
      -}
    • removedInput schema / properties / style_codes / maxItems
      Removed value: -8
    • removedInput schema / properties / style_codes / minItems
      Removed value: -1
    • removedInput schema / properties / style_codes / type
      Removed value: -"array"
    • changedInput schema / properties / style_preset / description
      Previous value: -"A named style preset as Ideogram lists them"New value: +"A named style preset; not with style codes or style references"
    • removedInput schema / properties / style_preset / maxLength
      Removed value: -100
    • removedInput schema / properties / style_preset / minLength
      Removed value: -1
    • removedInput schema / properties / style_preset / type
      Removed value: -"string"
    • addedInput schema / properties / style_reference_asset_identifiers
      Added value: +{
      +  "description": "Ideogram assets (uploads or earlier results) to use as style references"
      +}
    • addedInput schema / properties / style_reference_collection_id
      Added value: +{
      +  "description": "A saved style collection to apply"
      +}
    • addedInput schema / properties / style_reference_collection_version_id
      Added value: +{
      +  "description": "A version of the saved style collection"
      +}
    • changedInput schema / properties / style_reference_images / description
      Previous value: -"Local image files whose style the result follows (up to 3, 25 MB each)"New value: +"Local image files (or public https URLs) whose style the result follows"
    • removedInput schema / properties / style_reference_images / items
      Removed value: -{
      -  "minLength": 1,
      -  "type": "string"
      -}
    • removedInput schema / properties / style_reference_images / maxItems
      Removed value: -3
    • removedInput schema / properties / style_reference_images / minItems
      Removed value: -1
    • removedInput schema / properties / style_reference_images / type
      Removed value: -"array"
    • changedInput schema / properties / style_type / description
      Previous value: -"Visual style (the API default is GENERAL when omitted)"New value: +"Visual style family"
    • removedInput schema / properties / style_type / enum
      Removed value: -[
      -  "AUTO",
      -  "GENERAL",
      -  "REALISTIC",
      -  "DESIGN",
      -  "FICTION"
      -]
    • removedInput schema / properties / style_type / type
      Removed value: -"string"
    • addedInput schema / properties / upscale_factor
      Added value: +{
      +  "description": "x2, x4 or x8"
      +}
    • addedInput schema / properties / wait_s
      Added value: +{
      +  "description": "Seconds to wait for the result (0-50, default 45). The job is accepted first; if it is still running when the wait ends, the result is its generation_id for ideogram_generation (never resubmitted, never billed twice).",
      +  "maximum": 50,
      +  "minimum": 0,
      +  "type": "integer"
      +}
    • removedInput schema / required
      Removed value: -[
      -  "prompt"
      -]
  2. Changed12 schema fields changedv1.2.0
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / character_reference_image
      Added value: +{
      +  "description": "Local image file of a character to keep consistent (one image; Ideogram bills character references at its own rate)",
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / properties / character_reference_mask
      Added value: +{
      +  "description": "Grayscale mask of the character reference (same dimensions); needs character_reference_image",
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / properties / color_palette
      Added value: +{
      +  "anyOf": [
      +    {
      +      "additionalProperties": false,
      +      "properties": {
      +        "name": {
      +          "description": "A preset palette",
      +          "enum": [
      +            "EMBER",
      +            "FRESH",
      +            "JUNGLE",
      +            "MAGIC",
      +            "MELON",
      +            "MOSAIC",
      +            "PASTEL",
      +            "ULTRAMARINE"
      +          ],
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "name"
      +      ],
      +      "type": "object"
      +    },
      +    {
      +      "additionalProperties": false,
      +      "properties": {
      +        "members": {
      +          "description": "Explicit colours, most dominant first",
      +          "items": {
      +            "additionalProperties": false,
      +            "properties": {
      +              "color_hex": {
      +                "description": "The colour, #RRGGBB",
      +                "pattern": "^#[0-9A-Fa-f]{6}$",
      +                "type": "string"
      +              },
      +              "color_weight": {
      +                "description": "Its share of the palette (0.05-1)",
      +                "maximum": 1,
      +                "minimum": 0.05,
      +                "type": "number"
      +              }
      +            },
      +            "required": [
      +              "color_hex"
      +            ],
      +            "type": "object"
      +          },
      +          "maxItems": 10,
      +          "minItems": 1,
      +          "type": "array"
      +        }
      +      },
      +      "required": [
      +        "members"
      +      ],
      +      "type": "object"
      +    }
      +  ],
      +  "description": "A preset palette by name, or explicit colours with weights (not both)"
      +}
    • addedInput schema / properties / custom_model_uri
      Added value: +{
      +  "description": "A custom (trained) model: model/<name>/version/<version>",
      +  "pattern": "^model\\/[^/\\s]+\\/version\\/[^/\\s]+$",
      +  "type": "string"
      +}
    • addedInput schema / properties / enable_copyright_detection
      Added value: +{
      +  "description": "true runs Ideogram's copyright detection on this request; false leaves the organisation setting in force (it cannot switch an organisation-wide detection off)",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / model
      Added value: +{
      +  "description": "Ideogram model: 3.0 (default; every parameter below) or 4.0 (text prompt, resolution, rendering_speed except FLASH, enable_copyright_detection — the other parameters are refused)",
      +  "enum": [
      +    "3.0",
      +    "4.0"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / resolution
      Added value: +{
      +  "anyOf": [
      +    {
      +      "enum": [
      +        "512x1536",
      +        "576x1408",
      +        "576x1472",
      +        "576x1536",
      +        "640x1344",
      +        "640x1408",
      +        "640x1472",
      +        "640x1536",
      +        "704x1152",
      +        "704x1216",
      +        "704x1280",
      +        "704x1344",
      +        "704x1408",
      +        "704x1472",
      +        "736x1312",
      +        "768x1088",
      +        "768x1216",
      +        "768x1280",
      +        "768x1344",
      +        "800x1280",
      +        "832x960",
      +        "832x1024",
      +        "832x1088",
      +        "832x1152",
      +        "832x1216",
      +        "832x1248",
      +        "864x1152",
      +        "896x960",
      +        "896x1024",
      +        "896x1088",
      +        "896x1120",
      +        "896x1152",
      +        "960x832",
      +        "960x896",
      +        "960x1024",
      +        "960x1088",
      +        "1024x832",
      +        "1024x896",
      +        "1024x960",
      +        "1024x1024",
      +        "1088x768",
      +        "1088x832",
      +        "1088x896",
      +        "1088x960",
      +        "1120x896",
      +        "1152x704",
      +        "1152x832",
      +        "1152x864",
      +        "1152x896",
      +        "1216x704",
      +        "1216x768",
      +        "1216x832",
      +        "1248x832",
      +        "1280x704",
      +        "1280x768",
      +        "1280x800",
      +        "1312x736",
      +        "1344x640",
      +        "1344x704",
      +        "1344x768",
      +        "1408x576",
      +        "1408x640",
      +        "1408x704",
      +        "1472x576",
      +        "1472x640",
      +        "1472x704",
      +        "1536x512",
      +        "1536x576",
      +        "1536x640"
      +      ],
      +      "type": "string"
      +    },
      +    {
      +      "pattern": "^\\d{3,4}x\\d{3,4}$",
      +      "type": "string"
      +    }
      +  ],
      +  "description": "Exact output resolution: one of Ideogram 3.0's 69 sizes, or any WIDTHxHEIGHT for model 4.0; not with aspect_ratio"
      +}
    • addedInput schema / properties / style_codes
      Added value: +{
      +  "description": "8-character hexadecimal style codes from Ideogram",
      +  "items": {
      +    "pattern": "^[0-9A-Fa-f]{8}$",
      +    "type": "string"
      +  },
      +  "maxItems": 8,
      +  "minItems": 1,
      +  "type": "array"
      +}
    • addedInput schema / properties / style_preset
      Added value: +{
      +  "description": "A named style preset as Ideogram lists them",
      +  "maxLength": 100,
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / properties / style_reference_images
      Added value: +{
      +  "description": "Local image files whose style the result follows (up to 3, 25 MB each)",
      +  "items": {
      +    "minLength": 1,
      +    "type": "string"
      +  },
      +  "maxItems": 3,
      +  "minItems": 1,
      +  "type": "array"
      +}
    • changedInput schema / properties / style_type / description
      Previous value: -"Visual style (default: AUTO)"New value: +"Visual style (the API default is GENERAL when omitted)"
  3. First observedv1.0.3

TDQS

A4.1/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It usefully discloses that results are written to the output directory, that ideogram_quote does not generate, and that each model branch has its own field set. It omits billing semantics (per-image cost), permission/auth requirements, and the polling path implied by wait_s, leaving notable gaps for a mutation tool of this complexity.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three sentences with the action and scope front-loaded, then model coverage, then the pricing/default caveats. The long model enumeration is dense but earns its place by telling the agent which families are wired up.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 32-parameter, oneOf-heavy tool with no annotations and no output schema, the description covers the essentials: what is created, which models exist, the default, where output lands, and the related pricing tool. It stops short of explaining the wait/polling flow, but that is documented in the wait_s schema field rather than being strictly required here.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the list/enum details are already covered and the baseline would be 3. The sentence 'Each model takes its own fields (one variant per model in this schema)' adds genuine structural value over the raw oneOf, warning the agent that fields are model-specific. The default-model statement overlaps with the schema's model description, slightly limiting the gain.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Opens with a specific verb+resource ('Create images from a text prompt') and enumerates the exact model families the tool can drive, so an agent immediately knows this is the general-purpose generation entry point. It is also implicitly distinguished from siblings like ideogram_edit, ideogram_precise_edit and ideogram_quote, which are named in the text.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly routes price-checking to ideogram_quote ('prices a call first (nothing is generated)') and states the default model. However it never says when to prefer this over the sibling edit/remix/inpaint tools, so the generation-vs-manipulation boundary is left to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.