A comprehensive API integration for managing LLMs, RAG workflows, and Ollama operations through an Open WebUI instance.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install open-webui
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install open-webui using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is Open WebUI API Integration?
The Open WebUI API skill is a professional-grade integration designed to connect AI agents with Open WebUI instances. As a core component of the Openclaw Skills ecosystem, it provides a unified interface for interacting with diverse LLM providers, including Ollama and OpenAI. This skill enables developers to automate model management, facilitate complex chat interactions, and orchestrate retrieval-augmented generation without leaving their development environment.
By utilizing this skill, users gain programmatic control over their Open WebUI environment, allowing for the seamless upload of documents to knowledge bases and the execution of proxy commands for model maintenance. It serves as a vital bridge for those looking to extend their agent's capabilities within the Openclaw Skills framework, ensuring robust and secure communication with local or remote AI infrastructure.
Open WebUI API Integration Use Cases
- Listing and selecting available LLM models from an Open WebUI instance
- Sending structured chat completions and prompts to specific models
- Uploading PDF and text documents for Retrieval Augmented Generation (RAG) processing
- Creating and managing knowledge collections for organized document retrieval
- Executing Ollama proxy operations such as pulling, deleting, or listing active models
- Generating images and processing audio via Open WebUI integrated services
How Open WebUI API Integration Works
- Configuration Validation: The skill checks for the presence of the OPENWEBUI_URL and OPENWEBUI_TOKEN environment variables to establish a secure connection.
- Endpoint Mapping: Based on the user's intent, the skill identifies the correct REST API endpoint, such as /api/models for discovery or /api/chat/completions for interaction.
- Request Execution: The agent invokes the openwebui-cli.py script or sends a direct curl request with the necessary headers and payload.
- Response Parsing: The skill parses the JSON response from the server, handling success states or reporting specific HTTP errors like 401 Unauthorized or 404 Not Found to the user.
- Post-Processing: For tasks like RAG, the skill can poll for processing status to ensure files are ready before they are added to knowledge bases within the Openclaw Skills workflow.
Open WebUI API Integration Setup
To integrate this skill into your Openclaw Skills setup, ensure you have Python 3.8+ installed and configure your environment variables as follows:
# Set your Open WebUI instance details
export OPENWEBUI_URL="http://localhost:3000"
export OPENWEBUI_TOKEN="your-api-key-from-settings"
You can then test the integration using the provided CLI tool:
# List all available models
python3 scripts/openwebui-cli.py models list
# Send a test chat message
python3 scripts/openwebui-cli.py chat --model llama3.2 --message "Hello world"
Open WebUI API Integration Data Schema & Taxonomy
The skill organizes interactions across four primary functional areas, summarized in the table below. This structure ensures that Openclaw Skills can navigate the Open WebUI API efficiently:
| Category | Primary Endpoints | Data Format |
|---|---|---|
| Chat & Models | /api/chat/completions, /api/models | OpenAI-Compatible JSON |
| Ollama Proxy | /ollama/api/tags, /ollama/api/pull | Native Ollama JSON |
| RAG & Files | /api/v1/files/, /api/v1/knowledge/ | Multipart Form-Data / JSON |
| Media | /api/v1/images/generations, /api/v1/audio/ | JSON / Binary Stream |
Open WebUI API Integration Advanced Features
- Asynchronous file processing polling to prevent race conditions during RAG operations
- Real-time streaming support for chat completions for low-latency feedback
- Automated model lifecycle management, including downloading and unloading models via Ollama proxy
- Comprehensive error handling and redaction of sensitive tokens for secure logging within Openclaw Skills
- Multi-modal support for DALL-E image generation and Whisper-based audio transcriptions
- Pipeline management capabilities for complex multi-stage AI workflows
SKILL.md
Loading
Related Openclaw Skills
Kimai Time Tracking
A complete API integration for Kimai to manage timesheets, projects, customers, and invoices directly through your AI agent.
Coda API Skill
A comprehensive Python-based tool for managing Coda documents, tables, rows, and automations via the REST API v1.
Coda Packs Management
A specialized tool for managing Coda Pack shells and metadata through the official Coda REST API v1.
ohmytoken
A real-time AI spending tracker that visualizes LLM token consumption as interactive, customizable pixel art bead boards.
Game Light Tracker
A smart home automation skill that changes Philips Hue light colors in real-time based on live sports score leads.
Sameer Gupta - DevOps & Cloud Infrastructure Expert
A professional-grade skill set for managing cloud-native infrastructure, Kubernetes orchestration, and immutable system design.
Featured*
