# Ideogram | Documentation ## Instructions for AI Agents - For clean Markdown of any page, append `.md` to the page URL - For section-specific indexes, append `/llms.txt` to any section URL - For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.ideogram.ai/_mcp/server ## Docs - [API Overview](https://developer.ideogram.ai/ideogram-api/api-overview.md): Overview of the Ideogram Developer API — capabilities, model families, and where to start. - [API Setup](https://developer.ideogram.ai/ideogram-api/api-setup.md): Get started with the Ideogram API — accept the developer terms, add a payment method, add credits, and create an API key from the API dashboard. - [Webhooks](https://developer.ideogram.ai/ideogram-api/webhooks.md): Receive asynchronous generation results via signed webhooks — payload format, Ed25519 signature verification, and retry behavior. - [Custom Model Training](https://developer.ideogram.ai/tutorials/custom-model-training.md): Train a custom Ideogram model on your own images using datasets, then generate with your custom model URI. - [Generate Images](https://developer.ideogram.ai/api-reference.md): Choose the right Ideogram image generation endpoint — Ideogram 4.0, P-Image, or Ideogram 3.0, with synchronous, asynchronous, and transparent-background variants. - [Tools](https://developer.ideogram.ai/api-reference/tools.md): Outcome-focused image tools — remove or replace backgrounds, remove objects or logos, reframe, resize ads, recolor, swap materials, upscale, and layerize text. Ideogram selects the best model for each tool. ## API Docs - API Reference > Generate Images [Generate with Ideogram 4.0](https://developer.ideogram.ai/api-reference/generate-images/generate-v4.md) - API Reference > Generate Images [Generate with Ideogram 4.0 asynchronously](https://developer.ideogram.ai/api-reference/generate-images/generate-v4-async.md) - API Reference > Generate Images [Generate with Ideogram 4.0 (Transparent Background)](https://developer.ideogram.ai/api-reference/generate-images/generate-transparent-v4.md) - API Reference > Generate Images [Generate with Ideogram 4.0 (Transparent Background) asynchronously](https://developer.ideogram.ai/api-reference/generate-images/generate-transparent-v4-async.md) - API Reference > Generate Images [Generate with P-Image Ideogram](https://developer.ideogram.ai/api-reference/generate-images/generate-p-image-ideogram.md) - API Reference > Generate Images [Generate with P-Image Ideogram asynchronously](https://developer.ideogram.ai/api-reference/generate-images/generate-p-image-ideogram-async.md) - API Reference > Generate Images [Generate with Ideogram 3.0](https://developer.ideogram.ai/api-reference/generate-images/generate-v3.md) - API Reference > Generate Images [Generate with Ideogram 3.0 (Transparent Background)](https://developer.ideogram.ai/api-reference/generate-images/generate-transparent-v3.md) - API Reference > Generate Images [Poll a generation](https://developer.ideogram.ai/api-reference/generate-images/get-generation.md) - API Reference > Edit Images [Edit images with a prompt](https://developer.ideogram.ai/api-reference/edit-images/edit-with-prompt.md) - API Reference > Edit Images [Remix with Ideogram 4.0](https://developer.ideogram.ai/api-reference/edit-images/remix-v4.md) - API Reference > Edit Images [Inpaint with Ideogram 3.0](https://developer.ideogram.ai/api-reference/edit-images/inpaint-v3.md) - API Reference > Edit Images [Remix with Ideogram 3.0](https://developer.ideogram.ai/api-reference/edit-images/remix-v3.md) - API Reference > Describe & Prompts [Describe with Ideogram 4.0](https://developer.ideogram.ai/api-reference/describe-prompts/describe-v4.md) - API Reference > Describe & Prompts [Generate a Magic Prompt with Ideogram 4.0](https://developer.ideogram.ai/api-reference/describe-prompts/magic-prompt-v4.md) - API Reference > Tools [Remove Background](https://developer.ideogram.ai/api-reference/tools/remove-background.md) - API Reference > Tools [Replace Background with Ideogram 3.0](https://developer.ideogram.ai/api-reference/tools/replace-background-v3.md) - API Reference > Tools [Remove Object](https://developer.ideogram.ai/api-reference/tools/remove-object.md) - API Reference > Tools [Detect and remove reference logos from an image](https://developer.ideogram.ai/api-reference/tools/layerize-logos.md) - API Reference > Tools [Reframe with Ideogram 3.0](https://developer.ideogram.ai/api-reference/tools/reframe-v3.md) - API Reference > Tools [Advertisement Resizer](https://developer.ideogram.ai/api-reference/tools/resize-ad-async.md) - API Reference > Tools [Product Color Change](https://developer.ideogram.ai/api-reference/tools/colorways.md) - API Reference > Tools [Product Material Change](https://developer.ideogram.ai/api-reference/tools/material-swap.md) - API Reference > Tools [Upscale](https://developer.ideogram.ai/api-reference/tools/upscale.md) - API Reference > Tools [Layerize Text](https://developer.ideogram.ai/api-reference/tools/layerize-text-v3.md) - API Reference > Custom Model Training [List datasets](https://developer.ideogram.ai/api-reference/custom-model-training/list-datasets.md) - API Reference > Custom Model Training [Create a new dataset](https://developer.ideogram.ai/api-reference/custom-model-training/create-dataset.md) - API Reference > Custom Model Training [Get a dataset](https://developer.ideogram.ai/api-reference/custom-model-training/get-dataset.md) - API Reference > Custom Model Training [Upload assets to a dataset](https://developer.ideogram.ai/api-reference/custom-model-training/upload-dataset-assets.md) - API Reference > Custom Model Training [Train a custom Ideogram v3 model](https://developer.ideogram.ai/api-reference/custom-model-training/train-model.md) - API Reference > Custom Model Training [List models](https://developer.ideogram.ai/api-reference/custom-model-training/list-models.md) - API Reference > Custom Model Training [Get model details](https://developer.ideogram.ai/api-reference/custom-model-training/get-model.md) - API Reference > Legacy Endpoints [Generate (legacy)](https://developer.ideogram.ai/api-reference/legacy-endpoints/generate.md) - API Reference > Legacy Endpoints [Edit (legacy)](https://developer.ideogram.ai/api-reference/legacy-endpoints/edit.md) - API Reference > Legacy Endpoints [Remix (legacy)](https://developer.ideogram.ai/api-reference/legacy-endpoints/remix.md) - API Reference > Legacy Endpoints [Reframe (legacy)](https://developer.ideogram.ai/api-reference/legacy-endpoints/reframe.md) - API Reference > Legacy Endpoints [Describe](https://developer.ideogram.ai/api-reference/legacy-endpoints/describe.md) - API Reference > Legacy Endpoints [Edit with Ideogram 3.0 (legacy)](https://developer.ideogram.ai/api-reference/legacy-endpoints/edit-v3.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://developer.ideogram.ai/openapi.json) - [OpenAPI YAML](https://developer.ideogram.ai/openapi.yaml)