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

​
Example Usage

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

let value: ToolWebSearch20250305 = {
  name: "web_search",
  type: "web_search_20250305",
};

​
Fields

FieldTypeRequiredDescriptionExample
allowedDomainsstring[]:heavy_minus_sign:N/A
blockedDomainsstring[]:heavy_minus_sign:N/A
cacheControlmodels.AnthropicCacheControlDirective:heavy_minus_sign:Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. Currently supported for Anthropic Claude models.{"type": "ephemeral"}
maxUsesnumber:heavy_minus_sign:N/A
namemodels.NameWebSearch1:heavy_check_mark:N/A
typemodels.TypeWebSearch20250305:heavy_check_mark:N/A
userLocationmodels.AnthropicWebSearchToolUserLocation:heavy_minus_sign:N/A{"city": "San Francisco","country": "US","region": "California","timezone": "America/Los_Angeles","type": "approximate"}