راهنمای اتصال به API آونا
آدرس API و روش احراز هویت را اینجا پیدا کنید. بعد با یکی از نمونهکدها اولین درخواست را از پروژهتان بفرستید.
اولین درخواست در سه قدم
برای اولین درخواست، فقط یک کلید معتبر، یک مدل فعال و اعتبار کافی لازم دارید.
احراز هویت و کلید API
تمام درخواستهای خصوصی با هدر Bearer و کلید صادرشده از پنل شما احراز هویت میشوند.
آن را در متغیر محیطی سرور نگه دارید، نه در جاوااسکریپت مرورگر یا مخزن عمومی کد.
Authorization: Bearer av-YOUR_API_KEYنمونهها از متغیر محیطی AVENAAI_API_KEY استفاده میکنند. مقدار YOUR_API_KEY صرفاً جاینگهدار است.
نمونهکد آماده برای اتصال
یک مدل متنی منتشرشده را انتخاب کنید و کد متناسب با زبان پروژهتان را کپی کنید.
curl -sS https://api.avenaai.ir/v1/chat/completions \
-H "Authorization: Bearer $AVENAAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"model":"YOUR_ENABLED_MODEL","messages":[{"role":"user","content":"Hello from AvenaAI!"}],"max_completion_tokens":256}'در نمونهها سقف خروجی ۲۵۶ توکن قرار داده شده تا مبلغ رزروشده اولیه کنترل شود. شناسه مدل باید برای حساب شما مجاز باشد؛ انتشار عمومی مدل بهتنهایی بهمعنای دسترسی همه حسابها نیست.
مدلها و شناسههای قابل استفاده
لیست مدلها از تنظیمات زنده Gateway استخراج میشود. مدلهای قابل استفاده برای هر کلید را از مسیر خصوصی زیر دریافت کنید.
/v1/modelsاحراز هویت لازم استcurl -sS https://api.avenaai.ir/v1/models \
-H "Authorization: Bearer $AVENAAI_API_KEY"کیف پول، شارژ و محاسبه مصرف
اعتبار حساب به دلار نگهداری میشود. از همین کلید API میتوانید موجودی و کد ششرقمی شارژ را مشاهده کنید.
/v1/walletاحراز هویت لازم استcurl -sS https://api.avenaai.ir/v1/wallet \
-H "Authorization: Bearer $AVENAAI_API_KEY"در شارژ عمومی، کد ششرقمی کیف پول را وارد کرده و رسید پرداخت را برای تأیید دستی ارسال کنید.
رفتن به شارژ عمومیمدلهای متنی براساس توکن و مدلهای تصویری پشتیبانیشده مطابق تعرفه هر تصویر محاسبه میشوند. قیمت نهایی را در کاتالوگ مشاهده کنید.
مشاهده تعرفههامسیرهای اصلی API
مسیرهای زیر از نسخه v1 پشتیبانی میشوند؛ استفاده از هر مسیر به نوع مدل، تعرفه و دسترسی کلید بستگی دارد.
/v1/modelsفهرست مدلهای مجاز حساب/v1/walletموجودی و کد شارژ کیف پول/v1/chat/completionsگفتوگو با مدل متنی/v1/responsesدرخواست با رابط Responses/v1/embeddingsبردارسازی متن با مدل مجاز/v1/images/generationsتولید تصویر با مدل تصویر/v1/images/editsویرایش تصویر در مدل پشتیبانیشدهخطاهای رایج و معنای آنها
کد HTTP معمولاً مشخص میکند مشکل از اعتبار، دسترسی مدل، سهمیه یا سرویس بالادستی است.
پیش از تکرار درخواست، موجودی کیف پول و هزینه احتمالی مدل را بررسی کنید. سقف خروجی بزرگتر میتواند مبلغ پیشرزرو را بالا ببرد.
چند نکته برای اجرای مطمئن
امنیت کلید API و کنترل هزینهها را از اولین روز پروژه در نظر بگیرید.
پروژه بعدیات را به هوش مصنوعی وصل کن.
کلید API، مدلها و مدیریت اعتبار، همگی در پنل شخصی شما آمادهاند.

