[PR #648] [CLOSED] Added Complete API Reference #707

New issue

Closed

opened 2026-10-18 14:14:05 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-18 14:14:05 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/docs/pull/648
Author: @techelpr
Created: 8/9/2025
Status: ❌ Closed

Base: dev ← Head: main

📝 Commits (7)

92b1205 Update gh-pages.yml
37f1aa9 Update docusaurus.config.ts
4305f26 Add files via upload
9b86541 Create .nojekyll
698415a Update docusaurus.config.ts
dfe4411 Create api-reference.md
0da2fe2 Update api-reference.md

📊 Changes

5 files changed (+612 additions, -2 deletions)

View changed files

📝 .github/workflows/gh-pages.yml (+3 -0)
➕ .nojekyll (+1 -0)
➕ docs/getting-started/api-reference.md (+565 -0)
➕ docs/getting-started/quick-start/tab-kubernetes/Kustomize.md (+41 -0)
📝 docusaurus.config.ts (+2 -2)

📄 Description

Apologies if I was supposed to remove those other changes before opening a pull request. I've never actually done this part before, and am kind of new to the GitHub processes. I tried to follow the contribution guide. I commented this in a discussion post on the main open-webui codebase, and was encouraged to submit a PM, so this is my attempt. If I need to change something just let me know! Thanks, and hope this helps out. I know y'all have said that API documentation was not the highest priority right now, but a project I am working on had me going in circles trying to figure out the right way to do certain procedures, so I paused from that and reverse engineered the API as best as I could in a week (A few hours after work each day), and this is what I came up with. Based on the current main branch.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/open-webui/docs/pull/648 **Author:** [@techelpr](https://github.com/techelpr) **Created:** 8/9/2025 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `main` --- ### 📝 Commits (7) - [`92b1205`](https://github.com/open-webui/docs/commit/92b12059deaac40d8e347d5ac841b12c51a523fa) Update gh-pages.yml - [`37f1aa9`](https://github.com/open-webui/docs/commit/37f1aa94a90c3166dac22321a6b0fdc8b36947cb) Update docusaurus.config.ts - [`4305f26`](https://github.com/open-webui/docs/commit/4305f2672d1a1b61c68ae150988d3217c5c12682) Add files via upload - [`9b86541`](https://github.com/open-webui/docs/commit/9b865413f4bff5e5df2cf96801980beeb647acbf) Create .nojekyll - [`698415a`](https://github.com/open-webui/docs/commit/698415a25037c7196266c12fe383536bd3ac4bac) Update docusaurus.config.ts - [`dfe4411`](https://github.com/open-webui/docs/commit/dfe4411fd5e5eb9c217ca62ebd68164f4f766897) Create api-reference.md - [`0da2fe2`](https://github.com/open-webui/docs/commit/0da2fe22e7c78953d8887d7228698ab3f96ecb48) Update api-reference.md ### 📊 Changes **5 files changed** (+612 additions, -2 deletions) <details> <summary>View changed files</summary> 📝 `.github/workflows/gh-pages.yml` (+3 -0) ➕ `.nojekyll` (+1 -0) ➕ `docs/getting-started/api-reference.md` (+565 -0) ➕ `docs/getting-started/quick-start/tab-kubernetes/Kustomize.md` (+41 -0) 📝 `docusaurus.config.ts` (+2 -2) </details> ### 📄 Description Apologies if I was supposed to remove those other changes before opening a pull request. I've never actually done this part before, and am kind of new to the GitHub processes. I tried to follow the contribution guide. I commented this in a discussion post on the main open-webui codebase, and was encouraged to submit a PM, so this is my attempt. If I need to change something just let me know! Thanks, and hope this helps out. I know y'all have said that API documentation was not the highest priority right now, but a project I am working on had me going in circles trying to figure out the right way to do certain procedures, so I paused from that and reverse engineered the API as best as I could in a week (A few hours after work each day), and this is what I came up with. Based on the current main branch. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-18 14:14:05 +00:00