# Lightx · Relight API

> إعادة إضاءة فيديو بتوجيه من موجّه أو إطار مرجعي أو صورة HDR أو صورة خلفية

يغير إضاءة فيديو الإدخال. تحدد `relit_cond_type` الشرط: ic (يستخدم `relight_parameters`) أو ref أو hdr أو bg، وتحتاج الأنواع الثلاثة الأخيرة إلى صورة تهيئة في `relit_cond_img_url`. تحدد `ref_id` (من 0 إلى 48) الإطار المرجعي لوضع ref. يكون `prompt` النصي اختياريًا، ويُنشأ وصف تلقائي للفيديو عند حذفه.

- Model id: `lightx/relight`
- Made by: Open model
- Category: Video to Video
- Output: video
- Price per second of your output video: $0.10 / second of output video (cheapest run $0.10 (100 API credits))
- Run: `POST https://api.doitong.com/v1/run/lightx/relight`
- Quote: `POST https://api.doitong.com/v1/quote/lightx/relight`
- Docs page: https://doitong.com/ar/developers/models/lightx/relight

## Pricing

Price: **$0.10 / second of output video**. Price per second of your output video: the input files are measured before the run (length, resolution, frame rate). The quote measures the same files and is exactly what the run charges.

The full example input below costs $0.49 = 490 API credits (4.9 s output video × $0.10).

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/lightx/relight` 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 |
|---|---|---|---|---|---|---|
| `video_url` | `video` | string (video URL) | yes |  |  | عنوان URL لفيديو المدخل. |
| `prompt` |  | string \| null | no |  |  | موجّه نصي اختياري؛ ينشئ Light-X تسمية للفيديو تلقائيًا عند عدم توفير موجّه. |
| `seed` |  | integer \| null | no |  |  | بذرة تجعل التوليد قابلًا لإعادة الإنتاج. يؤدي ضبطها على None إلى اختيار بذرة عشوائيًا. |
| `relit_cond_type` |  | enum (string) | no | `ic` | `ic`, `ref`, `hdr`, `bg` | نوع الشرط المستخدم لإعادة الإضاءة. |
| `relight_parameters` |  | object {relight_prompt, bg_source, cfg, use_sky_mask} \| null | no |  |  | إعدادات إعادة الإضاءة التي يعتمد استخدامها على relight_condition_type: يتطلبها 'ic'، بينما يتجاهلها 'bg' ويتطلب بدلًا منها عنوان URL لصورة خلفية. |
| `relight_parameters.relight_prompt` |  | string | yes |  |  | موجّه نصي يحدد ظروف الإضاءة المطلوب إنتاجها. |
| `relight_parameters.bg_source` |  | enum (string) | no | `Left` | `Left`, `Right`, `Top`, `Bottom` | اتجاه مصدر الضوء لـ IC-light. |
| `relight_parameters.cfg` |  | number | no | `2` | 1 – 10 | مقياس التوجيه الخالي من المصنّف المطبّق أثناء إعادة الإضاءة. |
| `relight_parameters.use_sky_mask` |  | boolean | no | `false` |  | مفتاح قناع السماء للمشاهد الخارجية. |
| `relit_cond_img_url` |  | string \| null | no |  |  | عنوان URL لصورة شرط مطلوبة لإعدادات 'ref' و'hdr' و'bg' في relight_condition_type؛ وفي وضع 'bg' توفر الخلفية. |
| `ref_id` |  | integer | no | `0` | 0 – 48 | مرجع إعادة الإضاءة المحدد بواسطة فهرس الإطار، مع استخدام عدد الإطارات المُنشأة كحد أعلى حصري. القيمة الافتراضية لهذا العدد هي 49. |
| `enable_safety_checker` |  | boolean | no | `true` |  | يمكن تخفيف الفحص بضبط القيمة على false، شريطة أن يكون المستدعي مخولًا بذلك. |

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

A fuller example:

```json
{
  "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4"
}
```

## 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/lightx/relight?wait=20" \
  -H "Authorization: Bearer $DOITONG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4"
  }'

# 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/lightx/relight?wait=20", {
  method: "POST",
  headers,
  body: JSON.stringify({
    "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4"
  }),
});
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 = {
    "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4",
}

# Run the model; wait up to 20 s for the finished result in the same call
r = requests.post(API + "/run/lightx/relight", 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": "lightx/relight",
      "input": {
        "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4"
      },
      "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": "lightx/relight",
  "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": 490,
    "usd": "0.49",
    "charged": 490,
    "refunded": 0
  },
  "input": {
    "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4"
  },
  "output": {
    "video": {
      "url": "https://content.doitong.com/dev-api/2026/10/20/req_8k2m4q7x1z9c3v5b6n0p2r4t/0-output.mp4",
      "content_type": "video/mp4",
      "file_name": "0-output.mp4",
      "file_size": 1843200
    },
    "seed": 42,
    "input_video": {
      "url": "https://content.doitong.com/dev-api/2026/10/20/req_8k2m4q7x1z9c3v5b6n0p2r4t/0-output.mp4",
      "content_type": "video/mp4",
      "file_name": "0-output.mp4",
      "file_size": 1843200
    },
    "viz_video": {
      "url": "https://content.doitong.com/dev-api/2026/10/20/req_8k2m4q7x1z9c3v5b6n0p2r4t/0-output.mp4",
      "content_type": "video/mp4",
      "file_name": "0-output.mp4",
      "file_size": 1843200
    }
  },
  "outputs": [
    {
      "type": "video",
      "url": "https://content.doitong.com/dev-api/2026/10/20/req_8k2m4q7x1z9c3v5b6n0p2r4t/0-output.mp4",
      "content_type": "video/mp4",
      "file_size": 1843200,
      "width": 1280,
      "height": 720,
      "duration": 5,
      "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 |
|---|---|---|
| `video` | object {url, content_type, file_name, file_size} | ملف الفيديو الناتج عن التوليد. |
| `seed` | integer | قيمة البذرة المطبّقة أثناء التوليد. |
| `input_video` | object {url, content_type, file_name, file_size} \| null | فيديو المدخل المُطبّع أو المُعالَج، ويُعاد اختياريًا عندما ينتجه المسار. |
| `viz_video` | object {url, content_type, file_name, file_size} \| null | فيديو التصور أو تصحيح الأخطاء، ويُعاد اختياريًا عندما ينتجه المسار. |

## Related models

- [Lightx · Recamera](https://doitong.com/developers/models/lightx/recamera.md) (`lightx/recamera`): $0.10 / second of output video
- [AMT Interpolation](https://doitong.com/developers/models/amt-interpolation.md) (`amt-interpolation`): $0.000575 / second of processing time
- [AnimateDiff Turbo · Video to Video](https://doitong.com/developers/models/fast-animatediff/turbo/video-to-video.md) (`fast-animatediff/turbo/video-to-video`): $0.00125 / second of processing time
- [AnimateDiff · Video to Video](https://doitong.com/developers/models/fast-animatediff/video-to-video.md) (`fast-animatediff/video-to-video`): $0.00125 / second of processing time
- [Bernini-R Edit Video](https://doitong.com/developers/models/bernini-r/edit-video.md) (`bernini-r/edit-video`): from $0.04 / second of output video
- [Bernini-R Reference Edit Video](https://doitong.com/developers/models/bernini-r/reference-edit-video.md) (`bernini-r/reference-edit-video`): from $0.04 / second of output video
- [DWPose Pose Prediction · Video](https://doitong.com/developers/models/dwpose/video.md) (`dwpose/video`): $0.0006 / second of processing time
- [Editto](https://doitong.com/developers/models/editto.md) (`editto`): from $0.04 / second of output video

## Links

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