API दस्तावेज़ीकरण

प्रमाणीकरण और बेस यूआरएल

API हर अनुरोध के लिए एक बेयरर टोकन की आवश्यकता होती है। अपने API कुंजी पृष्ठ पर अपनी कुंजी जनरेट करें, Google या ईमेल पासवर्ड से साइन इन करके। कुंजी तुरंत प्रकट होती है, फोन सत्यापन के बिना। बेस URL का उपयोग करें https://api.uncensoredaigithub.com/v1 आधिकारिक OpenAI SDKs के साथ अपडेट करके base_url और api_key मूल्य। यह सेटअप किसी भी OpenAI-संगत क्लाइंट के साथ काम करता है।

एंडपॉइंट: https://api.uncensoredaigithub.com/v1

Auth हेडर: Authorization: Bearer YOUR_API_KEY

प्रत्येक खाता एक सक्रिय कुंजी का समर्थन करता है। एक नई कुंजी जारी करने से पिछली कुंजी स्वचालित रूप से अमान्य हो जाती है। यह विभिन्न वातावरणों में क्रेडेंशियल्स रोटेट करते समय टोकन ड्रिफ्ट को रोकता है।

चैट कंप्लीशंस एंडपॉइंट

टेक्स्ट अनुरोध को /v1/chat/completions मॉडल ID का उपयोग करने वाला एंडपॉइंट uncensored. API मानक चैट संदेश स्वीकार करती है और कानूनी वयस्क उपयोग के लिए सामग्री फिल्टर के बिना टेक्स्ट प्रतिक्रियाएं लौटाती है। आप पैरामीटर जैसे कॉन्फ़िगर कर सकते हैं temperature, top_p, और stop रचनात्मकता और आउटपुट लंबाई को नियंत्रित करने के लिए।

संदर्भ विंडो संयुक्त प्रॉम्प्ट और कंप्लीशन के लिए 100,000 टोकन तक की अनुमति देती है। सेट करें max_tokens आउटपुट को नियंत्रित करने के लिए, यदि छोड़ दिया जाए तो 2,048 टोकन का डिफ़ॉल्ट। त्रुटियां और अस्वीकृतियां क्रेडिट नहीं खर्च करतीं, इसलिए आप सुरक्षित रूप से परीक्षण कर सकते हैं।

स्ट्रीमिंग रिस्पॉन्सेस और उपयोग

सेटिंग करके स्ट्रीमिंग सक्षम करें stream: true अपने अनुरोध में। API सर्वर-सेंटेड इवेंट्स (SSE) लौटाता है जिसमें आंशिक टेक्स्ट चंक होते हैं। टोकन उपयोग डेटा केवल स्ट्रीम के अंतिम चंक में दिखाई देता है। यह प्रतिक्रियाओं के रियल-टाइम रेंडरिंग और उपभोग की सटीक ट्रैकिंग की अनुमति देता है।

स्ट्रीमिंग रोलप्ले एप्लिकेशन या लंबे-फॉर्म कंटेंट जनरेशन के लिए आदर्श है। आप UI को क्रमिक रूप से अपडेट करने के लिए SSE स्ट्रीम को पार्स कर सकते हैं। API यह सुनिश्चित करता है कि उपयोग मेट्रिक्स सटीक रहें, भले ही कनेक्शन समय से पहले टूट जाए।

फंक्शन कॉलिंग और टूल्स

एक प्रदान करके फ़ंक्शन कॉलिंग का समर्थन करें tools अनुरोध में एरे। मॉडल तर्कों के साथ संरचित टूल कॉल लौटा सकता है। उपयोग करें tool_choice विशिष्ट व्यवहार लागू करने के लिए, जैसे स्वचालित फ़ंक्शन निष्पादन। यह सुविधा बाहरी सेवाओं या कस्टम लॉजिक के साथ एकीकरण सक्षम बनाती है।

नाम, विवरण और पैरामीटर स्कीमा के साथ फ़ंक्शन परिभाषित करें। API प्रतिक्रिया में फ़ंक्शन नाम और तर्क लौटाता है। अपने कस्टम कोड को निष्पादित करने के लिए इन तर्कों को पार्स करें। यह क्षमता uncensored LLM API को जटिल एजेंट वर्कफ़्लो के लिए उपयुक्त बनाती है।

JSON मोड और पैरामीटर

सेट करके संरचित आउटपुट फ़ोर्स करें response_format को {"type": "json_object"}. मॉडल सादे टेक्स्ट के बजाय वैध JSON लौटाता है। यह डेटा एक्सट्रैक्शन या कॉन्फ़िगरेशन जनरेशन के लिए उपयोगी है। मजबूत API एकीकरण के लिए इसे फ़ंक्शन कॉलिंग के साथ जोड़ें।

अन्य समर्थित पैरामीटर शामिल हैं seed निर्धारक आउटपुट के लिए, presence_penalty, और frequency_penalty. उपयोग करें seed डिबगिंग के लिए विशिष्ट प्रतिक्रियाओं को पुन: उत्पन्न करने के लिए। दोहराव कम करने या अपने आउटपुट में विविध शब्दावली को प्रोत्साहित करने के लिए पेनल्टी को समायोजित करें।

त्रुटि हैंडलिंग और सीमाएँ

API प्रति मिनट 300 अनुरोधों और प्रति कुंजी 8 समवर्ती अनुरोधों की रेट लिमिट लागू करता है। अनुरोध बॉडी 8 MB से अधिक नहीं होनी चाहिए। यदि आप इन सीमाओं को पार करते हैं, तो आपको 429 स्टेटस कोड मिलता है। प्रमाणीकरण विफलता 401 त्रुटि लौटाती है। अपर्याप्त क्रेडिट 402 त्रुटि ट्रिगर करता है।

क्रेडिट वास्तविक टोकन उपयोग के आधार पर चार्ज किया जाता है। प्रीपेड क्रेडिट कभी समाप्त नहीं होता है, इसलिए आपको मासिक नवीनीकरण की चिंता करने की आवश्यकता नहीं है। डबल चार्ज जैसी समस्याओं को हल करने के लिए सपोर्ट पेज का उपयोग करें।

cURL

Copycurl https://api.uncensoredaigithub.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Run the unit tests for the new auth module."}]
  }'

Python

Copyfrom openai import OpenAI

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