Skip to main content
Glama

Remix an image

ideogram_remix

Create new images from a source image and a prompt, using image_weight to control how closely results follow the source. Results are saved to the output directory.

Instructions

Make new images from a source image and a prompt (Ideogram 3.0 and its variants, Ideogram 4.0, or auto); image_weight sets how closely the result follows the source. Results are saved to the output directory; ideogram_quote prices a call first (nothing is generated).

Input Schema

NameRequiredDescriptionDefault
seedNoRandom seed for a reproducible result
imageNoLocal image file to work on, or a public https URL of one
modelNoThe model (default ideogram-3); each takes the fields of its variant below
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)
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
image_weightNoHow closely the result follows the source image, 1-100
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
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
image_asset_identifierNoAn Ideogram asset (an upload or an earlier result) instead of a local image
style_reference_imagesNoLocal image files (or public https URLs) whose style the result follows
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. Changed73 schema fields changedv2.5.0
    • changedInput schema / additionalProperties
      Previous value: -falseNew value: +{}
    • addedInput schema / definitions
      Added value: +{
      +  "__schema0": {
      +    "anyOf": [
      +      {
      +        "properties": {
      +          "name": {
      +            "enum": [
      +              "ember",
      +              "fresh",
      +              "jungle",
      +              "magic",
      +              "melon",
      +              "mosaic",
      +              "pastel",
      +              "ultramarine"
      +            ],
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "name"
      +        ],
      +        "type": "object"
      +      },
      +      {
      +        "properties": {
      +          "members": {
      +            "items": {
      +              "$ref": "#/definitions/__schema1"
      +            },
      +            "maxItems": 8,
      +            "minItems": 1,
      +            "type": "array"
      +          }
      +        },
      +        "required": [
      +          "members"
      +        ],
      +        "type": "object"
      +      }
      +    ]
      +  },
      +  "__schema1": {
      +    "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"
      +  },
      +  "__schema2": {
      +    "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"
      +  },
      +  "__schema3": {
      +    "enum": [
      +      "auto",
      +      "on",
      +      "off"
      +    ],
      +    "type": "string"
      +  },
      +  "__schema4": {
      +    "pattern": "^[0-9a-fA-F]{8}$",
      +    "type": "string"
      +  },
      +  "__schema5": {
      +    "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"
      +  },
      +  "__schema6": {
      +    "default": "general",
      +    "enum": [
      +      "auto",
      +      "general",
      +      "realistic",
      +      "design",
      +      "custom",
      +      "fiction",
      +      "stylized"
      +    ],
      +    "type": "string"
      +  },
      +  "__schema7": {
      +    "enum": [
      +      "1x3",
      +      "3x1",
      +      "1x2",
      +      "2x1",
      +      "9x16",
      +      "16x9",
      +      "10x16",
      +      "16x10",
      +      "2x3",
      +      "3x2",
      +      "3x4",
      +      "4x3",
      +      "4x5",
      +      "5x4",
      +      "1x1"
      +    ],
      +    "type": "string"
      +  },
      +  "__schema8": {
      +    "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"
      +  },
      +  "shared1": {
      +    "maximum": 100,
      +    "minimum": 1,
      +    "type": "integer"
      +  },
      +  "shared2": {
      +    "maxLength": 10000,
      +    "type": "string"
      +  },
      +  "shared3": {
      +    "default": 1,
      +    "maximum": 8,
      +    "minimum": 1,
      +    "type": "integer"
      +  },
      +  "shared4": {
      +    "maxLength": 10000,
      +    "minLength": 1,
      +    "type": "string"
      +  },
      +  "shared5": {
      +    "maximum": 2147483647,
      +    "minimum": 0,
      +    "type": "integer"
      +  },
      +  "shared6": {
      +    "items": {
      +      "$ref": "#/definitions/__schema4"
      +    },
      +    "type": "array"
      +  },
      +  "shared7": {
      +    "items": {
      +      "$ref": "#/definitions/__schema2"
      +    },
      +    "maxItems": 10,
      +    "minItems": 1,
      +    "type": "array"
      +  },
      +  "shared8": {
      +    "default": "default",
      +    "enum": [
      +      "turbo",
      +      "default",
      +      "quality"
      +    ],
      +    "type": "string"
      +  }
      +}
    • addedInput schema / oneOf
      Added value: +[
      +  {
      +    "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"
      +      },
      +      "color_palette": {
      +        "$ref": "#/definitions/__schema0"
      +      },
      +      "enable_copyright_detection": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "image": {
      +        "type": "string"
      +      },
      +      "image_asset_identifier": {
      +        "$ref": "#/definitions/__schema2"
      +      },
      +      "image_weight": {
      +        "$ref": "#/definitions/shared1"
      +      },
      +      "magic_prompt": {
      +        "$ref": "#/definitions/__schema3"
      +      },
      +      "model": {
      +        "const": "auto",
      +        "type": "string"
      +      },
      +      "negative_prompt": {
      +        "$ref": "#/definitions/shared2"
      +      },
      +      "num_images": {
      +        "$ref": "#/definitions/shared3"
      +      },
      +      "private": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "prompt": {
      +        "$ref": "#/definitions/shared4"
      +      },
      +      "resolution": {
      +        "pattern": "^[1-9][0-9]{1,4}x[1-9][0-9]{1,4}$",
      +        "type": "string"
      +      },
      +      "resolution_tier": {
      +        "enum": [
      +          "1k",
      +          "2k"
      +        ],
      +        "type": "string"
      +      },
      +      "seed": {
      +        "$ref": "#/definitions/shared5"
      +      },
      +      "style_codes": {
      +        "$ref": "#/definitions/shared6"
      +      },
      +      "style_preset": {
      +        "$ref": "#/definitions/__schema5"
      +      },
      +      "style_reference_asset_identifiers": {
      +        "$ref": "#/definitions/shared7"
      +      },
      +      "style_reference_collection_id": {
      +        "type": "string"
      +      },
      +      "style_reference_collection_version_id": {
      +        "type": "string"
      +      },
      +      "style_type": {
      +        "$ref": "#/definitions/__schema6"
      +      }
      +    },
      +    "required": [
      +      "model",
      +      "prompt"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "aspect_ratio": {
      +        "$ref": "#/definitions/__schema7"
      +      },
      +      "color_palette": {
      +        "$ref": "#/definitions/__schema0"
      +      },
      +      "enable_copyright_detection": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "image": {
      +        "type": "string"
      +      },
      +      "image_asset_identifier": {
      +        "$ref": "#/definitions/__schema2"
      +      },
      +      "image_weight": {
      +        "$ref": "#/definitions/shared1"
      +      },
      +      "magic_prompt": {
      +        "$ref": "#/definitions/__schema3"
      +      },
      +      "model": {
      +        "const": "ideogram-3",
      +        "type": "string"
      +      },
      +      "negative_prompt": {
      +        "$ref": "#/definitions/shared2"
      +      },
      +      "num_images": {
      +        "$ref": "#/definitions/shared3"
      +      },
      +      "private": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "prompt": {
      +        "$ref": "#/definitions/shared4"
      +      },
      +      "rendering_speed": {
      +        "$ref": "#/definitions/shared8"
      +      },
      +      "resolution": {
      +        "$ref": "#/definitions/__schema8"
      +      },
      +      "seed": {
      +        "$ref": "#/definitions/shared5"
      +      },
      +      "style_codes": {
      +        "$ref": "#/definitions/shared6"
      +      },
      +      "style_preset": {
      +        "$ref": "#/definitions/__schema5"
      +      },
      +      "style_reference_asset_identifiers": {
      +        "$ref": "#/definitions/shared7"
      +      },
      +      "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": {
      +        "$ref": "#/definitions/__schema6"
      +      }
      +    },
      +    "required": [
      +      "prompt"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "aspect_ratio": {
      +        "$ref": "#/definitions/__schema7"
      +      },
      +      "character_reference_asset_identifiers": {
      +        "additionalItems": false,
      +        "items": [
      +          {
      +            "$ref": "#/definitions/__schema2"
      +          }
      +        ],
      +        "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"
      +        ]
      +      },
      +      "image": {
      +        "type": "string"
      +      },
      +      "image_asset_identifier": {
      +        "$ref": "#/definitions/__schema2"
      +      },
      +      "image_weight": {
      +        "$ref": "#/definitions/shared1"
      +      },
      +      "magic_prompt": {
      +        "$ref": "#/definitions/__schema3"
      +      },
      +      "model": {
      +        "const": "ideogram-3-character",
      +        "type": "string"
      +      },
      +      "negative_prompt": {
      +        "$ref": "#/definitions/shared2"
      +      },
      +      "num_images": {
      +        "$ref": "#/definitions/shared3"
      +      },
      +      "private": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "prompt": {
      +        "$ref": "#/definitions/shared4"
      +      },
      +      "rendering_speed": {
      +        "$ref": "#/definitions/shared8"
      +      },
      +      "resolution": {
      +        "$ref": "#/definitions/__schema8"
      +      },
      +      "seed": {
      +        "$ref": "#/definitions/shared5"
      +      },
      +      "style_reference_asset_identifiers": {
      +        "$ref": "#/definitions/shared7"
      +      },
      +      "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/__schema7"
      +      },
      +      "color_palette": {
      +        "$ref": "#/definitions/__schema0"
      +      },
      +      "custom_model_uri": {
      +        "maxLength": 512,
      +        "minLength": 1,
      +        "pattern": "^model\\/[^\\/]+\\/version\\/[^\\/]+$",
      +        "type": "string"
      +      },
      +      "enable_copyright_detection": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "image": {
      +        "type": "string"
      +      },
      +      "image_asset_identifier": {
      +        "$ref": "#/definitions/__schema2"
      +      },
      +      "image_weight": {
      +        "$ref": "#/definitions/shared1"
      +      },
      +      "magic_prompt": {
      +        "$ref": "#/definitions/__schema3"
      +      },
      +      "model": {
      +        "const": "ideogram-3-custom-model",
      +        "type": "string"
      +      },
      +      "negative_prompt": {
      +        "$ref": "#/definitions/shared2"
      +      },
      +      "num_images": {
      +        "$ref": "#/definitions/shared3"
      +      },
      +      "private": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "prompt": {
      +        "$ref": "#/definitions/shared4"
      +      },
      +      "rendering_speed": {
      +        "enum": [
      +          "turbo",
      +          "default",
      +          "quality"
      +        ],
      +        "type": "string"
      +      },
      +      "resolution": {
      +        "$ref": "#/definitions/__schema8"
      +      },
      +      "seed": {
      +        "$ref": "#/definitions/shared5"
      +      },
      +      "style_codes": {
      +        "$ref": "#/definitions/shared6"
      +      },
      +      "style_preset": {
      +        "$ref": "#/definitions/__schema5"
      +      },
      +      "style_reference_asset_identifiers": {
      +        "$ref": "#/definitions/shared7"
      +      },
      +      "style_reference_images": {
      +        "items": {
      +          "type": "string"
      +        },
      +        "maxItems": 10,
      +        "type": "array"
      +      }
      +    },
      +    "required": [
      +      "model",
      +      "custom_model_uri",
      +      "prompt"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "enable_copyright_detection": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "image": {
      +        "type": "string"
      +      },
      +      "image_asset_identifier": {
      +        "$ref": "#/definitions/__schema2"
      +      },
      +      "image_weight": {
      +        "$ref": "#/definitions/shared1"
      +      },
      +      "model": {
      +        "const": "ideogram-4",
      +        "type": "string"
      +      },
      +      "num_images": {
      +        "$ref": "#/definitions/shared3"
      +      },
      +      "private": {
      +        "type": [
      +          "boolean",
      +          "null"
      +        ]
      +      },
      +      "prompt": {
      +        "$ref": "#/definitions/shared4"
      +      },
      +      "rendering_speed": {
      +        "$ref": "#/definitions/shared8"
      +      },
      +      "resolution": {
      +        "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"
      +      }
      +    },
      +    "required": [
      +      "model",
      +      "prompt"
      +    ],
      +    "type": "object"
      +  }
      +]
    • changedInput schema / properties / aspect_ratio / description
      Previous value: -"Output aspect ratio"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"
    • addedInput schema / properties / custom_model_uri
      Added value: +{
      +  "description": "A custom model you trained or were given access to"
      +}
    • addedInput schema / properties / enable_copyright_detection
      Added value: +{
      +  "description": "Run Ideogram's copyright detection on the result (adds latency)"
      +}
    • changedInput schema / properties / image / description
      Previous value: -"Local file path of the source image to remix"New value: +"Local image file to work on, or a public https URL of one"
    • removedInput schema / properties / image / minLength
      Removed value: -1
    • removedInput schema / properties / image / type
      Removed value: -"string"
    • addedInput schema / properties / image_asset_identifier
      Added value: +{
      +  "description": "An Ideogram asset (an upload or an earlier result) instead of a local image"
      +}
    • changedInput schema / properties / image_weight / description
      Previous value: -"Original image influence (0-100, default: 50)"New value: +"How closely the result follows the source image, 1-100"
    • removedInput schema / properties / image_weight / maximum
      Removed value: -100
    • removedInput schema / properties / image_weight / minimum
      Removed value: -0
    • removedInput schema / properties / image_weight / type
      Removed value: -"integer"
    • 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 / model
      Added value: +{
      +  "description": "The model (default ideogram-3); each takes the fields of its variant below",
      +  "enum": [
      +    "auto",
      +    "ideogram-3",
      +    "ideogram-3-character",
      +    "ideogram-3-custom-model",
      +    "ideogram-4"
      +  ],
      +  "type": "string"
      +}
    • changedInput schema / properties / negative_prompt / description
      Previous value: -"What to exclude"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 variations (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: -"New creative direction"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"
    • changedInput schema / properties / rendering_speed / description
      Previous value: -"Speed/quality tradeoff (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"
    • changedInput schema / properties / resolution / description
      Previous value: -"Exact output resolution (one of Ideogram's 69 sizes); not with aspect_ratio"New value: +"Exact output size WIDTHxHEIGHT from the model's list; not with aspect_ratio"
    • removedInput schema / properties / resolution / enum
      Removed value: -[
      -  "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"
      -]
    • removedInput schema / properties / resolution / type
      Removed value: -"string"
    • addedInput schema / properties / resolution_tier
      Added value: +{
      +  "description": "The output resolution tier"
      +}
    • changedInput schema / properties / seed / description
      Previous value: -"Reproducibility seed"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"
    • 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 / 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: -[
      -  "image",
      -  "prompt"
      -]
  2. Changed9 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 / resolution
      Added value: +{
      +  "description": "Exact output resolution (one of Ideogram's 69 sizes); not with aspect_ratio",
      +  "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"
      +}
    • 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

B3.4/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. It usefully discloses that results are saved to the output directory and that quoting generates nothing and is not billed. It is silent on the cost per generated image, permission/asset requirements, or failure behavior, which matters for a paid generation tool with 29 optional parameters.

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?

Two dense sentences that are front-loaded with the core operation before the model list and the output/quote details. Given the tool's complexity this is compact and no sentence is filler, though the model parenthetical is slightly cluttered.

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

Completeness3/5

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

For a 29-parameter tool with a five-branch oneOf schema, no annotations, and no output schema, the description is thin. It omits how the model choice changes required fields (e.g. custom_model_uri, rendering_speed availability) and says nothing about the mutually exclusive resolution/aspect_ratio options the schema encodes.

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

Parameters3/5

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

Schema description coverage is 100%, so the schema already documents every parameter, establishing a baseline of 3. The description adds only the meaning of image_weight and the model list, both of which are effectively mirrored in the schema, so it contributes little beyond structured fields.

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

Purpose4/5

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

States a concrete verb and resource: making new images from a source image plus a prompt, which is a distinct image-to-image operation. It names supported models and explains what image_weight controls. It does not explicitly distinguish itself from remix-adjacent siblings like ideogram_precise_edit or ideogram_inpaint, so an agent must infer the boundary.

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

Usage Guidelines3/5

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

It usefully routes the agent to ideogram_quote for pricing before generating, which is a genuine usage hint. However there is no guidance on when to prefer remix over ideogram_generate, ideogram_edit, or ideogram_precise_edit, and no exclusions or prerequisites for the source image.

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