مرجع API

مرجع API نکسامدل

API نکسامدل برای مدل‌های متنی است و با OpenAI و Anthropic سازگار است. مسیرها، احراز هویت، خطاها و راه رفعشان و نکته‌های امنیت کلید را این‌جا می‌بینید. ساخت تصویر و ویدیو در استودیو انجام می‌شود، نه از راه API.

نمونه‌ها با آدرس واقعی API نوشته شده‌اند؛ فقط کلید API خودتان را جای $NEXAMODEL_API_KEY بگذارید. کلید را بعد از ثبت‌نام در پنل می‌سازید و همین تنظیمات آن‌جا با کلید خودتان آماده است.
آدرس اصلی
https://api.nexamodel.app
آدرس برای ابزارهای OpenAI
https://api.nexamodel.app/v1

ابزارهای سازگار با OpenAI این آدرس را می‌خواهند. ابزارهای Anthropic خودشان /v1 را اضافه می‌کنند؛ به آن‌ها آدرس اصلی را بدهید.

هدر کلید
Authorization: Bearer <key>
یا
x-api-key: <key>

دروازه هر دو را می‌پذیرد. ابزارهای Anthropic معمولاً دومی را همراه هدر anthropic-version می‌فرستند.

مسیرهای دروازه

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

مسیرکاربرد
POST/v1/chat/completionsگفتگو در قالب OpenAI Chat Completions
POST/v1/responsesهمان گفتگو در قالب OpenAI Responses
POST/v1/messagesگفتگو در قالب Anthropic Messages
POST/v1/messages/count_tokensشمارش توکن‌های ورودی، بدون درخواست به مدل و بدون هزینه
GET/v1/modelsفهرست مدل‌هایی که با همین کلید در دسترس‌اند
GET/healthبررسی روشن بودن دروازه، بدون کلید
همهٔ مسیرهای گفتگو پاسخ استریم را پشتیبانی می‌کنند: stream: true را در بدنهٔ درخواست بگذارید تا پاسخ به‌صورت SSE بیاید. بیشتر ابزارها همین را به‌طور پیش‌فرض می‌فرستند.
پاسخ هر درخواست، کنار تعداد توکن‌ها، فیلد usage.charged_toman را هم دارد: مبلغی که برای همان درخواست از کیف پولتان کم شد.

وقتی درخواست رد می‌شود

هر درخواستی که رد شود، یک کد و یک جملهٔ کوتاه انگلیسی برمی‌گرداند که دلیل دقیق را می‌گوید.

400

بدنهٔ درخواست خوانده نشد: JSON درست نیست یا model متن نیست.

در ابزارهای آماده، معمولاً آدرس اشتباه وارد شده و درخواست به مسیر دیگری می‌رود.

401

کلید فرستاده نشد یا شناخته نشد.

هدر را بررسی کنید. اگر کلید را تعویض کرده‌اید، کلید تازه را در همهٔ ابزارها وارد کنید؛ کلید قبلی دیگر کار نمی‌کند.

402

موجودی کیف پول کافی نیست.

کیف پول را شارژ کنید تا درخواست بعدی انجام شود.

403

درخواست درست بود ولی اجازه نداشت: مدل در فهرست مجاز این کلید نیست، یا کلید منقضی یا غیرفعال شده، یا سقف ماهانه پر شده، یا مدل قابلیتی را که خواسته‌اید ندارد. ساخت تصویر و ویدیو فقط در استودیو است و از راه کلید API هم همین پاسخ را می‌گیرد.

متن پیام دقیقاً می‌گوید کدام‌یک. محدودیت‌های هر کلید را در پنل، بخش کلیدها، می‌بینید و تغییر می‌دهید.

413

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

معمولاً یعنی فایل یا تصویر بزرگی کامل به پرامپت اضافه شده است؛ حجمش را کم کنید.

429

از سقف درخواست در دقیقه یا سقف درخواست هم‌زمان گذشتید.

کمی صبر کنید و دوباره بفرستید. سقف‌ها به پلن شما بستگی دارند؛ سقف هر پلن را در صفحهٔ تعرفه‌ها ببینید.

502 · 503

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

کمی بعد دوباره بفرستید. اگر ادامه داشت، وضعیت سرویس و مدل‌ها را در صفحهٔ وضعیت ببینید.

اگر نام مدل اشتباه باشد، خطای 403 می‌گیرید و 404 نمی‌بینید؛ دروازه به مدل ناشناخته و مدل غیرمجاز جواب یکسانی می‌دهد. پس اول نام مدل را با صفحهٔ مدل‌ها مقایسه کنید.

امنیت کلید

هر کسی کلیدتان را داشته باشد می‌تواند از کیف پولتان خرج کند؛ مثل رمز عبور از آن محافظت کنید.

  • برای هر ابزار و هر دستگاه کلید جدا بسازید. آن‌وقت اگر کلیدی لو رفت، فقط همان را تعویض می‌کنید و بقیه دست نمی‌خورند.

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

  • اگر کلیدی را فقط برای یک مدل ساخته‌اید، همان یک مدل را در فهرست مجازش بگذارید؛ هر درخواست دیگری با 403 رد می‌شود.

  • کلید را در کد نگه ندارید. در متغیر محیطی بگذارید و فایل تنظیمات را به مخزن اضافه نکنید؛ کلیدهای لورفته تقریباً همیشه از یک کامیت می‌آیند.

  • اگر فکر می‌کنید کلیدی لو رفته، آن را تعویض کنید. کلید قبلی از کار می‌افتد و مصرف و تاریخچه‌اش باقی می‌ماند.

  • کلیدهای API به‌صورت امن نگهداری می‌شوند.

چیزی جا افتاده؟ بپرسید