مستندات API & شروع سریع

تنظیم URL پایه و احراز هویت

کلید API هر درخواست را احراز هویت می‌کند. آن را از طریق داشبورد با استفاده از اعتبارنامه‌های Google یا ایمیل تولید کنید. آن را در Authorization هدر به عنوان یک توکن Bearer.

• URL پایه: https://api.unrestrictedlocalaimodels.com/v1
• هدر: Authorization: Bearer YOUR_API_KEY

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

Endpoint /v1/chat/completions

درخواست چت استاندارد را برای تولید متن بدون منطق رد محتوا ارسال کنید.

endpoint همان ساختار JSON را مانند OpenAI می‌پذیرد. تنظیم model به uncensored. سیستم ورودی شما را پردازش کرده و خروجی خام را برمی‌گرداند.

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

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

از کتابخانه رسمی پایتون OpenAI استفاده کنید. آن را به URL پایه ما متصل کنید.

این امکان استفاده از کدهای موجود را فراهم می‌کند. کتابخانه سریال‌سازی JSON را به‌طور خودکار مدیریت می‌کند.

تنظیم api_key به کلید خود. مقدار base_url به نقطه پایان. ارسال model="uncensored" در درخواست.

یکپارچه‌سازی SDK Node.js

کلاینت OpenAI را با URL پایه ما مقداردهی اولیه کنید. این با هر SDK سازگار کار می‌کند.

شیء کلاینت را پیکربندی کنید. کلید API خود را وارد کنید. کتابخانه چرخه حمله درخواست را مدیریت می‌کند.

فراخوانی chat.completions.create(). شناسه مدل را تنظیم کنید. شیء پاسخ را دریافت کنید که شامل متن تولید شده است.

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

استریمینگ را با تنظیم stream: true. سرور رویدادهای ارسالی سرور (SSE) ارسال می‌کند.

داده‌های مصرف توکن در قطعه نهایی ظاهر می‌شود. این امکان ردیابی دقیق صورت‌حساب را فراهم می‌کند.

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

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

محدودیت‌های نرخ به ازای هر کلید اعمال می‌شوند. می‌توانید ۳۰۰ درخواست در دقیقه ارسال کنید. همزمانی به ۸ درخواست همزمان محدود است.

وضعیت 401 به معنی کلید نامعتبر است. وضعیت 402 نشان‌دهنده اعتبار ناکافی است. وضعیت 429 نشان‌دهنده محدودیت نرخ است.

پنجره زمینه ۱۰۰,۰۰۰ توکن است. خروجی به ۱۶,۰۰۰ توکن محدود است. بدنه درخواست‌ها باید کمتر از ۸ مگابایت باشد.

cURL

Copycurl https://api.unrestrictedlocalaimodels.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the three main dependencies for this rust crate"}]
  }'

پایتون

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.unrestrictedlocalaimodels.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.js

Copyimport OpenAI from "openai";

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

جریان‌سازی

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)