# Image Editing Background Change API

> Hubadilisha mandharinyuma ya picha kwa mandhari unayoeleza kwenye kidokezo, ikiwa chaguomsingi ni machweo ya ufukweni

Hupokea picha kupitia `image_url` na kubadilisha mandhari yake ya nyuma kuwa mandhari iliyo kwenye `prompt`, ambayo chaguo-msingi ni machweo ya ufukweni yenye mitende. Unaweza kurekebisha `guidance_scale` (0 hadi 20), `num_inference_steps` (1 hadi 50) na `seed`. Matokeo ni jpeg au png, na `aspect_ratio` ina chaguo tisa kutoka 21:9 hadi 9:21.

- Model id: `image-editing/background-change`
- Made by: Utility
- Category: Image Editing
- Output: image
- Price: $0.04 / image (cheapest run $0.04 (40 API credits))
- Run: `POST https://api.doitong.com/v1/run/image-editing/background-change`
- Quote: `POST https://api.doitong.com/v1/quote/image-editing/background-change`
- Docs page: https://doitong.com/sw/developers/models/image-editing/background-change

## Pricing

Price: **$0.04 / image**. Billed per generated image.

The full example input below costs $0.04 = 40 API credits (1 image × 40 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/image-editing/background-change` 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_url` | `image` | string (image URL) | yes |  |  | Picha inayotumika kutoa kidokezo kwa modeli ya omni. |
| `guidance_scale` |  | number | no | `3.5` | 0 – 20 | Nguvu ya kufuata kidokezo kwa uteuzi wa picha, iliyoonyeshwa kama CFG (Classifier Free Guidance). |
| `num_inference_steps` |  | integer | no | `30` | 1 – 50 | Idadi ya hatua za inference zinazotumika wakati wa sampuli. |
| `safety_tolerance` |  | enum (string) | no | `2` | `1`, `2`, `3`, `4`, `5`, `6` | Mpangilio wa usalama wa picha zinazozalishwa: chagua 6 kwa uchujaji unaoruhusu zaidi au 1 kwa ukali zaidi. |
| `output_format` |  | enum (string) | no | `jpeg` | `jpeg`, `png` | Muundo wa faili wa picha inayotokana. |
| `aspect_ratio` |  | enum (string) \| null | no |  | `21:9`, `16:9`, `4:3`, `3:2`, `1:1`, `2:3`, `3:4`, `9:16`, `9:21` | Uwiano wa picha inayotokana. |
| `seed` |  | integer \| null | no |  |  | Seed ya picha zinazoweza kurudiwa: kidokezo na seed zinazofanana huzalisha picha inayofanana wakati toleo la modeli halijabadilika. |
| `prompt` |  | string | no | `beach sunset with palm trees` |  | Usuli wa kutumia kwenye picha. |

File parameters (`image`) 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
{
  "image": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg"
}
```

A fuller example:

```json
{
  "image_url": "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/image-editing/background-change?wait=20" \
  -H "Authorization: Bearer $DOITONG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "image_url": "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/image-editing/background-change?wait=20", {
  method: "POST",
  headers,
  body: JSON.stringify({
    "image_url": "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 = {
    "image_url": "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/image-editing/background-change", 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": "image-editing/background-change",
      "input": {
        "image_url": "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": "image-editing/background-change",
  "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": {
    "image_url": "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
  },
  "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} |  |
| `seed` | integer |  |

## Related models

- [Image Editing](https://doitong.com/developers/models/image-editing/baby-version.md) (`image-editing/baby-version`): $0.04 / image
- [Image Editing Age Progression](https://doitong.com/developers/models/image-editing/age-progression.md) (`image-editing/age-progression`): $0.04 / image
- [Image Editing Broccoli Haircut](https://doitong.com/developers/models/image-editing/broccoli-haircut.md) (`image-editing/broccoli-haircut`): $0.04 / image
- [Image Editing Cartoonify](https://doitong.com/developers/models/image-editing/cartoonify.md) (`image-editing/cartoonify`): $0.04 / image
- [Image Editing Color Correction](https://doitong.com/developers/models/image-editing/color-correction.md) (`image-editing/color-correction`): $0.04 / image
- [Image Editing Expression Change](https://doitong.com/developers/models/image-editing/expression-change.md) (`image-editing/expression-change`): $0.04 / image
- [Image Editing Face Enhancement](https://doitong.com/developers/models/image-editing/face-enhancement.md) (`image-editing/face-enhancement`): $0.04 / image
- [Image Editing Hair Change](https://doitong.com/developers/models/image-editing/hair-change.md) (`image-editing/hair-change`): $0.04 / image

## Links

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