راهنمای شروع ای‌فارس

اتصال به API ای‌فارس

از ساخت حساب تا اولین درخواست؛ کلید API خود را دریافت کنید، یک مدل فعال انتخاب کنید و قابلیت‌های هوش مصنوعی را به برنامه خود اضافه کنید.

سازگار با OpenAI

آدرس پایه اتصال

https://efars.com/v1

مسیر درخواست گفتگو

POST https://efars.com/v1/chat/completions

چهار قدم تا اولین درخواست

حساب خود را بسازید

در ای‌فارس ثبت‌نام کنید و وارد پنل کاربری شوید.

اعتبار اضافه کنید

از بخش کیف پول، اعتبار موردنیاز پروژه خود را افزایش دهید.

کلید API دریافت کنید

از بخش کلیدهای API پنل، یک کلید برای برنامه خود ایجاد کنید.

مدل را انتخاب و متصل شوید

نام دقیق یک مدل فعال را از صفحه تعرفه‌ها بردارید و درخواست خود را ارسال کنید.

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


curl https://efars.com/v1/chat/completions \
  -H "Authorization: Bearer YOUR_EFARS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model":"ACTIVE_MODEL_NAME","messages":[{"role":"user","content":"سلام! لطفاً خودت را معرفی کن."}]}'

این نمونه یک الگوست. پیش از اجرا، کلید و ACTIVE_MODEL_NAME را با کلید خود و نام دقیق یک مدل فعال جایگزین کنید. درخواست واقعی مطابق تعرفه مدل هزینه دارد.

کلید شما محرمانه است

کلید API را در سرور یا متغیرهای محیطی برنامه نگه دارید. آن را در کد سمت مرورگر، مخزن عمومی یا تصاویر راهنما قرار ندهید.

مدل مناسب را انتخاب کنید

مدل‌های قابل استفاده و هزینه آن‌ها در صفحه مدل‌ها و تعرفه‌ها به‌روز می‌شوند. نام مدل را دقیقاً از همان فهرست بردارید.

مشاهده مدل‌های فعال

اگر با خطا روبه‌رو شدید

401

کلید API پذیرفته نشده است

کلید و قالب هدر Authorization: Bearer را بررسی کنید؛ از کلید خود ای‌فارس استفاده کنید.

400

ساختار درخواست درست نیست

JSON، پارامترهای درخواست و نام دقیق مدل را بررسی کنید.

429

درخواست‌ها بیش از حد مجاز است

ارسال درخواست‌ها را آهسته‌تر کنید و زمان اعلام‌شده در هدر Retry-After را رعایت کنید.

5xx

سرویس موقتاً پاسخ نمی‌دهد

کمی بعد دوباره تلاش کنید. اگر خطا ادامه داشت، زمان و شناسه درخواست را برای بررسی نگه دارید.