Web Search

Perform web searches and optionally scrape the results.

Performs a web search and returns results with optional content scraping.

POST /v1/tools/web_search

Authentication

AuthorizationBearerrequired

API key as bearer token in the Authorization header. Create keys at Manage API Keys.

Headers

Content-Typestringrequired

Must be application/json.

Body

querystringrequired

The search query.

limitintegeroptionalDefault 10

Maximum number of results to return. Range: 1 to 50.

sourcesstring[]optional

Sources to search from.

categoriesobject[]optional

Categories to filter results.

includeDomainsstring[]optional

Only include results from these domains.

excludeDomainsstring[]optional

Exclude results from these domains.

tbsstringoptional

Time-based search parameter (e.g., qdr:d for past day, qdr:w for past week).

locationstringoptional

Geographic location for search (e.g., us, uk).

countrystringoptional

Country code for search.

timeoutintegeroptional

Request timeout in milliseconds. Minimum: 1.

ignoreInvalidURLsbooleanoptionalDefault false

Ignore invalid URLs in results.

enterpriseobject[]optional

Enterprise search options.

scrapeOptionsobjectoptional

Options for scraping search results. Includes:

scrapeOptions.formatsstring[]optional

Output formats for scraped content.

Allowed values:markdownsummaryhtmlrawHtmllinksimagesscreenshotjsonchangeTrackingbrandingaudiovideoquestionhighlights
scrapeOptions.onlyMainContentbooleanoptionalDefault false

Extract only the main content from scraped pages.

Response

idstringoptional

Unique request ID for this call.

dataSearchResult[]optional

Array of search results. Each contains url, title, description, and optionally scraped content fields.

Search Result Shape

Each result in the data array contains:

interface SearchResult {
  url: string;
  title: string;
  description: string;
  // If scrapeOptions provided:
  markdown?: string;
  html?: string;
  content?: string;
  links?: string[];
}

Use Cases

  • Research automation: Search and gather information programmatically
  • Content aggregation: Collect content from multiple sources
  • Competitive analysis: Monitor mentions and rankings
  • RAG pipelines: Fetch real-time web data for AI context