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

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

ابدأ بإنشاء المفتاح الخاص بك عبر لوحة التحكم. استخدم عنوان URL الأساسي https://api.grokapipricing.com/v1 لجميع الطلبات. اضبط Authorization الرأس إلى Bearer YOUR_API_KEY. يعمل المفتاح الواحد عبر جميع نقاط النهاية. قم بتدويره بحرية إذا لزم الأمر.

POST /v1/chat/completions

أرسل تلميحاتك إلى نقطة الدردشة. معرّف النموذج هو دائماً uncensored. قم بتكوين معلمات مثل temperature أو top_p للتحكم في الإبداع. تعود الاستجابات بإكمال محادثات قياسي مع بيانات استخدام الرموز. تشير الأخطاء مثل 402 أو 429 إلى مشكلات في الفواتير أو معدل الطلبات.

GET /v1/models

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

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

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

استدعاء الوظائف ووضع JSON

استخدام response_format مع {"type": "json_object"} لإخراج JSON صارم. فعّل استدعاء الوظائف عن طريق تعريف tools في طلبك. يدعم النموذج tool_choice للتنفيذ القسري أو التلقائي. هذا يضمن تكامل موثوق مع منطق الخلفية الخاص بك.

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

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

cURL

Copycurl https://api.grokapipricing.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Run query and return rows"}]
  }'

Python

Copyfrom openai import OpenAI

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

التدفق

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)