# Z Image Base API

> Z-Image cơ sở chuyển văn bản thành hình ảnh với số bước có thể điều chỉnh lên đến 50, thang hướng dẫn và lời nhắc âm

Tạo hình ảnh từ lời nhắc văn bản bằng mô hình nền tảng Z-Image. `num_inference_steps` từ 1 đến 50 (mặc định 28) và `guidance_scale` từ 1 đến 20. Hỗ trợ lời nhắc phủ định, sáu kích thước hình ảnh đặt trước, 1 đến 4 hình ảnh mỗi yêu cầu và đầu ra jpeg, png hoặc webp.

- Model id: `z-image/base`
- Made by: Alibaba
- 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/z-image/base`
- Quote: `POST https://api.doitong.com/v1/quote/z-image/base`
- Docs page: https://doitong.com/vi/developers/models/z-image/base

## 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/z-image/base` 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 |  |  | Lời nhắc định hướng việc tạo sinh hình ảnh. |
| `image_size` |  | object {width, height} \| enum (string) | no | `landscape_4_3` | `square_hd`, `square`, `portrait_4_3`, `portrait_16_9`, `landscape_4_3`, `landscape_16_9` | Kích thước hình ảnh được tạo. |
| `num_inference_steps` |  | integer | no | `28` | 1 – 50 | Số bước suy luận cần chạy. |
| `guidance_scale` |  | number | no | `4` | 1 – 20 | Thang tỷ lệ hướng dẫn được áp dụng trong quá trình tạo sinh hình ảnh. |
| `seed` |  | integer \| null | no |  |  | Seed cho hình ảnh có thể tái tạo: lời nhắc và seed giống hệt nhau sẽ tạo ra hình ảnh giống hệt khi phiên bản mô hình không đổi. |
| `num_images` | `num_outputs` | integer | no | `1` | 1 – 4 | Số lượng hình ảnh yêu cầu tạo sinh. |
| `enable_safety_checker` |  | boolean | no | `true` |  | Kiểm tra an toàn, trả về hình ảnh màu đen thay cho mọi hình ảnh bị đánh dấu không an toàn. Giá trị true bật kiểm tra; false chỉ tắt kiểm tra đối với tài khoản được cấp quyền, còn các yêu cầu không được cấp quyền vẫn luôn được kiểm tra. |
| `output_format` |  | enum (string) | no | `png` | `jpeg`, `png`, `webp` | Định dạng tệp của hình ảnh kết quả. |
| `acceleration` |  | enum (string) | no | `regular` | `none`, `regular`, `high` | Mức tăng tốc áp dụng cho quá trình xử lý. |
| `negative_prompt` |  | string | no | `` |  | Lời nhắc phủ định được sử dụng khi tạo sinh hình ảnh. |

## 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/z-image/base?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/z-image/base?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/z-image/base", 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": "z-image/base",
      "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": "z-image/base",
  "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
      }
    ],
    "timings": {},
    "seed": 42,
    "has_nsfw_concepts": [
      false
    ],
    "prompt": "string"
  },
  "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} | Thông tin tệp của các hình ảnh được tạo. |
| `timings` | object | Thông tin thời gian của quá trình tạo sinh. |
| `seed` | integer | Seed tạo sinh hình ảnh, bao gồm giá trị được chọn ngẫu nhiên nếu đầu vào không cung cấp seed; nếu không, lặp lại giá trị đã cung cấp. |
| `has_nsfw_concepts` | array of boolean | Cho biết các khái niệm NSFW có xuất hiện trong hình ảnh được tạo sinh hay không. |
| `prompt` | string | Lời nhắc được sử dụng trong quá trình tạo sinh hình ảnh. |

## Related models

- [Z Image Base Lora](https://doitong.com/developers/models/z-image/base/lora.md) (`z-image/base/lora`): $0.012 / megapixel
- [Z Image Turbo](https://doitong.com/developers/models/z-image/turbo.md) (`z-image/turbo`): $0.005 / megapixel
- [Z Image Turbo Lora](https://doitong.com/developers/models/z-image/turbo/lora.md) (`z-image/turbo/lora`): $0.0085 / megapixel
- [Z-Image Turbo Seamless Tiling](https://doitong.com/developers/models/z-image/turbo/tiling.md) (`z-image/turbo/tiling`): $0.02 / megapixel of output image
- [Z-Image Turbo Seamless Tiling Lora](https://doitong.com/developers/models/z-image/turbo/tiling/lora.md) (`z-image/turbo/tiling/lora`): $0.025 / megapixel of output image
- [Z Image Turbo Controlnet](https://doitong.com/developers/models/z-image/turbo/controlnet.md) (`z-image/turbo/controlnet`): $0.013 / image
- [Z Image Turbo Controlnet Lora](https://doitong.com/developers/models/z-image/turbo/controlnet/lora.md) (`z-image/turbo/controlnet/lora`): $0.04 / image
- [Z Image Turbo Image To Image](https://doitong.com/developers/models/z-image/turbo/image-to-image.md) (`z-image/turbo/image-to-image`): $0.015 / image

## Links

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