L'API OpenWebUI existe-t-elle ? Oui, dans deux directions

Deux API différentes selon ce que les gens entendent

Lorsque quelqu'un demande si Open WebUI dispose d'une API, il peut s'agir de l'une des deux directions. Les confondre est la principale raison pour laquelle les guides d'installation semblent déroutants ; il est donc utile de les distinguer dès le départ.

• Entrante : votre programme envoie des requêtes à Open WebUI. Il agit comme un serveur avec des endpoints pour le chat, les modèles et les fichiers, protégé par une clé API que vous générez dans l'application.
• Sortante : Open WebUI envoie des requêtes à un serveur de modèle afin que sa fenêtre de chat ait quelque chose à quoi répondre. C'est la connexion que vous configurez dans les Paramètres d'administration.

La réponse courte est donc oui pour les deux. Le projet documente une API avec un endpoint de type OpenAI, et il prend en charge la connexion à tout serveur compatible avec le protocole OpenAI. Les détails tels que les chemins exacts et la gestion des clés peuvent changer entre les versions, alors consultez la documentation de la version que vous utilisez.

Ce site fournit le modèle du côté sortant : une API de texte hébergée et compatible OpenAI avec un seul ID de modèle uncensored. Ce n'est pas Open WebUI et cela ne l'exécute pas pour vous. Open WebUI est un logiciel que vous hébergez vous-même.

Utilisation de la propre API d'Open WebUI

Open WebUI permet à un utilisateur connecté de créer une clé API dans les paramètres de son compte. Avec cette clé, vous pouvez appeler ses endpoints depuis des scripts. L'endpoint de chat suit le format OpenAI, de sorte que le code client existant peut souvent être pointé vers celui-ci. Le chemin documenté par le projet au moment de la rédaction est /api/chat/completions ; vérifiez-le par rapport à votre version.

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

Notez que dans ce cas, le nom du modèle est celui que Open WebUI a enregistré. Si vous avez connecté cette API comme backend, ce nom est uncensored. La clé dans cette requête est une clé Open WebUI, et non la clé de l'API du modèle. Il s'agit de deux identifiants distincts avec deux rôles distincts.

Pourquoi utiliser l'API entrante ? Elle est utile lorsque vous souhaitez utiliser les fonctionnalités d'Open WebUI derrière votre programme, telles que ses collections de connaissances stockées, ses comptes par utilisateur ou ses préréglages de modèle, et que vous souhaitez y accéder sans navigateur.

Utilisation d'une API externe comme backend

L'autre sens est celui dont la plupart des gens ont besoin. Open WebUI dispose d'une section pour les connexions compatibles OpenAI où vous entrez une URL et une clé. Pour ce service, les valeurs sont :

• URL : https://api.nsfwvideo.top/v1
• Clé : celle de la page clé
• Modèle : uncensored, découvert automatiquement via GET /v1/models

Étape par étape : ouvrez les Paramètres d'administration, allez dans Connexions, ajoutez une connexion API OpenAI, collez l'URL et la clé, enregistrez, et choisissez le modèle dans un nouveau chat. Si vous préférez un démarrage par ligne de commande, définissez les variables d'environnement OPENAI_API_BASE_URL et OPENAI_API_KEY lors du lancement du conteneur.

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

Sachez qu'Open WebUI enregistre de nombreux paramètres dans sa base de données au premier démarrage. Si vous modifiez ultérieurement une variable d'environnement et que rien ne se produit, modifiez la connexion dans le panneau d'administration. Le guide de démarrage rapide contient le format de requête que le backend attend si vous souhaitez le vérifier avec curl.

Chaînage des deux

Vous pouvez utiliser les deux directions à la fois. Votre application appelle l'API entrante d'Open WebUI avec une clé Open WebUI, Open WebUI relaie le chat vers le backend que vous avez configuré, et la réponse revient. Cette configuration a du sens dans quelques situations : une équipe exécute déjà Open WebUI avec des comptes et souhaite que des scripts partagent ses préréglages, ou vous voulez un seul endroit qui contient les paramètres de persona pour les humains et les programmes.

Cela ajoute un saut. Chaque requête traverse désormais votre serveur Open WebUI avant d'atteindre l'API du modèle, il y a donc une chose de plus à maintenir, patcher et sécuriser. Les limites de débit s'empilent également de manière peu évidente : la clé du backend autorise 8 requêtes simultanées et 300 par minute pour une clé complète, et chaque utilisateur et script passant par votre instance Open WebUI partage cette allocation. Si le backend répond avec HTTP 429, avec le code d'erreur rate_limited ou concurrency, l'échec apparaîtra généralement comme une erreur dans Open WebUI et chez votre appelant.

Quand sauter Open WebUI et appeler l'API directement

Si tout ce dont vous avez besoin est un script qui génère du texte, comme des esquisses, des descriptions de plans ou des brouillons de narration, Open WebUI est inutile. Ce service est un endpoint compatible OpenAI standard, de sorte que le SDK standard s'y connecte directement.

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)

Les appels directs vous donnent le streaming sur SSE, l'appel de fonctions, le mode JSON et chaque paramètre d'échantillonnage sans couche intermédiaire. Open WebUI est le meilleur choix lorsque vous voulez une interface de chat pour les personnes, avec historique, comptes et préréglages. Un script est le meilleur choix pour le travail par lots. L'API ne produit que du texte : elle ne rend pas de vidéo, d'images ou d'audio, donc pour un projet vidéo, elle fournit les parties écrites telles que les scripts et les prompts pour d'autres outils. La page pipeline vidéo entre dans cet usage.

Un guide de décision rapide

• Vous voulez une interface de chat pour vous ou une équipe : exécutez Open WebUI et ajoutez la connexion sortante.
• Vous voulez que des scripts réutilisent les préréglages ou les comptes d'Open WebUI : utilisez son API entrante avec une clé Open WebUI.
• Vous voulez une génération de texte par lots : appelez l'API du modèle directement avec le SDK OpenAI et sautez la couche supplémentaire.
• Vous voulez des images ou de la voix : ni Open WebUI ni cette API de texte ne les produiront par elles-mêmes. Connectez des outils séparés pour cette étape.

Quelle que soit la voie que vous choisissez, les faits du côté du modèle restent les mêmes : une fenêtre de contexte de 100 000 tokens partagée par le prompt et la réponse, l'appel de fonctions et le mode JSON disponibles, et une règle stricte contre le contenu sexuel impliquant des mineurs.

Notes de sécurité pour l'exposition de l'une ou l'autre API

Traitez les deux clés comme des secrets. La clé Open WebUI accorde tout ce que l'utilisateur créateur peut faire dans votre instance ; la clé API du modèle dépense votre solde prépayé. Ne collez aucune des deux dans du code côté client ou des dépôts publics.

• Mettez Open WebUI derrière HTTPS s'il est accessible au-delà de votre propre machine.
• Créez des clés Open WebUI distinctes par script afin de pouvoir révoquer l'une sans casser les autres.
• Faites tourner la clé API du modèle si elle apparaît dans un journal ou une capture d'écran.
• Surveillez l'en-tête de réponse X-Balance-USD sur le backend pour voir la dépense par appel.

En matière de confidentialité, les prompts envoyés à cette API ne sont pas utilisés pour l'entraînement. Open WebUI lui-même stocke l'historique du chat dans sa propre base de données sur votre serveur, donc vos choix d'hébergement déterminent qui peut lire cela.

Ce que coûte cette configuration

Open WebUI est un logiciel gratuit que vous hébergez ; votre coût est le serveur plus les tokens. Les tokens sont facturés à $0,15 par 1M en entrée et $0,50 par 1M en sortie, à partir d'un crédit prépayé sans abonnement. Effectuez un tour de chat avec 3 000 tokens d'entrée et 500 tokens de sortie : 3 000 x $0,15 / 1M = $0,00045 pour l'entrée et 500 x $0,50 / 1M = $0,00025 pour la sortie, soit un total de $0,0007. Un millier de ces tours coûtent $0,70.

Les recharges sont des montants entiers de 20 $ à 500 $, avec +5 % à partir de 50 $, +10 % à partir de 100 $ et +15 % à partir de 200 $. Le paiement se fait en crypto, USDT sur TRC20 ou USDC sur Base. Les requêtes échouées ou refusées ne sont pas facturées, et le crédit n'expire jamais. Les nouveaux utilisateurs peuvent réclamer un crédit d'essai gratuit de 0,50 $ pendant 7 jours en un clic et sans détails de paiement. Consultez la page des prix pour l'image complète.

Rappel concernant le contenu : le modèle est réglé pour répondre sans refus de contenu pour une utilisation adulte légale, et le contenu sexuel impliquant des mineurs n'est jamais autorisé.

Plus de guides

• API LLM sans censure pour les pipelines vidéo NSFW