# Firered Image Edit API

> ہدایات پر مبنی تصویر ایڈیٹر جو متعدد حوالہ تصاویر اور انگریزی یا چینی پرامپٹس قبول کرتا ہے

`prompt` میں لکھی ہدایت سے ایک یا زیادہ تصاویر میں ترمیم کرتا ہے، انگریزی یا چینی میں۔ `image_urls` میں مجازی لباس آزمائش یا انداز منتقلی جیسے tasks کے لیے متعدد حوالے رکھے جا سکتے ہیں۔ `num_images` کو 1 سے 4، `num_inference_steps` کو 2 سے 50، `guidance_scale` کو 1 سے 10 تک مقرر کیا جا سکتا ہے، اور آؤٹ پٹ png یا jpeg ہو سکتا ہے۔

- Model id: `firered-image-edit`
- Made by: Xiaohongshu
- Category: Image Editing
- Output: image
- Estimated price per run: $0.033 / image (cheapest run $0.033 (33 API credits))
- Run: `POST https://api.doitong.com/v1/run/firered-image-edit`
- Quote: `POST https://api.doitong.com/v1/quote/firered-image-edit`
- Docs page: https://doitong.com/ur/developers/models/firered-image-edit

## Pricing

Price: **$0.033 / image**. Estimated from the typical cost of one run, per output (`num_images`). The quote is exactly what the run charges.

The full example input below costs $0.033 = 33 API credits (1 image × 33 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/firered-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 |  |  | انگریزی یا چینی میں لکھی گئی تصویر میں ترمیم کی درخواست، جس میں لاگو کی جانے والی تبدیلیاں بیان ہوں۔ |
| `image_size` |  | object {width, height} \| enum (string) \| null | no |  | `square_hd`, `square`, `portrait_4_3`, `portrait_16_9`, `landscape_4_3`, `landscape_16_9` | تصویر کے ابعاد؛ None نیا آؤٹ پٹ سائز متعین کرنے کے بجائے ان پٹ کے ابعاد برقرار رکھتا ہے۔ |
| `num_inference_steps` |  | integer | no | `30` | 2 – 50 | Inference steps کی تعداد، جسے عموماً بہتر معیار کے نتائج کے لیے بڑھایا جا سکتا ہے۔ |
| `seed` |  | integer \| null | no |  |  | قابلِ تکرار تصاویر کے لیے سیڈ: ماڈل ورژن تبدیل نہ ہونے پر یکساں پرامپٹ اور سیڈ یکساں تصویر تیار کرتے ہیں۔ |
| `guidance_scale` |  | number | no | `4` | 1 – 10 | classifier-free guidance کے ذریعے کنٹرول کی جانے والی پرامپٹ سے مطابقت: اس scale کو بڑھانے سے تخلیق پرامپٹ کے زیادہ قریب ہو جاتی ہے۔ |
| `num_images` | `num_outputs` | integer | no | `1` | 1 – 4 | تخلیق کے لیے مطلوبہ تصاویر کی تعداد۔ |
| `enable_safety_checker` |  | boolean | no | `true` |  | حفاظتی جانچ، جو غیر محفوظ قرار دی گئی تصاویر کی جگہ سیاہ تصاویر واپس کرتی ہے۔ true جانچ فعال کرتا ہے؛ false اسے صرف مجاز اکاؤنٹس کے لیے غیر فعال کرتا ہے، جبکہ بغیر اجازت درخواستوں کی جانچ بہرحال ہوتی ہے۔ |
| `output_format` |  | enum (string) | no | `png` | `jpeg`, `png` | نتیجہ خیز تصویر کا فائل فارمیٹ۔ |
| `image_urls` | `images` | array of image URL | yes |  |  | ایک تصویر میں ترمیم کرنے یا متعدد تصاویر کو حوالوں کے طور پر استعمال کرنے کے لیے تصویر کے URLs فراہم کریں۔ حوالہ پر مبنی کاموں میں virtual try-on اور حوالہ تصویر کا style منتقل کرنا شامل ہے۔ |
| `negative_prompt` |  | string | no | `` |  | تخلیق کے دوران استعمال ہونے والا منفی پرامپٹ۔ |
| `acceleration` |  | enum (string) | no | `regular` | `none`, `regular`, `high` | Inference کی رفتار بہتر بنانے کے لیے acceleration کی ترتیب۔ |

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",
  "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/firered-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",
    "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/firered-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",
    "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",
    "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/firered-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": "firered-image-edit",
      "input": {
        "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field",
        "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": "firered-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": 33,
    "usd": "0.033",
    "charged": 33,
    "refunded": 0
  },
  "input": {
    "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field",
    "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",
        "width": 1024,
        "height": 768,
        "content_type": "image/jpeg"
      }
    ],
    "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, width, height, content_type} | نتیجے میں ترمیم شدہ تصاویر کی فائل کی معلومات۔ |
| `timings` | object |  |
| `seed` | integer | تصویر کی تخلیق کا سیڈ، جس میں ان پٹ میں سیڈ نہ دینے پر تصادفی طور پر منتخب قدر شامل ہوتی ہے؛ بصورتِ دیگر فراہم کردہ قدر دہرائی جاتی ہے۔ |
| `has_nsfw_concepts` | array of boolean | بتاتا ہے کہ تخلیق کردہ تصاویر میں NSFW تصورات موجود ہیں یا نہیں۔ |
| `prompt` | string | تصویر کی تخلیق کے دوران استعمال ہونے والا پرامپٹ۔ |

## Related models

- [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
- [Firered Image Edit V1.1](https://doitong.com/developers/models/firered-image-edit-v1.1.md) (`firered-image-edit-v1.1`): $0.065 / image
- [Age Modify](https://doitong.com/developers/models/image-apps-v2/age-modify.md) (`image-apps-v2/age-modify`): $0.04 / image

## Links

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