Are you looking to integrate your Open WebUI setup into your custom workflows? Whether you are building sophisticated automation scripts, connecting your favorite IDE, or bridging Open WebUI with other tools, the API is your gateway to a much more powerful ecosystem.
In this post, I’ll walk you through the quick and easy process of generating an API key in Open WebUI version v0.11.3.
Why API Access Matters
For power users and developers, the web interface is just the beginning. API access allows you to:
- Automate repetitive tasks using Java or shell scripts.
- Integrate with third-party applications like custom dashboards or internal tools.
- Programmatically interact with your LLM configurations.
Prerequisites
- You must have Administrator privileges on the Open WebUI instance.
- Ensure you are running Open WebUI version v0.11.3.
Step-by-Step Guide to Generating Your API Key
Follow these simple steps to get your credentials:
1. Log in as an Administrator
Access your Open WebUI instance via your browser and log in using an account with administrative permissions.
2. Navigate to Settings
Once logged in, look at the bottom-left corner of the interface. Click on your User Profile Icon. From the pop-up menu, select Settings.
3. Access the Account Section
In the Settings modal/page, look for the Account tab on the sidebar.
4. Locate API Keys
Within the Account section, you will see a dedicated option labeled API keys. Click on this to view the management area for your credentials.
5. Create and Copy Your Key
- Click the button to create a new API key.
- Important: Once the key is generated, copy it immediately. For security reasons, many systems only show the full key once.
- Store this key in a secure location (like a password manager or an environment variable).
How to Use It
Now that you have your key, you can include it in the header of your API requests. Typically, you will use it in an Authorization header like this:
Authorization: Bearer YOUR_API_KEY_HERE
A Quick Security Reminder
Your API key is as sensitive as your password. Since this key grants programmatic access to your Open WebUI instance, never hardcode it in public repositories and ensure your automation environments are properly secured.
Happy automating!