תיעוד API

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

התחל על ידי יצירת המפתח שלך דרך הדשבורד. השתמש בכתובת הבסיס https://api.grokapipricing.com/v1 לכל הבקשות. הגדר את Authorization header ל 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 לביצוע כפוי או אוטומטי. זה מבטיח שילוב אמין עם לוגיקת ה-backend שלך.

מגבלות קצב ואילוצים

אתה מוגבל ל-300 בקשות לדקה לכל מפתח. הקצב המקביל מוגבל ל-8 בקשות בו-זמנית. גודל גוף הבקשה המקסימלי הוא 8 MB. חלון ההקשר מאפשר 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)