Skip to main content
The Web Search action lets your Agents query the internet and retrieve real-time information from web sources. Web Search has two parts:
  • A search engine finds result URLs, snippets, and metadata for a query.
  • A web crawler reads the full contents of result pages and of links the user pastes into the chat.

Web Search in Onyx

Setup is the same on Onyx Cloud and self-hosted deployments. The built-in Onyx web crawler works by default, so users can paste a link into the chat and Onyx reads the page. The web search action does not appear in chat until an admin connects a search engine and sets it as the default.
1

Set up a search engine

Open Admin Panel → Web Search. In Search Engine, click Connect on a provider and enter its credentials. Onyx tests the connection before it saves.Web Search page in the Onyx Admin PanelSearch Engine providers
Create an API key in the Exa dashboard and paste it in the API Key field.Onyx also saves this key for the Exa web crawler, so you only need to select it there.
2

Set up a web crawler

The Web Crawler section lists the supported crawlers.Web Crawler providers
(Recommended) The built-in crawler. It is selected by default and needs no setup. It works for most pages but can be less reliable on complex sites.
3

Set the default providers

Click Set as Default on the search engine you want to use. Only one search engine is active at a time. Other connected providers stay available but are not used until you select them.The crawler marked Current Crawler reads result pages. If you disconnect the current crawler, Onyx falls back to the Onyx Web Crawler.Set as Default on a search engine

Enable Web Search for Agents

  • Default Chat: Go to Admin Panel > Chat Preferences > Actions & Tools and turn on Web Search.
  • Custom Agents: In the Agent editor, open Actions and turn on Web Search. Keep Open URL on as well. Without it, the Agent cannot read the pages it finds, and web results are much worse.
Users can turn Web Search off for a single message from the Actions menu in the chat input. Links the user pastes still resolve if the page is already indexed by a connector.