Skip to main content
The TypeScript SDK and docs are currently in beta. Report issues on GitHub.
Web search tool configuration

Example Usage

import { OpenResponsesWebSearchTool } from "@openrouter/sdk/models";

let value: OpenResponsesWebSearchTool = {
  type: "web_search",
};

Fields

FieldTypeRequiredDescriptionExample
type”web_search”:heavy_check_mark:N/A
filtersmodels.OpenResponsesWebSearchToolFilters:heavy_minus_sign:N/A
searchContextSizemodels.ResponsesSearchContextSize:heavy_minus_sign:Size of the search context for web search toolsmedium
userLocationmodels.ResponsesWebSearchUserLocation:heavy_minus_sign:User location information for web search{"type": "approximate","city": "San Francisco","country": "USA","region": "California","timezone": "America/Los_Angeles"}