توثيق API للمطورين

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

توصيل إلى البنية التحتية الخاصة بنا عن طريق توجيه عميلك إلى عنوان URL الأساسي المخصص وتوفير مفتاح API الفريد الخاص بك. نستخدم مصادقة الرأس القياسية بحيث يمكنك تبديل نقطة النهاية الخاصة بنا في تكوينات OpenAI SDK الحالية دون إعادة كتابة المنطق الأساسي الخاص بك. تحصل على مفتاح نشط واحد لكل حساب، وإنشاء مفتاح جديد يبطل السابق فورًا. يبقي هذا التصميم التكامل الخاص بك بسيطًا مع الحفاظ على تحكم واضح في الوصول. سجّل عبر Google أو البريد الإلكتروني لرؤية مفتاحك فورًا. لا نحتاج إلى رقم هاتف أو طريقة دفع للبدء.

• URL الأساسي: https://api.uncensoreai.com/v1
• رأس المصادقة: Authorization: Bearer YOUR_API_KEY

الطلب الأول (POST /v1/chat/completions)

أرسل أول إكمال عن طريق إرسال حمولة JSON إلى نقطة نهاية إكمال الدردشة. معرف النموذج هو uncensored وقبل هياكل الرسائل القياسية مع أدوار النظام، المستخدم، والمساعد. تحصل على مخرجات نصية فورية دون تعقيد التوجيه أو منطق اختيار النموذج. الأخطاء لا تستهلك رصيدك المدفوع مسبقاً، لذا يمكنك الاختبار بحرية. يتعامل النموذج مع التوليد مفتوح المصدر والمضبط للمحتوى البالغ دون رفض. استخدم هذا الهيكل لبدء تكاملك.

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

استخدم عميل Python الرسمي للتفاعل مع واجهة برمجة التطبيقات الخاصة بنا بسلاسة. اضبط عنوان URL الأساسي ومفتاح API في كائن التكوين الخاص بك قبل إجراء المكالمات. تتعامل المكتبة مع تسلسل JSON وتحليل الاستجابة لك. يمكنك الوصول إلى بيانات الاستخدام مباشرة من كائن الاستجابة. يعمل هذا النهج مع أي بيئة Python قياسية تدعم الطلبات غير المتزامنة أو المتزامنة. احتفظ بمفتاحك آمناً في متغيرات البيئة. يوضح نموذج الشيفرة استدعاء متزامن أساسي.

تكامل SDK Node.js

قم بالتكامل مع مشاريع Node.js باستخدام مدير الحزم القياسي. قم باستيراد العميل وقم بتكوين عنوان URL الأساسي للإشارة إلى خوادمنا. تدير الحطلبات طلبات HTTP وتوفر استجابات ذات أنواع محددة لمستخدمي TypeScript. يمكنك إضافة رؤوس أو تعديل فترات الانتظار بسهولة إذا لزم الأمر. تناسب هذه الطريقة تطبيقات الويب الحديثة والخدمات الخلفية. تأكد من توافق إصدار Node.js مع متطلبات الحزمة. يوضح المثال التالي طلب إكمال بسيط.

استجابات البث واستهلاك الرموز

تمكين المخرجات في الوقت الفعلي عن طريق ضبط stream القيمة true في طلبك. تُرجع الـ API أحداث الحدث المرسلة من الخادم (SSE) أثناء توليد الرموز. يمكنك عرض النص للمستخدمين فورًا دون انتظار الاستجابة الكاملة. تظهر تفاصيل استخدام الرموز في الشريحة النهائية للتدفق. يقلل هذا الميزة من زمن الاستجابة المُدرَك للمخرجات الطويلة. راقب رصيدك الائتماني بينما تتراكم الرموز. يعمل التدفق مع جميع المعاملات القياسية مثل درجة الحرارة وتسلسلات التوقف.

حدود، أخطاء، ونافذة السياق

يحتوي حسابك على نافذة سياق بحجم 100,000 رمز للإدخال والإكمال معاً. يمكنك إرسال ما يصل إلى 16,000 رمز في استجابة واحدة إذا حددت max_tokens. الحد الأقصى الافتراضي للإخراج هو 2,048 رمز إذا حذفت هذا المعلمة. تسمح حدود المعدل بـ 300 طلب في الدقيقة و8 طلبات متزامنة لكل مفتاح. تعني حالة 401 أن مفتاحك غير صالح. تشير حالة 402 إلى عدم كفاية الرصيد المدفوع مسبقًا. تعني حالة 429 أنك تجاوزت حد المعدل. لا يمكن أن تتجاوز أجسام الطلبات 8 ميجابايت.

cURL

Copycurl https://api.uncensoreai.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "fetch the current server status from the api endpoint"}]
  }'

Python

Copyfrom openai import OpenAI

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