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

البدء السريع: الطلب الأول

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

استخدم عنوان URL الأساسي المقدم في لوحة التحكم الخاصة بك. ضمّن مفتاح API الخاص بك في رأس التفويض. اضبط معرف النموذج على uncensored. يضمن ذلك أنك تضرب الخادم الصحيح الذي يشغل النموذج مفتوح المصدر والمُضبط للمخرجات غير المقيدة.

ابدل بطلب بسيط للتحقق من الاتصال. يعيد النظام استخدام الرموز والنص المولد في جسم الاستجابة.

المصادقة والمفاتيح

المصادقة على كل طلب برمز حامل في Authorization رأس الصفحة. يتم إنشاء مفتاح API الخاص بك فوراً عند التسجيل عبر جوجل أو البريد الإلكتروني.

احفظ مفتاحك بأمان. يوجد مفتاح نشط واحد فقط لكل حساب؛ يؤدي توليد مفتاح جديد إلى إلغاء صلاحية المفتاح السابق. يمنح المفتاح وصولاً كاملاً إلى رصيد الرصيد المدفوع مسبقاً.

إذا كان المفتاح غير صالح أو منتهي الصلاحية، يعيد الـ API خطأ 401.

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

تفاعل مع النموذج باستخدام الواجهة القياسية POST /v1/chat/completions endpoint. تتعامل هذه النقطة مع جميع مهام توليد النص.

أرسل سجل الرسائل في messages مصفوفة. تعالج واجهة برمجة التطبيقات المدخلات وتعيد استجابة النموذج. يمكنك تضمين تعليمات النظام لتوجيه السلوك.

تدعم نقطة النهاية وضع JSON واستدعاء الوظائف. استخدم هذه الميزات لتكامل واجهة برمجة التطبيقات في تطبيقاتك بسلاسة.

تأكد من أن حمولتك تبقى ضمن حد حجم طلب 8 ميجابايت.

البث وأحداث الإرسال الخادم (SSE)

فعّل توليد الرمز الفوري عن طريق تعيين stream: true في طلبك. تُعيد الـ API تدفقًا بأحداث الإرسال من الخادم.

يحتوي كل جزء على تحديثات نصية جزئية. يتضمن الجزء الأخير إحصائيات استخدام الرموز الكاملة.

يقلل هذا النهج من زمن الوصول المدرك للمستخدمين النهائيين. يسمح لتطبيقك بعرض النص أثناء توليده.

التعامل مع انقطاعات التدفق بسلاسة. تضمن الـ API تسليم جميع الرموز إذا بقي الاتصال مستقراً.

المعاملات والخيارات

تحكّم في سلوك التوليد باستخدام المعاملات القياسية. اضبط temperature للإبداع أو الحتمية. استخدم top_p للعينة النواة.

تعيين max_tokens لتحديد طول المخرجات. الافتراضي هو 2,048 رمزاً. الحد الأقصى المسموح به هو 16,000 رمز لكل طلب.

استخدام stop تسلسلات لإيقاف التوليد عند علامات محددة. الـ seed يضمن نتائج قابلة للتكرار لاكتشاف الأخطاء.

تعمل هذه الخيارات بشكل متسق عبر جميع العملاء.

معالجة الأخطاء والحدود

راقب معدل طلباتك ورصيد رصيدك. يفرض الـ API حدًا بـ 300 طلب في الدقيقة لكل مفتاح.

يشير خطأ 429 إلى أنك تجاوزت حد المعدل. يعني خطأ 402 أن رصيدك المدفوع مسبقاً قد استنفد.

تدعم نافذة السياق إجمالي 100,000 رمز موزع. يشمل ذلك كلًا من النص الأولي والإكمال.

الأخطاء أثناء المعالجة لا تستهلك الرصيد. يتم فرض الفاتورة فقط على توليد الرموز الناجحة.

cURL

Copycurl 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."}]
  }'

Python

Copyfrom 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

Copyimport 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);

التدفق

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)