مستندات اندپوینت‌های سازگار با OpenAI

احراز هویت و URL پایه

ابتدا کلید API خود را از طریق داشبورد و با استفاده از حساب Google یا ایمیل تولید کنید. این کلید را به عنوان Authorization: Bearer YOUR_API_KEY. URL پایه https://api.openaicompatibleendpoints.com/v1, که تضمین می‌کند کد کلاینت موجود شما بدون تغییر کار می‌کند. شما یک کلید فعال در هر حساب دریافت می‌کنید که می‌توانید بلافاصله در صورت آسیب‌دیدگی آن را بازیابی کنید. برای ثبت‌نام به شماره تلفن نیازی نیست، که فرآیند را سریع و خصوصی نگه می‌دارد.

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

یک درخواست کامل‌شدن چت استاندارد به ارسال کنید تا تولید متن فوراً آغاز شود. این تأیید می‌کند که اعتبارنامه‌ها و موجودی توکن شما فعال هستند قبل از مقیاس‌بندی جریان کاری‌تان. این نقطه پایانی پُیک‌لودهای JSON استاندارد مطابق با فرمت OpenAI را می‌پذیرد و به شما امکان می‌دهد اتصال را با حداقل سربار آزمایش کنید.

Copycurl https://api.openaicompatibleendpoints.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Return the current server time in UTC format"}]
  }'

یکپارچه‌سازی SDK Python

پکیج رسمی پایتون OpenAI را نصب کنید و آن را به سمت URL پایه ما پیکربندی کنید تا از الگوهای آشنا بهره‌مند شوید. این روش به‌طور یکپارچه با ابزارهایی مانند LangChain یا LlamaIndex که به انتهای‌های سازگار با OpenAI نیاز دارند، کار می‌کند. با به‌روزرسانی ساده‌ی پیکربندی URL پایه، می‌توانید مدل‌ها یا ارائه‌دهندگان را تغییر دهید بدون اینکه منطق برنامه‌ی خود را تغییر دهید. این انعطاف‌پذیری برای آژانس‌هایی که چندین پایپلاین استنتاج را مدیریت می‌کنند، حیاتی است.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.openaicompatibleendpoints.com/v1", api_key="YOUR_KEY")

resp = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)

استفاده Node SDK

کلاینت Node.js را با URL پایه و کلید API خود مقداردهی اولیه کنید تا شروع به ارسال درخواست‌های جریان‌دار یا سینک کنید. این پیکربندی رابط کلاینت استاندارد OpenAI را شبیه‌سازی می‌کند و ادغام آن در برنامه‌های Express یا Fastify را آسان می‌سازد. می‌توانید خطاها را به‌طور شایسته با بررسی کدهای وضعیت برگشتی از سرور مدیریت کنید و اطمینان حاصل کنید که برنامه شما در طول استفاده با حجم بالا مقاوم باقی بماند.

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.openaicompatibleendpoints.com/v1", apiKey: process.env.API_KEY });

const resp = await client.chat.completions.create({
  model: "uncensored",
  messages: [{ role: "user", content: "Draft a villain monologue for my game." }],
});
console.log(resp.choices[0].message.content);

پاسخ‌های استریم (SSE)

با تنظیم stream پارامتر را true تنظیم کنید که داده‌ها را از طریق رویدادهای ارسال‌شده توسط سرور (SSE) به‌صورت بلادرنگ برمی‌گرداند. این موضوع تأخیر ادراک‌شده را برای کاربران نهایی، به‌ویژه هنگام تولید پاسخ‌های طولانی یا زنجیره‌های استدلال پیچیده، کاهش می‌دهد. هر قطعه حاوی محتوای ناقص است و به شما امکان می‌دهد متن را به‌تدریج در رابط کاربری خود رندر کنید. قطعه نهایی شامل آمار کامل مصرف توکن برای ردیابی دقیق صورتحساب است.

Copystream = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Tell the story in second person."}],
    stream=True,
)
for chunk in stream:
    if chunk.choices and chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="", flush=True)

محدودیت‌ها، خطاها و زمینه

کلید API شما از تا 300 درخواست در دقیقه و 8 اتصال همزمان پشتیبانی می‌کند. اگر از این محدودیت‌ها تجاوز کنید، سرور کد وضعیت 429 را برمی‌گرداند؛ کمبود موجودی منجر به خطای 402 و کلیدهای نامعتبر منجر به خطای 401 می‌شود. مدل از یک پنجره زمینه 100,000 توکنی (ترکیب prompt و completion) پشتیبانی می‌کند. خطاها و رد شدن‌ها اعتبار پیش‌پرداخت شما را مصرف نمی‌کنند، بنابراین فقط برای استنتاج معتبر هزینه می‌پردازید.