API दस्तावेज़

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

सभी अनुरोधों के लिए बेस यूआरएल है https://api.grokapiplatform.com/v1. पास करते समय अपनी विशिष्ट API कुंजी को Authorization हेडर। हर अनुरोध में आपके खाते के बैलेंस की पुष्टि करने और रेट लिमिट्स लागू करने के लिए इस हेडर की आवश्यकता होती है।

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

टेक्स्ट क्वेरी भेजें POST /v1/chat/completions. उपयोग करने के लिए मॉडल आईडी "uncensored" है। यह एंडपॉइंट मानक टेक्स्ट-इन, टेक्स्ट-आउट इंटरैक्शन संभालता है बिना बुनियादी उपयोग के लिए अतिरिक्त कॉन्फ़िगरेशन की आवश्यकता के।

Copycurl https://api.grokapiplatform.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Check my current token usage balance."}]
  }'

मॉडल 100,000 टोकन संदर्भ विंडो के साथ काम करता है। इनपुट और आउटपुट टोकन इस सीमा को साझा करते हैं। संदर्भ विंडो से अधिक अनुरोध तुरंत विफल हो जाएंगे।

SSE के साथ स्ट्रीमिंग प्रतिक्रियाएं

सेटिंग करके स्ट्रीमिंग सक्षम करें stream: true अपने अनुरोध बॉडी में। सर्वर इंट्रीमेंटल टोकन अपडेट के साथ सर्वर-सेंट इवेंट्स (SSE) लौटाता है। इसे रियल-टाइम डिस्प्ले या अनुपस्थित लेटेंसी को कम करने के लिए उपयोग करें।

Copyfrom openai import OpenAI

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

टोकन उपयोग विवरण स्ट्रीम के अंतिम चंक में दिखाई देते हैं। आप हर मध्यवर्ती डेल्टा को पार्स किए बिना प्रति अनुरोध कुल उपभोग ट्रैक कर सकते हैं।

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

में टूल्स परिभाषित करें tools एरे और सेट tool_choice विशिष्ट व्यवहार ट्रिगर करने के लिए। मॉडल OpenAI SDKs के साथ संगत मानक टूल उपयोग पैटर्न का समर्थन करता है।

Copyimport OpenAI from "openai";

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

उपयोग करें tool_choice: "auto" स्वचालित चयन के लिए या बाध्यकारी निष्पादन के लिए टूल का नाम निर्दिष्ट करें। यह जटिल तर्क कार्यों के लिए अनसेंसर्ड मॉडल के साथ सहज रूप से काम करता है।

संरचित आउटपुट के लिए JSON मोड

सेट करें response_format को {"type": "json_object"} कठोर JSON आउटपुट लागू करने के लिए। इससे फ्रंटएंड ऐप्स या डेटा पाइपलाइन के साथ एकीकरण करते समय पार्सिंग त्रुटियां कम होती हैं।

पैरामीटर और सीमाएं

समायोजित करें temperature, top_p, और seed यादृच्छिकता को नियंत्रित करने के लिए। प्रति अनुरोध अधिकतम आउटपुट 16,000 टोकन है। 401 जैसी त्रुटियां अमान्य कुंजियों को संकेतित करती हैं, 402 का अर्थ अपर्याप्त प्रीपेड क्रेडिट है, और 429 रेट लिमिट्स को संकेतित करता है। सीमा प्रति कुंजी प्रति मिनट 300 अनुरोध है। क्रेडिट कभी समाप्त नहीं होता, इसलिए आप जब भी USDT या USDC के साथ टॉप-अप कर सकते हैं।

स्ट्रीमिंग

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)