# SDXL ControlNet Union API

> SDXL متن سے تصویر، زیادہ سے زیادہ چھ کنٹرول تصاویر سے رہنمائی کے ساتھ: openpose, گہرائی کا نقشہ, teed, canny, normal, سیگمینٹیشن

`prompt` سے SDXL تصاویر بناتا ہے، جن کی رہنمائی openpose، گہرائی کا نقشہ، teed، canny، normal یا سیگمینٹیشن جیسی کنٹرول تصاویر کرتی ہیں، اور ہر ایک کے لیے پری پروسیسنگ کا الگ ٹوگل ہوتا ہے۔ `controlnet_conditioning_scale` کی حد 0 سے 1 ہے۔ تصویر کا سائز کنٹرول تصویر سے اخذ کیا جا سکتا ہے۔ LoRA، ایمبیڈنگ، 1 سے 8 تصاویر اور jpeg یا png آؤٹ پٹ کی معاونت کرتا ہے۔

- Model id: `sdxl-controlnet-union`
- Made by: Stability AI
- Category: Text to Image
- Output: image
- Estimated price per run: $0.014 / image (cheapest run $0.014 (14 API credits))
- Run: `POST https://api.doitong.com/v1/run/sdxl-controlnet-union`
- Quote: `POST https://api.doitong.com/v1/quote/sdxl-controlnet-union`
- Docs page: https://doitong.com/ur/developers/models/sdxl-controlnet-union

## Pricing

Price: **$0.014 / 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.014 = 14 API credits (1 image × 14 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/sdxl-controlnet-union` 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 |  |  | جتنی ممکن ہو تفصیل کے ساتھ مطلوبہ تصویر بیان کریں تاکہ بہترین نتائج حاصل ہوں۔ |
| `controlnet_conditioning_scale` |  | number | no | `0.5` | 0 – 1 | ControlNet پر لاگو conditioning کی strength۔ |
| `negative_prompt` |  | string | no | `` |  | خارج کی جانے والی تصویر کی تفصیلات بتانے والا منفی پرامپٹ، مثلاً رنگ، اشیا، مناظر یا باریک خصوصیات۔ مثالوں میں مونچھ، دھندلا پن یا کم ریزولوشن شامل ہیں۔ |
| `image_size` |  | object {height, width} \| enum (string) \| null | no |  | `square_hd`, `square`, `portrait_4_3`, `portrait_16_9`, `landscape_4_3`, `landscape_16_9` | آؤٹ پٹ dimensions؛ size نہ دیے جانے پر control تصویر سے خودکار طور پر طے کیے جاتے ہیں۔ |
| `num_inference_steps` |  | integer | no | `35` | 1 – 70 | چلائے جانے والے inference steps کی تعداد۔ |
| `seed` |  | integer \| null | no |  |  | Stable Diffusion میں تصاویر دوبارہ بنانے کے لیے seed۔ ماڈل ورژن، پرامپٹ اور seed یکساں رکھ کر ہر بار تصویر بالکل دوبارہ بنائی جا سکتی ہے۔ |
| `guidance_scale` |  | number | no | `7.5` | 0 – 20 | تصویر کے انتخاب کے لیے پرامپٹ کی پابندی کی طاقت، CFG (Classifier Free Guidance) کے طور پر ظاہر کی جاتی ہے۔ |
| `num_images` | `num_outputs` | integer | no | `1` | 1 – 8 | تخلیق کے لیے مطلوبہ تصاویر کی تعداد۔ |
| `loras` |  | array of object {force, path, scale} | no | `[]` |  | استعمال کے لیے منتخب کردہ LoRA weights، فہرست کے طور پر فراہم کیے جاتے ہیں۔ |
| `loras[].force` |  | boolean | no | `false` |  | آیا embedding کا استعمال لازمی ہے: true اسے لازمی بناتا ہے۔ |
| `loras[].path` |  | string | yes |  |  | LoRA weight کا ماخذ، HF ماڈل identifier کے طور پر فراہم کیا جاتا ہے جو safetensors weights، یا URL یا path سے واقع safetensors فائل پر resolve ہوتا ہے۔ |
| `loras[].scale` |  | number | no | `1` | 0 – 1 | بنیادی ماڈل میں ضم کرنے سے پہلے LoRA weight پر لاگو ہونے والا multiplier۔ |
| `embeddings` |  | array of object {path, tokens} | no | `[]` |  | استعمال کے لیے منتخب کردہ embeddings، فہرست کے طور پر فراہم کیے جاتے ہیں۔ |
| `embeddings[].path` |  | string | yes |  |  | URL یا فائل کے پاتھ سے متعین کردہ ایمبیڈنگ ویٹس۔ |
| `embeddings[].tokens` |  | array of string \| null | no |  |  | Embedding ٹوکن کی فہرست؛ اسے نہ دینے پر خودکار نام گذاری دستیاب ہے: embedding فائل کے ہر vector کو sequence <s0>، <s1>، ... میں سے ایک ٹوکن ملتا ہے۔ |
| `enable_safety_checker` |  | boolean | no | `true` |  | حفاظتی checker کی فعالیت؛ true جانچ فعال کرتا ہے۔ |
| `safety_checker_version` |  | enum (string) | no | `v1` | `v1`, `v2` | حسبِ ضرورت ViT safety checker (`v2`) اور CompVis checker (`v1`، ڈیفالٹ) میں سے انتخاب کریں۔ |
| `expand_prompt` |  | boolean | no | `false` |  | اضافی پرامپٹس کے ساتھ پرامپٹ کی توسیع، true ہونے پر فعال۔ |
| `format` |  | enum (string) | no | `jpeg` | `jpeg`, `png` | نتیجہ خیز تصویر کا فائل فارمیٹ۔ |
| `request_id` |  | string | no | `` |  | درخواست کا identifier، اس درخواست سے تیار ہونے والے response کے ساتھ ربط کے لیے۔ |
| `openpose_image_url` |  | string (image URL) \| null | no |  |  | control تصویر کا URL۔ |
| `openpose_preprocess` |  | boolean | no | `true` |  | openpose تصویر کی پری پروسیسنگ کو کنٹرول کرتا ہے۔ |
| `depth_image_url` |  | string (image URL) \| null | no |  |  | control تصویر کا URL۔ |
| `depth_preprocess` |  | boolean | no | `true` |  | depth تصویر کی پری پروسیسنگ کو کنٹرول کرتا ہے۔ |
| `teed_image_url` |  | string (image URL) \| null | no |  |  | control تصویر کا URL۔ |
| `teed_preprocess` |  | boolean | no | `true` |  | teed تصویر کی پری پروسیسنگ کو کنٹرول کرتا ہے۔ |
| `canny_image_url` |  | string (image URL) \| null | no |  |  | control تصویر کا URL۔ |
| `canny_preprocess` |  | boolean | no | `true` |  | canny تصویر کی پری پروسیسنگ کو کنٹرول کرتا ہے۔ |
| `normal_image_url` |  | string (image URL) \| null | no |  |  | control تصویر کا URL۔ |
| `normal_preprocess` |  | boolean | no | `true` |  | normal تصویر کی پری پروسیسنگ کو کنٹرول کرتا ہے۔ |
| `segmentation_image_url` |  | string (image URL) \| null | no |  |  | control تصویر کا URL۔ |
| `segmentation_preprocess` |  | boolean | no | `true` |  | segmentation تصویر کی پری پروسیسنگ کو کنٹرول کرتا ہے۔ |

File parameters (`openpose_image_url`, `depth_image_url`, `teed_image_url`, `canny_image_url`, `normal_image_url`, `segmentation_image_url`) 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/sdxl-controlnet-union?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/sdxl-controlnet-union?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/sdxl-controlnet-union", 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": "sdxl-controlnet-union",
      "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": "sdxl-controlnet-union",
  "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": 14,
    "usd": "0.014",
    "charged": 14,
    "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",
        "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

- [SDXL ControlNet Union · Image to Image](https://doitong.com/developers/models/sdxl-controlnet-union/image-to-image.md) (`sdxl-controlnet-union/image-to-image`): $0.048 / image
- [SDXL ControlNet Union · Inpainting](https://doitong.com/developers/models/sdxl-controlnet-union/inpainting.md) (`sdxl-controlnet-union/inpainting`): $0.012 / image
- [FLUX.1 \[dev\]](https://doitong.com/developers/models/flux/dev.md) (`flux/dev`): $0.025 / megapixel
- [FLUX.1 \[schnell\]](https://doitong.com/developers/models/flux/schnell.md) (`flux/schnell`): $0.003 / megapixel
- [FLUX.2 \[dev\]](https://doitong.com/developers/models/flux-2.md) (`flux-2`): $0.012 / megapixel
- [FLUX.2 \[pro\]](https://doitong.com/developers/models/flux-2-pro.md) (`flux-2-pro`): $0.015 / megapixel of output image
- [GPT Image 2.5 Text to Image](https://doitong.com/developers/models/openai/gpt-image-2.5/flare/text-to-image.md) (`openai/gpt-image-2.5/flare/text-to-image`): from $0.008 / image
- [Ideogram V4.5](https://doitong.com/developers/models/ideogram/v4.5.md) (`ideogram/v4.5`): from $0.03 / image

## Links

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