البدء السريع: الطلب الأول
ابدأ بتوجيه عميلك إلى عنوان URL الأساسي الخاص بنا. استخدم https://api.grockapi.com/v1 واضبط مفتاح API الخاص بك في الرأس. معرف النموذج هو دائماً uncensored. يعمل مع أي مكتلة SDK متوافقة مع OpenAI.
المصادقة تتطلب رمز حامل صالح. مرره كـ Authorization: Bearer YOUR_API_KEY. إذا كان المفتاح مفقوداً أو غير صالح، تتلقى خطأ 401 فوراً.
أرسل استدعاءك الأول لاختبار الاتصال. يجب أن يتضمن جسم الطلب اسم النموذج ومصفوفة messages.
المعلمات المدعومة والأوضاع
قم بتكوين سلوك التوليد باستخدام المعاملات القياسية. يمكنك تعديل درجة الحرارة للإبداع أو top_p للعينة النووية. استخدم معامل stop لتحديد تسلسلات محددة توقف التوليد.
عيّن seed للمخرجات الحتمية أثناء التصحيح. تساعد عقوبات الحضور والتكرار في تقليل التكرار. يدعم النموذج ما يصل إلى 100,000 رمز في نافذة السياق.
يتم تحديد الحد الأقصى للإخراج بـ 16,000 رمز لكل طلب. اترك max_tokens غير مضبوط لاستخدام حد الإخراج الافتراضي البالغ 2,048. لا تستهلك الأخطاء والرفضات رصيدك.
استخدام الرموز والبث
فعّل البث عن طريق تعيين stream: true. تُعيد الـ API أجزاء عبر أحداث الإرسال من الخادم (SSE). يحتوي كل جزء على محتوى جزئي وبيانات تعريفية.
تظهر تفاصيل استهلاك الرموز في الشريحة الأخيرة. هذا يسمح لك بتتبع التكاليف بدقة في الوقت الفعلي. تتضمن الشريحة الأخيرة إحصائيات الاستخدام الكاملة للطلب.
التعامل مع إغلاق التدفق بشكل صحيح لتجنب تسرب الموارد. قم دائماً بمعالجة الشريحة الأخيرة للحصول على بيانات الفوترة الدقيقة.
استدعاء الوظائف (الأدوات)
عرّف الأدوات في جسم الطلب. حدد أسماء الأدوات ووصفها ومخططات المعاملات. يستجيب النموذج باستدعاءات للأدوات عند الاقتضاء.
استخدم معلمة tool_choice لفرض أو السماح بسلوكيات محددة. يمكنك تعيينها على auto أو required أو معرفات أدوات محددة.
معالجة استدعاءات الأدوات في منطق التطبيق الخاص بك. إرسال مخرجات الأداة مرة أخرى إلى النموذج لمواصلة المحادثة. هذا يمكّن سير العمل المعقدة متعددة الخطوات دون التحليل الخارجي.
وضع JSON والقيود
فرض إخراج منظم عن طريق تعيين response_format إلى json_object. سيعيد النموذج صيغة JSON دون كتل كود Markdown.
هذه الحالة مثالية لتحليل البيانات إلى التطبيقات. تأكد من أن المخطط واضح لتحسين الدقة. قد تؤدي هياكل JSON غير الصالحة إلى أخطاء في التحليل في عميلك.
ادمج وضع JSON مع ضوابط درجة الحرارة للحصول على تنسيق متسق. استخدم تسلسلات التوقف (Stop Sequences) لمنع الأحرف الزائدة بعد القوس المتعرج الإغلاق.
حدود المعدلات والحصص
يُقتصر كل مفتاح API على 300 طلب في الدقيقة. يمكنك تشغيل ما يصل إلى 8 طلبات متزامنة في وقت واحد. الحد الأقصى لحجم جسم الطلب هو 8 ميجابايت.
يشير خطأ 429 إلى أنك تجاوزت حد المعدل. انتظر قبل إعادة المحاثة أو قلل من التزامن. يوجد مفتاح نشط واحد لكل حساب؛ استبدال المفتاح الجديد للمفتاح القديم.
راقب استهلاكك عبر قطعة التدفق النهائية أو رؤوس الاستجابة. الأخطاء مثل 402 (عدم وجود رصيد) أو 401 (مفتاح غير صالح) مجانية ولا تُحتسب ضمن الحصة الخاصة بك.
cURL
curl https://api.grockapi.com/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [{"role": "user", "content": "calculate the sum of two and three"}]
}'Python
from openai import OpenAI
client = OpenAI(base_url="https://api.grockapi.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
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://api.grockapi.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 = 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)