شروع سریع: اولین درخواست
یک درخواست تکمیل به انتهای‌پوینت تکی بدون سانسور ارسال کنید. API پیک‌لودهای JSON استاندارد chat-completions را می‌پذیرد و پاسخ‌های متنی بدون رد محتوای بزرگسالان قانونی برمی‌گرداند.
از URL پایه ارائه شده در داشبورد خود استفاده کنید. کلید API خود را در هدر authorization قرار دهید. شناسه مدل را به uncensored. این امر تضمین می‌کند که به سرور صحیحی که مدل وزن‌باز را برای خروجی بدون محدودیت تنظیم‌شده اجرا می‌کند متصل می‌شوید.
با یک پرامپت ساده برای تأیید اتصال شروع کنید. سیستم استفاده از توکن و متن تولیدشده را در بدنه پاسخ برمی‌گرداند.
کلیدهای احراز هویت
احراز هویت هر درخواست با یک توکن Bearer در Authorization header. کلید API شما بلافاصله پس از ثبت‌نام از طریق گوگل یا ایمیل ایجاد می‌شود.
کلید خود را امن نگه دارید. فقط یک کلید فعال برای هر حساب کاربری وجود دارد؛ تولید کلید جدید، کلید قبلی را لغو می‌کند. کلید دسترسی کامل به موجودی اعتبار پیش‌پرداخت شما را فراهم می‌کند.
اگر کلید نامعتبر یا منقضی شده باشد، API خطای 401 را برمی‌گرداند.
نقطه پایانی تکمیل چت
با مدل با استفاده از نقطه پایانی استاندارد تعامل داشته باشید: POST /v1/chat/completions نقطه پایانی. این نقطه پایانی تمام وظایف تولید متن را مدیریت می‌کند.
تاریخچه پیام‌های خود را در messages آرایه. API ورودی را پردازش کرده و پاسخ مدل را برمی‌گرداند. می‌توانید دستورات سیستم را برای هدایت رفتار اضافه کنید.
اندپوینت از حالت JSON و فراخوانی تابع پشتیبانی می‌کند. از این ویژگی‌ها برای یکپارچه‌سازی API در برنامه‌های خود به‌طور روان استفاده کنید.
اطمینان حاصل کنید که پیکربندی شما در محدودیت بدنه درخواست 8 MB باقی می‌ماند.
استریمینگ و SSE
با تنظیم stream: true در درخواست شما. API یک جریان رویدادهای ارسالی سرور برمی‌گرداند.
هر تکه شامل به‌روزرسانی‌های متن جزئی است. تکه نهایی شامل آمار کامل مصرف توکن است.
این رویکرد تأخیر ادراک‌شده برای کاربران نهایی را کاهش می‌دهد. به برنامه شما اجازه می‌دهد متن را همان‌طور که تولید می‌شود نمایش دهد.
قطع شدن استریم را به صورت ایمن مدیریت کنید. API تحویل تمام توکن‌ها را در صورت پایداری اتصال تضمین می‌کند.
پارامترها و گزینه‌ها
رفتار تولید را با پارامترهای استاندارد کنترل کنید. تنظیم temperature برای خلاقیت یا قطعیت. از top_p برای نمونه‌گیری هسته.
تنظیم max_tokens برای محدود کردن طول خروجی. پیش‌فرض 2,048 توکن است. حداکثر مجاز 16,000 توکن در هر درخواست است.
استفاده stop sequences برای توقف تولید در نشانگرهای خاص. The seed پارامتر نتایج قابل تکرار را برای اشکال‌زدایی فراهم می‌کند.
این گزینه‌ها در تمام کلاینت‌ها به طور یکسان کار می‌کنند.
مدیریت خطا و محدودیت‌ها
نرخ درخواست و موجودی اعتبار خود را پایش کنید. API محدودیتی معادل ۳۰۰ درخواست در دقیقه به ازای هر کلید را اعمال می‌کند.
خطای ۴۲۹ نشان می‌دهد که به محدودیت نرخ دسترسی پیدا کرده‌اید. خطای ۴۰۲ به این معنی است که اعتبار پیش‌پرداخت شما تمام شده است.
پنجره زمینه (context window) از مجموعاً ۱۰۰,۰۰۰ توکن پشتیبانی می‌کند. این مقدار شامل هم ورودی (prompt) و هم خروجی (completion) است.
خطاها در حین پردازش اعتبار مصرف نمی‌کنند. فقط تولید موفق توکن‌ها صورت‌حساب می‌شود.
cURL
curl https://api.mostuncensoredllm.com/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [{"role": "user", "content": "Generate a list of ten distinct Linux shell commands for system monitoring."}]
}'پایتون
from openai import OpenAI
client = OpenAI(base_url="https://api.mostuncensoredllm.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
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://api.mostuncensoredllm.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 = 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)