نِت اَرز · مستندات API هوش مصنوعی
همهٔ مستندات
مدل‌ها و قیمت‌ها مرجع تعاملی دریافت کلید

حساب و مصرف

GET /me برای موجودی اعتبار و محدودیت‌ها، GET /usage برای گزارش مصرف و GET /requests/{id} برای وضعیت یک درخواست در API هوش مصنوعی نِت اَرز.

base_url: https://netarz.ir/api/ai/v1 به‌روزرسانی: 1405/07/06

سه endpoint برای پایش حساب از داخل برنامهٔ شما — همان کلید پروژه را می‌پذیرند و فقط اطلاعات همان پروژه را برمی‌گردانند.

موجودی و محدودیت‌ها

GET /api/ai/v1/me نیازمند کلید API
cURL
curl https://netarz.ir/api/ai/v1/me \
  -H "Authorization: Bearer $NETARZ_API_KEY"
پاسخ
{
  "object": "account",
  "balance": {
    "usd": "12.345678",           // موجودی دقیق (۶ رقم اعشار)
    "usd_display": "$12.3457",
    "toman_estimate": 2469136     // معادل تومانی با نرخ لحظه
  },
  "status": "active",             // active | suspended
  "project": { "id": 7, "name": "ربات تلگرام" },
  "key": {
    "name": "production",
    "prefix": "sk-ntz-v1-ab12",
    "rpm_limit": 60,              // محدودیت مؤثر: کلید → حساب → پیش‌فرض
    "spend_limit_usd": "50.00",   // null = بدون سقف
    "spent_usd": "3.120000",
    "expires_at": null
  },
  "limits": { "concurrency": 8, "max_request_kb": 20480 }
}

از این endpoint برای هشدار موجودی کم در سیستم مانیتورینگ خودتان استفاده کنید (مثلاً وقتی balance.usd از یک آستانه پایین‌تر رفت).

گزارش مصرف

GET /api/ai/v1/usage نیازمند کلید API
پارامترتوضیح
from، toبازهٔ تاریخ میلادی (YYYY-MM-DD). پیش‌فرض: ۳۰ روز اخیر.
groupday (پیش‌فرض) یا model.
scopeproject (پیش‌فرض: همهٔ کلیدهای پروژه) یا key (فقط کلیدی که درخواست را فرستاده).
cURL
# مصرف ۳۰ روز اخیر پروژه، به تفکیک روز (پیش‌فرض)
curl "https://netarz.ir/api/ai/v1/usage" -H "Authorization: Bearer $NETARZ_API_KEY"

# بازهٔ دلخواه، به تفکیک مدل، فقط همین کلید
curl "https://netarz.ir/api/ai/v1/usage?from=2026-08-01&to=2026-08-30&group=model&scope=key" \
  -H "Authorization: Bearer $NETARZ_API_KEY"
پاسخ
{
  "object": "usage",
  "from": "2026-08-01",
  "to": "2026-08-30",
  "group": "model",
  "total_usd": "4.210000",
  "data": [
    { "key": "gpt-4o-mini",      "requests": 812, "errors": 3, "input_tokens": 410250, "output_tokens": 96110, "usd": "1.020000" },
    { "key": "openrouter/anthropic/claude-sonnet-4.5", "requests": 120, "errors": 0, "input_tokens": 88000, "output_tokens": 24000, "usd": "3.190000" }
  ]
}

اعداد از جدول تجمیع روزانه خوانده می‌شوند و مقدار usd مبلغ کسرشده از اعتبار (قیمت نِت اَرز) است. errors درخواست‌های ناموفق را می‌شمارد که هزینه‌ای نداشته‌اند.

وضعیت یک درخواست

GET /api/ai/v1/requests/{id} نیازمند کلید API

شناسه از هدر X-Request-Id یا فیلد id پاسخ برداشته می‌شود. فقط درخواست‌های همین پروژه قابل مشاهده‌اند؛ در غیر این صورت ۴۰۴ با کد request_not_found.

cURL
curl https://netarz.ir/api/ai/v1/requests/req_9f2c1e0b7a6d4c3f8e1a2b3c \
  -H "Authorization: Bearer $NETARZ_API_KEY"
پاسخ
{
  "id": "req_9f2c1e0b7a6d4c3f8e1a2b3c",
  "object": "request",
  "created": 1756540800,
  "model": "gpt-4o-mini",
  "endpoint": "chat",              // chat | completions | responses | embeddings | images | audio_stt | audio_translation | audio_tts | moderations
  "status": "success",             // pending | success | error | cancelled
  "streamed": true,
  "usage": { "input_tokens": 58, "output_tokens": 27, "cached_tokens": 0, "total_tokens": 85 },
  "usd": "0.000041",
  "latency_ms": 1840,
  "error": null                    // در خطا: {"code": "...", "message": "..."}
}

در پنل کاربری

در پنل کاربری ← API هوش مصنوعی همین اطلاعات به‌صورت گرافیکی در دسترس است: موجودی و شارژ، دفتر کل اعتبار، مصرف روزانه به تفکیک پروژه/کلید/مدل، فهرست درخواست‌ها با وضعیت، توکن‌ها و تأخیر، و مدیریت پروژه‌ها و کلیدها.

حریم خصوصی

در گزارش درخواست‌ها فقط فراداده نگه‌داری می‌شود؛ متن پیام‌ها و پاسخ‌ها هرگز ذخیره نمی‌شوند.