Name: Ideogram 4.5 Precise Edit API: AI Image Editing
Brand: magicapi
SKU: api-magicapi-precise-image-editing-ideogram-ai-ideogram-4-5-precise-edit
Availability: InStock
Author: API Market

Shashank Agarwal

# 🖌️ Image Editing API (Ideogram 4.5 Precise Edit)

## Overview
Ideogram 4.5 Precise Edit is an image editing model from Ideogram. Its developer describes it as precisely editing source images.

Send a source `image` and a `prompt` that describes the change. Add a `mask` to limit the edit to part of the image, and up to 4 `reference_images` to guide the result. Each request returns 1 to 8 edited images.

## Features
- **Instruction editing**: describe the change in plain words, for example "change these to elephants".
- **Masked edits**: a black and white `mask` the same size as the source; black pixels are edited, white pixels are kept.
- **Reference images**: up to 4 `reference_images` (3 when a mask is provided) to guide the edit.
- **Quality levels**: `very_low`, `low`, `medium` (default) or `high`. Higher quality is slower and costs more.
- **Several results**: `num_images` from 1 to 8 per request.
- **Seed**: set `seed` (up to 2147483647) to reproduce a result.

## Use Cases
1. **Object swaps**: replace one kind of object or animal with another while keeping the scene.
2. **Local fixes**: change only the masked area of a photo, such as a sign, a product or a background element.
3. **Product variations**: edit a product shot to match a reference style or color.
4. **Creative variations**: generate several edited versions of one image and pick the best.

## Visual Examples
### Example Input
Prompt: "change these to elephants"

![Source image for the edit](https://blog.api.market/wp-content/uploads/2026/10/ideogram-4-5-precise-edit-input-api-market.png)

Settings: `quality` `medium`, `num_images` 1; no mask or reference images.

### Example Output
![Edited image produced for the prompt change these to elephants](https://blog.api.market/wp-content/uploads/2026/10/ideogram-4-5-precise-edit-output-q19965s0-api-market.png)

## Input Parameters
| Field | Type | Required | Default | Allowed values | Description |
| --- | --- | --- | --- | --- | --- |
| `prompt` | string | Yes |  |  | Text prompt describing the edit to apply. |
| `image` | string (URL) | Yes |  |  | The source image to edit (URL). |
| `mask` | string (URL) | No | none |  | Optional black and white mask URL matching the source dimensions. Black pixels are edited, white pixels are preserved. |
| `reference_images` | array of URLs | No | none |  | Up to 4 reference image URLs to guide the edit (3 when a mask is provided). |
| `quality` | string | No | `medium` | `very_low`, `low`, `medium`, `high` | Edit quality. Higher quality is slower and more expensive. |
| `num_images` | integer | No | `1` | `1` to `8` | Number of images to generate. |
| `seed` | integer | No | none | up to `2147483647` | Random seed. Set for reproducible generation. |

## Pricing
- **Pay As You Go (PAYG) pricing**: you only pay for what you use.
- **Price**: $0.01 per API unit.
- **1 API unit = 1 output image at `very_low` quality.** Higher `quality` values multiply the units per image:

| `quality` | Units per image | Price per image |
| --- | --- | --- |
| `very_low` | 1 | $0.01 |
| `low` | 3.75 | $0.0375 |
| `medium` (default) | 7.5 | $0.075 |
| `high` | 27.5 | $0.275 |

- When `quality` is omitted, `medium` applies ($0.075 per image).
- Each request returns `num_images` images (1 to 8, default 1), and each image is billed. For example, 8 images at `high` cost $2.20.
- **Example cost**: the example request returned 1 image at `medium` quality: **$0.075**.
- **Failed or cancelled predictions are not billed.**
- **GET requests to check prediction status** are free and don't count toward API unit usage.
- **No monthly subscription fee.**

## API Documentation

### Base URL
All API requests go to: `https://prod.api.market/api/v1/magicapi/precise-image-editing-ideogram-ai-ideogram-4-5-precise-edit`

### Authentication
Send your api.market API key in the `x-api-market-key` header:
```
x-api-market-key: YOUR_API_MARKET_KEY
```

### Asynchronous Processing
**IMPORTANT**: This API is asynchronous. The flow is:
1. Send a POST request to `/predictions`. A successful request returns **201 Created** with a prediction `id` and a `status` of `starting` or `processing`.
2. Poll GET `/predictions/{id}` with that ID.
3. Keep polling while `status` is `starting` or `processing`.
4. Stop when `status` is `succeeded` (read `output`), `failed` or `canceled` (read `error`).

A polling interval of 1 second and an overall timeout of 600 seconds (10 minutes) work well. The example request (medium quality) finished in about 21 seconds.

### Endpoints

#### Create a Prediction
```bash
curl -X POST "https://prod.api.market/api/v1/magicapi/precise-image-editing-ideogram-ai-ideogram-4-5-precise-edit/predictions" \
  -H "Content-Type: application/json" \
  -H "x-api-market-key: YOUR_API_MARKET_KEY" \
  -d '{
    "version": "ideogram-ai/ideogram-4-5-precise-edit",
    "input": {
      "image": "https://blog.api.market/wp-content/uploads/2026/10/ideogram-4-5-precise-edit-input-api-market.png",
      "prompt": "change these to elephants",
      "quality": "medium",
      "num_images": 1
    }
  }'
```

Response (201 Created):
```json
{
  "id": "q19965s01xrmt0d1c6srjb5vk4",
  "version": "ideogram-ai/ideogram-4-5-precise-edit",
  "status": "starting",
  "created_at": "2026-10-22T03:41:31.731Z"
}
```

#### Check Prediction Status
```bash
curl -X GET "https://prod.api.market/api/v1/magicapi/precise-image-editing-ideogram-ai-ideogram-4-5-precise-edit/predictions/{id}" \
  -H "x-api-market-key: YOUR_API_MARKET_KEY"
```

Response when the prediction has finished (200 OK):
```json
{
  "id": "q19965s01xrmt0d1c6srjb5vk4",
  "status": "succeeded",
  "output": [
    "https://blog.api.market/wp-content/uploads/2026/10/ideogram-4-5-precise-edit-output-q19965s0-api-market.png"
  ],
  "error": null,
  "created_at": "2026-10-22T03:41:31.731Z",
  "started_at": "2026-10-22T03:41:32.231Z",
  "completed_at": "2026-10-22T03:41:52.318Z"
}
```

`output` is a list of image URLs, one per image requested with `num_images`.

### Status Codes
- **201 Created**: prediction created (POST `/predictions`). This is the normal success response.
- **200 OK**: prediction details returned (GET `/predictions/{id}`).
- **400 Bad Request**: invalid input, for example a missing `image` or a `num_images` above 8.
- **401 Unauthorized**: missing or invalid API key.
- **404 Not Found**: no prediction with that ID.
- **429 Too Many Requests**: rate limit exceeded.
- **500 Internal Server Error** or **503 Service Unavailable**: temporary server problem; retry later.

## Rate Limits
All plans allow 10 requests per second. Requests above that return `429 Too Many Requests`; back off before retrying and honour any `Retry-After` header. Polling a prediction with GET is free but still counts toward the per-second limit, so poll every 1 to 5 seconds rather than in a tight loop.
## Error Handling
- Check the HTTP status code of every request and read the response body for the error message.
- A prediction can also end with `status` set to `failed`; the `error` field then explains why. Failed predictions are not billed.
- Retry 429, 500 and 503 responses with exponential backoff. Fix the input before retrying a 400.

## Implementation Guide
### Example Code

#### JavaScript
```javascript
const apiKey = "YOUR_API_MARKET_KEY";
const baseUrl = "https://prod.api.market/api/v1/magicapi/precise-image-editing-ideogram-ai-ideogram-4-5-precise-edit";

async function createAndWaitForPrediction(input) {
  const response = await fetch(`${baseUrl}/predictions`, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "x-api-market-key": apiKey
    },
    body: JSON.stringify({ version: "ideogram-ai/ideogram-4-5-precise-edit", input })
  });

  if (response.status !== 201) {
    throw new Error(`API error: ${response.status} ${await response.text()}`);
  }

  const prediction = await response.json();
  return pollForResults(prediction.id);
}

const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));

async function pollForResults(predictionId) {
  const maxTimeout = 600000;
  const pollInterval = 1000;
  const startTime = Date.now();

  while (Date.now() - startTime < maxTimeout) {
    const response = await fetch(`${baseUrl}/predictions/${predictionId}`, {
      headers: { "x-api-market-key": apiKey }
    });

    if (!response.ok) {
      throw new Error(`API error: ${response.status} ${await response.text()}`);
    }

    const prediction = await response.json();

    if (prediction.status === "succeeded") {
      return prediction.output;
    }

    if (prediction.status === "failed" || prediction.status === "canceled") {
      throw new Error(`Prediction ${prediction.status}: ${prediction.error || "Unknown error"}`);
    }

    await delay(pollInterval);
  }

  throw new Error("Prediction timed out after 10 minutes");
}

createAndWaitForPrediction({
    "image": "https://blog.api.market/wp-content/uploads/2026/10/ideogram-4-5-precise-edit-input-api-market.png",
    "prompt": "change these to elephants",
    "quality": "medium",
    "num_images": 1
  }).then((output) => console.log(output));
```

#### Python
```python
import time
import requests

API_KEY = "YOUR_API_MARKET_KEY"
BASE_URL = "https://prod.api.market/api/v1/magicapi/precise-image-editing-ideogram-ai-ideogram-4-5-precise-edit"


def create_and_wait_for_prediction(input_data):
    headers = {"Content-Type": "application/json", "x-api-market-key": API_KEY}
    response = requests.post(
        f"{BASE_URL}/predictions",
        headers=headers,
        json={"version": "ideogram-ai/ideogram-4-5-precise-edit", "input": input_data},
    )

    if response.status_code != 201:
        raise Exception(f"API error: {response.status_code} {response.text}")

    return poll_for_results(response.json()["id"])


def poll_for_results(prediction_id):
    max_timeout = 600
    poll_interval = 1
    headers = {"x-api-market-key": API_KEY}
    start_time = time.time()

    while time.time() - start_time < max_timeout:
        response = requests.get(f"{BASE_URL}/predictions/{prediction_id}", headers=headers)

        if response.status_code != 200:
            raise Exception(f"API error: {response.status_code} {response.text}")

        prediction = response.json()

        if prediction["status"] == "succeeded":
            return prediction["output"]

        if prediction["status"] in ("failed", "canceled"):
            raise Exception(f"Prediction {prediction['status']}: {prediction.get('error') or 'Unknown error'}")

        time.sleep(poll_interval)

    raise Exception("Prediction timed out after 10 minutes")


print(create_and_wait_for_prediction({
    "image": "https://blog.api.market/wp-content/uploads/2026/10/ideogram-4-5-precise-edit-input-api-market.png",
    "prompt": "change these to elephants",
    "quality": "medium",
    "num_images": 1
}))
```

## FAQ
- **How do I edit only part of an image?**
  - Send a black and white `mask` with the same dimensions as the source. Black pixels are edited; white pixels are preserved.
- **How many reference images can I send?**
  - Up to 4, or up to 3 when you also send a mask.
- **Which quality should I use?**
  - `medium` is the default ($0.075 per image). `very_low` ($0.01) and `low` ($0.0375) are cheaper and faster; `high` ($0.275) is slower and more expensive.
- **How many images does one request return?**
  - `num_images`, from 1 to 8 (default 1). Each image is billed.

- **Is the 201 response from POST an error?**
  - No. 201 Created means the prediction was accepted. Use the returned `id` to poll GET `/predictions/{id}` until `status` is `succeeded`, `failed` or `canceled`.
- **What if my prediction fails?**
  - Failed predictions are not billed. Read the `error` field, adjust the input and try again.

## Contact Us
If you have any questions or need assistance, you can reach out to us through the embedded chat on the bottom right corner of the page or send an email to hello@magicapi.com.


Ideogram 4.5 Precise Edit API: edit a source image from a text instruction, with an optional mask and up to 4 reference images, at four quality levels.