एक API: क्विकस्टार्ट गाइड

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

अपने क्लाइंट को हमारे समर्पित एंडपॉइंट की ओर इशारा करके शुरू करें। यह OpenAI-सुसंगत API मानक प्रमाणीकरण हेडर का उपयोग करता है, इसलिए आपको अपनी कॉन्फ़िगरेशन में केवल दो मान बदलने की आवश्यकता है।

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

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

प्रत्यक्ष प्रतिक्रिया प्राप्त करने के लिए एक सरल टेक्स्ट प्रॉम्प्ट भेजें। यह हमारे डेवलपर्स के लिए AI API ऑफरिंग का मुख्य हिस्सा है। मॉडल कानूनी वयस्क उपयोग के लिए बिना सामग्री अस्वीकृति के टेक्स्ट लौटाता है, जिससे यह रचनात्मक या असीमित कार्यों के लिए आदर्श है।

• मॉडल ID: uncensored
• एंडपॉइंट: POST /v1/chat/completions
• कॉन्टेक्स्ट: 100,000 टोकन

इस उदाहरण के साथ अपना पहला अनुरोध करें:

Copycurl https://api.onekeyllmapi.com/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 SDK इंटीग्रेशन

हमारी सेवा के साथ इंटरैक्ट करने के लिए आधिकारिक OpenAI Python लाइब्रेरी का उपयोग करें। आवश्यक एकमात्र बदलाव base_url और api_key हैं। यह सुनिश्चित करता है कि आपकी मौजूदा लॉजिक बिना संशोधन के काम करे।

• इंस्टॉल करें pip install openai
• एनवायरनमेंट वेरिएबल सेट करें या क्लाइंट इनिट में सीधे पास करें
• chat.completions.create() को सामान्य तरीके से कॉल करें

क्लाइंट को इस तरह कॉन्फ़िगर करें:

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.onekeyllmapi.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 SDK उपयोग

मानक OpenAI Node पैकेज का उपयोग करके JavaScript या TypeScript प्रोजेक्ट्स के साथ इंटीग्रेट करें। क्लाइंट को हमारे URL की ओर इशारा करें और अपनी कुंजी प्रदान करें। यह दृष्टिकोण किसी भी OpenAI-संगत क्लाइंट संरचना के साथ संगतता बनाए रखता है।

• इंस्टॉल करें npm install openai
• कस्टम बेस URL के साथ इनिशियलाइज़ करें
• मानक async/await पैटर्न का उपयोग करें

उदाहरण इनिशियलाइज़ेशन:

Copyimport OpenAI from "openai";

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

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

कम लैटेंसी के लिए टोकन-दर-टोकन प्रतिक्रियाएँ प्राप्त करें। हमारा स्ट्रीमिंग API Server-Sent Events (SSE) का समर्थन करता है, जिससे आप आउटपुट को जनरेट होते हुए प्रदर्शित कर सकते हैं। यह चैट इंटरफ़ेस या रियल-टाइम एप्लिकेशन के लिए उपयोगी है।

• अपने अनुरोध में stream: true सेट करें
• क्लाइंट पर SSE स्ट्रीम को पार्स करें
• आंशिक टोकन को कुशलता से हैंडल करें

अपने कोड में स्ट्रीमिंग सक्षम करें:

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)

सीमाएँ, त्रुटियाँ और कॉन्टेक्स्ट

मजबूत इंटीग्रेशन बनाने के लिए बाधाओं को समझें। API एक 100k context api विंडो का समर्थन करता है, जो लंबे दस्तावेज़ों या बातचीत की अनुमति देता है। अनुरोधों को 8 MB बॉडी साइज तक सीमित किया गया है।

सामान्य त्रुटियों में अमान्य कुंजियों के लिए 401, प्रीपेड क्रेडिट खत्म होने पर 402, और प्रति मिनट 300 अनुरोधों से अधिक के लिए 429 शामिल हैं। पे-एज़-यू-गो क्रेडिट कभी समाप्त नहीं होता, और आप $10 से टॉप-अप कर सकते हैं। फ़ंक्शन निष्पादन के लिए टूल कॉलिंग का समर्थन किया जाता है।