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

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

مفتاح واجهة برمجة التطبيقات الخاص بك يصادق على كل طلب. أرسله في Authorization رأس الصفحة كرمز حامل (Bearer token). يشير عنوان URL الأساسي مباشرة إلى نقطة النهاية الخاصة بنا.

استرجع مفتاحك على الفور من لوحة التحكم بعد التسجيل باستخدام Google أو البريد الإلكتروني. لا يلزم التحقق برقم الهاتف.

نقطة النهاية هي https://api.unsupportedcodexauthmethodapikey.com/v1. استخدم هذا العنوان لجميع طلبات HTTP.

Copycurl https://api.unsupportedcodexauthmethodapikey.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Parse the JSON string in the request body"}]
  }'

POST /v1/chat/completions

أرسل تلميحك إلى هذه النقطة. معرّف النموذج هو دائماً "uncensored". يعيد الـ API إكمالات نصية بناءً على مدخلاتك.

أدرج مطالبة النظام لتحديد السلوك. يجيب النموذج دون رفضات محتوى للاستخدام القانوني للبالغين.

تكوين معاملات مثل temperature و top_p للتحكم في الإبداع. استخدم json_object للمخرجات المُهيّأة.

Copyfrom openai import OpenAI

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

GET /v1/models

استعلم عن النماذج المتاحة. يُدرج هذا المسار معرّف النموذج غير المقيد الوحيد. يؤكد ذلك أن مفتاح الواجهة البرمجية الخاص بك صالح.

استخدم هذا للتحقق من الاتصال قبل إرسال حمولات البيانات الثقيلة. تحتوي الاستجابة على بيانات تعريفية حول النموذج.

نموذج واحد فقط متاح. إنه نموذج مفتوح المصدر تم ضبطه للحرية والخصوصية.

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.unsupportedcodexauthmethodapikey.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: true. استلم الرموز عبر أحداث الإرسال عبر الخادم (SSE). تظهر تفاصيل استخدام الرموز في الجزء الأخير.

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

استخدام stop تسلسلات لإيقاف التوليد. نافذة السياق هي 100,000 رمز إجمالاً.

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)

معالجة الأخطاء

عالج الأخطاء بسلاسة. يعني حالة 401 أن مفتاحك غير صالح. تشير حالة 402 إلى عدم كفاية الرصيد.

تدل حالة 429 على تحديد معدل الطلبات. أنت محدود بـ 300 طلب في الدقيقة. تحقق من Retry-After رأس.

تُرجع الرفضات بسبب حدود المحتوى خطأ 400. تُرجع الأخطاء في تنسيق الطلب خطأ 400. لا تُفرض رسوم الفوترة على الأخطاء.

الحدود ونافذة السياق

نافذة السياق تتسع لـ 100,000 رمز. ويشمل ذلك كلًا من النص التوجيهي والإكمال. حجم جسم الطلب الأقصى هو 8 ميجابايت.

الطلبات المتزامنة محدودة بـ 8 لكل مفتاح. حد المعدل هو 300 طلب في الدقيقة. يؤدي تجاوز هذه إلى إرجاع 429.

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