ideogram-image

What it does

Describes a skill that guides an AI agent to interact with the Ideogram Developer API for image generation and manipulation tasks (generate, remix, describe, inpaint, reframe, layerize, upscale) and to manage synchronous or webhook workflows, migrations, and API pricing/safety/QA considerations.

How it works

• It instructs the agent to use the official Developer API directly and treat a checked date as part of the contract.
• It provides sections on selecting API routes (e.g., POST /v1/ideogram-v4/generate, POST /v1/ideogram-v4/remix, POST /v1/ideogram-v3/generate, etc.), and explains not to send model strings, to use route segments ideogram-v4 or ideogram-v3, and to avoid legacy routes for new work.
• It specifies authentication: base URL https://api.ideogram.ai and Api-Key header; emphasizes reading documents for pricing, limits, and policy before release.
• It details request formats (multipart/form-data for most, JSON for V4 Magic Prompt), success shapes, and examples of responses (e.g., ImageGenerationResponseV4, ImageGenerationResponseV3).
• It outlines input-touch points and limits (image file types, size limits, and per-route inputs like prompt, image, mask, etc.).
• It enumerates exact route paths, required vs. optional fields, and how to interpret success responses; it includes exact endpoint paths such as /v1/ideogram-v4/generate, /v1/ideogram-v4/remix, /v1/ideogram-v3/generate, /v1/edit, /upscale, /describe, and more.
• It provides guidance on risk areas, including API volatility, the need to validate live schemas, and handling of safety flags in responses.
• It includes instructions for layout, typography, and prompt construction (e.g., using json_prompt vs text_prompt, Magic Prompt behavior, and how to structure V4 vs V3 prompts).

When to use it

• Use when Codex must integrate Ideogram 4.0 or 3.0, render reliable typography or structured layouts, use style or character references, build synchronous or webhook workflows, migrate legacy Ideogram endpoints, or reason about API pricing, safety, privacy, and QA.
• Use to migrate legacy endpoints and manage API lifecycle notes (e.g., route migration and retirement cautions).

What it can touch

• The skill references specific tools: claude-code, codex, copilot, cursor.
• It specifies interaction with the Ideogram API endpoints, including authentication headers and content types. It discusses requesting and handling image URLs from responses and downloading results immediately.

Caveats

• It repeatedly notes that API facts are documented and subject to change; volatility of endpoints, lifecycle, pricing, limits, policy, and URL lifetimes.
• It emphasizes not promising specific outputs (e.g., PNG/JPEG from URL suffix) and to validate dimensions, prompts, and safety flags against live docs.
• It warns about legacy routes and the need to migrate away from deprecated paths.
• It requires validation against live OpenAPI contracts and live pricing before releases or quotes.