مستندات

Chat Completions

POST /v1/chat/completions — پارامترها، شکل پاسخ و stream.

POSThttps://iranrouter.com/v1/chat/completions

مسیر اصلی. سازگار با OpenAI، پس شکل درخواست و پاسخ همان است که SDKها انتظار دارند.

پارامترها

نام	نوع	توضیح
`model`	string	الزامی. شناسهٔ مدل یا نام مستعار.
`messages`	array	الزامی. پیام‌ها با نقش system / user / assistant / tool.
`max_tokens`	int	سقف توکن خروجی. روی مبلغ رزروشده اثر مستقیم دارد — واقع‌بینانه ببندید.
`max_completion_tokens`	int	معادل max_tokens برای کلاینت‌های جدیدتر؛ هر دو خوانده می‌شوند.
`stream`	bool	پاسخ جریانی SSE.
`temperature`	number	تصادفی‌بودن خروجی.
`top_p`	number	نمونه‌برداری هسته‌ای.
`tools`	array	تعریف ابزارها. schema آن‌ها هم توکن ورودی حساب می‌شود.
`tool_choice`	string\|object	اجبار یا آزادگذاشتن انتخاب ابزار.
`response_format`	object	خروجی ساختاریافته / JSON.
`stop`	string\|array	دنباله‌های توقف.
`seed`	int	برای تکرارپذیری، اگر مدل پشتیبانی کند.

هر مدل زیرمجموعهٔ خودش را می‌پذیرد. فهرست دقیق پارامترهای پشتیبانی‌شدهٔ هر مدل، در صفحهٔ همان مدل آمده است؛ پارامترهای ناشناخته بی‌اثرند، نه خطا.

پاسخ

json

{
  "id": "chatcmpl-...",
  "object": "chat.completion",
  "created": 1767000000,
  "model": "openai/gpt-4o-mini",
  "choices": [
    {
      "index": 0,
      "message": { "role": "assistant", "content": "..." },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 24,
    "completion_tokens": 108,
    "total_tokens": 132
  }
}

پاسخ غیرجریانی tool_calls, logprobs, refusal و n>1 را کامل برمی‌گرداند.

نمونهٔ کامل

bash

curl https://iranrouter.com/v1/chat/completions \
  -H "Authorization: Bearer ir-..." \
  -H "Content-Type: application/json" \
  -d '{
    "model": "openai/gpt-4o-mini",
    "messages": [
      {"role": "system", "content": "You answer in Persian."},
      {"role": "user", "content": "پایتخت ایران کجاست؟"}
    ],
    "max_tokens": 200,
    "temperature": 0.4
  }'

برای stream اینجا ← · برای ابزارها ←