TypeScript SDKAPI ReferenceModels

LegacyWebSearchServerTool - TypeScript SDK

LegacyWebSearchServerTool type definition

The TypeScript SDK and docs are currently in beta. Report issues on GitHub.

Web search tool configuration

Example Usage

1import { LegacyWebSearchServerTool } from "@openrouter/sdk/models";
2
3let value: LegacyWebSearchServerTool = {
4  type: "web_search",
5};

Fields

FieldTypeRequiredDescriptionExample
enginemodels.WebSearchEngineEnum➖Which search engine to use. “auto” (default) uses native if the provider supports it, otherwise Exa. “native” forces the provider’s built-in search. “exa” forces the Exa search API. “firecrawl” uses Firecrawl (requires BYOK). “parallel” uses the Parallel search API.auto
filtersmodels.WebSearchDomainFilter➖N/A{"allowed_domains": ["example.com"],"excluded_domains": ["spam.com"]}
maxResultsnumber➖Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and Parallel engines; ignored with native provider search.5
searchContextSizemodels.SearchContextSizeEnum➖Size of the search context for web search toolsmedium
type”web_search”✔️N/A
userLocationmodels.WebSearchUserLocation➖User location information for web search{"city": "San Francisco","country": "USA","region": "California","timezone": "America/Los_Angeles","type": "approximate"}