OpenWebUI ha un'API? Sì, in due direzioni

Due API diverse a cui si fa riferimento

Quando qualcuno chiede se Open WebUI ha un'API, potrebbe riferirsi a una delle due direzioni. Confonderle è il motivo principale per cui le guide di configurazione risultano confuse, quindi è utile separarle subito.

• Inbound: il tuo programma invia richieste a Open WebUI. Agisce come server con endpoint per chat, modelli e file, protetti da una chiave API che generi all'interno dell'app.
• Outbound: Open WebUI invia richieste a un server di modello in modo che la sua finestra di chat abbia qualcosa da cui rispondere. Questa è la connessione che configuri nelle Impostazioni amministrative.

Quindi la risposta breve è sì per entrambi. Il progetto documenta un'API con un endpoint di chat in stile OpenAI e supporta la connessione a qualsiasi server che parli il protocollo OpenAI. Dettagli come i percorsi esatti e la gestione delle chiavi possono cambiare tra le versioni, quindi controlla la documentazione per la release che stai utilizzando.

Questo sito fornisce il modello sul lato outbound: un'API di testo ospitata e compatibile con OpenAI con un singolo ID modello uncensored. Non è Open WebUI e non lo esegue per te. Open WebUI è un software che ospiti tu stesso.

Uso della propria API di Open WebUI

Open WebUI permette a un utente che ha effettuato l'accesso di creare una chiave API nelle impostazioni del proprio account. Con quella chiave puoi chiamare i suoi endpoint da script. L'endpoint chat segue la struttura OpenAI, quindi il codice client esistente può spesso essere puntato verso di esso. Il percorso documentato dal progetto al momento della stesura è /api/chat/completions; conferma in base alla tua versione.

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

Nota che qui il nome del modello è quello che Open WebUI ha registrato. Se hai collegato questa API come backend, quel nome è uncensored. La chiave in questa richiesta è una chiave Open WebUI, non la chiave API del modello. Sono due credenziali separate con due compiti separati.

Perché usare l'API in entrata? È utile quando vuoi le funzionalità extra di Open WebUI dietro il tuo programma, come le raccolte di conoscenza memorizzate, i singoli account utente o i preset dei modelli, e desideri accedervi senza un browser.

Uso di un'API esterna come backend

L'altra direzione è quella che la maggior parte delle persone necessita. Open WebUI ha una sezione per le connessioni compatibili con OpenAI dove inserisci un URL e una chiave. Per questo servizio i valori sono:

• URL: https://api.nsfwvideo.top/v1
• Chiave: quella dalla pagina delle chiavi
• Modello: uncensored, scoperto automaticamente tramite GET /v1/models

Passo dopo passo: apri le Impostazioni amministratore, vai su Connessioni, aggiungi una connessione API OpenAI, incolla l'URL e la chiave, salva e scegli il modello in una nuova chat. Se preferisci un avvio da riga di comando, imposta le variabili d'ambiente OPENAI_API_BASE_URL e OPENAI_API_KEY durante l'avvio del container.

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

Tieni presente che Open WebUI salva molte impostazioni nel suo database al primo avvio. Se in seguito modifichi una variabile d'ambiente e non succede nulla, modifica la connessione nel pannello di amministrazione invece. La guida rapida ha il formato della richiesta che il backend si aspetta se vuoi verificarlo con curl.

Concatenazione delle due

Puoi usare entrambe le direzioni contemporaneamente. La tua applicazione chiama l'API in entrata di Open WebUI con una chiave Open WebUI, Open WebUI inoltra la chat al backend che hai configurato e la risposta torna indietro. Questa disposizione ha senso in alcune situazioni: un team esegue già Open WebUI con account e vuole che gli script condividano i suoi preset, o vuoi un unico punto che contenga le impostazioni del personaggio sia per gli umani che per i programmi.

Aggiunge un salto. Ogni richiesta attraversa ora il tuo server Open WebUI prima di raggiungere l'API del modello, quindi c'è un altro componente da mantenere attivo, aggiornare e proteggere. Anche i limiti di richiesta si accumulano in modo poco ovvio: la chiave del backend consente 8 richieste parallele e 300 al minuto per una chiave completa, e ogni utente e script che passa attraverso la tua istanza Open WebUI condivide tale limite. Se il backend risponde con HTTP 429, con codice di errore rate_limited o concurrency, il fallimento di solito si manifesta come un errore in Open WebUI e nel tuo client.

Quando saltare Open WebUI e chiamare l'API direttamente

Se ti serve solo uno script che genera testo, come bozze, descrizioni di scene o narrazioni provvisorie, Open WebUI è inutile. Questo servizio è un endpoint compatibile con OpenAI, quindi l'SDK standard vi si connette direttamente.

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)

Le chiamate dirette ti offrono lo streaming su SSE, la chiamata di funzioni, la modalità JSON e tutti i parametri di campionamento senza uno strato intermedio. Open WebUI è la scelta migliore quando vuoi un'interfaccia chat per le persone, con cronologia, account e preset. Uno script è la scelta migliore per il lavoro in batch. L'API produce solo testo: non renderizza video, immagini o audio, quindi per un progetto video fornisce le parti scritte come script e prompt per altri strumenti. La pagina della pipeline video approfondisce questo caso d'uso.

Guida rapida alle decisioni

• Vuoi una finestra di chat per te o per un team: esegui Open WebUI e aggiungi la connessione outbound.
• Vuoi che gli script riutilizzino i preset o gli account di Open WebUI: usa la sua API inbound con una chiave Open WebUI.
• Vuoi la generazione di testo in batch: chiama direttamente l'API del modello con l'SDK OpenAI e salta lo strato extra.
• Vuoi immagini o voce: né Open WebUI né questa API di testo le produrranno da sole. Collega strumenti separati per quel passaggio.

Qualunque percorso tu scelga, i fatti lato modello restano gli stessi: una finestra di contesto di 100.000 token condivisa da prompt e risposta, chiamata di funzioni e modalità JSON disponibili, e una regola rigida contro i contenuti sessuali che coinvolgono i minorenni.

Note sulla sicurezza per esporre una delle due API

Tratta entrambe le chiavi come segreti. La chiave Open WebUI concede tutto ciò che l'utente che l'ha creata può fare all'interno della tua istanza; la chiave API del modello spende il tuo credito prepagato. Non incollare nessuna delle due nel codice lato client o nei repository pubblici.

• Metti Open WebUI dietro HTTPS se è raggiungibile oltre la tua macchina.
• Crea chiavi Open WebUI separate per ogni script in modo da poter revocarne una senza interrompere le altre.
• Ruota la chiave API del modello se appare mai in un log o in uno screenshot.
• Monitora l'intestazione di risposta X-Balance-USD sul backend per vedere la spesa per chiamata.

Per quanto riguarda la privacy, i prompt inviati a questa API non vengono utilizzati per l'addestramento. Open WebUI memorizza la cronologia delle chat nel proprio database sul tuo server, quindi sono le tue scelte di hosting a determinare chi può leggerla.

Costi di gestione di questa configurazione

Open WebUI è un software gratuito che ospiti; il tuo costo è il server più i token. I token vengono addebitati a $0,15 per 1M di input e $0,50 per 1M di output, dal credito prepagato senza abbonamento. Fai un turno di chat con 3.000 token di input e 500 token di output: 3.000 x $0,15 / 1M = $0,00045 per l'input e 500 x $0,50 / 1M = $0,00025 per l'output, per un totale di $0,0007. Un migliaio di tali turni costano $0,70.

Le ricariche sono qualsiasi importo intero da $20 a $500, con +5% da $50, +10% da $100 e +15% da $200. Il pagamento è in cripto, USDT su TRC20 o USDC su Base. Le richieste fallite o rifiutate non vengono addebitate e il credito non scade mai. I nuovi utenti possono richiedere un periodo di prova di $0,50 per 7 giorni con un clic e senza dettagli di pagamento. Consulta la pagina dei prezzi per il quadro completo.

Un promemoria sui contenuti: il modello è ottimizzato per rispondere senza rifiuti sui contenuti per l'uso adulto lecito, e i contenuti sessuali che coinvolgono minorenni non sono mai consentiti.

Altre guide

• API LLM senza censura per pipeline video NSFW