# Bria Guided Remove Background API

> إزالة خلفية موجهة بمطالبة تضيف كائنات أو تحذفها أو تعزلها في القصاصة

يبدأ بقصاصة افتراضية للموضوع الرئيسي في `image_url`، ثم يضبطها باستخدام `prompt` اختيارية بلغة واضحة، مثل الاحتفاظ بكائن إضافي أو عزل كائن واحد فقط. تُحفظ وحدات البكسل الأصلية وتُضاف قناة ألفا، وتُعاد الصورة بصيغة RGBA PNG. يضبط `autocrop` اللوحة بإحكام حول المحتوى المحتفظ به.

- Model id: `bria/guided-remove-background`
- Made by: Bria AI
- Category: Background Removal
- Output: image
- Price: $0.03 / image (cheapest run $0.03 (30 API credits))
- Run: `POST https://api.doitong.com/v1/run/bria/guided-remove-background`
- Quote: `POST https://api.doitong.com/v1/quote/bria/guided-remove-background`
- Docs page: https://doitong.com/ar/developers/models/bria/guided-remove-background

## Pricing

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

The full example input below costs $0.03 = 30 API credits (1 image × 30 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/bria/guided-remove-background` 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) | no | `https://labs-assets.bria.ai/api-examples/guided-remove-background/yoga_studio_input.jpg` |  | الصورة المصدر المقدمة عبر عنوان URL عام، أو وحدات بايت للصورة بترميز base64 الخام، أو URI لبيانات base64 مثل data:image/png;base64,... . |
| `prompt` |  | string \| null | no |  |  | تعديل اختياري بلغة بسيطة للاقتطاع الافتراضي: وسّع التحديد باستخدام 'the person with the mat and the plant'، أو استبعد الكائنات باستخدام 'the woman at her desk without the lamp'، أو قيّده باستخدام 'only the chair'. تحدد القيمة الفارغة الموضوع الواضح في الصورة دون تعديل. تبقى وحدات البكسل المحتفظ بها دون تغيير؛ وتُضاف قناة ألفا جديدة فقط. |
| `autocrop` |  | boolean | no | `false` |  | اقتصاص لوحة المخرج بإحكام حول المحتوى المحتفظ به. |

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

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/bria/guided-remove-background?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/bria/guided-remove-background?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/bria/guided-remove-background", 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": "bria/guided-remove-background",
      "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": "bria/guided-remove-background",
  "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": 30,
    "usd": "0.03",
    "charged": 30,
    "refunded": 0
  },
  "input": {
    "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field"
  },
  "output": {
    "image": {
      "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
    }
  },
  "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 |
|---|---|---|
| `image` | object {url, content_type, file_name, file_size, width, height} | ملف PNG بصيغة RGBA يحتفظ بالصورة المصدر مع قناة ألفا مُنشأة حديثًا تحدد الموضوع الرئيسي الظاهر، بعد تنقيحه وفقًا للموجّه. |

## Related models

- [Bria Text-to-Image Base](https://doitong.com/developers/models/bria/text-to-image/base.md) (`bria/text-to-image/base`): $0.04 / image
- [Bria Text-to-Image Fast](https://doitong.com/developers/models/bria/text-to-image/fast.md) (`bria/text-to-image/fast`): $0.028 / image
- [Bria Text-to-Image HD](https://doitong.com/developers/models/bria/text-to-image/hd.md) (`bria/text-to-image/hd`): $0.04 / image
- [Bria](https://doitong.com/developers/models/bria/reimagine.md) (`bria/reimagine`): $0.04 / image
- [Bria Background Replace](https://doitong.com/developers/models/bria/background/replace.md) (`bria/background/replace`): $0.04 / image
- [Bria Eraser](https://doitong.com/developers/models/bria/eraser.md) (`bria/eraser`): $0.04 / request
- [Bria Expand Image](https://doitong.com/developers/models/bria/expand.md) (`bria/expand`): $0.04 / request
- [Bria GenFill](https://doitong.com/developers/models/bria/genfill.md) (`bria/genfill`): $0.04 / image

## Links

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