توثيق واجهة برمجة التطبيقات

المصادقة وURL الأساسي

استخدم مفتاح API الخاص بك مع كل طلب. عنوان URL الأساسي هو https://api.nsfwroleplayapi.com/v1. تعيين Authorization الرأس إلى Bearer YOUR_API_KEY. يمنحك المفتاح الوصول إلى نقطة النهاية chat-completions.

نقطة نهاية إكمال الدردشة

أرسل تلميحك إلى POST /v1/chat/completions. حدد النموذج "uncensored" في جسم الطلب. تعيد واجهة برمجة التطبيقات نصًا مُولّدًا بناءً على مدخلاتك.

context_window تسمح بإجمالي 100,000 رمز. يشمل ذلك كلًا من الطلب والاستجابة. يمكنك تعيين 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 تسلسلات لإيقاف التوليد مبكراً. تمنحك هذه المعلمات تحكماً دقيقاً.

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 300 طلب في الدقيقة. يمكنك إجراء 8 طلبات متزامنة في وقت واحد. حد حجم جسم الطلب هو 8 ميجابايت. يؤدي تجاوز هذه الحدود إلى إرجاع خطأ 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 إلى عدم كفاية الرصيد المدفوع مسبقاً. حدّث رصيدك عبر لوحة التحكم.

يشير خطأ 429 إلى استنفاد حد المعدل. انتظر قبل إعادة المحاثة. يرفض النموذج الطلبات التي تتضمن قاصرين. جميع محتويات البالغين القانونية الأخرى مسموح بها. تحقق من جسم الاستجابة للتفاصيل.