مستندات API

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

از کلید API خود با هر درخواست استفاده کنید. آدرس پایه https://api.nsfwroleplayapi.com/v1. تنظیم Authorization هدر به Bearer YOUR_API_KEY. کلید شما دسترسی به اندپوینت chat-completions را فراهم می‌کند.

نقطه پایانی تکمیل چت

پرامپت خود را به POST /v1/chat/completions. مدل را مشخص کنید "uncensored" در بدنه درخواست. API متن تولید شده را بر اساس ورودی شما برمی‌گرداند.

context_window تا ۱۰۰,۰۰۰ توکن در مجموع اجازه می‌دهد. این شامل هم متن درخواست و هم پاسخ است. می‌توانید max_tokens برای محدود کردن خروجی.

Copycurl https://api.nsfwroleplayapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Confirm monthly credit balance is active"}]
  }'

استریمینگ و استفاده از توکن

استریمینگ را با تنظیم stream: true. API رویدادهای ارسالی سرور (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)

پارامترها: دما، Top P و حالت JSON

تولید را با کنترل کنید temperature و top_p. این‌ها را تنظیم کنید تا خلاقیت یا قطعیت تغییر کند. از response_format با {"type": "json_object"} برای داده ساختاریافته. این تضمین می‌کند که قالب‌های خروجی یکسان باشند.

همچنین می‌توانید seed برای نتایج تکرارپذیر. مقدار stop sequences برای توقف تولید زودهنگام. این پارامترها کنترل دقیقی به شما می‌دهند.

Copyfrom openai import OpenAI

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

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

هر کلید API از ۳۰۰ درخواست در دقیقه پشتیبانی می‌کند. شما می‌توانید ۸ درخواست همزمان به طور همزمان داشته باشید. محدودیت اندازه بدنه درخواست ۸ مگابایت است. تجاوز از این محدودیت‌ها خطای 429 را برمی‌گرداند.

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

Copyimport OpenAI from "openai";

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

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

خطاها را با بررسی کد وضعیت HTTP مدیریت کنید. خطای 401 به این معنی است که کلید API شما نامعتبر است. خطای 402 نشان‌دهنده اعتبار پیش‌پرداخت ناکافی است. موجودی خود را از طریق داشبورد تازه‌سازی کنید.

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