بازگشت به خانه Developers

مستندات توسعه‌دهندگان API

این مستندات برای اتصال سریع کلاینت‌ها با دو استاندارد OpenAI-compatible و Anthropic-compatible طراحی شده است. در اغلب ابزارها کافی است فقط token و baseUrl را تنظیم کنید.

شروع سریع

۱) دریافت کلید API

برای اتصال Codex، Claude Code یا هر کلاینت سازگار، ابتدا یک کلید API اختصاصی از پنل کاربری دریافت کنید. کلیدها با پیشوند sk- صادر می‌شوند و فقط برای حساب شما معتبر هستند.

  1. وارد حساب کاربری خود شوید (یا ثبت‌نام کنید).
  2. از منوی کاربری به صفحه کلید API بروید.
  3. روی دکمه ایجاد کلید API کلیک کنید و کلید را در جای امن ذخیره کنید.
  4. کلید را در ابزار موردنظر (Codex / Claude Code / curl) به‌عنوان توکن قرار دهید.
کلید API را در مخزن Git، اسکرین‌شات یا چت عمومی قرار ندهید. در صورت افشا، فوراً کلید را حذف و کلید جدید بسازید.
ورود و دریافت کلید API

برای ایجاد کلید API باید وارد حساب کاربری شوید.

۲) اطلاعات پایه API

  • Base URL: ریشه دامنه سرویس شما، مثال https://api.your-domain.com
  • Authorization: هدر Authorization: Bearer sk-... یا x-api-key
  • فرمت درخواست و پاسخ: application/json
  • کلید API را در کلاینت امن نگه دارید و هرگز در مخزن Git قرار ندهید.

۳) مسیرهای OpenAI-compatible

POST /v1/chat/completions

POST /v1/responses

GET /v1/models

نمونه درخواست:

curl -X POST "https://aivida.ir/v1/chat/completions" \
  -H "Authorization: Bearer sk-your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o-mini",
    "messages": [
      { "role": "user", "content": "سلام! یک معرفی کوتاه بنویس." }
    ],
    "stream": false
  }'

۴) مسیرهای Anthropic-compatible

POST /v1/messages

POST /v1/messages/count_tokens

نمونه درخواست:

curl -X POST "https://aivida.ir/v1/messages" \
  -H "x-api-key: sk-your-api-key" \
  -H "anthropic-version: 2023-06-01" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "claude-sonnet-4",
    "max_tokens": 512,
    "messages": [
      { "role": "user", "content": "یک چک لیست برای دیپلوی امن بده." }
    ]
  }'

۵) راهنمای پیکربندی Codex و Claude Code

پس از دریافت کلید API از پنل کاربری، تنظیمات زیر را در فایل‌های پیکربندی هر ابزار قرار دهید. در هر دو مورد، پس از ذخیرهٔ تنظیمات، یک‌بار برنامه را ببندید و دوباره باز کنید.

Codex

در فایل C:\Users\<UserName>\.codex\config.toml محتوای زیر را قرار دهید:

model_provider = "aivida"
model = "auto"

[model_providers.aivida]
name = "AIVida"
base_url = "https://aivida.ir/v1"
env_key = "AIVIDA_API_KEY"
wire_api = "responses"

کلید API را نیز در متغیرهای محیطی ویندوز با نام AIVIDA_API_KEY تنظیم کنید. در CMD (دائمی برای کاربر فعلی):

setx AIVIDA_API_KEY "sk-YourApiKey"

پس از setx، پنجرهٔ CMD یا Codex را ببندید و دوباره باز کنید تا مقدار جدید خوانده شود. مقدار sk-YourApiKey را با کلید واقعی خود از پنل AIVida جایگزین کنید.

یک‌بار برنامهٔ Codex را ببندید و دوباره باز کنید.

Claude Code

در فایل C:\Users\<UserName>\.claude\settings.json تنظیمات زیر را بنویسید:

{
  "env": {
    "ANTHROPIC_BASE_URL": "https://aivida.ir",
    "ANTHROPIC_AUTH_TOKEN": "sk-YourApiKey",
    "ANTHROPIC_MODEL": "auto"
  }
}

مقدار ANTHROPIC_BASE_URL باید فقط ریشهٔ دامنه باشد (بدون /v1). مقدار sk-YourApiKey را با کلید API خود جایگزین کنید.

یک‌بار برنامهٔ Claude Code را ببندید و دوباره باز کنید.

نکات امنیتی و عملیاتی

  • کلیدها را فقط از طریق Secret Manager یا متغیر محیطی مدیریت کنید.
  • در صورت لو رفتن کلید، سریعاً آن را حذف و rotate کنید.
  • برای خطاهای 401/403 ابتدا اعتبار token و مجوز مدل را بررسی کنید.