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

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

عنوان URL الأساسي لجميع الطلبات هو https://api.grokapiplatform.com/v1. قم بالمصادقة عن طريق تمرير مفتاح API الفريد الخاص بك في Authorization رأس. يجب أن يتضمن كل طلب هذا الرأس للتحقق من رصيد حسابك وتطبيق حدود معدل الاستخدام.

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

أرسل استعلامات نصية إلى POST /v1/chat/completions. معرف النموذج المراد استخدامه هو "uncensored". يتعامل هذا الطرف مع تفاعلات النص القياسي (إدخال نص، إخراج نص) دون الحاجة إلى تكوين إضافي للاستخدام الأساسي.

Copycurl https://api.grokapiplatform.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Check my current token usage balance."}]
  }'

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

استجابات التدفق عبر أحداث الإرسال عبر الخادم (SSE)

فعّل البث عن طريق تعيين stream: true في جسم الطلب الخاص بك. يُعيد الخادم أحداث الإرسال من الخادم (SSE) مع تحديثات رموز تدريجية. استخدم هذا للعرض في الوقت الفعلي أو لتقليل زمن الاستجابة المُدرَك.

Copyfrom openai import OpenAI

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

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

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

عرّف الأدوات في tools مصفوفة و tool_choice لتحريك سلوكيات محددة. يدعم النموذج أنماط استخدام الأدوات القياسية المتوافقة مع SDKs الخاصة بـ OpenAI.

Copyimport OpenAI from "openai";

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

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

وضع JSON للإخراج المهيكلي

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

المعاملات والحدود

تعديل temperature, top_p، و seed للتحكم في العشوائية. الحد الأقصى للمخرجات لكل طلب هو 16,000 رمز. تشير الأخطاء مثل 401 إلى مفاتيح غير صالحة، وتعني 402 عدم وجود رصيد مدفوع مسبقاً كافٍ، وتشير 429 إلى حدود المعدل. الحد هو 300 طلب في الدقيقة لكل مفتاح. لا تنتهي صلاحية الرهونات، لذا يمكنك الشحن بـ USDT أو USDC في أي وقت تحتاج فيه.

التدفق

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)