HushSearchDocs

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-Key header. See Authentication.
  • Credits per call. Each endpoint has a fixed credit price. Every response reports credits_used, credits_remaining and response_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 SearchPOST /v1/search/1 credit
Streaming SearchPOST /v1/search/stream1 credit
Batch SearchPOST /v1/search/batch1 credit / query
Find SimilarPOST /v1/search/similar1 credit

Answers & research

Cited AnswerPOST /v1/answer/4 credits
Deep ResearchPOST /v1/research/8 credits
Search & SummarizePOST /v1/search-and-summarize/5 credits
Context PackPOST /v1/context/2 credits
AgentPOST /v1/agent/4 credits

Scrape & extract

ScrapePOST /v1/scrape/2 credits
ExtractPOST /v1/extract/3 credits
ReaderGET /v1/reader/2 credits
ContentsPOST /v1/contents/2 credits / URL
Structured ExtractPOST /v1/structured-extract/4 credits
Search + ExtractPOST /v1/search-extract/6 credits
Multi-URL ExtractPOST /v1/multi-extract/4 credits

Crawl & map

MapPOST /v1/map/1 credit
CrawlPOST /v1/crawl/3 credits
Crawl PipelinePOST /v1/crawl/pipeline4 credits
Batch ScrapePOST /v1/batch-scrape/2 credits / URL

Browsers

ScreenshotPOST /v1/screenshot/3 credits
Browser SessionsPOST /v1/browser/sessions3 credits
Browser ExecutePOST /v1/browser-execute/2 credits
Agent ScrapePOST /v1/agent-scrape/5 credits

Documents

Render → DoclingPOST /v1/render-extract/6 credits
Docling MarkdownPOST /v1/docling-markdown/4 credits
Docling OCRPOST /v1/docling-ocr/3 credits
Docling StructuredPOST /v1/docling-structured/6 credits

Platform

EmbeddingsPOST /v1/embeddings/1 credit / input
RerankPOST /v1/rerank/1 credit
Async JobsPOST /v1/jobs/5 credits / job (research 8 · crawl 5 · batch 3 · multi-extract 4)
Change MonitorPOST /v1/change-monitor/2 credits
Knowledge LookupGET /v1/knowledge1 credit
EnrichPOST /v1/enrich4 credits
MCP ServerPOST /v1/mcp/billed per tool call

Base URL

https://api.hushsearch.io

Call 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-health

Point 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 dev

See the Quickstart and Self-hosting for the full setup.

Trust surface

Machine-readable posture:

  • GET /v1/trust/status
  • GET /v1/trust/privacy
  • GET /v1/trust/sla
  • GET /v1/trust/anti-bot
  • GET /v1/trust/economics

Or open the Trust center.