क्या OpenWebUI में API है? हाँ, दो तरीकों से

दो अलग-अलग API जिनका संदर्भ दिया जाता है

जब कोई यह पूछता है कि Open WebUI में API है या नहीं, तो वे दो दिशाओं में से किसी एक के बारे में पूछ रहे हो सकते हैं। इन्हें मिलाना सेटअप गाइडों को भ्रमित करने का मुख्य कारण है, इसलिए उन्हें पहले अलग करना बेहतर है।

• इनबाउंड: आपका प्रोग्राम अनुरोध Open WebUI को भेजता है। यह एक सर्वर के रूप में कार्य करता है जिसमें चैट, मॉडल और फ़ाइलों के लिए एंडपॉइंट होते हैं, जो ऐप के अंदर आपके द्वारा बनाई गई API कुंजी से सुरक्षित होते हैं।
• आउटबाउंड: Open WebUI मॉडल सर्वर को अनुरोध भेजता है ताकि उसका चैट विंडो संचार कर सके। यह वह कनेक्शन है जिसे आप एडमिन सेटिंग्स के तहत कॉन्फ़िगर करते हैं।

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

यह साइट आउटबाउंड साइड पर मॉडल प्रदान करती है: एक होस्टेड, OpenAI-संगत टेक्स्ट API जिसमें एकल मॉडल ID uncensored है। यह Open WebUI नहीं है और न ही यह आपके लिए इसे चलाता है। Open WebUI एक सॉफ़्टवेयर है जिसे आप स्वयं होस्ट करते हैं।

Open WebUI की अपनी API का उपयोग करना

Open WebUI साइन इन किए उपयोगकर्ता को अपने अकाउंट सेटिंग्स में API कुंजी बनाने की अनुमति देता है। उस कुंजी के साथ आप स्क्रिप्ट्स से इसके एंडपॉइंट्स को कॉल कर सकते हैं। चैट एंडपॉइंट OpenAI के समान प्रारूप का पालन करता है, इसलिए मौजूदा क्लाइंट कोड अक्सर इसे इशारा कर सकता है। लेखन के समय प्रोजेक्ट द्वारा दस्तावेज़ीकृत राउट /api/chat/completions है; अपनी वर्जन के खिलाफ पुष्टि करें।

Copy# Open WebUI running locally on port 3000, key created in Settings > Account
curl http://localhost:3000/api/chat/completions \
  -H "Authorization: Bearer $OPENWEBUI_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model":"uncensored","messages":[{"role":"user","content":"Summarize this scene in one line."}]}'

ध्यान दें कि यहाँ मॉडल का नाम वह है जिसे Open WebUI ने पंजीकृत किया है। यदि आपने इस API को बैकएंड के रूप में जोड़ा है, तो वह नाम uncensored है। इस अनुरोध में कुंजी एक Open WebUI कुंजी है, न कि मॉडल API कुंजी। वे दो अलग-अलग क्रेडेंशियल्स हैं जिनके दो अलग-अलग काम हैं।

इनबाउंड API का उपयोग क्यों करें? यह उपयोगी है जब आप अपने प्रोग्राम के पीछे Open WebUI के अतिरिक्त फीचर्स चाहते हैं, जैसे कि इसके संग्रहीत ज्ञान संग्रह, इसके उपयोगकर्ता-विशिष्ट अकाउंट्स या इसके मॉडल प्रीसेट्स, और आप उन्हें बिना ब्राउज़र के पहुँचना चाहते हैं।

एक बाहरी API को बैकएंड के रूप में उपयोग करना

दूसरी दिशा वह है जिसकी सबसे अधिक लोगों को आवश्यकता होती है। Open WebUI में OpenAI-संगत कनेक्शनों के लिए एक सेक्शन है जहाँ आप एक URL और एक कुंजी दर्ज करते हैं। इस सेवा के लिए मान हैं:

• URL: https://api.nsfwvideo.top/v1
• कुंजी: कुंजी पेज से वह
• मॉडल: uncensored, GET /v1/models के माध्यम से स्वचालित रूप से खोजा गया

चरण-दर-चरण: एडमिन सेटिंग्स खोलें, कनेक्शन्स पर जाएं, एक OpenAI API कनेक्शन जोड़ें, URL और कुंजी पेस्ट करें, सेव करें, और एक नई चैट में मॉडल चुनें। यदि आप कमांड लाइन शुरुआत पसंद करते हैं, तो कंटेनर लॉन्च करते समय पर्यावरण चर OPENAI_API_BASE_URL और OPENAI_API_KEY सेट करें।

Copydocker run -d -p 3000:8080 \
  -e OPENAI_API_BASE_URL=https://api.nsfwvideo.top/v1 \
  -e OPENAI_API_KEY=$API_KEY \
  -v open-webui:/app/backend/data \
  ghcr.io/open-webui/open-webui:main

ध्यान रखें कि Open WebUI अपनी डेटाबेस में पहली बार शुरू होने पर कई सेटिंग्स सहेजता है। यदि आप बाद में एक वातावरण चर बदलते हैं और कुछ नहीं होता है, तो कनेक्शन को एडमिन पैनल में संपादित करें। क्विकस्टार्ट में वह अनुरूप प्रारूप दिया गया है जो बैकएंड अपेक्षित करता है यदि आप इसे curl के साथ सत्यापित करना चाहते हैं।

दोनों को चेन करना

आप दोनों दिशाओं का एक साथ उपयोग कर सकते हैं। आपका एप Open WebUI की इनबाउंड API को एक Open WebUI कुंजी के साथ कॉल करता है, Open WebUI चैट को आपके द्वारा कॉन्फ़िगर किए गए बैकएंड पर आगे बढ़ाता है, और जवाब वापस बहता है। यह व्यवस्था कुछ स्थितियों में समझ में आती है: एक टीम पहले से ही अकाउंट्स के साथ Open WebUI चला रही है और स्क्रिप्ट्स को उसके प्रीसेट्स साझा करना चाहती है, या आप एक जगह चाहते हैं जो मानवों और प्रोग्राम्स दोनों के लिए पर्सोना सेटिंग्स रखती है।

यह एक अतिरिक्त हॉप जोड़ता है। हर अनुरोध अब मॉडल API तक पहुँचने से पहले आपके Open WebUI सर्वर से गुजरता है, इसलिए चलाने, पैच करने और सुरक्षित करने के लिए एक और चीज़ है। रेट लिमिट भी एक अस्पष्ट तरीके से जमा होते हैं: बैकएंड कुंजी एक पूर्ण कुंजी के लिए 8 समानांतर अनुरोध और प्रति मिनट 300 की अनुमति देती है, और आपके Open WebUI इंस्टेंस से गुजरने वाला हर उपयोगकर्ता और स्क्रिप्ट उस अनुमति को साझा करता है। यदि बैकएंड HTTP 429 के साथ उत्तर देता है, त्रुटि कोड rate_limited या concurrency के साथ, तो विफलता आमतौर पर Open WebUI और आपके कॉलर में एक त्रुटि के रूप में दिखाई देगी।

कब Open WebUI छोड़ें और API को सीधे कॉल करें

यदि आपको केवल एक स्क्रिप्ट की आवश्यकता है जो टेक्स्ट जनरेट करती है, जैसे कि आउटलाइन, शॉट विवरण या ड्राफ्ट नैरेशन, तो Open WebUI अनावश्यक है। यह सेवा एक सामान्य OpenAI-संगत एंडपॉइंट है, इसलिए मानक SDK सीधे इससे संचार करता है।

Copyimport os
from openai import OpenAI

client = OpenAI(base_url="https://api.nsfwvideo.top/v1", api_key=os.environ["API_KEY"])

resp = client.chat.completions.create(
    model="uncensored",
    messages=[
        {"role": "system", "content": "You write concise shot lists for short films."},
        {"role": "user", "content": "Shot list for a ninety second chase through a night market."},
    ],
    temperature=0.7,
)
print(resp.choices[0].message.content)

सीधे कॉल आपको SSE के साथ स्ट्रीमिंग, टूल कॉलिंग, JSON मोड और हर सैम्पलिंग पैरामीटर बिना किसी मध्यवर्ती परत के देते हैं। जब आपको लोगों के लिए चैट इंटरफ़ेस चाहिए, जिसमें इतिहास, खाते और प्रीसेट हों, तो Open WebUI बेहतर विकल्प है। बैच वर्क के लिए स्क्रिप्ट बेहतर विकल्प है। API केवल टेक्स्ट उत्पन्न करता है: यह वीडियो, छवियाँ या ऑडियो रेंडर नहीं करता है, इसलिए वीडियो प्रोजेक्ट के लिए यह अन्य टूल्स के लिए लिखित भाग जैसे स्क्रिप्ट और प्रॉम्प्ट प्रदान करता है। वीडियो पाइपलाइन पेज उस उपयोग पर विस्तार से बताता है।

एक त्वरित निर्णय गाइड

• आप खुद या टीम के लिए एक चैट विंडो चाहते हैं: Open WebUI चलाएँ और आउटबाउंड कनेक्शन जोड़ें।
• आप चाहते हैं कि स्क्रिप्ट Open WebUI प्रीसेट या खातों का पुन: उपयोग करे: इसके इनबाउंड API का उपयोग Open WebUI कुंजी के साथ करें।
• आप बैच टेक्स्ट जनरेशन चाहते हैं: OpenAI SDK के साथ मॉडल API को सीधे कॉल करें और अतिरिक्त परत को छोड़ दें।
• आप छवियाँ या आवाज़ चाहते हैं: न Open WebUI और न ही यह टेक्स्ट API स्वयं उन्हें उत्पन्न करेगा। उस चरण के लिए अलग टूल्स कनेक्ट करें।

आप जो भी पथ चुनते हैं, मॉडल-साइड के तथ्य वही रहते हैं: प्रॉम्प्ट और जवाब के लिए साझा 100,000-टोकन कॉन्टेक्स्ट विंडो, टूल कॉलिंग और JSON मोड उपलब्ध, और नाबालिगों से जुड़ी यौन सामग्री के खिलाफ एक कठोर नियम।

दोनों API को एक्सपोज़ करने के लिए सुरक्षा नोट्स

दोनों कुंजियों को सीक्रेट मानें। Open WebUI कुंजी आपके इंस्टेंस के अंदर बनाए गए उपयोगकर्ता द्वारा जो कुछ भी किया जा सकता है, उसकी अनुमति देती है; मॉडल API कुंजी आपके प्रीपेड क्रेडिट को खर्च करती है। इनमें से किसी को भी क्लाइंट-साइड कोड या सार्वजनिक रिपॉजिटरी में पेस्ट न करें।

• यदि Open WebUI आपके स्वयं के मशीन से परे पहुँच योग्य है, तो इसे HTTPS के पीछे रखें।
• स्क्रिप्ट के लिए अलग-अलग Open WebUI कुंजियाँ बनाएँ ताकि आप एक को रद्द कर सकें बिना अन्य को तोड़े।
• यदि मॉडल API कुंजी कभी एक लॉग या स्क्रीनशॉट में दिखाई देती है, तो उसे रोटेट करें।
• बैकएंड पर X-Balance-USD रिस्पॉन्स हेडर को देखें ताकि कॉल प्रति खर्च पता चल सके।

गोपनीयता पर, इस API को भेजे गए प्रॉम्प्ट्स को ट्रेनिंग के लिए उपयोग नहीं किया जाता है। Open WebUI स्वयं चैट इतिहास को अपने सर्वर पर अपनी डेटाबेस में सहेजता है, इसलिए आपके होस्टिंग विकल्प यह निर्धारित करते हैं कि इसे कौन पढ़ सकता है।

इस सेटअप को चलाने का खर्च

Open WebUI मुफ़्त सॉफ़्टवेयर है जिसे आप होस्ट करते हैं; आपका खर्च सर्वर और टोकन है। टोकन $0.15 प्रति 1M इनपुट और $0.50 प्रति 1M आउटपुट पर बिल किए जाते हैं, प्रीपेड क्रेडिट से, कोई सब्सक्रिप्शन नहीं। 3,000 इनपुट टोकन और 500 आउटपुट टोकन के साथ एक चैट टर्न लें: 3,000 x $0.15 / 1M = $0.00045 इनपुट के लिए और 500 x $0.50 / 1M = $0.00025 आउटपुट के लिए, कुल $0.0007। एक हजार ऐसे टर्न्स का खर्च $0.70 होता है।

टॉप-अप $20 से $500 तक की पूर्ण राशि होती है, जिसमें $50 से +5%, $100 से +10% और $200 से +15% मिलता है। भुगतान क्रिप्टो, TRC20 पर USDT या Base पर USDC द्वारा होता है। विफल या अस्वीकृत अनुरोधों पर चार्ज नहीं किया जाता, और क्रेडिट कभी समाप्त नहीं होता। नए उपयोगकर्ता एक क्लिक और बिना भुगतान विवरण के 7 दिनों के लिए $0.50 का ट्रायल क्रेडिट दावा कर सकते हैं। पूरी जानकारी के लिए मूल्य निर्धारण पेज देखें।

सामग्री पर एक याद दिलाते हुए: मॉडल कानूनी वयस्कों के उपयोग के लिए बिना सेंसर जवाब देने के लिए ट्यून्ड है, और नाबालिगों से जुड़े यौन सामग्री की कभी अनुमति नहीं है।

अधिक गाइड

• ⟦a0⟍NSFW वीडियो पाइपलाइन्स के लिए Uncensored LLM API⟦/a0⟍