תיעוד API

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

השתמש במפתח ה-API שלך עם כתובת הבסיס https://api.paidapi.cc/v1. העבר את המפתח ב Authorization כותרת כטוקן Bearer. הגדרה זו עובדת עם כל ספריית לקוח תואמת OpenAI ללא שלבי תצורה נוספים.

Copycurl https://api.paidapi.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Set up a cron job to run every hour"}]
  }'

שמור על המפתח שלך מאובטח. אם תאבד אותו, צור מפתח חדש מלוח הבקרה שלך. המפתח הישן יפסיק לעבוד מיד.

בקשה ראשונה

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

Copyfrom openai import OpenAI

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

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

תגובות בסטרימינג

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

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.paidapi.cc/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 Calling & כלים

הגדירו כלים בגוף הבקשה. המודל מחזיר קריאות לכלים כאשר מתאים. פרסרו את שם הפונקציה והארגומנטים מהתגובה.

הגדר tool_choice לשליטה מתי המודל משתמש בכלים. השתמש "auto" לבחירה אוטומטית או ציין שם כלי. תכונה זו עובדת באופן אמין עם המודל ללא צנזורה שלנו למשימות מורכבות.

תצורת מצב JSON

הגדר response_format אל {"type": "json_object"}. המודל מסדר את הפלט כ-JSON תקף. זה מפשט ניתוח לזרימות עבודה תכנותיות.

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

מגבלות קצב & שגיאות

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

טפל בשגיאות 401 על ידי אימות המפתח שלך. שגיאות 402 אומרות שאתה צריך יותר קרדיט. שגיאות לא צורכות טוקנים. שמור על הקרדיט המשולם מראש שלך מלא כדי להימנע מהפרעות.

זרימה

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)