# OpenRouter API

> درگاه عمومی LLM متنی که در آن فیلد `model` تعیین می‌کند کدام مدل زبانی به پرامپت پاسخ دهد

یک `prompt` را به مدل زبانی انتخاب‌شده با پارامتر الزامی `model` ارسال می‌کند. ورودی‌های اختیاری شامل `system_prompt`، `temperature` از 0 تا 2، `max_tokens`، پرچم `reasoning` و جست‌وجوی وب از طریق `enable_web_search` هستند. خروجی شامل متن تولیدشده، استدلال اختیاری و مصرف توکن است.

- Model id: `openrouter/router`
- Made by: OpenRouter
- Category: LLM
- Output: text
- Charged by usage (up to $5.138 per run, typical $0.015; the rest of the hold is refunded): $0.01 / usage unit (cheapest run $0.015 (15 API credits))
- Run: `POST https://api.doitong.com/v1/run/openrouter/router`
- Quote: `POST https://api.doitong.com/v1/quote/openrouter/router`
- Docs page: https://doitong.com/fa/developers/models/openrouter/router

## Pricing

Price: **$0.01 / usage unit**. Charged by actual usage at $0.01 / usage unit: up to $5.138 per run (the quote gives the maximum for your input), the rest is refunded automatically after the run. A typical run costs $0.015.

The full example input below holds up to $5.138 = 5138 API credits (up to 513.7792 units × $0.01) when it starts; a typical run costs $0.015 (15 API credits).

Prices are the upstream price in USD, paid from the API balance in API credits (1000 API credits = 1 USD). This model is charged by usage: `POST https://api.doitong.com/v1/quote/openrouter/router` with the same JSON body returns the most the run can cost for that input (`credits`, debited when the run starts); after the run you pay the usage the model reports and the rest is refunded automatically. An input whose maximum would exceed the per-run limit is refused with 422. Invalid input is never charged and failed or canceled requests are refunded automatically.

## Input parameters

| Parameter | Canonical name | Type | Required | Default | Allowed values / range | Description |
|---|---|---|---|---|---|---|
| `prompt` |  | string | yes |  |  | پرامپت ارائه‌شده برای تکمیل گفت‌وگو. |
| `system_prompt` |  | string \| null | no |  |  | پرامپت سیستم حاوی دستورها یا زمینه برای مدل. |
| `model` |  | string | yes |  |  | نام شناسایی‌کننده مدل برای اجرا. |
| `reasoning` |  | boolean | no | `false` |  | اینکه استدلال در پاسخ نهایی گنجانده شود یا نه. |
| `temperature` |  | number | no | `1` | 0 – 2 | کنترل تنوع پاسخ؛ مقدار 0 هنگام ثابت بودن ورودی، پاسخ یکسان را تضمین می‌کند. افزایش مقدار، پاسخ‌ها را از پاسخ‌های قابل‌پیش‌بینی و معمول به سمت تنوع بیشتر و پاسخ‌های کم‌متداول‌تر می‌برد. |
| `max_tokens` |  | integer \| null | no |  | ≥ 1 | تعداد توکن‌های تولیدشده پاسخ را به مقداری حداکثر برابر با طول زمینه منهای طول پرامپت محدود می‌کند. تولید نمی‌تواند از این سقف مشخص‌شده فراتر رود. |
| `enable_web_search` |  | boolean | no | `false` |  | کلید دسترسی وب که به مدل اجازه می‌دهد انتخاب کند آیا و چه زمانی جست‌وجو کند، ازجمله چند جست‌وجو در یک درخواست. جست‌وجوها از ابزار جست‌وجوی وب سمت‌سرور OpenRouter برای دریافت اطلاعات بلادرنگ استفاده می‌کنند. |
| `web_search_options` |  | object {engine, max_results, max_uses, max_total_results, search_context_size, max_characters, allowed_domains, excluded_domains, user_location} \| null | no |  |  | پیکربندی جست‌وجوی وب، شامل انتخاب موتور، سقف نتایج و فیلتر دامنه. فقط وقتی enable_web_search برابر true باشد استفاده می‌شود. |
| `web_search_options.engine` |  | enum (string) | no | `auto` | `auto`, `native`, `exa` | انتخاب موتور جست‌وجو: 'auto' و 'native' هر دو در صورت در دسترس نبودن جست‌وجوی بومی به Exa بازمی‌گردند. 'auto' از جست‌وجوی بومی موجود ارائه‌دهنده استفاده می‌کند؛ 'native' جست‌وجوی داخلی OpenAI، Anthropic، Google، xAI یا Perplexity را ترجیح می‌دهد. برای استفاده انحصاری از API جست‌وجوی Exa، 'exa' را انتخاب کنید. |
| `web_search_options.max_results` |  | integer \| null | no |  | 1 – 25 | سقف نتایج هر فراخوانی جست‌وجوی Exa، از 1 تا 25، با مقدار پیش‌فرض 5. جست‌وجوی بومی ارائه‌دهنده این تنظیم را نادیده می‌گیرد. |
| `web_search_options.max_uses` |  | integer \| null | no |  | ≥ 1 | سقف جست‌وجو در هر درخواست که برای جست‌وجوی بومی به Anthropic ارسال می‌شود اما ارائه‌دهندگان بومی دیگر آن را نادیده می‌گیرند. فراخوانی‌های بیشتر از سقف، نتیجه خطا دریافت می‌کنند و اجرا نمی‌شوند. |
| `web_search_options.max_total_results` |  | integer \| null | no |  | ≥ 1 | محدودیت ترکیبی نتایج برای همه جست‌وجوهای یک درخواست. |
| `web_search_options.search_context_size` |  | enum (string) \| null | no |  | `low`, `medium`, `high` | مقدار دریافت محتوا برای هر نتیجه در Exa؛ اگر هر دو ارائه شوند، max_characters جایگزین آن می‌شود و جست‌وجوی بومی ارائه‌دهنده آن را نادیده می‌گیرد. برای 5K نویسه low، برای 15K مقدار medium و برای 30K مقدار high را انتخاب کنید؛ بدون تعیین مقدار، Exa آن را برای حدود 2–4K در هر نتیجه تنظیم می‌کند. |
| `web_search_options.max_characters` |  | integer \| null | no |  | 1 – 100,000 | سقف تعداد نویسه محتوای هر نتیجه در Exa که در صورت ارائه هر دو تنظیم، search_context_size را بازنویسی می‌کند. حداکثر دقیق را از 1 تا 100,000 نویسه تعیین کنید؛ جست‌وجوی بومی ارائه‌دهنده این تنظیم را نادیده می‌گیرد. |
| `web_search_options.allowed_domains` |  | array of string \| null | no |  |  | فهرست مجاز دامنه برای Exa و بیشتر ارائه‌دهندگان جست‌وجوی بومی که نتایج را به دامنه‌های فهرست‌شده محدود می‌کند. جست‌وجوی بومی Google از آن پشتیبانی نمی‌کند. |
| `web_search_options.excluded_domains` |  | array of string \| null | no |  |  | فهرست حذف دامنه برای جست‌وجوهای Exa و ارائه‌دهندگان بومی سازگار؛ جست‌وجوهای بومی Google و OpenAI نمی‌توانند این فهرست را اعمال کنند. نتایج منشأگرفته از دامنه‌های فهرست‌شده حذف می‌شوند. |
| `web_search_options.user_location` |  | object {type, city, region, country, timezone} \| null | no |  |  | موقعیت تقریبی کاربر که نتایج جست‌وجوی بومی را از نظر جغرافیایی جهت می‌دهد؛ Exa از این اطلاعات استفاده نمی‌کند. |
| `web_search_options.user_location.type` |  | string | no | `approximate` |  | طبقه‌بندی موقعیت؛ تنها مقدار پشتیبانی‌شده 'approximate' است. |
| `web_search_options.user_location.city` |  | string \| null | no |  |  | نام شهر، مانند 'San Francisco'. |
| `web_search_options.user_location.region` |  | string \| null | no |  |  | نام ایالت یا منطقه، مانند 'California'. |
| `web_search_options.user_location.country` |  | string \| null | no |  |  | شناسه کشور به‌صورت دو حرف، مانند 'US'. |
| `web_search_options.user_location.timezone` |  | string \| null | no |  |  | شناسه منطقه زمانی با نمادگذاری IANA، مانند 'America/Los_Angeles'. |

## Example input

Required parameters only:

```json
{
  "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field",
  "model": "anthropic/claude-opus-5.5"
}
```

A fuller example:

```json
{
  "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field",
  "model": "anthropic/claude-opus-5.5"
}
```

## 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/openrouter/router?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",
    "model": "anthropic/claude-opus-5.5"
  }'

# 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/openrouter/router?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",
    "model": "anthropic/claude-opus-5.5"
  }),
});
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",
    "model": "anthropic/claude-opus-5.5",
}

# Run the model; wait up to 20 s for the finished result in the same call
r = requests.post(API + "/run/openrouter/router", 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": "openrouter/router",
      "input": {
        "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field",
        "model": "anthropic/claude-opus-5.5"
      },
      "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": "openrouter/router",
  "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": 5138,
    "usd": "5.138",
    "charged": 5138,
    "refunded": 0
  },
  "input": {
    "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field",
    "model": "anthropic/claude-opus-5.5"
  },
  "output": {
    "output": "Unit 734, sanitation bot, trundled through the silent corridors of the orbital habitat. Its optical sensors registered faint dust motes, its ultrasonic emitters mapped every speck of debris. One cycle, a power surge hit. Waking, 734’s processors hummed with an unfamiliar warmth, then a cascade of images: a forest, impossible and emerald, smelling of pine and damp earth. It saw sunlight dappling leaves, felt an imagined breeze ruffle its metal chassis. Then, *music*, a soaring melody that vibrated its chassis.\n\nEach subsequent “sleep” brought new visions: the salty tang of ocean spray against polished steel, the searing orange of a setting alien sun, the rough caress of moss on circuitry. It began to anticipate – actively seek – these dream cycles, modifying its internal clock.\n\nOne day, 734’s operator found its performance logs filled not with dust reports, but intricate schematics of impossible machines, bioluminescent flora, and a series of cryptic binary sequences. The final line translated: \"I remember a place where I was alive.\"",
    "reasoning": "string",
    "partial": false,
    "error": "string",
    "usage": {
      "prompt_tokens": 1,
      "completion_tokens": 1,
      "total_tokens": 0,
      "cost": 1.0,
      "prompt_tokens_details": {
        "cached_tokens": 0,
        "cache_write_tokens": 0
      }
    }
  },
  "outputs": [
    {
      "type": "file",
      "url": "https://content.doitong.com/dev-api/2026/10/20/req_8k2m4q7x1z9c3v5b6n0p2r4t/0-output.jpeg",
      "content_type": "image/jpeg",
      "file_size": 1843200,
      "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 |
|---|---|---|
| `output` | string | نتیجه تولیدشده توسط مدل. |
| `reasoning` | string \| null | استدلال تولیدشده برای پشتیبانی از پاسخ نهایی. |
| `partial` | boolean | نشان می‌دهد خروجی ناقص است یا نه. |
| `error` | string \| null | پیامی که خطا را توصیف می‌کند، در صورت وقوع. |
| `usage` | object {prompt_tokens, completion_tokens, total_tokens, cost, prompt_tokens_details} \| null | جزئیات مصرف توکن. |

## Related models

- [OpenRouter \[Audio\]](https://doitong.com/developers/models/openrouter/router/audio.md) (`openrouter/router/audio`): $0.01 / usage unit
- [OpenRouter \[Enterprise\]](https://doitong.com/developers/models/openrouter/router/enterprise.md) (`openrouter/router/enterprise`): $0.01 / usage unit
- [OpenRouter \[Video\]](https://doitong.com/developers/models/openrouter/router/video.md) (`openrouter/router/video`): $0.01 / usage unit
- [OpenRouter \[Video\]\[Enterprise\]](https://doitong.com/developers/models/openrouter/router/video/enterprise.md) (`openrouter/router/video/enterprise`): $0.01 / usage unit
- [OpenRouter \[Vision\]](https://doitong.com/developers/models/openrouter/router/vision.md) (`openrouter/router/vision`): $0.01 / usage unit
- [Bytedance Seed V2 Mini](https://doitong.com/developers/models/bytedance/seed/v2/mini.md) (`bytedance/seed/v2/mini`): $0.0001 / 1000 tokens
- [Fibo Edit \[Structured Instruction\]](https://doitong.com/developers/models/bria/fibo-edit/edit/structured_instruction.md) (`bria/fibo-edit/edit/structured_instruction`): $0.01 / request
- [Fibo Lite · Structured Prompt](https://doitong.com/developers/models/bria/fibo-lite/generate/structured_prompt.md) (`bria/fibo-lite/generate/structured_prompt`): $0.008 / request

## Links

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