Czy OpenWebUI ma API? Tak, w dwóch kierunkach

Dwa różne API, o które pytają ludzie

Gdy ktoś pyta, czy Open WebUI ma API, może pytać o któryś z dwóch kierunków. Mylenie ich jest główną przyczyną, że przewodniki konfiguracji są mylące, więc warto je najpierw rozdzielić.

• Przychodzące: Twój program wysyła zapytania do Open WebUI. Działa jako serwer z endpointami do czatu, modeli i plików, chronionymi kluczem API, który generujesz wewnątrz aplikacji.
• Wychodzące: Open WebUI wysyła zapytania do serwera modeli, aby jego okno czatu miało z kim rozmawiać. To połączenie konfigurujesz w Ustawieniach administratora.

Krótka odpowiedź brzmi: tak w obu przypadkach. Projekt dokumentuje API z endpointem czatu w stylu OpenAI i obsługuje łączenie się z dowolnym serwerem obsługującym protokół OpenAI. Szczegóły, takie jak dokładne ścieżki i obsługa kluczy, mogą się zmieniać między wersjami, więc sprawdź dokumentację dla wydania, które uruchamiasz.

Ta strona dostarcza model po stronie wychodzącej: hostowane, kompatybilne z OpenAI API tekstowe z pojedynczym ID modelu uncensored. Nie jest to Open WebUI i nie uruchamia go za Ciebie. Open WebUI to oprogramowanie, które hostujesz samodzielnie.

Korzystanie z własnego API Open WebUI

Open WebUI pozwala zalogowanemu użytkownikowi wygenerować klucz API w ustawieniach konta. Dzięki temu kluczowi możesz wywoływać jego endpointy ze skryptów. Endpoint czatu ma strukturę OpenAI, więc istniejący kod klienta często można skierować pod tę ścieżkę. Ścieżka udokumentowana przez projekt w momencie pisania to /api/chat/completions; zweryfikuj to dla swojej wersji.

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

Pamiętaj, że tutaj nazwą modelu jest dowolny model, który zarejestrował Open WebUI. Jeśli podłączyłeś to API jako backend, nazwą jest uncensored. Klucz w tym żądaniu to klucz Open WebUI, a nie klucz API modelu. To dwa osobne poświadczenia z dwoma osobnymi zadaniami.

Po co korzystać z API przychodzącego? Jest przydatne, gdy chcesz mieć dostęp do dodatków Open WebUI za swoim programem, takich jak przechowywane kolekcje wiedzy, konta użytkowników lub ustawienia modeli, i chcesz do nich dotrzeć bez przeglądarki.

Korzystanie z zewnętrznego API jako backendu

Drugi kierunek to ten, którego potrzebuje większość ludzi. Open WebUI ma sekcję dla połączeń kompatybilnych z OpenAI, gdzie wpisujesz URL i klucz. Dla tej usługi wartości to:

• URL: https://api.nsfwvideo.top/v1
• Klucz: ten ze strony z kluczem
• Model: uncensored, wykrywany automatycznie przez GET /v1/models

Krok po kroku: otwórz Ustawienia administratora, przejdź do Połączeń, dodaj połączenie API OpenAI, wklej URL i klucz, zapisz i wybierz model w nowym czacie. Jeśli wolisz start z linii poleceń, ustaw zmienne środowiskowe OPENAI_API_BASE_URL i OPENAI_API_KEY podczas uruchamiania kontenera.

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

Pamiętaj, że Open WebUI przy pierwszym uruchomieniu zapisuje wiele ustawień w swojej bazie danych. Jeśli później zmienisz zmienną środowiskową i nic się nie stanie, edytuj połączenie w panelu administracyjnym. przewodnik szybkiego startu zawiera format żądania oczekiwany przez backend, jeśli chcesz go zweryfikować za pomocą curl.

Łączenie ich w łańcuch

Możesz używać obu kierunków jednocześnie. Twoja aplikacja wywołuje API przychodzące Open WebUI kluczem Open WebUI, Open WebUI przekierowuje czat do skonfigurowanego backendu, a odpowiedź wraca. Ta konfiguracja ma sens w kilku sytuacjach: zespół już uruchomił Open WebUI z kontami i chce, aby skrypty współdzieliły jego ustawienia, albo chcesz mieć jedno miejsce, które przechowuje ustawienia person dla ludzi i programów.

Dodaje to jeden skok. Każde zapytanie przechodzi przez Twój serwer Open WebUI zanim dotrze do API modelu, więc musisz utrzymywać, aktualizować i zabezpieczać jeszcze jeden element. Limity zapytań nakładają się w sposób nieoczywisty: klucz backendowy pozwala na 8 równoległych zapytań i 300 na minutę dla pełnego klucza, a każdy użytkownik i skrypt przechodzący przez Twoją instancję Open WebUI dzieli się tym limitem. Jeśli backend zwróci HTTP 429 z kodem błędu rate_limited lub concurrency, awaria zwykle pojawi się jako błąd w Open WebUI i u Twojego wywołującego.

Kiedy pominąć Open WebUI i wywoływać API bezpośrednio

Jeśli potrzebujesz tylko skryptu generującego tekst, np. zarysy, opisy ujęć lub szkic narracji, Open WebUI jest niepotrzebny. Ta usługa to zwykły endpoint kompatybilny z OpenAI, więc standardowe SDK komunikuje się z nim bezpośrednio.

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)

Bezpośrednie wywołania dają Ci strumieniowanie przez SSE, wywoływanie funkcji, tryb JSON i wszystkie parametry próbkowania bez warstwy pośredniej. Open WebUI jest lepszym wyborem, gdy chcesz interfejsu czatu dla ludzi, z historią, kontami i ustawieniami. Skrypt jest lepszym wyborem do pracy wsadowej. API generuje tylko tekst: nie renderuje wideo, obrazów ani audio, więc do projektu wideo dostarcza tekstowe części, takie jak skrypty i prompty dla innych narzędzi. Na stronie pipeline wideo omówiono to zastosowanie.

Szybki przewodnik decyzyjny

• Chcesz okno czatu dla siebie lub zespołu: uruchom Open WebUI i dodaj połączenie wychodzące.
• Chcesz, by skrypty mogły ponownie wykorzystać ustawienia lub konta Open WebUI: użyj jego API przychodzącego z kluczem Open WebUI.
• Chcesz generowanie tekstu wsadowego: wywołaj API modelu bezpośrednio za pomocą OpenAI SDK i pomiń dodatkową warstwę.
• Chcesz obrazy lub głos: ani Open WebUI, ani to API tekstowe nie wygenerują ich samodzielnie. Podłącz osobne narzędzia do tego kroku.

Bez względu na wybraną ścieżkę, fakty po stronie modelu pozostają takie same: okno kontekstu 100 000 tokenów dzielone przez prompt i odpowiedź, dostępne wywoływanie narzędzi i tryb JSON oraz twarda zasada przeciwko treściom seksualnym z udziałem nieletnich.

Uwagi bezpieczeństwa dotyczące udostępniania któregokolwiek API

Traktuj oba klucze jako dane tajne. Klucz Open WebUI przyznaje uprawnienia, jakie ma tworzący użytkownik w Twojej instancji; klucz API modelu zużywa Twój przedpłacony balans. Nie wklejaj żadnego z nich do kodu po stronie klienta ani do publicznych repozytoriów.

• Umieść Open WebUI za HTTPS, jeśli jest dostępne poza Twoją własną maszyną.
• Twórz osobne klucze Open WebUI dla każdego skryptu, aby móc unieważnić jeden bez naruszenia działania pozostałych.
• Zmień klucz API modelu, jeśli kiedykolwiek pojawi się w logu lub zrzucie ekranu.
• Obserwuj nagłówek odpowiedzi X-Balance-USD po stronie backendu, aby zobaczyć wydatki na każde wywołanie.

Jeśli chodzi o prywatność, prompty wysłane do tego API nie są używane do trenowania. Sam Open WebUI przechowuje historię czatu w swojej bazie danych na Twoim serwerze, więc Twoje wybory hostingu determinują, kto może ją przeczytać.

Ile kosztuje utrzymanie tej konfiguracji

Open WebUI to darmowe oprogramowanie, które hostujesz; Twój koszt to serwer plus tokeny. Tokeny są rozliczane po $0,15 za 1M tokenów wejściowych i $0,50 za 1M tokenów wyjściowych, z przedpłaconego kredytu bez subskrypcji. Weź turę czatu z 3000 tokenami wejściowymi i 500 wyjściowymi: 3000 x $0,15 / 1M = $0,00045 za wejście i 500 x $0,50 / 1M = $0,00025 za wyjście, razem $0,0007. Tysiąc takich tur kosztuje $0,70.

Doładowania to dowolna kwota całkowita od $20 do $500, z +5% od $50, +10% od $100 i +15% od $200. Płatność jest kryptowalutami, USDT na TRC20 lub USDC na Base. Nieudane lub odrzucone zapytania nie są rozliczane, a kredyt nigdy nie wygasa. Nowi użytkownicy mogą odebrać darmowy kredyt próbny $0.50 na 7 dni jednym kliknięciem bez podawania danych płatności. Zobacz stronę z cenami, aby zobaczyć pełny obraz.

Przypomnienie dotyczące treści: model jest dostrojony do odpowiadania bez odrzucania treści dla prawnego użytku dorosłych, a treści seksualne z udziałem nieletnich są zawsze zabronione.

Więcej przewodników

• API LLM bez cenzury dla potoków wideo NSFW