Web Search
Search the web (metered). Returns ranked results with query-relevant snippets.
Authorizations
API key from Settings > Developer > REST API
Headers
Calendar-dated API version pin. New integrations should pin 2026-05-01 to opt into the newest response shapes. For back-compat the server also accepts requests with no header and resolves them to the current default (today: 2026-04-12); that default advances on each sunset date. Any unsupported value returns 400 unsupported_version.
2026-04-12, 2026-05-01 "2026-05-01"
Body
The search query.
1 - 2000Results to return (max 10).
1 <= x <= 10Also return each result's leading document text (~2000 chars) as text.
A retried call with the same key replays the stored response (replayed:true) instead of paying for a second provider request.
200Response
Successful Response
The response is of type Response Websearch · object.