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

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

استخدم مفتاح API الخاص بك مع عنوان URL الأساسي https://api.paidapi.cc/v1. مرر المفتاح في Authorization رأس الصفحة كرمز حامل (Bearer token). هذا الإعداد يعمل مع أي مكتبة عميل متوافقة مع OpenAI دون خطوات تكوين إضافية.

Copycurl https://api.paidapi.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Set up a cron job to run every hour"}]
  }'

حافظ على أمان مفتاحك. إذا فقدته، أنشئ مفتاحًا جديدًا من لوحة التحكم. يتوقف المفتاح القديم عن العمل على الفور.

الطلب الأول

أرسل طلب POST إلى /v1/chat/completions مع نموذج "uncensored". قم بتضمين مصفوفة الرسائل في جسم الطلب. يُرجع الـ API إكمالات نصية بناءً على سياق مطالبتك.

Copyfrom openai import OpenAI

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

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

استجابات البث

فعّل البث عن طريق تعيين stream: true. تُرسل الـ API أجزاء جزئية أثناء توليدها. يقلل هذا من زمن الاستجابة المُدرَك للمخرجات الطويلة.

Copyimport OpenAI from "openai";

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

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

استدعاء الوظائف والأدوات

عرّف الأدوات في جسم الطلب. يعيد النموذج استدعاءات للأدوات عند الاقتضاء. قم بتحليل اسم الوظلة والحجج من الاستجابة.

تعيين tool_choice للتحكم في توقيت استخدام النموذج للأدوات. استخدم "auto" للاختيار التلقائي أو تحديد اسم أداة. تعمل هذه الميزة بشكل موثوق مع نموذجنا غير الخاضع للرقابة للمهام المعقدة.

تكوين وضع JSON

تعيين response_format إلى {"type": "json_object"}. ينظم النموذج المخرجات كـ JSON صالح. هذا يبسط التحليل لعمليات سير العمل البرمجية.

تأكد من أن موجهك يحدد مخطط JSON بوضوح. يلتزم النموذج بالهيكل الذي تحدده. استخدم هذا الوضع لاستخراج البيانات أو مهام التوليد المهيكل.

حدود معدل الطلبات والأخطاء

تحصل على 300 طلب في الدقيقة و8 طلبات متزامنة لكل مفتاح. يؤدي تجاوز هذه الحدود إلى إرجاع خطأ 429. يجب أن تبقى أحجام الطلبات أقل من 8 ميجابايت. نافذة السياق هي 100,000 رمز إجمالي.

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

التدفق

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)