Skip to content

Commit b49aab7

Browse files
committed
doc: functions
1 parent d697511 commit b49aab7

7 files changed

Lines changed: 94 additions & 0 deletions

File tree

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
sidebar_position: 5
3+
title: "πŸ”Œ Getting Started with Functions"
4+
---
5+
6+
## Overview
7+
8+
Did you know Open WebUI can connect to almost **anything**β€”not just OpenAI-compatible APIs?
9+
10+
Thanks to **Pipe Functions**, you can bring in services that don’t support the OpenAI API (like **Anthropic**, Home Assistant, Google Search, or *any* Python codebase). No restrictions on LLMs or AI models: if you can automate it in Python, you can turn it into a plugin for Open WebUI!
11+
12+
This guide walks you through setting up your first Pipe Function, using the [Anthropic Pipe](https://openwebui.com/f/justinrahb/anthropic) plugin as an example.
13+
14+
## What are Pipe Functions?
15+
16+
Pipe Functions are β€œbring-your-own-model (or tool)” plugins:
17+
18+
- **Act like models**: They show up as selectable models in your Open WebUI sidebar.
19+
- **Flexible**: Integrate with *any* backend, API, or workflowβ€”no OpenAI compatibility required.
20+
- **No LLM required**: You can build plugins for search, home automation, weather, databases, or whatever you like.
21+
- **Pure Python**: All logic is Python code that runs *directly inside* your WebUI (so be cautious with what you enable!).
22+
23+
## Step 1: Find a Pipe Function to Try
24+
25+
Let’s integrate **Anthropic** with Open WebUIβ€”even though Anthropic only supports its own native API (not OpenAI-compatible endpoints)!
26+
27+
1. Go to the [Anthropic Chat function page](https://openwebui.com/f/justinrahb/anthropic).
28+
29+
2. Click **Get**.
30+
31+
![Anthropic Pipe Function Page](/images/getting-started/pipe-anthropic-function.png)
32+
33+
## Step 2: Import the Function to Open WebUI
34+
35+
A modal will appear:
36+
37+
1. Enter your Open WebUI URL (e.g., `http://localhost:3000`) in the prompt.
38+
2. Click **Import to Open WebUI**.
39+
40+
![Import Modal Screenshot](/images/getting-started/pipe-import-modal.png)
41+
42+
You’ll be redirected **directly to the Functions Editor** within your running instance of Open WebUI.
43+
44+
## Step 3: Review & Save
45+
46+
- You’ll see all of the Pipe Function’s Python code and configuration.
47+
- **Important:** Functions run arbitrary Python! Review the code for safety, and only install from sources you trust.
48+
- If you’re happy with the code, click **Save** to add it to your instance.
49+
50+
![Function Editor Screenshot](/images/getting-started/pipe-function-editor.png)
51+
52+
53+
## Step 4: Enable the Function
54+
55+
Your new Pipe Function is now available, but **must be enabled**:
56+
57+
1. Switch the toggler to enable the function.
58+
59+
![Enable Function Screenshot](/images/getting-started/pipe-enable.png)
60+
61+
## Step 5: Enter any Required API Keys via Valves
62+
63+
Some functions need credentials (like Anthropic’s API key):
64+
65+
1. Click on the Gear icon next to the switch to open the **Valves** configuration.
66+
2. Input your required API key(s) for the Pipe Function.
67+
68+
![Valves/API Key Screenshot](/images/getting-started/pipe-valves.png)
69+
70+
## Step 6: Start Using Your New Plugin!
71+
72+
- The new function now appears as a selectable β€œmodel” in the chat interface.
73+
- Select `Anthropic` (or whatever you installed), and start chatting!
74+
75+
![Select Pipe Function as Model Screenshot](/images/getting-started/pipe-select-model.png)
76+
77+
## πŸŽ‰ That’s Itβ€”You’re Plugged Into Anything!
78+
79+
- Pipe Functions open Open WebUI to *any* API, model, or automationβ€”not just OpenAI-compatible endpoints.
80+
- Think beyond LLMs: Integrate tools, APIs, local scripts, or your entire smart home.
81+
82+
## ⚠️ Security Notes
83+
84+
- **Always** review function code before enabling.
85+
- Only use plugins from trusted sources.
86+
- You have the power to enhance (or break!) your WebUIβ€”use responsibly.
87+
88+
### Next Steps & Learn More
89+
90+
- [Pipe Functions Guide](https://docs.openwebui.com/features/plugin/functions/pipe)
91+
- [Browse community functions](https://openwebui.com/functions)
92+
93+
94+
πŸš€ With Pipe Functions, your Open WebUI is limited *only by your imagination*!
111 KB
Loading
41.2 KB
Loading
116 KB
Loading
81.6 KB
Loading
47.2 KB
Loading
40 KB
Loading

0 commit comments

Comments
Β (0)