WebSearchPlugin Type | OpenRouter TypeScript SDK | OpenRouter

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

Example Usage

1 import { WebSearchPlugin } from "@openrouter/sdk/models";
2 
3 let value: WebSearchPlugin = {
4   id: "web",
5 };

Field	Type	Required	Description	Example
`enabled`	boolean	➖	Set to false to disable the web-search plugin for this request. Defaults to true.
`engine`	models.WebSearchEngine	➖	The search engine to use for web search.	exa
`excludeDomains`	string[]	➖	A list of domains to exclude from web search results. Supports wildcards (e.g. “*.substack.com”) and path filtering (e.g. “openai.com/blog”).	[ “example.com”, “*.substack.com”, “openai.com/blog” ]
`id`	”web”	✔️	N/A
`includeDomains`	string[]	➖	A list of domains to restrict web search results to. Supports wildcards (e.g. “*.substack.com”) and path filtering (e.g. “openai.com/blog”).	[ “example.com”, “*.substack.com”, “openai.com/blog” ]
`maxResults`	number	➖	N/A
`maxUses`	number	➖	Maximum number of times the model can invoke web search in a single turn. Passed through to native providers that support it (e.g. Anthropic).
`searchPrompt`	string	➖	N/A
`userLocation`	models.UserLocation	➖	N/A	`{"city": "San Francisco","country": "US","region": "California","timezone": "America/Los_Angeles","type": "approximate"}`