مستندات برای کلید API سازگار با OpenAI

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

کلید تولید شده خود را با URL پایه ارائه شده برای اتصال فوری استفاده کنید. endpoint https://api.openaicompatibleapikey.com/v1 و با هر کلاینت سازگار با OpenAI کار می‌کند. شما یک کلید فعال برای هر حساب دریافت می‌کنید؛ ایجاد کلید جدید، کلید قبلی را جایگزین می‌کند. احراز هویت از طریق Authorization هدر با Bearer scheme. شماره تلفن برای ثبت‌نام لازم نیست و می‌توانید با ۰.۵۰ دلار آزمایش رایگان شروع کنید.

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

یک پیام ساده ارسال کنید تا اتصال و مدل بدون سانسور را بررسی کنید. درخواست از قالب استاندارد POST /v1/chat/completions اندپوینت با شناسه مدل تنظیم شده به uncensored. این تأیید می‌کند که کلید API شما معتبر است و نقطه پایان قبل از یکپارچه‌سازی آن در برنامه شما قابل دسترسی است. پاسخ شامل مصرف توکن و متن تولیدشده است.

Copycurl https://api.openaicompatibleapikey.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Calculate the total price including tax"}]
  }'

یکپارچه‌سازی SDK پایتون

API را در پروژه‌های پایتون خود با بازنویسی URL پایه پیش‌فرض یکپارچه کنید. این امکان را به شما می‌دهد تا از openai کتابخانه با LLM بدون سانسور ما بدون تغییر منطق کد خود. کلید API و URL پایه خاص را به راه‌اندازی مشتری منتقل کنید. شناسه مدل uncensored برای تمام درخواست‌ها.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.openaicompatibleapikey.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 خود، تنظیم کنید که baseURL و apiKey properties. این سازگاری با کد کلاینت موجود OpenAI-compatible را تضمین می‌کند. می‌توانید از پارامترهای استاندارد مانند messages و model. کلاینت درخواست‌ها را به سرورهای میزبانی‌شده ما برای تولید بدون سانسور هدایت خواهد کرد.

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.openaicompatibleapikey.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);

پاسخ‌های استریم‌شده و مصرف توکن

استریمینگ را با تنظیم stream: true در پارامترهای درخواست. API رویدادهای ارسال‌شده توسط سرور (SSE) را برای تحویل بلادرنگ توکن برمی‌گرداند. جزئیات مصرف توکن در قطعه نهایی جریان گنجانده شده است. این به شما امکان می‌دهد هزینه‌ها و استفاده از زمینه را هنگام تولید متن نظارت کنید. مدل از پنجره زمینه 100,000 توکن پشتیبانی می‌کند.

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)

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

محدودیت سهمیه خود را پایش کنید تا از وقفه در سرویس جلوگیری شود. محدودیت 300 درخواست در دقیقه به ازای هر کلید و 8 درخواست همزمان است. خطای 401 نشان‌دهنده کلید نامعتبر است، در حالی که 402 نشان‌دهنده عدم وجود اعتبار کافی است. خطاها و رد شدن‌ها رایگان هستند. پنجره زمینه 100,000 توکن است، با حداکثر خروجی 16,000 توکن در هر درخواست. اعتبار هرگز منقضی نمی‌شود.