واجهة برمجة تطبيقات Character AI: قم بتغيير العميل الخاص بك في ثلاثة أسطر

المتطلبات المسبقة

قبل كتابة الكود، تحتاج إلى حساب نشط على characteraiapi.com. قم بزيارة صفحة الحصول على مفتاح API وسجّل باستخدام البريد الإلكتروني وكلمة المرور فقط. لا يلزم بطاقة ائتمان للبدء، ويحصل الحسابات الجديدة على $0.50 من رصيد تجريبي مجاني صالح لمدة 7 أيام. بمجرد التسجيل، يتم عرض مفتاح API الخاص بك على الفور. احتفظ بهذا المفتاح بأمان، لأنه يصادق على جميع الطلبات إلى نقطة النهاية. ستحتاج أيضًا إلى تثبيت واجهة برمجة تطبيقات (SDK) للغة مدعومة في بيئة التطوير الخاصة بك. تقبل نقطة النهاية character ai api معايير OpenAI القياسية، لذا يمكن لأي عميل متوافق مع OpenAI العمل مع تغييرات قليلة.

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

لمشاريع Python، قم بتثبيت الحزمة الرسمية لـ OpenAI باستخدام pip. تتعامل هذه المكتبة تلقائياً مع تسلسل JSON وطلبات HTTP. لتطبيقات Node.js، استخدم npm لإضافة الحزمة openai. تدعم كلتا المكتبتين ميزتي البث المتدفق واستدعاء الأدوات الموضحة لاحقاً في هذا الدليل. تأكد من أن إصدار SDK الخاص بك حديث بما يكفي لدعم أحداث Server-Sent Events (SSE) للبث المتدفق للرموز. إذا كنت تستخدم عميل HTTP مخصصاً بدلاً من SDK، فيجب عليك معالجة حمولة JSON وتحليل تدفق SSE يدوياً وفقاً لمواصفات واجهة برمجة التطبيقات OpenAI.

المصادقة

يجب أن يتضمن كل طلب إلى واجهة برمجة التطبيقات مفتاح API الخاص بك في رأس Authorization. استخدم التنسيق Bearer YOUR_API_KEY. عنوان URL الأساسي لجميع الطلبات هو https://api.characteraiapi.com/v1. عند استخدام واجهة برمجة التطبيقات (SDK)، قم بتعيين تكوين base_url إلى هذه القيمة وقم بتوفير مفتاحك عبر معلمة api_key. إذا فقدت مفتاحك أو اشتبهت في تسربه، يمكنك تجديده من لوحة التحكم؛ سيتم إلغاء سريان المفتاح القديم على الفور. يُسمح بمفتاح نشط واحد فقط لكل حساب. تأكد من استخدام عنوان URL الأساسي الصحيح، حيث ستفشل الطلبات إلى نقطة النهاية القياسية لـ OpenAI بخطأ 404 أو 401.

إكمال الدردشة الأساسي

تُقدّم الوظيفة الأساسية عبر نقطة النهاية /v1/chat/completions. أرسل طلب POST مع اسم النموذج uncensored وسجل الرسائل الخاص بك. يستجيب النموذج بمخرجات نصية دون تطبيق فلاتر المحتوى القياسية للمحتوى البالغ القانوني. فيما يلي مثال curl يوضح طلب إكمال نصي بسيط.

Copycurl https://api.characteraiapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'

يعيد هذا الطلب كائن إكمال يحتوي على النص المولد. يمكنك ضبط معاملات مثل temperature للتحكم في العشوائية أو max_tokens لتقييد طول الإخراج. يدعم النموذج نافذة سياق من 100,000 رمز، مما يسمح بمعالجة سجل محادثات كبير أو مستندات طويلة في طلب واحد.

الاستجابات المتدفقة

لتحسين تجربة المستخدم، فعّل البث المتدفق عن طريق تعيين stream: true في طلبك. تُعيد واجهة برمجة التطبيقات أحداث Server-Sent Events (SSE) تحتوي على أجزاء من الرموز كما يتم توليدها. يقلل هذا من زمن الاستجابة المُدرَك لتطبيقات روبوتات المحادثة. استخدم المعلمة stream_options إذا كنت ترغب في تلقي إحصائيات الاستخدام النهائية في الحدث الأخير. يعد البث المتدفق مفيداً بشكل خاص في لعب الأدوار بالشخصيات في الوقت الفعلي، حيث يعزز عرض النص كلمة بكلمة من الغمر. تأكد من معالجة كود العميل الخاص بتنسيق 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)

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

تفرض واجهة برمجة التطبيقات حداً قدره 300 طلب في الدقيقة لكل مفتاح. إذا تجاوزت هذا الحد، ستتلقى خطأ 429 Too Many Requests. حدود أحجام الطلبات هي 8 ميجابايت. تشمل الأخطاء الشائعة 401 للمفتاح غير الصحيح أو المفقود، و402 إذا استُنفد رصيدك المسبق الدفع. يمكنك شحن الرصيد من 10 دولارات أمريكية باستخدام العملات المشفرة (USDT أو USDC)، مع وجود رصيد إضافي متاح للإيداعات الأكبر. على عكس بعض المزودين، لا توجد رسوم خفية أو قفل اشتراك؛ أنت تدفع فقط مقابل الرموز التي تستهلكها. الأسعار شفافة: 0.25 دولار لكل مليون رمز مدخل و1.00 دولار لكل مليون رمز مخرج. تأكد من أن منطق معالجة الأخطاء الخاص بك يعيد المحاولة عند حدوث أخطاء 429 مع زيادة أسية في الانتظار.

Copyfrom openai import OpenAI

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