Introduction
What HushSearch is, how requests work, and where to start.
HushSearch is one API for every kind of web data. It returns live search results, clean page content, whole-site crawls, browser sessions, converted PDFs and cited research as structured JSON, for AI agents, RAG pipelines and ordinary backends.
How it works
- One key. Every endpoint authenticates with the
X-API-Keyheader. See Authentication. - Credits per call. Each endpoint has a fixed credit price. Every response reports
credits_used,credits_remainingandresponse_time_ms. See Credits. - Refunds on failure. Calls that fail on our side are refunded to your balance.
- Async when it's slow. Crawls and deep research can run as jobs with webhooks.
Endpoints
35 endpoints, one key.
Search
| Web Search | POST /v1/search/ | 1 credit |
| Streaming Search | POST /v1/search/stream | 1 credit |
| Batch Search | POST /v1/search/batch | 1 credit / query |
| Find Similar | POST /v1/search/similar | 1 credit |
Answers & research
| Cited Answer | POST /v1/answer/ | 4 credits |
| Deep Research | POST /v1/research/ | 8 credits |
| Search & Summarize | POST /v1/search-and-summarize/ | 5 credits |
| Context Pack | POST /v1/context/ | 2 credits |
| Agent | POST /v1/agent/ | 4 credits |
Scrape & extract
| Scrape | POST /v1/scrape/ | 2 credits |
| Extract | POST /v1/extract/ | 3 credits |
| Reader | GET /v1/reader/ | 2 credits |
| Contents | POST /v1/contents/ | 2 credits / URL |
| Structured Extract | POST /v1/structured-extract/ | 4 credits |
| Search + Extract | POST /v1/search-extract/ | 6 credits |
| Multi-URL Extract | POST /v1/multi-extract/ | 4 credits |
Crawl & map
| Map | POST /v1/map/ | 1 credit |
| Crawl | POST /v1/crawl/ | 3 credits |
| Crawl Pipeline | POST /v1/crawl/pipeline | 4 credits |
| Batch Scrape | POST /v1/batch-scrape/ | 2 credits / URL |
Browsers
| Screenshot | POST /v1/screenshot/ | 3 credits |
| Browser Sessions | POST /v1/browser/sessions | 3 credits |
| Browser Execute | POST /v1/browser-execute/ | 2 credits |
| Agent Scrape | POST /v1/agent-scrape/ | 5 credits |
Documents
| Render → Docling | POST /v1/render-extract/ | 6 credits |
| Docling Markdown | POST /v1/docling-markdown/ | 4 credits |
| Docling OCR | POST /v1/docling-ocr/ | 3 credits |
| Docling Structured | POST /v1/docling-structured/ | 6 credits |
Platform
| Embeddings | POST /v1/embeddings/ | 1 credit / input |
| Rerank | POST /v1/rerank/ | 1 credit |
| Async Jobs | POST /v1/jobs/ | 5 credits / job (research 8 · crawl 5 · batch 3 · multi-extract 4) |
| Change Monitor | POST /v1/change-monitor/ | 2 credits |
| Knowledge Lookup | GET /v1/knowledge | 1 credit |
| Enrich | POST /v1/enrich | 4 credits |
| MCP Server | POST /v1/mcp/ | billed per tool call |
Base URL
https://api.hushsearch.ioCall paths exactly as listed, including the trailing slash where shown.
Self-hosting and local development
The whole stack runs on your own machines:
make native-up # Redis + SearXNG (:8888) + FastAPI (:8000)
make gateway-up # optional Rust gateway on :8080
make native-healthPoint the Next.js app at the API:
# .env.local
NEXT_PUBLIC_API_URL=http://127.0.0.1:8000
NEXT_PUBLIC_USE_MOCK_API=false
npm run devSee the Quickstart and Self-hosting for the full setup.
Trust surface
Machine-readable posture:
GET /v1/trust/statusGET /v1/trust/privacyGET /v1/trust/slaGET /v1/trust/anti-botGET /v1/trust/economics
Or open the Trust center.