תיעוד API

כתובת הבסיס ואימות

כתובת הבסיס לכל הבקשות היא 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)