[PR #13191] [MERGED] feat: Add Firecrawl search engine #46177

New Issue

GiteaMirror · 2026-04-29T20:52:34-05:00

GiteaMirror commented

2026-04-29 20:52:34 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/13191
Author: @tth37
Created: 4/24/2025
Status: ✅ Merged
Merged: 4/29/2025
Merged by: @tjbck

Base: dev ← Head: feat_firecrawl_search_engine

📝 Commits (1)

92dbeb1 feat: Add Firecrawl search engine

📊 Changes

3 files changed (+91 additions, -1 deletions)

View changed files

➕ backend/open_webui/retrieval/web/firecrawl.py (+49 -0)
📝 backend/open_webui/routers/retrieval.py (+9 -0)
📝 src/lib/components/admin/Settings/WebSearch.svelte (+33 -1)

📄 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

Related discussion: #12209

This PR integrates the Firecrawl Search API as an option for search engine backends.

No additional configuration entries were introduced, as the existing FIRECRAWL_API_KEY and FIRECRAWL_API_BASE_URL (originally used for Firecrawl web loader support) are reused.

Added

retrieval/web/firecrawl.py: Implements the Firecrawl search backend, following the API documentation.
routers/retrieval.py: Adds the firecrawl engine as a backend for search_web.

Changed

WebSearch.svelte:
- Added firecrawl as an engine option.
- Included Firecrawl form data input.
- Disabled the web loader's Firecrawl form data input when the web search engine is set to Firecrawl to avoid conflicts.

Contributor License Agreement

By submitting this pull request, I confirm that I have read and fully agree to the CONTRIBUTOR_LICENSE_AGREEMENT, 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/13191 **Author:** [@tth37](https://github.com/tth37) **Created:** 4/24/2025 **Status:** ✅ Merged **Merged:** 4/29/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `feat_firecrawl_search_engine` --- ### 📝 Commits (1) - [`92dbeb1`](https://github.com/open-webui/open-webui/commit/92dbeb19390023d54faf76880506202279aab262) feat: Add Firecrawl search engine ### 📊 Changes **3 files changed** (+91 additions, -1 deletions) <details> <summary>View changed files</summary> ➕ `backend/open_webui/retrieval/web/firecrawl.py` (+49 -0) 📝 `backend/open_webui/routers/retrieval.py` (+9 -0) 📝 `src/lib/components/admin/Settings/WebSearch.svelte` (+33 -1) </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. - [ ] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources? - [ ] **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 Related discussion: #12209 This PR integrates the Firecrawl Search API as an option for search engine backends. No additional configuration entries were introduced, as the existing `FIRECRAWL_API_KEY` and `FIRECRAWL_API_BASE_URL` (originally used for Firecrawl web loader support) are reused. ### Added - `retrieval/web/firecrawl.py`: Implements the Firecrawl search backend, following the [API documentation](https://docs.firecrawl.dev/features/search). - `routers/retrieval.py`: Adds the `firecrawl` engine as a backend for `search_web`. ### Changed - `WebSearch.svelte`: - Added `firecrawl` as an engine option. - Included Firecrawl form data input. - Disabled the web loader's Firecrawl form data input when the web search engine is set to Firecrawl to avoid conflicts. --- ### Contributor License Agreement By submitting this pull request, I confirm that I have read and fully agree to the [CONTRIBUTOR_LICENSE_AGREEMENT](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>

GiteaMirror added the pull-request label 2026-04-29 20:52:34 -05:00

GiteaMirror closed this issue

2026-04-29 20:52:36 -05:00

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/open-webui#46177