---
title: "Ideogram Image Edit - Edit an image using inpainting"
method: POST
path: "/v1/ai/ideogram-image-edit"
tags: ["ideogram-image-edit"]
---

# Ideogram Image Edit - Edit an image using inpainting

`POST /v1/ai/ideogram-image-edit`

## Request

- Base URL: `https://api.magnific.com`
- URL: `https://api.magnific.com/v1/ai/ideogram-image-edit`
- Auth: API key in header `x-magnific-api-key`

Edit an image using Ideogram AI's inpainting capabilities. Provide an image and a mask to specify the areas to edit, along with a prompt describing the desired changes.

**Key features:**
- Inpainting: Edit specific areas of an image using a mask
- Multiple rendering speeds: TURBO, DEFAULT, or QUALITY
- MagicPrompt: Automatically enhance your prompt for better results
- Style customization: Use style codes, style types, and reference images
- Character reference: Use reference images to maintain character consistency

**Supported formats:** JPEG, WebP, PNG (max 10MB each)

## Request body

- RequestContent8
  - `prompt` string, required: The prompt describing the desired changes to the image.
  - `image` string, required: The image to be edited. Supports HTTPS URLs or Base64 encoded string. Supported formats: JPEG, WebP, PNG (max 10MB)
  - `mask` string, required: A black and white image of the same size as the image being edited. Black regions indicate where to edit the image. Supports HTTPS URLs or Base64 encoded string. Supported formats: JPEG, WebP, PNG (max 10MB)
  - `seed` integer: Optional seed for reproducibility
  - `rendering_speed` 'TURBO' | 'DEFAULT' | 'QUALITY': The rendering speed for image generation. - TURBO: Fastest, lower quality - DEFAULT: Balanced speed and quality - QUALITY: Slower, higher quality
  - `magic_prompt` 'AUTO' | 'ON' | 'OFF': Determine if MagicPrompt should be used to enhance the prompt. - AUTO: Automatically decide - ON: Always use MagicPrompt - OFF: Never use MagicPrompt
  - `color_palette` RequestContent8ColorPalette: A color palette for generation. Specify either name (preset) or members (custom colors), not both.
    - `name` 'EMBER' | 'FRESH' | 'JUNGLE' | 'MAGIC' | 'MELON' | 'MOSAIC' | 'PASTEL' | 'ULTRAMARINE': A color palette preset value
    - `members` RequestContent8ColorPaletteMembersInner[]: Custom color palette members
      - `color_hex` string, required: Hexadecimal color code
      - `color_weight` number: Weight of the color in the palette
  - `style_codes` string[]: A list of style codes to use for image generation
  - `style_type` 'AUTO' | 'GENERAL' | 'REALISTIC' | 'DESIGN': The type of style to use. Must be specified if character_reference_images is provided. - AUTO: Automatically select style - GENERAL: General purpose style - REALISTIC: Realistic style - DESIGN: Design-oriented style
  - `style_reference_images` string[]: Images to use as style references. Provide as Base64 strings or URLs. Maximum total size: 10MB across all references. Supported formats: JPEG, PNG, WebP
  - `character_reference_images` string[]: Images to use as character references for consistency. Provide as Base64 strings or URLs. Maximum total size: 10MB across all references. Supported formats: JPEG, PNG, WebP
  - `webhook_url` string, uri: Optional callback URL that will receive asynchronous notifications whenever the task changes status. The payload sent to this URL is the same as the corresponding GET endpoint response, but without the data field.

## Response `200`

OK - The task exists and the status is returned

- InlineObject4
  - `data` TaskDetail1, required
    - `task_id` string, uuid, required: Task identifier
    - `status` 'CREATED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED', required: Task status
    - `generated` string[], required

## Other responses

- `400`: Bad Request - The server could not understand the request due to invalid syntax.
- `401`: Unauthorized - The client must authenticate itself to get the requested response.
- `500`: Internal Server Error - The server has encountered a situation it doesn't know how to handle.
- `503`: Service Unavailable

---

[API](https://skmtc.dev/magnific/apis/magnific-api.md) · [All operations](https://skmtc.dev/magnific/apis/magnific-api/llms.txt) · [OpenAPI document](https://skmtc.dev/magnific/apis/magnific-api/revisions/60711fb082c7?raw)