Web Search
webSearchSearch Google using query text or a search URL, returning parsed JSON or HTML results with region, language, page, JavaScript rendering, and timeout controls.
Instructions
Searches Google from query text or a Google search URL passed as url. Matches the Python SDK's web_search options. Set raw=false and format=json for parsed results; the SDK-compatible default raw=true returns HTML. Google URLs supply q, gl, hl, and start; explicit region, language, and page override URL-derived values. render_js enables dynamic features; timeout controls the local request deadline. Returns status_code, data, and sanitized headers.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | SDK compatibility default: true requests HTML and overrides format. Set false for parsed JSON results. | |
| url | Yes | Required search query text or complete Google search URL. | |
| page | No | One-based result page; overrides the page derived from start in a Google URL. | |
| format | No | Response representation when raw=false. | json |
| region | No | Country code; overrides gl from a Google search URL. | |
| timeout | No | Local upstream HTTP deadline in seconds; omitted from the JSON body. | |
| language | No | Language code; overrides hl from a Google search URL. | |
| render_js | No | Render JavaScript-dependent search features. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | Response body as parsed JSON or text. | |
| error | No | Request failure message, if any. | |
| headers | Yes | Response headers with credentials and cookies removed. | |
| status_code | Yes | Upstream HTTP status, or null for a network failure. |