Recursos para Desenvolvedores

Open WebUI

Instale o Open WebUI, adicione o RunAPI como uma conexão compatível com OpenAI, selecione um modelo e verifique um chat.

Ver Markdown

Conecte o Open WebUI ao RunAPI por meio de sua Conexão compatível com OpenAI. Você precisa de acesso de administrador ao Open WebUI e de uma Chave de API padrão do RunAPI do Guia de Autenticação.

Instalar Open WebUI

Siga o início rápido oficial do Open WebUI para sua plataforma. Para uma instalação local com Docker, a imagem oficial pode ser iniciada com:

SHELL

docker run -d -p 3000:8080 -v open-webui:/app/backend/data --name open-webui ghcr.io/open-webui/open-webui:main

Abra o aplicativo, crie a conta de administrador e faça login antes de adicionar a conexão.

Adicionar a conexão RunAPI

Abra Admin Settings → Connections → OpenAI e selecione Add Connection.
Defina a URL como https://runapi.ai/v1 e insira sua Chave de API do RunAPI.
Deixe Model IDs (Filter) vazio na primeira tentativa de conexão para que o Open WebUI possa descobrir os modelos disponíveis.
Salve a conexão e aguarde a conclusão da verificação.

O Open WebUI envia a verificação de conexão a partir do seu backend e usa GET /v1/models para descoberta. A URL do RunAPI é HTTPS pública, portanto uma instalação Docker não precisa de host.docker.internal para esta conexão.

Selecionar um modelo

Abra um novo chat e selecione um modelo RunAPI no seletor de modelos do chat. Use o Catálogo de Modelos para confirmar o identificador e as capacidades atuais do modelo.

Se a descoberta não preencher o seletor, edite a conexão e adicione o identificador exato em Model IDs (Filter). Um erro de descoberta de modelo e um erro de Chat Completions são sinais separados; teste o modelo adicionado manualmente antes de remover a conexão.

Verificar a conexão

Envie um prompt curto como Reply with the word connected. Uma resposta normal em streaming ou completa confirma que o Open WebUI pode usar o modelo RunAPI selecionado.

Solucionar problemas

A verificação retorna 401 ou 403: substitua a Chave de API na conexão por uma chave padrão válida do Guia de Autenticação.
Nenhum modelo RunAPI aparece: confirme que a URL termina em /v1, adicione um identificador atual em Model IDs (Filter) e tente o chat novamente.
O modelo está visível, mas o chat falha: confirme que o identificador suporta Chat Completions compatível com OpenAI no Catálogo de Modelos e inspecione os logs do backend do Open WebUI para o status da requisição.
Uma URL local funciona no navegador, mas não no Open WebUI: as conexões do Open WebUI se originam do seu backend. Isso não afeta a URL pública https://runapi.ai/v1, mas é relevante para outras conexões locais.

Para o comportamento de protocolo compartilhado, use o Início rápido da API LLM. Para campos de requisição e resposta, use a Referência da API Chat Completions.