> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onyx.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Web Search

> Enable web search capabilities for your AI Agents in Onyx

The web search action allows your Agents to query the internet and retrieve real-time information from web sources.

## Web Search in Onyx

### On Onyx Cloud

Web search is already active and ready to use on Onyx Cloud - no additional configuration required!

### Self-Hosted

<Steps>
  <Step title="Naivigate to the Web Search Dashboard">
    Click your user profile icon and select Admin Panel and select the Web Search tab in the sidebar.

    <img className="rounded-image" src="https://mintcdn.com/danswer/uSkKTfhzLzI7ngUH/assets/admins/actions/web_search/web_search.png?fit=max&auto=format&n=uSkKTfhzLzI7ngUH&q=85&s=95e0cb87e6ddd2ff66edea7421f12241" alt="Web Search dashboard in Onyx Admin Panel" width="2516" height="1440" data-path="assets/admins/actions/web_search/web_search.png" />
  </Step>

  <Step title="Set up web search providers">
    We currently support the following web search providers: Exa AI, Serper, and Google PSE. To set any ofthem up,
    follow the steps below.

    <img className="rounded-image" src="https://mintcdn.com/danswer/uSkKTfhzLzI7ngUH/assets/admins/actions/web_search/search_engines.png?fit=max&auto=format&n=uSkKTfhzLzI7ngUH&q=85&s=6836aca26bbd67e1e1975e6a422dd688" alt="Search Engine Providers" width="1910" height="650" data-path="assets/admins/actions/web_search/search_engines.png" />

    <Tabs tabs={["Exa AI", "Serper", "Google PSE"]}>
      <Tab title="Exa AI">
        Create an Exa API key in the [Exa AI dashboard](https://exa.ai/dashboard).

        In Onyx, click **Connect** and paste the API key in the **API Key** field.
      </Tab>

      <Tab title="Serper">
        Create a Serper API key in the [Serper dashboard](https://serper.dev/dashboard).

        In Onyx, click **Connect** and paste the API key in the **API Key** field.
      </Tab>

      <Tab title="Google PSE">
        Create a Google PSE API key in the [Google PSE
        dashboard](https://programmablesearchengine.google.com/controlpanel/all).

        In Onyx,
        click **Connect** and paste the API key in the **API Key** field and the Search Engine ID in the **Search Engine
        ID** field.
      </Tab>
    </Tabs>
  </Step>

  <Step title="Set up Web Crawler">
    We currently support the following web crawlers: Onyx web crawler and Firecrawl. To set them up,
    follow the steps below.

    <img className="rounded-image" src="https://mintcdn.com/danswer/uSkKTfhzLzI7ngUH/assets/admins/actions/web_search/crawlers.png?fit=max&auto=format&n=uSkKTfhzLzI7ngUH&q=85&s=a61696648df6086cebc057e3571ad17b" alt="Crawler Providers" width="1910" height="398" data-path="assets/admins/actions/web_search/crawlers.png" />

    <Tabs tabs={["Onyx Web Crawler", "Firecrawl"]}>
      <Tab title="Onyx Web Crawler">
        **(Recommended)** It is already set up and ready to use, no additional setup required.
      </Tab>

      <Tab title="Firecrawl">
        Create a Firecrawl API key in the [Firecrawl dashboard](https://firecrawl.com/dashboard).

        In Onyx, click **Connect** and paste the API key in the **API Key** field.
      </Tab>
    </Tabs>
  </Step>

  <Step title="Set Default Provider">
    Make sure to **Set as Default** the provider if you have multiple providers set up for the search engine and web
    crawler. You can change it at any time.

    <img className="rounded-image" src="https://mintcdn.com/danswer/uSkKTfhzLzI7ngUH/assets/admins/actions/web_search/set_default_provider.png?fit=max&auto=format&n=uSkKTfhzLzI7ngUH&q=85&s=06493d2c996a60c2467e731518e029cd" alt="Set Default Provider" width="1910" height="604" data-path="assets/admins/actions/web_search/set_default_provider.png" />
  </Step>
</Steps>

<Note>
  Make sure your Agent has the Web Search Action enabled!
</Note>