Skip to content

Include api access OpenWebUI #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ShaivanBhagat wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Include api access OpenWebUI #124

Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
21ec2f1
include ollama manual
ShaivanBhagat Mar 28, 2026
aac0201
Apply suggestions
ShaivanBhagat Apr 1, 2026
6c0d04e
update ollama
ShaivanBhagat Apr 2, 2026
4d19b56
include suggestions
ShaivanBhagat Apr 11, 2026
a54ddf7
include api access
ShaivanBhagat Apr 16, 2026
d301cc5
Merge branch 'main' into include-ollama
ShaivanBhagat Apr 16, 2026
280a8c5
include suggestion
ShaivanBhagat Apr 23, 2026
39dc585
include http
ShaivanBhagat Apr 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions docs/workspaces/utility/ollama-open-webui.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,38 @@ Open WebUI supports **Functions** that allow you to customize and extend how mod
Do you want to use Ollama models from within Python code? Check out the [Ollama from Python manual](../../manuals/ollama.qmd) for instructions on setting up Ollama in Python workbench and UU VRE workspaces.
:::

## Using API Keys

If you want to interact with your Ollama models programmatically from scripts or applications instead of only using the web interface, you can enable API access.

You can use the [Open WebUI API keys](https://docs.openwebui.com/features/authentication-access/api-keys) to:

- Automate model interactions from scripts
- Integrate Ollama into data processing pipelines
- Batch process multiple documents
- Build custom applications using your models

### Enabling API Access

Open WebUI API is disabled by default, however you can enable it during the last step of creating your workspace.
Comment thread
ShaivanBhagat marked this conversation as resolved.
Outdated

Under Workspace Parameters, you can enable API access by entering **`yes`** in the **"Expose OpenWebUI API (yes/no)"** parameter

::: {.callout-tip}
Only enable the API if you need programmatic access. Exposing Open WebUI API bypasses SRAM authentication and uses API keys for security instead.
:::

### Setting Up and Using API Keys

To see how to create and set up an API Key, follow this manual: [Open WebUI API Keys Manual](https://docs.openwebui.com/features/authentication-access/api-keys#getting-started)

**API Endpoint:** The API is accessible at `https://your-workspace-url/ext/api` (Note: uses `/ext/api`, not `/api`)

Additional documentation on Open WebUI API access can be found here: [Open WebUI API Documentation](https://github.com/UtrechtUniversity/src-component-openwebui?tab=readme-ov-file#api)
Copy link
Copy Markdown
Member

@dometto dometto Apr 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe could add note or callout here, indicating that you can also add HTTP basic authentication (linking to the component docs for that is fine). This note or callout could be marked as for advanced users.


::: {.callout-important}
Do not share your API keys with anyone, and do not expose them in public code repositories. Treat them like passwords to prevent unauthorized access to your models and data.
:::


::: {.callout-tip}
Expand Down