0ffce3f feat: Enable tool calling for custom models via API
📊 Changes
1 file changed (+187 additions, -8 deletions)
View changed files
📝backend/open_webui/utils/middleware.py (+187 -8)
📄 Description
Pull Request Checklist
Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.
Before submitting, make sure you've checked the following:
Target branch: Please verify that the pull request targets the dev branch.
Description: Provide a concise description of the changes made in this pull request.
Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
Documentation: Have you updated relevant documentation Open WebUI Docs, or other documentation sources?
Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
Testing: Have you written and run sufficient tests to validate the changes?
Code review: Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
Prefix: To clearly categorize this pull request, prefix the pull request title using one of the following:
BREAKING CHANGE: Significant changes that may affect compatibility
build: Changes that affect the build system or external dependencies
ci: Changes to our continuous integration processes or workflows
chore: Refactor, cleanup, or other non-functional code changes
docs: Documentation update or addition
feat: Introduces a new feature or enhancement to the codebase
fix: Bug fix or error correction
i18n: Internationalization or localization changes
perf: Performance improvement
refactor: Code restructuring for better maintainability, readability, or scalability
style: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.)
test: Adding missing tests or correcting existing tests
WIP: Work in progress, a temporary label for incomplete or ongoing work
Changelog Entry
Description
This change enables the use of tools defined on custom models when making requests via the API. Previously, tool-calling functionality was only available when interacting with custom models through the web interface, creating an inconsistency in behavior. This PR resolves that gap by ensuring the server-side API handler correctly identifies and executes tools associated with a custom model during an API call.
Added
Support for tool execution on custom models when called from the API
Changed
The API middle ware handler logic has been updated to load and run tools defined in a custom model's configuration.
By submitting this pull request, I confirm that I have read and fully agree to the Contributor License Agreement (CLA), and I am providing my contributions under its terms.
🔄 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/open-webui/pull/15733
**Author:** [@csanz91](https://github.com/csanz91)
**Created:** 7/15/2025
**Status:** ❌ Closed
**Base:** `dev` ← **Head:** `run_custom_models_tools_on_api_requests`
---
### 📝 Commits (1)
- [`0ffce3f`](https://github.com/open-webui/open-webui/commit/0ffce3f83431673205971615cd5b45327fe9397c) feat: Enable tool calling for custom models via API
### 📊 Changes
**1 file changed** (+187 additions, -8 deletions)
<details>
<summary>View changed files</summary>
📝 `backend/open_webui/utils/middleware.py` (+187 -8)
</details>
### 📄 Description
# Pull Request Checklist
### Note to first-time contributors: Please open a discussion post in [Discussions](https://github.com/open-webui/open-webui/discussions) and describe your changes before submitting a pull request.
**Before submitting, make sure you've checked the following:**
- [x] **Target branch:** Please verify that the pull request targets the `dev` branch.
- [x] **Description:** Provide a concise description of the changes made in this pull request.
- [x] **Changelog:** Ensure a changelog entry following the format of [Keep a Changelog](https://keepachangelog.com/) is added at the bottom of the PR description.
- [x] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources?
- [x] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation?
- [x] **Testing:** Have you written and run sufficient tests to validate the changes?
- [x] **Code review:** Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
- [x] **Prefix:** To clearly categorize this pull request, prefix the pull request title using one of the following:
- **BREAKING CHANGE**: Significant changes that may affect compatibility
- **build**: Changes that affect the build system or external dependencies
- **ci**: Changes to our continuous integration processes or workflows
- **chore**: Refactor, cleanup, or other non-functional code changes
- **docs**: Documentation update or addition
- **feat**: Introduces a new feature or enhancement to the codebase
- **fix**: Bug fix or error correction
- **i18n**: Internationalization or localization changes
- **perf**: Performance improvement
- **refactor**: Code restructuring for better maintainability, readability, or scalability
- **style**: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.)
- **test**: Adding missing tests or correcting existing tests
- **WIP**: Work in progress, a temporary label for incomplete or ongoing work
# Changelog Entry
### Description
This change enables the use of tools defined on custom models when making requests via the API. Previously, tool-calling functionality was only available when interacting with custom models through the web interface, creating an inconsistency in behavior. This PR resolves that gap by ensuring the server-side API handler correctly identifies and executes tools associated with a custom model during an API call.
### Added
Support for tool execution on custom models when called from the API
### Changed
The API middle ware handler logic has been updated to load and run tools defined in a custom model's configuration.
### Deprecated
N/A
### Removed
N/A
### Fixed
N/A
### Security
N/A
### Breaking Changes
N/A
---
### Additional Information
#14925
### Screenshots or Videos
N/A
### Contributor License Agreement
By submitting this pull request, I confirm that I have read and fully agree to the [Contributor License Agreement (CLA)](/CONTRIBUTOR_LICENSE_AGREEMENT), and I am providing my contributions under its terms.
---
<sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
📋 Pull Request Information
Original PR: https://github.com/open-webui/open-webui/pull/15733
Author: @csanz91
Created: 7/15/2025
Status: ❌ Closed
Base:
dev← Head:run_custom_models_tools_on_api_requests📝 Commits (1)
0ffce3ffeat: Enable tool calling for custom models via API📊 Changes
1 file changed (+187 additions, -8 deletions)
View changed files
📝
backend/open_webui/utils/middleware.py(+187 -8)📄 Description
Pull Request Checklist
Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.
Before submitting, make sure you've checked the following:
devbranch.Changelog Entry
Description
This change enables the use of tools defined on custom models when making requests via the API. Previously, tool-calling functionality was only available when interacting with custom models through the web interface, creating an inconsistency in behavior. This PR resolves that gap by ensuring the server-side API handler correctly identifies and executes tools associated with a custom model during an API call.
Added
Support for tool execution on custom models when called from the API
Changed
The API middle ware handler logic has been updated to load and run tools defined in a custom model's configuration.
Deprecated
N/A
Removed
N/A
Fixed
N/A
Security
N/A
Breaking Changes
N/A
Additional Information
#14925
Screenshots or Videos
N/A
Contributor License Agreement
By submitting this pull request, I confirm that I have read and fully agree to the Contributor License Agreement (CLA), and I am providing my contributions under its terms.
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.