مرجع توسعه‌دهندگان

EFARS API

اولین درخواست به EFARS

چهار قدم برای اتصال برنامه با کلید ای‌فارس و پروتکل دلخواه.

راهنمای اتصال مشتریان
curl · Python · JavaScript

۱. کلید API بسازید

وارد حساب شوید و در بخش کلیدهای API یک کلید با نام مشخص برای برنامه بسازید. تاریخ انقضا و سقف مصرف را متناسب با کاربرد انتخاب کنید. کلید ای‌فارس جایگزین کلید مستقیم ارائه‌دهنده در اتصال به EFARS می‌شود.

۲. مدل و پروتکل را انتخاب کنید

در صفحه مدل‌ها و تعرفه‌ها، شناسه دقیق مدل و قابلیت آن را بررسی کنید. پشتیبانی مدل از یک عملیات مانند Chat، Messages، GenerateContent یا Embeddings باید برای همان عملیات تأیید شود. صرف دیده‌شدن نام در فهرست مدل‌ها تضمین اجرای هر عملیات نیست.

۳. متغیر محیطی را تنظیم کنید

Shell · محیط امن سرور

export EFARS_API_KEY="YOUR_EFARS_API_KEY"

کلید را در تنظیمات امن محیط اجرای سرور قرار دهید. فایل حاوی کلید را در Git ثبت نکنید و آن را در کد فرانت‌اند، URL یا تصویر صفحه قرار ندهید. نمونه‌های JavaScript این راهنما برای Node.js هستند.

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

نمونه‌ها آموزشی‌اند و حاصل اجرای زنده نیستند. YOUR_EFARS_API_KEY و نام‌های ختم‌شونده به MODEL_NAME جای‌نگهدارند؛ پیش از اجرا، کلید ای‌فارس و مدل مجاز حساب خود را جایگزین کنید. مقادیر شناسه و مصرف در پاسخ‌های نمونه، گزارش مصرف واقعی نیستند.

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