SEARCH · EXAMPLES

Search Examples

Copy these examples directly. They use the production hostname, standard Bearer authentication, and the current Search request contract.

Search Overview Parameters Authentication

One canonical header

Every paid Search request uses Authorization: Bearer <your-api-key>. Do not add a colon after Bearer; API keys are not Clerk JWTs.

PowerShell 5.1 — serialize JSON before curl.exePowerShell

$body = @{ query = 'latest AI developments'; max_results = 5 } | ConvertTo-Json -Compress
curl.exe -X POST "https://search.venym.io/api/v1/search" -H "Authorization: Bearer $env:VENYM_SEARCH_API_KEY" -H "Content-Type: application/json" --data-raw $body

Basic Search

Beginner2 credits

The smallest useful request: a query and a result limit.

Basic Search implementation

curl -X POST https://search.venym.io/api/v1/search \
  -H "Authorization: Bearer $VENYM_SEARCH_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{"query":"Python web scraping libraries","max_results":10}'

Search with Automatic Scraping

IntermediateUp to 8 credits

Reserve the top two pages for scraping and receive both result sets in one response.

Search with Automatic Scraping implementation

curl -X POST https://search.venym.io/api/v1/search \
  -H "Authorization: Bearer $VENYM_SEARCH_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{"query":"agent memory architecture","max_results":5,"auto_scrape_top":2}'

Plan-Gated Enrichment

Advanced2 + scrape credits

Request contact and social extraction only when the account has the required plan access.

Plan-Gated Enrichment implementation

curl -X POST https://search.venym.io/api/v1/search \
  -H "Authorization: Bearer $VENYM_SEARCH_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{"query":"developer tools companies","max_results":10,"auto_scrape_top":3,"include_contacts":true,"include_social":true}'

Scrape API Error handling

$body = @{ query = 'latest AI developments'; max_results = 5 } | ConvertTo-Json -Compress curl.exe -X POST "https://search.venym.io/api/v1/search" -H "Authorization: Bearer $env:VENYM_SEARCH_API_KEY" -H "Content-Type: application/json" --data-raw $body

curl -X POST https://search.venym.io/api/v1/search \ -H "Authorization: Bearer $VENYM_SEARCH_API_KEY" \ -H "Content-Type: application/json" \ --data '{"query":"Python web scraping libraries","max_results":10}'

curl -X POST https://search.venym.io/api/v1/search \ -H "Authorization: Bearer $VENYM_SEARCH_API_KEY" \ -H "Content-Type: application/json" \ --data '{"query":"agent memory architecture","max_results":5,"auto_scrape_top":2}'

curl -X POST https://search.venym.io/api/v1/search \ -H "Authorization: Bearer $VENYM_SEARCH_API_KEY" \ -H "Content-Type: application/json" \ --data '{"query":"developer tools companies","max_results":10,"auto_scrape_top":3,"include_contacts":true,"include_social":true}'