Python SDKAPI ReferenceComponents

ToolWebSearch20250305 - Python SDK

ToolWebSearch20250305 method reference

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

Fields

FieldTypeRequiredDescriptionExample
allowed_domainsList[str]➖N/A
blocked_domainsList[str]➖N/A
cache_controlOptional[components.AnthropicCacheControlDirective]➖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"}
max_usesOptionalNullable[int]➖N/A
namecomponents.NameWebSearch1✔️N/A
typecomponents.TypeWebSearch20250305✔️N/A
user_locationOptionalNullable[components.AnthropicWebSearchToolUserLocation]➖N/A{"city": "San Francisco","country": "US","region": "California","timezone": "America/Los_Angeles","type": "approximate"}