Python SDKAPI ReferenceComponents

Preview20250311WebSearchServerTool - Python SDK

Preview20250311WebSearchServerTool method reference

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

Web search preview tool configuration (2025-03-11 version)

Fields

FieldTypeRequiredDescriptionExample
engineOptional[components.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
filtersOptionalNullable[components.WebSearchDomainFilter]➖N/A{"allowed_domains": ["example.com"],"excluded_domains": ["spam.com"]}
max_resultsOptional[int]➖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
search_context_sizeOptional[components.SearchContextSizeEnum]➖Size of the search context for web search toolsmedium
typecomponents.Preview20250311WebSearchServerToolType✔️N/A
user_locationOptionalNullable[components.PreviewWebSearchUserLocation]➖N/A{"city": "San Francisco","country": "USA","region": "California","timezone": "America/Los_Angeles","type": "approximate"}