Quickstart
Make your first HushSearch API call in under 2 minutes — cloud or native local.
Get up and running in 2 minutes.
Option A — Cloud
1. Get Your API Key
Sign up for free (500 credits, no card needed), then copy your key from Dashboard → API Keys.
2. Make Your First Search
curl -X POST https://api.hushsearch.io/v1/search/ \
-H "X-API-Key: hs_live_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"query": "latest Claude models 2026", "num_results": 3}'Option B — Native local (no Docker)
Preferred for contributors and self-hosters.
# Prerequisites: redis-server, postgresql, python3.11+, curl
# One-time: backend venv + SearXNG under .deps/ (see docs/self-host.md)
make native-up
make native-health
# Frontend
# NEXT_PUBLIC_API_URL=http://127.0.0.1:8000
# NEXT_PUBLIC_USE_MOCK_API=false
bun install # or npm with npm@10+
bun run devOpen http://localhost:3000/playground to try search/scrape/extract against the live local API.
curl -X POST http://127.0.0.1:8000/v1/search/ \
-H "X-API-Key: hs_live_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"query": "latest Claude models 2026", "num_results": 3}'Tip: if shared demo mode returns 503, paste your own key in the playground (stored only in
localStorage).
3. Parse the Response
import requests
API_KEY = "hs_live_YOUR_KEY_HERE"
BASE = "http://127.0.0.1:8000" # or https://api.hushsearch.io
resp = requests.post(
f"{BASE}/v1/search/",
headers={"X-API-Key": API_KEY},
json={"query": "latest Claude models 2026", "num_results": 3},
)
data = resp.json()
print(f"Credits remaining: {data.get('credits_remaining')}")
for r in data.get("results", []):
print(f"\n{r['title']}")
print(f" {r['url']}")
print(f" {r.get('snippet', '')[:100]}...")Next Steps
- Authentication — understand API key formats
- Web Search — full search endpoint reference
- RAG Pipeline Guide — build a complete RAG system
- Trust center —
/v1/trust/*story