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

इंस्टॉलेशन और सेटअप

हमारा API मानक OpenAI SDKs के साथ पूर्णतः संगत है। OpenRouter से बदलने के लिए, आपको केवल दो कॉन्फ़िगरेशन मान अपडेट करने की आवश्यकता है: base_url और api_key। अपने क्लाइंट को https://api.openrouterapi.cc/v1 की ओर निर्देशित करें और अपने डैशबोर्ड पर उत्पन्न की का उपयोग करें। किसी कस्टम हेडर या जटिल रूटिंग तर्क की आवश्यकता नहीं है। अनुरोध करने के लिए मॉडल आईडी uncensored है।

सुनिश्चित करें कि आपका SDK संस्करण base_url पैरामीटर का समर्थन करता है। यदि आप एक कच्चा HTTP क्लाइंट उपयोग कर रहे हैं, तो लक्ष्य URL को सरलता से अपडेट करें। यह सेटअप सुनिश्चित करता है कि आपका मौजूदा क्लाइंट कोड बिना संशोधन के काम करे, बशर्ते आप केवल टेक्स्ट कंप्लीशन अनुरोध भेज रहे हों।

प्रमाणीकरण

प्रमाणीकरण मानक Authorization हेडर के माध्यम से संभाला जाता है। अपनी API कुंजी को Bearer टोकन के रूप में पास करें। यदि कुंजी अमान्य या समाप्त हो गई है, तो API एक 401 त्रुटि लौटाता है। कुछ प्रदाताओं के विपरीत, हम विफल अनुरोधों के लिए शुल्क नहीं लेते; त्रुटियाँ और अस्वीकृतियाँ मुफ्त हैं, इसलिए आप बिना क्रेडिट खपत किए प्रमाणीकरण का परीक्षण कर सकते हैं।

प्रत्येक खाते एक समय में एक सक्रिय कुंजी का समर्थन करता है। एक नई कुंजी जनरेट करने से पिछली कुंजी तुरंत अमान्य हो जाती है। अपनी कुंजी को सुरक्षित रखें और यदि आप संदेह करते हैं कि वह उजागर हो गई है, तो उसे बदलें। कुंजी साइनअप के तुरंत बाद प्रदर्शित होती है, इसलिए पृष्ठ छोड़ने से पहले इसे कॉपी करें।

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

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

model फ़ील्ड को uncensored पर सेट करें। आप temperature, top_p, और stop जैसे पैरामीटर का उपयोग करके व्यवहार को नियंत्रित कर सकते हैं। API response_format के माध्यम से JSON मोड और tools के माध्यम से फ़ंक्शन कॉलिंग का समर्थन करता है। सभी अनुरोध असिंक्रोनously प्रसंस्कृत किए जाते हैं, और आपको मॉडल समाप्त होने पर पूर्ण कंप्लीशन प्राप्त होता है।

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

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

टोकन उपयोग की जानकारी स्ट्रीम के अंतिम चंक में प्रदान की जाती है। इससे आपको हर व्यक्तिगत टोकन को पार्स किए बिना लागत की सटीक निगरानी करने की अनुमति मिलती है। स्ट्रीमिंग उन चैट इंटरफेस के लिए आदर्श है जहां लेटेंसी मायने रखती है। सुनिश्चित करें कि आपका क्लाइंट SSE को सही ढंग से संभालता है और स्ट्रीम समाप्त होने पर कनेक्शन बंद करता है।

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

API tools पैरामीटर के माध्यम से फ़ंक्शन कॉलिंग का समर्थन करता है। अपने फ़ंक्शन्स को tools सरणी में परिभाषित करें और tool_choice को auto या एक विशिष्ट फ़ंक्शन नाम पर सेट करें। यदि कोई फ़ंक्शन ट्रिगर होता है, तो मॉडल संरचित JSON तर्क लौटाएगा।

यह सुविधा LLM को बाहरी APIs या डेटाबेस के साथ एकीकृत करने के लिए उपयोगी है। सुनिश्चित करें कि आपकी फ़ंक्शन परिभाषाएं सटीक हों, क्योंकि मॉडल मान्य आर्गुमेंट्स जनरेट करने के लिए उन पर निर्भर करता है। API फ़ंक्शन्स को एक्जीक्यूट नहीं करता है; आपको एप्लिकेशन कोड में एक्जीक्यूशन लॉजिक संभालना होगा।

JSON मोड

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

सुनिश्चित करें कि आपके प्रॉम्प्ट्स मॉडल को JSON लौटने के लिए स्पष्ट रूप से निर्देशित करते हैं। यदि प्रॉम्प्ट अस्पष्ट है, तो अमान्य JSON रिस्पॉन्स आ सकते हैं। JSON मोड मानक और स्ट्रीमिंग दोनों मोड में समर्थित है। इसका उपयोग तब करें जब आपको भविष्यवाणी योग्य, मशीन-पढ़ने योग्य आउटपुट की आवश्यकता हो।

लिमिट्स, एरर्स और कॉन्टेक्स्ट

प्रॉम्प्ट और कंप्लीशन के लिए कॉन्टेक्स्ट विंडो 100,000 टोकन है। प्रति अनुरोध अधिकतम आउटपुट 32,000 टोकन है (2,048 यदि max_tokens सेट नहीं है)। रेट लिमिट प्रति मिनट 300 अनुरोध और प्रति कुंजी 8 समानांतर अनुरोध हैं। अनुरोध बॉडी 8 MB तक सीमित है।

त्रुटियां मानक HTTP कोड लौटाती हैं: अमान्य कुंजियों के लिए 401, अपर्याप्त क्रेडिट के लिए 402, और रेट लिमिट्स के लिए 429। क्रेडिट प्रीपेड है, इसलिए 402 त्रुटि का अर्थ है कि आपको टॉप-अप करने की आवश्यकता है। त्रुटियां और अस्वीकृतियां मुफ्त हैं, इसलिए आप बिना लागत के पुन: प्रयास कर सकते हैं। कठोर सामग्री लिमिट किशोरों से संबंधित यौन सामग्री को ब्लॉक करती है।

cURL

Copycurl https://api.openrouterapi.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.openrouterapi.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.openrouterapi.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)