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

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

يعيش عنوان الـ API في https://api.openrouteraiapi.com/v1. مرر مفتاح API الخاص بك في Authorization قيمة التوكن كـ bearer token. هذا الرأس هو التغيير الوحيد اللازم لإعادة توجيه حركة المرور من مزودك الحالي إلى نموذجنا غير الخاضع للرقابة.

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

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

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

إليك طلب قياسي باستخدام cURL للتحقق من الاتصال وتنسيق الاستجابة.

Copycurl https://api.openrouteraiapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list the top five python libraries for data science"}]
  }'

يشمل الرد النص المُولّد في choices[0].message.content الحقل. يمكنك تحليل هذا مباشرة في سير عمل تطبيقك.

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

استخدم عميل Python الرسمي من OpenAI للاتصال بسلاسة. اضبط base_url و api_key المتغيرات لتشير إلى بنية التحتية الخاصة بنا. يقلل هذا النهج من تغييرات الكود عند التبديل بين المزودين.

Copyfrom openai import OpenAI

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

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

استخدام SDK Node.js

قم بتهيئة عميل OpenAI لـ Node.js باستخدام عنوان URL الأساسي المخصص. يتيح ذلك لتطبيقات JavaScript التفاعل مع النموذج غير الخاضع للرقابة باستخدام الأساليب المألوفة. يدير حزمة SDK طلبات HTTP بكفاءة.

Copyimport OpenAI from "openai";

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

استدعاء chat.completions.create() مع رسائلك. يوفر كائن الاستجابة الوصول إلى المحتوى المولد وبيانات الاستخدام. يعمل هذا التكامل بشكل جيد لخوادم الويب ودوال الحافة.

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

فعّل البث عن طريق تعيين stream: true في طلبك. يعيد الخادم أحداث خادم المراسلة (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)

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

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

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

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