A OpenWebUI tem uma API? Sim, em duas direções

Duas APIs diferentes às quais as pessoas se referem

Quando alguém pergunta se o Open WebUI tem uma API, pode estar se referindo a uma de duas direções. Confundi-las é o principal motivo pelo qual os guias de configuração parecem confusos, então ajuda separá-las primeiro.

• Entrada: seu programa envia requisições para o Open WebUI. Ele atua como um servidor com endpoints para chat, modelos e arquivos, protegido por uma chave de API que você gera dentro do aplicativo.
• Saída: O Open WebUI envia requisições para um servidor de modelos para que sua janela de chat tenha com quem conversar. Esta é a conexão que você configura em Configurações do Administrador.

Então a resposta curta é sim para ambos. O projeto documenta uma API com um endpoint de chat no estilo OpenAI e suporta a conexão com qualquer servidor que implemente o protocolo OpenAI. Detalhes como caminhos exatos e manipulação de chaves podem mudar entre versões, então verifique a documentação da versão que você executa.

Este site fornece o modelo no lado do envio: uma API de texto hospedada e compatível com OpenAI com o único ID de modelo uncensored. Não é o Open WebUI e não o executa para você. O Open WebUI é um software que você hospeda sozinho.

Usando a API própria da Open WebUI

O Open WebUI permite que um usuário conectado crie uma chave de API nas configurações da sua conta. Com essa chave, você pode chamar seus endpoints via scripts. O endpoint de chat segue o formato OpenAI, então o código de cliente existente muitas vezes pode ser apontado para ele. A rota documentada pelo projeto no momento da escrita é /api/chat/completions; confirme contra a sua versão.

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

Observe que, aqui, o nome do modelo é qualquer modelo que o Open WebUI tenha registrado. Se você conectou esta API como o backend, esse nome é uncensored. A chave nesta requisição é uma chave do Open WebUI, não a chave de API do modelo. São duas credenciais separadas com duas funções separadas.

Por que usar a API de recebimento? É útil quando você quer os recursos adicionais do Open WebUI atrás do seu programa, como suas coleções de conhecimento armazenadas, suas contas por usuário ou seus predefinidos de modelo, e você gostaria de acessá-los sem um navegador.

Usando uma API externa como backend

A outra direção é a que a maioria das pessoas precisa. A Open WebUI tem uma seção para conexões compatíveis com OpenAI onde você insere uma URL e uma chave. Para este serviço, os valores são:

• URL: https://api.nsfwvideo.top/v1
• Chave: a da página de chaves
• Modelo: uncensored, descoberto automaticamente através de GET /v1/models

Passo a passo: abra Configurações do Admin, vá para Conexões, adicione uma conexão de API OpenAI, cole a URL e a chave, salve e escolha o modelo em um novo chat. Se você preferir começar pela linha de comando, defina as variáveis de ambiente OPENAI_API_BASE_URL e OPENAI_API_KEY ao iniciar o 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

Esteja ciente de que o Open WebUI salva muitas configurações em seu banco de dados na primeira inicialização. Se você alterar uma variável de ambiente depois e nada acontecer, edite a conexão no painel de administração. O início rápido tem o formato de requisição que o backend espera se você quiser verificá-lo com curl.

Encadeando os dois

Você pode usar ambas as direções ao mesmo tempo. Seu aplicativo chama a API de entrada da Open WebUI com uma chave da Open WebUI, a Open WebUI encaminha o chat para o backend que você configurou e a resposta volta. Essa configuração faz sentido em algumas situações: uma equipe já executa a Open WebUI com contas e quer que scripts compartilhem seus presets, ou você quer um único lugar que contenha configurações de persona para humanos e programas.

Adiciona uma parada. Cada solicitação agora cruza seu servidor Open WebUI antes de alcançar a API do modelo, então há mais uma coisa para manter em execução, corrigir e proteger. Os limites de taxa também se empilham de maneira não óbvia: a chave do backend permite 8 requisições simultâneas e 300 por minuto para uma chave completa, e cada usuário e script que passa pela sua instância Open WebUI compartilha essa cota. Se o backend responder com HTTP 429, com código de erro rate_limited ou concurrency, a falha geralmente aparecerá como um erro na Open WebUI e no seu chamador.

Quando pular a Open WebUI e chamar a API diretamente

Se tudo o que você precisa é de um script que gera texto, como esboços, descrições de cenas ou narração em rascunho, a Open WebUI é desnecessária. Este serviço é um endpoint compatível com OpenAI normal, então o SDK padrão fala com ele diretamente.

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)

Chamadas diretas dão a você streaming sobre SSE, chamada de funções, modo JSON e todos os parâmetros de amostragem sem uma camada intermediária. A Open WebUI é a melhor escolha quando você quer uma interface de chat para pessoas, com histórico, contas e presets. Um script é a melhor escolha para trabalho em lote. A API produz apenas texto: não renderiza vídeo, imagens ou áudio, então para um projeto de vídeo ela fornece as partes escritas como roteiros e prompts para outras ferramentas. A página do pipeline de vídeo entra nesse uso.

Um guia rápido de decisão

• Você quer uma janela de chat para você ou uma equipe: execute a Open WebUI e adicione a conexão de saída.
• Você quer que scripts reutilizem presets ou contas da Open WebUI: use sua API de entrada com uma chave da Open WebUI.
• Você quer geração de texto em lote: chame a API do modelo diretamente com o SDK OpenAI e pule a camada extra.
• Você quer imagens ou voz: nem a Open WebUI nem esta API de texto as produzirão sozinhas. Conecte ferramentas separadas para essa etapa.

Qualquer que seja o caminho que você escolher, os fatos do lado do modelo permanecem os mesmos: uma janela de contexto de 100.000 tokens compartilhada por prompt e resposta, chamada de funções e modo JSON disponíveis, e uma regra rígida contra conteúdo sexual envolvendo menores de idade.

Notas de segurança para expor qualquer API

Trate ambas as chaves como segredos. A chave da Open WebUI concede tudo o que o usuário que a criou pode fazer dentro da sua instância; a chave da API do modelo gasta seu crédito pré-pago. Não cole nenhuma delas em código do lado do cliente ou repositórios públicos.

• Coloque a Open WebUI atrás de HTTPS se ela for acessível além da sua própria máquina.
• Crie chaves separadas da Open WebUI por script para que você possa revogar uma sem quebrar as outras.
• Gire a chave da API do modelo se ela aparecer em um log ou captura de tela.
• Observe o cabeçalho de resposta X-Balance-USD no backend para ver o gasto por chamada.

Sobre privacidade, prompts enviados para esta API não são usados para treinamento. A própria Open WebUI armazena o histórico de chat em seu próprio banco de dados em seu servidor, então suas escolhas de hospedagem determinam quem pode ler isso.

Quanto custa executar esta configuração

A Open WebUI é um software gratuito que você hospeda; seu custo é o servidor mais os tokens. Os tokens são cobrados a $0,15 por 1M de entrada e $0,50 por 1M de saída, a partir de crédito pré-pago sem assinatura. Faça uma rodada de chat com 3.000 tokens de entrada e 500 tokens de saída: 3.000 x $0,15 / 1M = $0,00045 para entrada e 500 x $0,50 / 1M = $0,00025 para saída, um total de $0,0007. Mil rodadas assim custam $0,70.

Recargas são qualquer valor inteiro de $20 a $500, com +5% de $50, +10% de $100 e +15% de $200. O pagamento é por cripto, USDT na TRC20 ou USDC na Base. Solicitações falhas ou recusadas não são cobradas, e o crédito nunca expira. Novos usuários podem reivindicar uma trial de $0,50 por 7 dias com um clique e sem detalhes de pagamento. Veja a página de preços para o panorama completo.

Um lembrete sobre o conteúdo: o modelo é ajustado para responder sem recusas de conteúdo para uso adulto legal, e conteúdo sexual envolvendo menores de idade nunca é permitido.

Mais guias

• API LLM sem censura para pipelines de vídeo NSFW