Sign in
SearchScraper

Start Searchscraper

post/v1/searchscraper

Request body

user_promptstring required
num_resultsinteger

Number of websites to scrape (3-20). Default is 3.

headersobject nullable

Optional headers to send with the request, including cookies and user agent

output_schemaobject nullable
extraction_modeboolean

True for AI extraction mode, False for markdown conversion only

markdown_modeboolean

True for markdown conversion mode, False for raw mode

stealthboolean

Enable stealth mode to avoid bot detection

mockboolean
streamboolean

Whether to return streaming response

webhook_urlstring nullable

Webhook URL to send the job result to

location_geo_codestring nullable

The geo code of the location to search in

time_range'past_hour' | 'past_24_hours' | 'past_week' | 'past_month' | 'past_year'

Example request

{
  "user_prompt": "What is the latest version of Python?",
  "num_results": 5,
  "headers": {
    "Cookie": "cookie1=value1; cookie2=value2",
    "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36"
  }
}

Response

Successful Response

request_idstring uuid required
status'queued' | 'processing' | 'completed' | 'failed' required
user_promptstring required
num_resultsinteger nullable
reference_urlsstring[] nullable required
markdown_contentstring nullable

Raw markdown content when extraction_mode is False

errorstring nullable

Changes