תיעוד API למפתחים

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

התחבר לתשתית שלנו על ידי הפניית הלקוח שלך לכתובת ה-URL הבסיסית המיועדת וספק את מפתח ה-API הייחודי שלך. אנו משתמשים באימות כותרות סטנדרטי כך שתוכל להחליף את נקודת הקצה שלנו לתצורות SDK קיימות של OpenAI ללא כתיבת מחדש של הלוגיקה הבסיסית שלך. אתה מקבל מפתח פעיל אחד לחשבון, ויצירת מפתח חדש מבטלת מיד את הקודם. עיצוב זה שומר על האינטגרציה שלך פשוטה תוך שמירה על בקרת גישה ברורה. הרשם דרך Google או אימייל כדי לראות את המפתח שלך מיד. אנו לא דורשים מספר טלפון או שיטת תשלום להתחלה.

• כתובת בסיס: https://api.uncensoreai.com/v1
• כותרת Auth: Authorization: Bearer YOUR_API_KEY

בקשה ראשונה (POST /v1/chat/completions)

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

אינטגרציית SDK Python

השתמשו בלקוח Python הרשמי כדי לתקשר עם ה-API שלנו בצורה חלקה. הגדירו את כתובת ה-URL הבסיסית ואת מפתח ה-API באובייקט התצורה שלכם לפני ביצוע קריאות. הספרייה מטפלת בשרשור JSON ופיענוח תגובות עבורכם. תוכלו לגשת לנתוני שימוש ישירות מאובייקט התגובה. גישה זו עובדת עם כל סביבת Python סטנדרטית התומכת בקריאות async או sync. שמרו על המפתח שלכם מאובטח במשתני סביבה. דוגמת הקוד מדגימה קריאה סינכרונית בסיסית.

שילוב SDK Node.js

שילוב עם פרויקטי Node.js באמצעות מנהל החבילות הסטנדרטי. ייבא את הלקוח והגדר את כתובת ה-URL הבסיסית כך שתצביה על השרתים שלנו. ה-SDK מנהל את בקשות ה-HTTP ומספק תגובות מסוגננות (Typed) למשתמשי TypeScript. ניתן להוסיף כותרות בקלות או לשנות זמני המתנה אם נדרש. שיטה זו מתאימה לאפליקציות ווב מודרניות ושירותי Backend. ודא שהגרסה של Node שלך תואמת לדרישות ה-SDK. הדוגמה הבאה מציגה בקשת השלמה פשוטה.

תגובות בסטרימינג וצריכת טוקנים

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

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

לחשבון שלך יש חלון הקשר של 100,000 אסימונים לקלט ופלט משולבים. ניתן לשלוח עד 16,000 אסימונים בתגובה אחת אם מציינים max_tokens. מגבלת הפלט הסטנדרטית היא 2,048 טוקנים אם תשמיט פרמטר זה. מגבלות קצב מאפשרות 300 בקשות לדקה ו-8 בקשות מקבילות למפתח. סטטוס 401 אומר שהמפתח שלך לא חוקי. סטטוס 402 מציין אשראי קנוי לא מספיק. סטטוס 429 אומר שחרגת ממגבלת הקצב. גופי בקשות לא יכולים לעלות על 8 MB.

cURL

Copycurl https://api.uncensoreai.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "fetch the current server status from the api endpoint"}]
  }'

Python

Copyfrom openai import OpenAI

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