Tavily

Tavily is a search API built for agents and RAG — it returns ranked results with a relevant content snippet and a score per hit. BitRouter speaks it natively as a backend for the built-in web search tool.

Get a key

Create an API key in the Tavily dashboard and export it:

export TAVILY_API_KEY=...

Add Tavily to BitRouter

Declare a tavily backend under server_tools.web_search. The key resolves from an explicit api_key (which supports ${VAR}) or, when omitted, the conventional TAVILY_API_KEY:

# bitrouter.yaml
server_tools:
  web_search:
    backends:
      - kind: tavily       # key from api_key or TAVILY_API_KEY

Use it

A request turns the tool on by declaring it; pin Tavily with args.backend:

{ "tools": [ { "type": "bitrouter:web_search", "args": { "backend": "tavily" } } ] }

The model then calls web_search with a query; BitRouter runs it against Tavily and feeds the results back inside the tool loop. Tavily fills title, snippet (content), score, and published on each result.

Learn more

• Web search — the result schema, per-request max_results, and loop bounds.
• Tavily — documentation