מדריך אינטגרציה למפתחים

הגדרת כתובת הבסיס ואימות

התחל על ידי יצירת מפתח ה-API שלך בדשבורד. כתובת הבסיס היא HTTPS://api.apiaicheap.com/v1. שלח את המפתח שלך בכותרת Authorization כ-bearer token.

• לחץ על "קבל מפתח API" והתחבר באמצעות Google או מייל.
• העתק את המפתח מיד; הוא מוצג רק פעם אחת.

מפתח זה מאמת את כל הבקשות לנקודת הקצה של השלמת צ'אט.

כותרת דוגמה

הרשאה: Bearer YOUR_API_KEY

בקשה ראשונה עם cURL

שלח השלמת צ'אט בסיסית כדי לבדוק את ההגדרה שלך. השתמש בנקודת הקצה POST /v1/chat/completions עם המודל "uncensored".

זה מאשר את יתרת האשראי שלך ואת זמן התגובה (latency).

• הגדירו את ה- role ל- "user".
• שמרו על ההודעה פשוטה לבדיקה הראשונית.

בדוק את התגובה לשדה טקסט שנוצר.

• חפשו את הערך "content".

אם אתה מקבל 200 OK, האינטגרציה שלך עובדת.

Copycurl https://api.apiaicheap.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Fix the null pointer in the login handler"}]
  }'

אינטגרציה עם SDK ב-Python

השתמשו בספריית הפיתון הרשמית של OpenAI לשילוב קל. צביאו אותו לכתובת הבסיס שלנו והגדירו את מפתח ה-API שלכם.

גישה זו מטפלת בניסיונות חוזרים ובניתוח JSON באופן אוטומטי.

• התקן את הספרייה באמצעות pip.
• הגדר את הפרמטר base_url לנקודת הקצה שלנו.

התקשר לשיטת chat.completions.create.

העבירו את רשימת ההודעות שלכם כארגומנט.

• כלול את שם המודל "uncensored".

גישה לטקסט התשובה דרך תכונות האובייקט.

שיטה זו נקיאה וקריאה לתסכיתים לייצור.

Copyfrom openai import OpenAI

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

הגדרת SDK Node.js

SDK Node.js עובד באופן דומה לגרסת Python. אתחל את הלקוח עם המפתח שלך וכתובת ה-URL הבסיסית שלנו.

זה מאפשר לך להשתמש בתבניות מוכרות של async/await.

• ייבאו את החבילה של OpenAI.
• הגדר את כתובת הבסיס בבנאי.

צור בקשת השלמה עם ההודעות שלך.

טפול בהבטחה כדי לקבל את התוצאה.

• חלץ את תוכן ההודעה מהתגובה.

תעדו את הפלט כדי לוודא שהמודל מגיב כראוי.

התצורה הזו אידיאלית לשרתי ווב ושירותי Backend.

Copyimport OpenAI from "openai";

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

תגובות בזרם עם SSE

אפשרו סטרימינג על ידי הגדרת stream ל-true בבקשה שלכם. ה-API מחזיר מקטעים כפי שהם נוצרים באמצעות אירועים מוכווני שרת.

דבר זה מפחית את תחושת העיכוב עבור משתמשים באפליקציות צ'אט.

• הגדר stream: true במטען.
• עבדו כל חלק כפי שהוא מגיע.

שלבו את החלקים ליצירת התגובה הסופית.

פרטי צריכת הטוקנים מופיעים בפסגה האחרונה.

• בדקו את שדה ה-"usage" בחלק הסופי.

גישה זו שומרת על ממשק המשתמש רספונסיבי במהלך יצירות ארוכות.

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)

מגבלות, שגיאות וחלון ההקשר

לחשבון שלך יש מגבלה של 300 בקשות לדקה לכל מפתח. חלון ההקשר תומך ב-100,000 אסימונים סה"כ לקלט ופלט.

שגיאות מטופלות באמצעות קודי סטטוס HTTP סטנדרטיים.

• 401 מצביע על מפתח API לא תקין או חסר.
• 402 אומר שהאשראי המוקדם שלך אזל.
• 429 מסמן שחרגת ממגבלת הקצב.

סירובים לא עולים אשראי. שגיאות גם כן חינם.

פלט מקסימלי הוא 16,000 טוקנים לכל בקשה. הגדר max_tokens אם אתה צריך פחות.

מבנה זה מבטיח חשבונית וביצועים צפויים.