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

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

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

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

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

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

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

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 از پنل کاربری، تنظیمات زیر را در فایل‌های پیکربندی هر ابزار قرار دهید. در هر دو مورد، پس از ذخیرهٔ تنظیمات، یک‌بار برنامه را ببندید و دوباره باز کنید. برای اپلیکیشن دسکتاپ، بخش پیکربندی Claude Desktop را ببینید.

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

آموزش: آموزش نصب Claude Code Terminal

در فایل 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 را ببندید و دوباره باز کنید.