# Hidream O1 Image · Edit API

> Uhariri wa picha za marejeo wenye ubora kamili na ubinafsishaji wa mada, hadi takriban 2048x2048, hatua 50

Huhariri picha au huunda matokeo yanayoongozwa na mada kutoka kwenye picha moja au zaidi za rejeleo (`reference_image_urls`) pamoja na `prompt` ya maandishi. Ukubwa wa tokeo hutumia mipangilio au ukubwa maalum, hadi takriban 2048x2048. Chaguomsingi ni hatua 50 za uondoaji wa kelele na mwongozo 5, na inaweza kurudisha picha 1 hadi 4 kama PNG, JPEG au WebP. `keep_original_aspect` huhifadhi uwiano wa vipimo inapotolewa rejeleo moja.

- Model id: `hidream-o1-image/edit`
- Made by: HiDream
- Category: Image Editing
- Output: image
- Price: $0.01 / megapixel (cheapest run $0.04 (40 API credits))
- Run: `POST https://api.doitong.com/v1/run/hidream-o1-image/edit`
- Quote: `POST https://api.doitong.com/v1/quote/hidream-o1-image/edit`
- Docs page: https://doitong.com/sw/developers/models/hidream-o1-image/edit

## Pricing

Price: **$0.01 / megapixel**. Billed per megapixel of output (width × height of every image). Each image is rounded up to a whole megapixel.

The full example input below costs $0.04 = 40 API credits (4 MP × 10 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/hidream-o1-image/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 |
|---|---|---|---|---|---|---|
| `prompt` |  | string | yes |  | ≥ 1 characters | Maelekezo ya maandishi ya kuzalisha au kuhariri picha, au ya ubinafsishaji unaoendeshwa na mada. |
| `reference_image_urls` | `images` | array of image URL | yes |  | ≥ 1 items | Picha zinazotolewa kama marejeo ya kuhariri au ubinafsishaji unaoendeshwa na mada. |
| `image_size` |  | object {width, height} \| enum (string) | no | `{"height":2048,"width":2048}` | `square_hd`, `square`, `portrait_4_3`, `portrait_16_9`, `landscape_4_3`, `landscape_16_9` | Chagua vipimo vya picha; kwa matokeo yanayotegemea picha za marejeo, ombi hili huendana na mwonekano wa karibu zaidi unaoungwa mkono na modeli, wenye kiwango cha juu cha takriban 2048 × 2048 pikseli. |
| `num_inference_steps` |  | integer | no | `50` | 1 – 50 | Idadi ya hatua za kuondoa kelele zitakazotekelezwa. |
| `guidance_scale` |  | number | no | `5` | 0 – 20 | Kipimo cha mwongozo usio na klasifaya; chaguomsingi ni 5.0 kwa modeli kamili. |
| `seed` |  | integer \| null | no |  |  | Seed nasibu inayofanya uzalishaji uweze kurudiwa. |
| `num_images` | `num_outputs` | integer | no | `1` | 1 – 4 | Idadi ya picha za kuzalisha. |
| `output_format` |  | enum (string) | no | `png` | `jpeg`, `png`, `webp` | Muundo wa faili wa picha inayotokana. |
| `enable_safety_checker` |  | boolean | no | `true` |  | Hudhibiti ikiwa picha zilizozalishwa hukaguliwa kwa usalama. |
| `keep_original_aspect` |  | boolean | no | `false` |  | Uhifadhi wa uwiano wa fremu kwa uzalishaji wa marejeo moja: tokeo hufuata uwiano wa marejeo hayo ikiwa tu picha moja imetolewa. |

File parameters (`images`) 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",
  "images": [
    "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",
  "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/hidream-o1-image/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",
    "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/hidream-o1-image/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",
    "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",
    "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/hidream-o1-image/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": "hidream-o1-image/edit",
      "input": {
        "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field",
        "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": "hidream-o1-image/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": 40,
    "usd": "0.04",
    "charged": 40,
    "refunded": 0
  },
  "input": {
    "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field",
    "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,
        "width": 1024,
        "height": 768
      }
    ],
    "seed": 42,
    "has_nsfw_concepts": [
      false
    ],
    "prompt": "string",
    "timings": {}
  },
  "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, width, height} | Picha zilizozalishwa. |
| `seed` | integer | Thamani ya seed inayotumika wakati wa uzalishaji. |
| `has_nsfw_concepts` | array of boolean | Hali ya alama ya kikaguzi cha usalama kwa kila picha iliyozalishwa. |
| `prompt` | string | Kidokezo kilichotumika kutengeneza tokeo. |
| `timings` | object | Vipimo vya muda wa uzalishaji. |

## Related models

- [Hidream O1 Image](https://doitong.com/developers/models/hidream-o1-image.md) (`hidream-o1-image`): $0.01 / megapixel
- [Hidream O1 Image · Dev](https://doitong.com/developers/models/hidream-o1-image/dev.md) (`hidream-o1-image/dev`): $0.005 / megapixel
- [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/hidream-o1-image/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=hidream-o1-image/edit
- Errors: https://doitong.com/developers/docs/errors
- Model details as JSON: https://api.doitong.com/v1/models/hidream-o1-image/edit