Search Engine Setup

​

Setting Up Search Engine in OpenHands

OpenHands can be configured to use Tavily as a search engine, which allows the agent to search the web for information when needed. This capability enhances the agent’s ability to provide up-to-date information and solve problems that require external knowledge.

​

Getting a Tavily API Key

To use the search functionality in OpenHands, you’ll need to obtain a Tavily API key:

1. Visit Tavily’s website and sign up for an account.
2. Navigate to the API section in your dashboard.
3. Generate a new API key.
4. Copy the API key (it should start with tvly-).

​

Configuring Search in OpenHands

Once you have your Tavily API key, you can configure OpenHands to use it:

​

In the OpenHands UI

1. Open OpenHands and navigate to the Settings page.
2. Under the LLM tab, enter your Tavily API key (starting with tvly-) in the Search API Key (Tavily) field.
3. Click Save to apply the changes.

​

Using Configuration Files

If you’re running OpenHands in headless mode or via CLI, you can configure the search API key in your configuration file:

# In your OpenHands config file
[core]
search_api_key = "tvly-your-api-key-here"

​

How Search Works in OpenHands

When the search engine is configured:

• The agent can decide to search the web when it needs external information.
• Search queries are sent to Tavily’s API via Tavily’s MCP server which includes a variety of tools (search, extract, crawl, map).
• Results are returned and incorporated into the agent’s context.
• The agent can use this information to provide more accurate and up-to-date responses.

​

Limitations

• Search results depend on Tavily’s coverage and freshness.
• Usage may be subject to Tavily’s rate limits and pricing tiers.
• The agent will only search when it determines that external information is needed.

​

Troubleshooting

If you encounter issues with the search functionality:

• Verify that your API key is correct and active.
• Check that your API key starts with tvly-.
• Ensure you have an active internet connection.
• Check Tavily’s status page for any service disruptions.