# Hidream O1 Image API

> Tauira kuputuhi-ki-te-atahanga HiDream hikoinga-katoa e whakaae ana hoki ki ngā whakaahua tohutoro kōwhiringa mō te whakatika, te whakarite kaupapa rānei

Ka whakaputa atahanga mai i tētahi `prompt`, me ngā `reference_image_urls` kōwhiringa: kore mō te kuputuhi-ki-te-atahanga noa, kotahi mō te whakatika, he maha mō te whakawhaiaro mā te kaupapa. Ko te taunoa he 50 hipanga tango haruru me te arataki scale 5. Ka tae te putanga ki te 2048x2048 pea, me te 1 ki te 4 atahanga ia tono hei png, jpeg, webp rānei.

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

## 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.01 = 10 API credits (1 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` 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 | Tohutohu kuputuhi mō te whakaputa, te whakatika atahanga rānei, mō te whakawhaiaro ā-kaupapa rānei. |
| `reference_image_urls` | `images` | array of image URL | no | `[]` |  | Ngā atahanga tohutoro mō te whakatika (he atahanga kotahi), mō te whakawhaiaro ā-kaupapa rānei (ngā atahanga maha); waiho kia kore mō te whakaputanga kuputuhi-ki-te-atahanga. |
| `image_size` |  | object {width, height} \| enum (string) | no | `{"height":1024,"width":1024}` | `square_hd`, `square`, `portrait_4_3`, `portrait_16_9`, `landscape_4_3`, `landscape_16_9` | Ngā rahinga putanga, tata ki te 2048 × 2048 pika te mōrahi; ka whakahekea ia rahinga tono ki te taurea tata o te 32. |
| `num_inference_steps` |  | integer | no | `50` | 1 – 50 | Te maha o ngā hīkoi whakakore haruru hei mahi. |
| `guidance_scale` |  | number | no | `5` | 0 – 20 | Tauine mō te aronga kore-whakarōpū; ko te taunoa 5.0 mō te tauira katoa. |
| `seed` |  | integer \| null | no |  |  | Kākano matapōkere e taea ai te whakahoki anō i te whakaputanga. |
| `num_images` | `num_outputs` | integer | no | `1` | 1 – 4 | Te maha o ngā atahanga hei whakaputa. |
| `output_format` |  | enum (string) | no | `png` | `jpeg`, `png`, `webp` | Te hōputu kōnae mō te atahanga ka puta. |
| `enable_safety_checker` |  | boolean | no | `true` |  | Ka whakahaere mēnā ka tirohia te haumaru o ngā atahanga kua whakaputaina. |
| `keep_original_aspect` |  | boolean | no | `false` |  | Te pupuri ōwehenga āhuatanga mō te whakaputanga tohutoro-kotahi: ka rite ngā ōwehenga o te putanga ki taua tohutoro ina kotahi anake te atahanga ka tukuna. |

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"
}
```

A fuller example:

```json
{
  "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field"
}
```

## 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?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"
  }'

# 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?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"
  }),
});
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",
}

# Run the model; wait up to 20 s for the finished result in the same call
r = requests.post(API + "/run/hidream-o1-image", 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",
      "input": {
        "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field"
      },
      "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",
  "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": 10,
    "usd": "0.01",
    "charged": 10,
    "refunded": 0
  },
  "input": {
    "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field"
  },
  "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} | Ngā atahanga i whakaputaina. |
| `seed` | integer | Te uara kākano i whakamahia i te whakaputanga. |
| `has_nsfw_concepts` | array of boolean | Tūnga o te haki kaitaki haumaru mō ia atahanga kua whakaputaina. |
| `prompt` | string | Te tohutohu i whakamahia hei whakaputa i te putanga. |
| `timings` | object | Ngā inenga wā mō te whakaputanga. |

## Related models

- [Hidream O1 Image · Dev](https://doitong.com/developers/models/hidream-o1-image/dev.md) (`hidream-o1-image/dev`): $0.005 / megapixel
- [Hidream O1 Image · Edit](https://doitong.com/developers/models/hidream-o1-image/edit.md) (`hidream-o1-image/edit`): $0.01 / megapixel
- [FLUX.1 \[dev\]](https://doitong.com/developers/models/flux/dev.md) (`flux/dev`): $0.025 / megapixel
- [FLUX.1 \[schnell\]](https://doitong.com/developers/models/flux/schnell.md) (`flux/schnell`): $0.003 / megapixel
- [FLUX.2 \[dev\]](https://doitong.com/developers/models/flux-2.md) (`flux-2`): $0.012 / megapixel
- [FLUX.2 \[pro\]](https://doitong.com/developers/models/flux-2-pro.md) (`flux-2-pro`): $0.015 / megapixel of output image
- [GPT Image 2.5 Text to Image](https://doitong.com/developers/models/openai/gpt-image-2.5/flare/text-to-image.md) (`openai/gpt-image-2.5/flare/text-to-image`): from $0.008 / image
- [Ideogram V4.5](https://doitong.com/developers/models/ideogram/v4.5.md) (`ideogram/v4.5`): from $0.03 / image

## Links

- HTML page: https://doitong.com/developers/models/hidream-o1-image
- 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
- Errors: https://doitong.com/developers/docs/errors
- Model details as JSON: https://api.doitong.com/v1/models/hidream-o1-image