Pipelines: UI-Agnostic OpenAI API Plugin Framework

Welcome to Pipelines, an Open WebUI initiative. Pipelines bring modular, customizable workflows to any UI client supporting OpenAI API specs – and much more! Easily extend functionalities, integrate unique logic, and create dynamic workflows with just a few lines of code.

🚀 Why Choose Pipelines?

• Seamless Integration: Compatible with any UI/client supporting OpenAI API specs.
• Limitless Possibilities: Easily add custom logic and integrate Python libraries, from AI agents to home automation APIs.
• Custom Hooks: Build and integrate custom pipelines.

🔧 How It Works

Integrating Pipelines with any OpenAI API-compatible UI client is simple. Launch your Pipelines instance and set the OpenAI URL on your client to the Pipelines URL. That's it! You're ready to leverage any Python library for your needs.

⚡ Quick Start with Docker

Warning

Pipelines are a plugin system with arbitrary code execution — don't fetch random pipelines from sources you don't trust.

For a streamlined setup using Docker:

1. Run the Pipelines container:

   docker run -d -p 9099:9099 -v pipelines:/app/pipelines --name pipelines --restart always ghcr.io/open-webui/pipelines:main

2. Connect to Open WebUI:

   • Navigate to the Settings > Connections > OpenAI API section in Open WebUI.
   • Set the API URL to http://localhost:9099 and the API key to 0p3n-w3bu!. Your pipelines should now be active.

3. Manage Configurations:

   • In the admin panel, go to Admin Settings > Pipelines tab.
   • Select your desired pipeline and modify the valve values directly from the WebUI.

If you need to install a custom pipeline with additional dependencies:

• Run the following command:

  docker run -d -p 9099:9099 -e PIPELINES_PATH="https://github.com/open-webui/pipelines/blob/main/examples/filters/detoxify_filter_pipeline.py" -v pipelines:/app/pipelines --name pipelines --restart always ghcr.io/open-webui/pipelines:main

Alternatively, you can directly install pipelines from the admin settings by copying and pasting the pipeline URL, provided it doesn't have additional dependencies.

That's it! You're now ready to build customizable AI integrations effortlessly with Pipelines. Enjoy!

📦 Installation and Setup

Get started with Pipelines in a few easy steps:

1. Ensure Python 3.11 is installed.

2. Clone the Pipelines repository:

   git clone https://github.com/open-webui/pipelines.git
   cd pipelines

3. Install the required dependencies:

   pip install -r requirements.txt

4. Start the Pipelines server:

   sh ./start.sh

Once the server is running, set the OpenAI URL on your client to the Pipelines URL. This unlocks the full capabilities of Pipelines, integrating any Python library and creating custom workflows tailored to your needs.

📂 Directory Structure and Examples

The /pipelines directory is the core of your setup. Add new modules, customize existing ones, and manage your workflows here. All the pipelines in the /pipelines directory will be automatically loaded when the server launches.

Integration Examples

Find various integration examples in the /pipelines/examples directory. These examples show how to integrate different functionalities, providing a foundation for building your own custom pipelines.

🎉 Work in Progress

We’re continuously evolving! We'd love to hear your feedback and understand which hooks and features would best suit your use case. Feel free to reach out and become a part of our Open WebUI community!

Our vision is to push Pipelines to become the ultimate plugin framework for our AI interface, Open WebUI. Imagine Open WebUI as the WordPress of AI interfaces, with Pipelines being its diverse range of plugins. Join us on this exciting journey! 🌍