Name: Image Generation and Inpainting API (Ideogram v2)
Brand: magicapi
SKU: api-magicapi-image-inpainting-text-rendering-api-ideogram-ai-ideogram-v2
Availability: InStock
Author: API Market

Shashank Agarwal

# 🖼️ Image Generation and Inpainting API (Ideogram v2)

## Overview
Ideogram v2 is an image model from Ideogram. Its developer describes it as strong at inpainting, prompt comprehension and text rendering. You send a text prompt and get back the URL of one image. You can pick an aspect ratio or an exact resolution, choose a style type, let Magic Prompt rewrite your prompt, and inpaint part of an existing image with an image and a mask.

## Features
- **Text to image**: one image per request from a text `prompt`.
- **Negative prompt**: `negative_prompt` lists things you do not want to see in the image.
- **Aspect ratio**: `1:1`, `16:9`, `9:16`, `4:3`, `3:4`, `3:2`, `2:3`, `16:10`, `10:16`, `3:1`, `1:3` (default `1:1`).
- **Exact resolution**: pick a size such as `1024x1024` or `1280x768` with `resolution`. A resolution overrides the aspect ratio.
- **Style type**: `None`, `Auto`, `General`, `Realistic`, `Design`, `Render 3D`, `Anime` (default `None`).
- **Magic Prompt**: `Auto` (default), `On` or `Off`. It interprets and rewrites your prompt to improve variety and quality, and lets you write prompts in different languages.
- **Inpainting**: send an `image` and a black and white `mask`. Black pixels are inpainted, white pixels are preserved. The mask is resized to match the image size. When an inpainting image is given, `aspect_ratio` and `resolution` are ignored.
- **Seed**: set `seed` (up to 2147483647) to reproduce a result.

## Use Cases
1. **Signs, posters and social graphics**: create images that include short words or titles, like the example below.
2. **Marketing visuals**: generate images for ads, banners and landing pages in the aspect ratio each channel needs.
3. **Image edits**: replace or add objects in part of an existing image with inpainting.
4. **Concept art**: try many visual directions with different style types and seeds.

## Visual Examples
This is a real request sent through api.market and the file it returned.

Prompt used: "A neon sign that reads 'api.market' on a brick wall at night"

All other fields were left at their defaults.

**Output image:**

![A white neon sign that reads API.MARKET on a brick wall at night](https://blog.api.market/wp-content/uploads/2026/10/ideogram-v2-output-api-market.webp)

The image shown is a resized WebP copy of the PNG file the request returned.

## Input Parameters
| Field | Type | Required | Default | Allowed values | Description |
| --- | --- | --- | --- | --- | --- |
| `prompt` | string | Yes |  |  | Text prompt for image generation |
| `negative_prompt` | string | No |  |  | Things you do not want to see in the generated image. |
| `aspect_ratio` | string | No | `1:1` | `1:1`, `16:9`, `9:16`, `4:3`, `3:4`, `3:2`, `2:3`, `16:10`, `10:16`, `3:1`, `1:3` | Aspect ratio. Ignored if a resolution or inpainting image is given. |
| `resolution` | string | No | `None` | `None` or a WIDTHxHEIGHT size from the list in the spec | Resolution. Overrides aspect ratio. Ignored if an inpainting image is given. |
| `style_type` | string | No | `None` | `None`, `Auto`, `General`, `Realistic`, `Design`, `Render 3D`, `Anime` | The styles help define the specific aesthetic of the image you want to generate. |
| `magic_prompt_option` | string | No | `Auto` | `Auto`, `On`, `Off` | Magic Prompt will interpret your prompt and optimize it to maximize variety and quality of the images generated. You can also use it to write prompts in different languages. |
| `image` | string | No |  | URL | An image file to use for inpainting. You must also use a mask. |
| `mask` | string | No |  | URL | A black and white image. Black pixels are inpainted, white pixels are preserved. The mask will be resized to match the image size. |
| `seed` | integer | No |  | up to 2147483647 | Random seed. Set for reproducible generation |

### Output
`output` is the URL of one image (a string).

## Pricing
- **Pay As You Go (PAYG) pricing**: you only pay for what you use.
- **Price**: $0.10 per API unit.
- **1 API unit = 1 output image.** Each request returns one image, so each successful request costs 1 unit, $0.10.
- Text to image and inpainting requests cost the same. Aspect ratio, resolution, style type and Magic Prompt do not change the price.
- **Failed or cancelled predictions are not billed.**
- **GET requests to check prediction status** (GET /api/v1/magicapi/image-inpainting-text-rendering-api-ideogram-ai-ideogram-v2/predictions/{id}) 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/image-inpainting-text-rendering-api-ideogram-ai-ideogram-v2`

### 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`. 201 means the request was accepted; it is not an error.
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.

### Endpoints

#### Create a Prediction
```bash
curl -X POST "https://prod.api.market/api/v1/magicapi/image-inpainting-text-rendering-api-ideogram-ai-ideogram-v2/predictions" \
  -H "Content-Type: application/json" \
  -H "x-api-market-key: YOUR_API_MARKET_KEY" \
  -d '{
    "version": "3e6071946ab5319b3bcc37a4d00083e743dfdff5be386df6a2ff1f212fc7365b",
    "input": {
      "prompt": "A neon sign that reads '\''api.market'\'' on a brick wall at night"
    }
  }'
```

Response (201 Created):
```json
{
  "id": "ufawqhfynnddngldkgtslldrkq",
  "version": "3e6071946ab5319b3bcc37a4d00083e743dfdff5be386df6a2ff1f212fc7365b",
  "status": "starting",
  "created_at": "2026-10-13T10:40:12.511Z"
}
```

#### Check Prediction Status
```bash
curl -X GET "https://prod.api.market/api/v1/magicapi/image-inpainting-text-rendering-api-ideogram-ai-ideogram-v2/predictions/ufawqhfynnddngldkgtslldrkq" \
  -H "x-api-market-key: YOUR_API_MARKET_KEY"
```

Response when the prediction has finished (200 OK):
```json
{
  "id": "ufawqhfynnddngldkgtslldrkq",
  "status": "succeeded",
  "output": "https://blog.api.market/wp-content/uploads/2026/10/ideogram-v2-output-api-market.webp",
  "error": null,
  "created_at": "2026-10-13T10:40:12.511Z",
  "started_at": "2026-10-13T10:40:13.020Z",
  "completed_at": "2026-10-13T10:40:21.734Z"
}
```

### 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 `prompt`, or an `aspect_ratio`, `resolution` or `style_type` that is not in the list.
- **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

### JavaScript
```javascript
const apiKey = "YOUR_API_MARKET_KEY";
const baseUrl = "https://prod.api.market/api/v1/magicapi/image-inpainting-text-rendering-api-ideogram-ai-ideogram-v2";

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: "3e6071946ab5319b3bcc37a4d00083e743dfdff5be386df6a2ff1f212fc7365b", 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({
  "prompt": "A neon sign that reads 'api.market' on a brick wall at night"
}).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/image-inpainting-text-rendering-api-ideogram-ai-ideogram-v2"

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": "3e6071946ab5319b3bcc37a4d00083e743dfdff5be386df6a2ff1f212fc7365b", "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({
  "prompt": "A neon sign that reads 'api.market' on a brick wall at night"
}))
```

## FAQ
- **How many images does one request return?**
  - One. `output` is a single image URL, billed at $0.10.
- **Should I use aspect_ratio or resolution?**
  - Use `aspect_ratio` for a standard shape. Use `resolution` when you need an exact size from the allowed list; it overrides `aspect_ratio`.
- **How do I inpaint?**
  - Send the image in `image` and a black and white `mask` of the same scene. Black areas are regenerated from your `prompt`, white areas stay as they are.
- **What does Magic Prompt do?**
  - It interprets your prompt and rewrites it to maximize variety and quality. Set `magic_prompt_option` to `Off` if you want your prompt used as written.
- **Is the 201 response from POST an error?**
  - No. 201 Created means the prediction was accepted. 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.


Image generation and inpainting with Ideogram v2: create images from text or edit a masked area. Set aspect ratio, style and Magic Prompt. $0.10 per image.