# Grok Imagine Image · Edit API

> زیادہ سے زیادہ 3 ان پٹ تصاویر سے Grok تصویر ایڈیٹنگ، جس کی نسبتِ ابعاد ڈیفالٹ طور پر پہلی تصویر جیسی ہوتی ہے

8000 کریکٹرز تک کے پرامپٹ کے ذریعے بیان کردہ تصاویر کو ایڈٹ کرتا ہے، جس میں `image_urls` میں 3 URLs تک استعمال کیے جا سکتے ہیں۔ `aspect_ratio` ڈیفالٹ طور پر auto ہوتا ہے، جو پہلی ان پٹ تصویر کا ریشو برقرار رکھتا ہے، یا اسے واضح طور پر سیٹ کیا جا سکتا ہے۔ ریزولوشن 1k یا 2k ہے، جس میں jpeg، png یا webp میں 4 آؤٹ پٹ تک ملتے ہیں۔ ایک ترمیم شدہ پرامپٹ واپس کیا جاتا ہے۔

- Model id: `xai/grok-imagine-image/edit`
- Made by: xAI
- Category: Image Editing
- Output: image
- Price: $0.022 / image (cheapest run $0.022 (22 API credits))
- Run: `POST https://api.doitong.com/v1/run/xai/grok-imagine-image/edit`
- Quote: `POST https://api.doitong.com/v1/quote/xai/grok-imagine-image/edit`
- Docs page: https://doitong.com/ur/developers/models/xai/grok-imagine-image/edit

## Pricing

Price: **$0.022 / image**. Billed per generated image (`num_images`, default 1).

The full example input below costs $0.022 = 22 API credits (1 image × 22 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/xai/grok-imagine-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 |  | ≤ 8000 characters | تخلیق کی جانے والی تصویر کی متنی تفصیل۔ |
| `num_images` | `num_outputs` | integer | no | `1` | 1 – 4 | تیار کی جانے والی تصاویر کی تعداد۔ |
| `aspect_ratio` |  | enum (string) | no | `auto` | `auto`, `2:1`, `20:9`, `19.5:9`, `16:9`, `4:3`, `3:2`, `1:1`, `2:3`, `3:4`, `9:16`, `9:19.5`, `9:20`, `1:2` | تصویر editing کے لیے آؤٹ پٹ aspect-ratio setting، جس میں `auto` پہلے ان پٹ کے تناسب استعمال کرتا ہے۔ یہ خودکار setting ڈیفالٹ ہے۔ |
| `resolution` |  | enum (string) | no | `1k` | `1k`, `2k` | تصویر کے ریزولوشن کا انتخاب، standard (`1k`) اور high (`2k`) کے درمیان۔ |
| `output_format` |  | enum (string) | no | `jpeg` | `jpeg`, `png`, `webp` | نتیجہ خیز تصویر کا فائل فارمیٹ۔ |
| `enable_safety_checker` |  | boolean | no | `true` |  | false سیٹ کر کے اسکریننگ نرم کی جا سکتی ہے، بشرطیکہ کال کرنے والا مجاز ہو۔ |
| `image_urls` | `images` | array of image URL | no |  |  | editing کے لیے تصویر کے URLs، زیادہ سے زیادہ 3 تصاویر کی فہرست کے طور پر۔ |

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/xai/grok-imagine-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"
  }'

# 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/xai/grok-imagine-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"
  }),
});
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/xai/grok-imagine-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": "xai/grok-imagine-image/edit",
      "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": "xai/grok-imagine-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": 22,
    "usd": "0.022",
    "charged": 22,
    "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
      }
    ],
    "revised_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} | ترمیم شدہ تصویر کی طرف اشارہ کرنے والا URL۔ |
| `revised_prompt` | string \| null | تصویر کی تخلیق کے لیے استعمال ہونے والا بہتر پرامپٹ۔ |

## Related models

- [Grok Imagine Image](https://doitong.com/developers/models/xai/grok-imagine-image.md) (`xai/grok-imagine-image`): $0.02 / image
- [Grok Imagine Image · Quality · Text to Image](https://doitong.com/developers/models/xai/grok-imagine-image/quality/text-to-image.md) (`xai/grok-imagine-image/quality/text-to-image`): from $0.05 / image
- [Grok Imagine Image Editing Quality](https://doitong.com/developers/models/xai/grok-imagine-image/quality/edit.md) (`xai/grok-imagine-image/quality/edit`): from $0.05 / run of output image
- [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

## Links

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