Search

Voxvey Search exposes v2 web search, scrape, map, and crawl routes behind the Voxvey gateway. Use your Voxvey bearer token, not an upstream search provider key.

Search the web

Use POST /v2/search to search the web. Add scrapeOptions when you want the matched pages returned with full markdown content instead of only title, URL, and description fields.

curl https://api.voxvey.com/v2/search \
  -H "Authorization: Bearer $VOXVEY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "site:developers.voxvey.com docs",
    "limit": 5,
    "scrapeOptions": {
      "formats": [
        {"type": "markdown"}
      ]
    }
  }'

{
  "success": true,
  "data": {
    "web": [
      {
        "url": "https://developers.voxvey.com/docs/search",
        "title": "Search",
        "description": "Search and scrape web data through Voxvey Search v2 routes.",
        "markdown": "# Search\n\n..."
      }
    ]
  },
  "creditsUsed": 1
}

Scrape a page

Use POST /v2/scrape when you already know the URL and want clean page content.

curl https://api.voxvey.com/v2/scrape \
  -H "Authorization: Bearer $VOXVEY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "formats": ["markdown"],
    "onlyMainContent": true
  }'

Map a site

Use POST /v2/map to discover URLs from a site before deciding what to scrape or crawl.

curl https://api.voxvey.com/v2/map \
  -H "Authorization: Bearer $VOXVEY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://developers.voxvey.com",
    "search": "api reference",
    "limit": 20
  }'

Crawl a site

Use POST /v2/crawl for multi-page extraction. The create call returns a crawl ID; poll GET /v2/crawl/{id} for status and results.

curl https://api.voxvey.com/v2/crawl \
  -H "Authorization: Bearer $VOXVEY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://developers.voxvey.com",
    "limit": 10,
    "scrapeOptions": {
      "formats": ["markdown"],
      "onlyMainContent": true
    }
  }'

curl https://api.voxvey.com/v2/crawl/$CRAWL_ID \
  -H "Authorization: Bearer $VOXVEY_TOKEN"

Useful search filters

Filter	Example
Exact phrase	"developer API"
Exclude term	web scraping -ads
Site only	site:developers.voxvey.com search
File type	filetype:pdf climate report
Title match	intitle:API reference

Billing

Successful chargeable Search requests consume credits. Upstream errors release reserved credits instead of settling them.