zf-kbot/md-me-ideogram | API reference

Public

51 runs

Run zf-kbot/md-me-ideogram with an API

Use one of our client libraries to get started quickly. Clicking on a library will take you to the Playground tab where you can tweak different inputs, see the results, and copy the corresponding code to use in your own project.

Input schema

The fields you can use to run this model with an API. If you don't give a value for a field its default value will be used.

Field	Type	Default value	Description
prompt	string	a clean studio product poster for the words IDEOGRAM 4, crisp typography, premium lighting	Plain text prompt or Ideogram 4 structured JSON caption.
resolution	None	2048x2048	Output resolution preset. Select custom to use width and height.
width	integer	2048 Min: 256 Max: 4096	Custom output width. Used only when resolution=custom. Must be a multiple of 16.
height	integer	2048 Min: 256 Max: 4096	Custom output height. Used only when resolution=custom. Must be a multiple of 16.
sampler_preset	None	V4_TURBO_12	Ideogram 4 sampler preset.
transparent_background	boolean	False	Prompt-driven transparent PNG mode. Verifies alpha after generation and fails if the output is opaque.
seed	integer	-1 Min: -1 Max: 2147483647	Random seed. Use -1 for a random seed.
use_magic_prompt	boolean	False	Expand plain prompts through the hosted magic-prompt API. Requires magic_prompt_key or IDEOGRAM_API_KEY.
warn_on_caption_issues	boolean	False	Warn instead of failing when the caption verifier reports issues.
magic_prompt_key	string		Optional Ideogram/OpenRouter key for hosted magic-prompt expansion.
hive_text_key	string		Optional Hive Text Moderation key for prompt screening.
hive_visual_key	string		Optional Hive Visual Moderation key for output screening.

{
  "type": "object",
  "title": "Input",
  "properties": {
    "seed": {
      "type": "integer",
      "title": "Seed",
      "default": -1,
      "maximum": 2147483647,
      "minimum": -1,
      "x-order": 6,
      "description": "Random seed. Use -1 for a random seed."
    },
    "width": {
      "type": "integer",
      "title": "Width",
      "default": 2048,
      "maximum": 4096,
      "minimum": 256,
      "x-order": 2,
      "description": "Custom output width. Used only when resolution=custom. Must be a multiple of 16."
    },
    "height": {
      "type": "integer",
      "title": "Height",
      "default": 2048,
      "maximum": 4096,
      "minimum": 256,
      "x-order": 3,
      "description": "Custom output height. Used only when resolution=custom. Must be a multiple of 16."
    },
    "prompt": {
      "type": "string",
      "title": "Prompt",
      "default": "a clean studio product poster for the words IDEOGRAM 4, crisp typography, premium lighting",
      "x-order": 0,
      "description": "Plain text prompt or Ideogram 4 structured JSON caption."
    },
    "resolution": {
      "enum": [
        "2048x2048",
        "1440x2880",
        "2880x1440",
        "1664x2496",
        "2496x1664",
        "1792x2240",
        "2240x1792",
        "1440x2560",
        "2560x1440",
        "1600x2560",
        "2560x1600",
        "1728x2304",
        "2304x1728",
        "1296x3168",
        "3168x1296",
        "1152x2944",
        "2944x1152",
        "1248x3328",
        "3328x1248",
        "1280x3072",
        "3072x1280",
        "512x512",
        "768x768",
        "1024x1024",
        "768x1344",
        "832x1216",
        "896x1152",
        "1152x896",
        "1216x832",
        "1344x768",
        "1536x1024",
        "1024x1536",
        "custom"
      ],
      "type": "string",
      "title": "resolution",
      "description": "Output resolution preset. Select custom to use width and height.",
      "default": "2048x2048",
      "x-order": 1
    },
    "hive_text_key": {
      "type": "string",
      "title": "Hive Text Key",
      "format": "password",
      "x-order": 10,
      "nullable": true,
      "writeOnly": true,
      "description": "Optional Hive Text Moderation key for prompt screening.",
      "x-cog-secret": true
    },
    "sampler_preset": {
      "enum": [
        "V4_DEFAULT_20",
        "V4_QUALITY_48",
        "V4_TURBO_12"
      ],
      "type": "string",
      "title": "sampler_preset",
      "description": "Ideogram 4 sampler preset.",
      "default": "V4_TURBO_12",
      "x-order": 4
    },
    "hive_visual_key": {
      "type": "string",
      "title": "Hive Visual Key",
      "format": "password",
      "x-order": 11,
      "nullable": true,
      "writeOnly": true,
      "description": "Optional Hive Visual Moderation key for output screening.",
      "x-cog-secret": true
    },
    "magic_prompt_key": {
      "type": "string",
      "title": "Magic Prompt Key",
      "format": "password",
      "x-order": 9,
      "nullable": true,
      "writeOnly": true,
      "description": "Optional Ideogram/OpenRouter key for hosted magic-prompt expansion.",
      "x-cog-secret": true
    },
    "use_magic_prompt": {
      "type": "boolean",
      "title": "Use Magic Prompt",
      "default": false,
      "x-order": 7,
      "description": "Expand plain prompts through the hosted magic-prompt API. Requires magic_prompt_key or IDEOGRAM_API_KEY."
    },
    "transparent_background": {
      "type": "boolean",
      "title": "Transparent Background",
      "default": false,
      "x-order": 5,
      "description": "Prompt-driven transparent PNG mode. Verifies alpha after generation and fails if the output is opaque."
    },
    "warn_on_caption_issues": {
      "type": "boolean",
      "title": "Warn On Caption Issues",
      "default": false,
      "x-order": 8,
      "description": "Warn instead of failing when the caption verifier reports issues."
    }
  }
}

Output schema

The shape of the response you’ll get when you run this model with an API.

Schema

{
  "type": "string",
  "title": "Output",
  "format": "uri"
}