Skip to main content

SearchApi

warning

This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.

SearchApi API

SearchApi is a collection of real-time SERP APIs. Any existing or upcoming SERP engine that returns organic_results is supported. The default web search engine is google, but it can be changed to bing, baidu, google_news, bing_news, google_scholar, google_patents, and others.

Setup

  1. Go to SearchApi, and log on or create a new account.
  2. Go to Dashboard and copy the API key.
  3. With API key, open Open WebUI Admin panel and click Settings tab, and then click Web Search.
  4. Enable Web search and set Web Search Engine to searchapi.
  5. Fill SearchApi API Key with the API key that you copied in step 2 from SearchApi dashboard.
  6. [Optional] Enter the SearchApi engine name you want to query. Example, google, bing, baidu, google_news, bing_news, google_videos, google_scholar and google_patents. By default, it is set to google.
  7. Click Save.

Open WebUI Admin panel

Note

You have to enable Web search in the prompt field, using plus (+) button to search the web using SearchApi engines.

enable Web search