ग्रॉक उपयोगकर्ताओं के लिए क्विकस्टार्ट

बेस URL और प्रमाणीकरण

हमारा API OpenAI SDKs के साथ पूरी तरह से संगत है। आपको केवल base_url अपडेट करना है और Authorization हेडर में अपनी कुंजी प्रदान करनी है। तुरंत अपनी कुंजी प्राप्त करने के लिए Google या ईमेल के माध्यम से साइन अप करें। शुरू करने के लिए फ़ोन नंबर या क्रेडिट कार्ड की आवश्यकता नहीं है। सभी अनुरोधों के लिए uncensored मॉडल ID का उपयोग करें।

प्रमाणीकरण Bearer टोकन के माध्यम से संभाला जाता है। सुनिश्चित करें कि आपकी कुंजी हर अनुरोध हेडर में भेजी जाती है। यदि आपको 401 त्रुटि मिलती है, तो आपकी कुंजी अमान्य या समाप्त हो चुकी है। हमारी सेवा स्वतंत्र है और अन्य वेंडर्स के मॉडल पुनर्विक्रित नहीं करती है।

बेसिक चैट कंप्लीशन

POST अनुरोध को /v1/chat/completions पर भेजें। API टेक्स्ट इनपुट स्वीकार करता है और टेक्स्ट आउटपुट लौटाता है। आप मॉडल के व्यवहार को निर्देशित करने के लिए सिस्टम प्रॉम्प्ट परिभाषित कर सकते हैं। मॉडल कानूनी वयस्क सामग्री, कथा साहित्य या विवादास्पद विषयों के लिए अस्वीकृतियों के बिना प्रतिक्रिया देता है।

अपने पेलोड में मॉडल को uncensored निर्दिष्ट करें। कॉन्टेक्स्ट विंडो कुल मिलाकर 100,000 टोकन तक समर्थित है। प्रति अनुरोध अधिकतम आउटपुट 32,000 टोकन है। त्रुटियां और अस्वीकृतियां क्रेडिट नहीं खपती हैं।

स्ट्रीमिंग रिस्पॉन्स

stream: true सेट करके स्ट्रीमिंग सक्षम करें। API सर्वर-सेंट इवेंट्स (SSE) लौटाता है। प्रत्येक चंक में क्रमिक पाठ अपडेट होते हैं। अंतिम चंक में बिलिंग पारदर्शिता के लिए टोकन उपयोग आंकड़े शामिल होते हैं।

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

फ़ंक्शन कॉलिंग

tools पैरामीटर में टूल्स परिभाषित करें। मॉडल संरचित फ़ंक्शन कॉलिंग लौटा सकता है। विशिष्ट व्यवहारों को लागू करने के लिए tool_choice का उपयोग करें। इससे बाहरी सिस्टम और वर्कफ़्लो के साथ एकीकरण संभव होता है।

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

JSON मोड

कठोर JSON आउटपुट के लिए response_format को {"type": "json_object"} पर सेट करें। मॉडल अपनी प्रतिक्रिया को मान्य JSON के रूप में प्रारूपित करेगा। यह एप्लिकेशन में संरचित डेटा के विश्लेषण के लिए उपयोगी है।

JSON मोड सुसंगत प्रारूप सुनिश्चित करता है। इसका उपयोग करें जब आपका डाउनस्ट्रीम कोड विशिष्ट स्कीमा संरचनाओं की उम्मीद करता है। मॉडल अनुरोधित प्रारूप का पालन करता है। इससे अतिरिक्त पार्सिंग लॉजिक की आवश्यकता कम हो जाती है।

पैरामीटर्स, लिमिट्स और त्रुटियां

temperature, top_p और stop अनुक्रमों के साथ जनरेशन को नियंत्रित करें। रेट लिमिट प्रति कुंजी प्रति मिनट 300 अनुरोध है। आपके पास अधिकतम 8 समानांतर अनुरोध हो सकते हैं। अनुरोध बॉडी 8 MB से अधिक नहीं होनी चाहिए। 402 त्रुटि अपर्याप्त क्रेडिट को दर्शाती है। 429 त्रुटि का अर्थ है कि आपने रेट लिमिट को पार कर लिया है। क्रेडिट प्रीपेड है और कभी समाप्त नहीं होता। त्रुटियाँ मुफ़्त हैं।

cURL

Copycurl https://api.grokuncensored.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'

Python

Copyfrom openai import OpenAI

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

Node.js

Copyimport OpenAI from "openai";

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

स्ट्रीमिंग

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)