# Ideogram V3 Character Edit API

> Ideogram V3 基于蒙版编辑图像，同时保留参考角色的身份特征

使用 `mask_url` 对 `image_url` 的蒙版区域进行局部重绘（两者尺寸必须完全相同），同时使用 `prompt` 和 `reference_image_urls` 中的角色参考图像（使用 1 张图像）。适用于更改姿势、表情或服装。支持可选的风格参考、`rendering_speed` 以及最多 8 个输出图像。

- Model id: `ideogram/character/edit`
- Made by: Ideogram
- Category: Image Editing
- Output: image
- Price: from $0.10 / image (cheapest run $0.10 (100 API credits))
- Run: `POST https://api.doitong.com/v1/run/ideogram/character/edit`
- Quote: `POST https://api.doitong.com/v1/quote/ideogram/character/edit`
- Docs page: https://doitong.com/zh/developers/models/ideogram/character/edit

## Pricing

Price: **from $0.10 / image** (the lowest tier; the quote prices your exact input). Billed per generated image (`num_images`, default 1).

Price rules (the first rule that matches the input wins; a parameter you leave out counts as its default):

- When `rendering_speed` = BALANCED: $0.15 (150 API credits) / image
- When `rendering_speed` = QUALITY: $0.20 (200 API credits) / image

The full example input below costs $0.15 = 150 API credits (1 image × 150 API credits).

Prices are the upstream price in USD, paid from the API balance in API credits (1000 API credits = 1 USD). `POST https://api.doitong.com/v1/quote/ideogram/character/edit` with the same JSON body returns the exact price for that input; the quote is exactly what a run charges. Invalid input is never charged and failed or canceled requests are refunded automatically.

## Input parameters

Send either the canonical name or the native field name (not both). Canonical names are the same across models.

| Parameter | Canonical name | Type | Required | Default | Allowed values / range | Description |
|---|---|---|---|---|---|---|
| `image_urls` | `images` | array of image URL \| null | no |  |  | JPEG、PNG 或 WebP 格式的风格参考图像。合计大小不得超过 10 MB。 |
| `rendering_speed` |  | enum (string) | no | `BALANCED` | `TURBO`, `BALANCED`, `QUALITY` | 渲染速度设置。 |
| `color_palette` |  | object {members, name} \| null | no |  |  | 生成过程中使用的调色板。可通过名称指定预设，或通过 members 指定显式十六进制颜色，也可以选择性包含权重。 |
| `color_palette.members` |  | array of object {rgb, color_weight} \| null | no |  |  | 定义调色板颜色的调色板成员列表。 |
| `color_palette.members[].rgb` |  | object {r, g, b} | yes |  |  | 以 RGB 表示的调色板成员颜色。 |
| `color_palette.members[].color_weight` |  | number \| null | no | `0.5` | 0.05 – 1 | 在调色板中分配给该颜色的权重。 |
| `color_palette.name` |  | enum (string) \| null | no |  | `EMBER`, `FRESH`, `JUNGLE`, `MAGIC`, `MELON`, `MOSAIC`, `PASTEL`, `ULTRAMARINE` | 调色板的预设选择。 |
| `style_codes` |  | array of string \| null | no |  |  | 图像风格代码，以每个 8 字符的十六进制字符串提供；使用此列表时省略 style_reference_images 和 style。 |
| `expand_prompt` |  | boolean | no | `true` |  | 请求生成的 MagicPrompt 使用开关。 |
| `num_images` | `num_outputs` | integer | no | `1` | 1 – 8 | 要生成的图像数量。 |
| `seed` |  | integer \| null | no |  |  | 随机数生成的种子值。 |
| `prompt` |  | string | yes |  |  | 描述图像遮罩区域填充内容的提示词。 |
| `image_url` | `image` | string (image URL) | yes |  |  | 以图像 URL 提供的生成源图像；宽度和高度都必须分别与蒙版对应尺寸完全相等。 |
| `mask_url` | `mask` | string (image URL) | yes |  |  | 通过 URL 提供的修复蒙版；宽度和高度都必须分别与输入图像对应尺寸完全相等。 |
| `reference_image_urls` |  | array of image URL | yes |  |  | JPEG、PNG 或 WebP 格式的角色参考图像；所有角色参考图像合计不得超过 10 MB。目前仅支持 1 张图像，其他图像会被忽略。 |
| `reference_mask_urls` |  | array of image URL | no |  |  | JPEG、PNG 或 WebP 格式的角色参考蒙版；所有角色参考图像合计不得超过 10 MB。目前仅使用 1 个蒙版，其他蒙版会被忽略。 |

File parameters (`images`, `image`, `mask`, `reference_image_urls`, `reference_mask_urls`) take a public `https://` URL, a `data:` URI up to 10 MB, or the `file_url` of an upload from `POST /files`.

## Example input

Required parameters only:

```json
{
  "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field",
  "image": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
  "mask": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
  "reference_image_urls": [
    "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg"
  ]
}
```

A fuller example:

```json
{
  "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field",
  "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
  "mask_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
  "reference_image_urls": [
    "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg"
  ]
}
```

## Run it

Set `DOITONG_API_KEY` to a key from https://doitong.com/developers/dashboard#keys. `?wait=20` returns the finished request in the same call when it is ready within 20 seconds; otherwise poll `GET /requests/{id}` (it also accepts `?wait=`), or pass `webhook_url`.

### curl

```bash
# Run the model; wait up to 20 s for the finished result in the same call
curl -X POST "https://api.doitong.com/v1/run/ideogram/character/edit?wait=20" \
  -H "Authorization: Bearer $DOITONG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field",
    "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
    "mask_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
    "reference_image_urls": [
      "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg"
    ]
  }'

# Still "queued" or "running"? Poll with the id from the response:
curl "https://api.doitong.com/v1/requests/REQUEST_ID?wait=20" \
  -H "Authorization: Bearer $DOITONG_API_KEY"
```

### JavaScript

```javascript
const API = "https://api.doitong.com/v1";
const headers = {
  "Authorization": "Bearer " + process.env.DOITONG_API_KEY,
  "Content-Type": "application/json",
};

// Run the model; wait up to 20 s for the finished result in the same call
let res = await fetch(API + "/run/ideogram/character/edit?wait=20", {
  method: "POST",
  headers,
  body: JSON.stringify({
    "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field",
    "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
    "mask_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
    "reference_image_urls": [
      "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg"
    ]
  }),
});
let request = await res.json();
if (!res.ok) throw new Error(request.error.code + ": " + request.error.message);

// Not finished yet: long-poll until it is
while (request.status === "queued" || request.status === "running") {
  res = await fetch(API + "/requests/" + request.id + "?wait=20", { headers });
  request = await res.json();
}
if (request.status !== "succeeded") throw new Error(JSON.stringify(request.error));
console.log(request.outputs.map((o) => o.url), request.cost.credits + " API credits ($" + request.cost.usd + ")");
```

### Python

```python
import os
import requests

API = "https://api.doitong.com/v1"
headers = {"Authorization": "Bearer " + os.environ["DOITONG_API_KEY"]}

payload = {
    "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field",
    "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
    "mask_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
    "reference_image_urls": [
        "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
    ],
}

# Run the model; wait up to 20 s for the finished result in the same call
r = requests.post(API + "/run/ideogram/character/edit", params={"wait": 20}, json=payload, headers=headers)
request = r.json()
if not r.ok:
    raise RuntimeError(request["error"]["code"] + ": " + request["error"]["message"])

# Not finished yet: long-poll until it is
while request["status"] in ("queued", "running"):
    request = requests.get(API + "/requests/" + request["id"], params={"wait": 20}, headers=headers).json()
if request["status"] != "succeeded":
    raise RuntimeError(request["error"])
print([o["url"] for o in request["outputs"]], request["cost"]["credits"], "API credits", "$" + request["cost"]["usd"])
```

### MCP

The MCP server at `https://api.doitong.com/v1/mcp` exposes the tools `search_models`, `get_model`, `quote`, `run`, `get_request`, `cancel_request`, `list_requests`, `create_upload` and `get_account`. A `run` call for this model:

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "run",
    "arguments": {
      "model_id": "ideogram/character/edit",
      "input": {
        "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field",
        "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
        "mask_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
        "reference_image_urls": [
          "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg"
        ]
      },
      "wait_seconds": 20
    }
  }
}
```

## Response

Every call returns a request object. `status` is one of `queued`, `running`, `succeeded`, `failed`, `canceled`. `outputs` lists the generated files with URLs on our storage (kept forever, or 7 days with `?storage=temporary`; `storage` says which); `output` is the model's own result object with the same URLs.

```json
{
  "id": "req_8k2m4q7x1z9c3v5b6n0p2r4t",
  "object": "request",
  "model": "ideogram/character/edit",
  "status": "succeeded",
  "created_at": "2026-10-20T12:00:00Z",
  "started_at": "2026-10-20T12:00:02Z",
  "completed_at": "2026-10-20T12:00:09Z",
  "queue_position": null,
  "cost": {
    "credits": 150,
    "usd": "0.15",
    "charged": 150,
    "refunded": 0
  },
  "input": {
    "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field",
    "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
    "mask_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
    "reference_image_urls": [
      "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg"
    ]
  },
  "output": {
    "images": [
      {
        "url": "https://content.doitong.com/dev-api/2026/10/20/req_8k2m4q7x1z9c3v5b6n0p2r4t/0-output.jpeg",
        "content_type": "image/jpeg",
        "file_name": "0-output.jpeg",
        "file_size": 1843200
      }
    ],
    "seed": 42
  },
  "outputs": [
    {
      "type": "image",
      "url": "https://content.doitong.com/dev-api/2026/10/20/req_8k2m4q7x1z9c3v5b6n0p2r4t/0-output.jpeg",
      "content_type": "image/jpeg",
      "file_size": 1843200,
      "width": 1024,
      "height": 768,
      "stored": true
    }
  ],
  "error": null,
  "metrics": {
    "inference_seconds": 6.8
  },
  "urls": {
    "self": "https://api.doitong.com/v1/requests/req_8k2m4q7x1z9c3v5b6n0p2r4t",
    "cancel": "https://api.doitong.com/v1/requests/req_8k2m4q7x1z9c3v5b6n0p2r4t/cancel"
  }
}
```

### Output fields (`output`)

| Field | Type | Description |
|---|---|---|
| `images` | array of object {url, content_type, file_name, file_size} |  |
| `seed` | integer | 用于随机数生成的种子值。 |

## Related models

- [Ideogram V3 Character](https://doitong.com/developers/models/ideogram/character.md) (`ideogram/character`): from $0.10 / image
- [Ideogram V3 Character Remix](https://doitong.com/developers/models/ideogram/character/remix.md) (`ideogram/character/remix`): from $0.10 / image
- [FLUX.1 Kontext \[pro\]](https://doitong.com/developers/models/flux-pro/kontext.md) (`flux-pro/kontext`): $0.04 / image
- [GPT Image 2.5 Edit](https://doitong.com/developers/models/openai/gpt-image-2.5/flare/edit.md) (`openai/gpt-image-2.5/flare/edit`): from $0.12 / image
- [Nano Banana 2 Edit](https://doitong.com/developers/models/nano-banana-2/edit.md) (`nano-banana-2/edit`): from $0.06 / image
- [Nano Banana Pro Edit](https://doitong.com/developers/models/nano-banana-pro/edit.md) (`nano-banana-pro/edit`): from $0.15 / image
- [Qwen Image 3 Edit](https://doitong.com/developers/models/alibaba/qwen-image-3/edit.md) (`alibaba/qwen-image-3/edit`): from $0.04 / image
- [Seedream 5.0 Pro Edit](https://doitong.com/developers/models/bytedance/seedream/v5/pro/edit.md) (`bytedance/seedream/v5/pro/edit`): from $0.0675 / run of output image

## Links

- HTML page: https://doitong.com/developers/models/ideogram/character/edit
- All models and guides for AI agents: https://doitong.com/developers/llms.txt
- OpenAPI 3.1 with this model's typed request body: https://doitong.com/developers/openapi.json?model=ideogram/character/edit
- Errors: https://doitong.com/developers/docs/errors
- Model details as JSON: https://api.doitong.com/v1/models/ideogram/character/edit