OpenWebUI'nin bir API'si var mı? Evet, iki yönde

İnsanların kastettiği iki farklı API

Birisi Open WebUI'nin bir API'si olup olmadığını sorduğunda, iki yönden birini soruyor olabilir. Bunları karıştırmak kurulum kılavuzlarının kafa karıştırıcı gelmesinin ana nedenidir, bu yüzden önce ayırmak faydalıdır.

• Gelen: programınız Open WebUI'ye istek gönderir. Sohbet, modeller ve dosyalar için uç noktaları olan bir sunucu gibi davranır ve uygulama içinde oluşturduğunuz bir API anahtarı ile korunur.
• Giden: Open WebUI, sohbet penceresinin bir şeylerle konuşabilmesi için istekleri bir model sunucusuna gönderir. Bu bağlantıyı Yönetici Ayarları altında yapılandırırsınız.

Kısa cevap her ikisi için de evettir. Proje, OpenAI tarzı bir sohbet uç noktasına sahip bir API'yi belgeler ve OpenAI protokolünü konuşan herhangi bir sunucuya bağlanmayı destekler. Kesin yollar ve anahtar işleme gibi detaylar sürümler arasında değişebilir, bu yüzden çalıştırdığınız sürüm için belgelere bakın.

Bu site model giden tarafta sağlar: tek model ID'si uncensored ile barındırılan, OpenAI uyumlu bir metin API'si. Open WebUI değildir ve sizin için onu çalıştırmaz. Open WebUI, kendi kendinize barındırdığınız bir yazılımdır.

Open WebUI'nin kendi API'sini kullanma

Open WebUI, oturum açmış bir kullanıcının hesap ayarlarında bir API anahtarı oluşturmasına olanak tanır. Bu anahtarla betiklerden uç noktalarını çağırabilirsiniz. Sohbet uç noktası OpenAI şeklini izler, bu nedenle mevcut istemci kodu genellikle buna işaret edilebilir. Yazma anında proje tarafından belgelenen rota /api/chat/completions'dir; sürümünüzle doğrulayın.

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."}]}'

Burada model adının, Open WebUI'nin kaydettiği herhangi bir model olduğunu unutmayın. Bu API'yi arka uç olarak bağladıysanız, bu ad uncensored olur. Bu istekteki anahtar bir Open WebUI anahtarıdır, model API anahtarı değildir. Bunlar iki ayrı kimlik bilgisi ve iki ayrı işlevdir.

Neden gelen API'yi kullanmalısınız? Programınızın arkasındaki Open WebUI'nin ek özelliklerini (örneğin kayıtlı bilgi koleksiyonları, kullanıcı bazlı hesaplar veya model önceden ayarları) bir tarayıcı olmadan erişmek istediğinizde kullanışlıdır.

Arka uç olarak dış bir API kullanma

Diğer yön, çoğu insanın ihtiyacı olan yöndür. Open WebUI'nin OpenAI uyumlu bağlantılar için bir bölümü vardır ve bir URL ve anahtar girdiğiniz yerdir. Bu hizmet için değerler şunlardır:

• URL: https://api.nsfwvideo.top/v1
• Anahtar: anahtar sayfasından
• Model: uncensored, GET /v1/models üzerinden otomatik olarak keşfedilir

Adım adım: Yönetici Ayarları'nı açın, Bağlantılar'a gidin, bir OpenAI API bağlantısı ekleyin, URL'yi ve anahtarı yapıştırın, kaydedin ve yeni bir sohbette modeli seçin. Komut satırı başlatmayı tercih ediyorsanız, kapsayıcıyı başlatırken OPENAI_API_BASE_URL ve OPENAI_API_KEY ortam değişkenlerini ayarlayın.

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'nin ilk başlatmada ayarların çoğunu veritabanına kaydettiğini unutmayın. Daha sonra bir ortam değişkenini değiştirir ve hiçbir şey olmazsa, bağlantıyı yönetici panelinde düzenleyin. hızlı başlangıç, curl ile doğrulamak isterseniz arka ucun beklediği istek formatını içerir.

İkisini zincirleme

Her iki yönü de aynı anda kullanabilirsiniz. Uygulamanız bir Open WebUI anahtarı ile Open WebUI'nin gelen API'sini çağırır, Open WebUI sohbeti yapılandırdığınız arka uca iletir ve yanıt geri akar. Bu düzenleme birkaç durumda mantıklıdır: bir ekip zaten hesaplarla Open WebUI çalıştırıyorsa ve betiklerin ön ayarlarını paylaşmasını istiyorsa veya hem insanlar hem de programlar için kişilik ayarlarını tutan tek bir yer istiyorsanız.

Bu bir ek atlama ekler. Her istek artık model API'sine ulaşmadan önce Open WebUI sunucunuzdan geçer; bu nedenle çalışır durumda tutmanız, yama yapmanız ve güvenli hale getirmeniz gereken bir şey daha vardır. Hız limitleri de belirsiz bir şekilde üst üste biner: arka uç anahtarı tam bir anahtar için 8 eşzamanlı istek ve dakikada 300 istek izni verir; Open WebUI örneğiniz üzerinden geçen her kullanıcı ve betik bu haddi paylaşır. Arka uç HTTP 429, rate_limited veya concurrency hata koduyla yanıt verirse, hata genellikle Open WebUI'de ve çağrı yapanınızda bir hata olarak görünür.

Open WebUI'yi atlayıp API'yi doğrudan çağırma zamanı

Sadece taslaklar, sahne betimlemeleri veya taslak anlatım gibi metinler üreten bir komut dosyasına ihtiyacınız varsa, Open WebUI gereksizdir. Bu hizmet normal bir OpenAI uyumlu uç noktadır, bu nedenle standart SDK doğrudan ona bağlanır.

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)

Doğrudan istekler size SSE üzerinden akış, fonksiyon çağırma, JSON modu ve ara katman olmadan tüm örnekleme parametrelerini sağlar. İnsanlar için geçmiş, hesaplar ve hazır ayarlar içeren bir sohbet arayüzü istiyorsanız Open WebUI daha iyi bir tercihtir. Toplu işler için bir betik daha iyi bir tercihtir. API yalnızca metin üretir; video, görüntü veya ses işlemez, bu nedenle bir video projesi için diğer araçlar için senaryolar ve istemler gibi yazılı kısımları sağlar. Video işleme hattı sayfası bu kullanımı detaylandırır.

Hızlı bir karar rehberi

• Kendiniz veya bir ekip için bir sohbet penceresi istiyorsunuz: Open WebUI'yi çalıştırın ve giden bağlantıyı ekleyin.
• Betiklerin Open WebUI ön ayarlarını veya hesaplarını yeniden kullanmasını istiyorsunuz: bir Open WebUI anahtarı ile gelen API'sini kullanın.
• Toplu metin üretimi istiyorsunuz: OpenAI SDK ile model API'sini doğrudan çağırın ve ekstra katmanı atlayın.
• Görüntü veya ses istiyorsunuz: ne Open WebUI ne de bu metin API'si bunları kendi başlarına üretecektir. Bu adım için ayrı araçlar bağlayın.

Hangi yolu seçerseniz seçin, model tarafındaki gerçekler aynı kalır: istem ve yanıt tarafından paylaşılan 100.000 token'lık bağlam penceresi, fonksiyon çağırma ve JSON modu kullanılabilir durumda ve reşit olmayanları içeren cinsel içerik için katı bir kural geçerlidir.

Herhangi bir API'yi dışa açma için güvenlik notları

Her iki anahtarı da gizli olarak muamele edin. Open WebUI anahtarı oluşturucu kullanıcının örneğiniz içinde yapabileceği her şeye izin verir; model API anahtarı ön ödemeli bakiyenizi harcar. Bunları istemci tarafı koduna veya genel depolara yapıştırmayın.

• Open WebUI kendi makinenizin ötesinde erişilebilirse HTTPS'nin arkasına koyun.
• Diğerlerini bozmadan birini iptal edebilmeniz için betik başına ayrı Open WebUI anahtarları oluşturun.
• Eğer model API anahtarı bir günlükte veya bir ekran görüntüsünde görünürse, anahtarı yenileyin.
• Arka uçta X-Balance-USD yanıt başlığını izleyerek çağrı başına harcamayı görün.

Gizlilik konusunda, bu API'ye gönderilen istemler eğitim için kullanılmaz. Open WebUI kendisi sohbet geçmişini sunucunuzdaki kendi veritabanında depolar, bu nedenle barındırma seçimleriniz kimin okuyabileceğini belirler.

Bu kurulumu çalıştırmanın maliyeti

Open WebUI barındırdığınız ücretsiz bir yazılımdır; maliyetiniz sunucu ve tokenlardır. Tokenlar ön ödemeli kredi ile, abonelik olmadan, 1M giriş başına $0.15 ve 1M çıktı başına $0.50 fiyatlandırılır. 3.000 giriş tokenı ve 500 çıktı tokenı ile bir sohbet dönüşü yapın: 3.000 x $0.15 / 1M = giriş için $0.00045 ve 500 x $0.50 / 1M = çıktı için $0.00025, toplam $0.0007. Bin böyle dönüş $0.70'a mal olur.

Yüklemeler $20 ile $500 arasında herhangi bir tam miktardadır, $50'den +5%, $100'den +10% ve $200'den +15% ile. Ödeme kripto ile, TRC20 üzerinde USDT veya Base üzerinde USDC ile yapılır. Başarısız veya reddedilen istekler ücretlendirilmez ve kredi hiç sona ermez. Yeni kullanıcılar tek tıkla ve ödeme bilgileri olmadan 7 gün için $0.50 deneme talep edebilir. Tam resim için fiyatlandırma sayfasına bakın.

İçerik konusunda bir hatırlatma: model, yasal yetişkin kullanımı için içerik reddi olmadan yanıt verecek şekilde ayarlanmıştır ve reşit olmayanları içeren cinsel içerik asla kabul edilmez.

Daha fazla kılavuz

• NSFW Video Pipeline'ları için Sansürsüz LLM API'si