# HushSearch documentation

> One API for every kind of web data — search, scrape, crawl, browsers, documents and research.

Source: http://localhost:3000/docs

HushSearch turns the web into data your code and agents can use: live search results, clean Markdown from any page, whole-site crawls, real browser sessions, PDF and OCR conversion, and cited research. Every endpoint takes the same `X-API-Key` header and reports what it cost and how long it took.

- [Quickstart](http://localhost:3000/docs/getting-started/quickstart): Get a key and make your first call in two minutes.
  - [Authentication](http://localhost:3000/docs/getting-started/authentication): API keys, the X-API-Key header and dashboard tokens.
  - [Credits](http://localhost:3000/docs/getting-started/credits): How calls are priced, refunded and reported.
  - [Playground](http://localhost:3000/playground): Try any endpoint in the browser, no key needed for the demo.
## Your first request

```bash
curl -X POST https://api.hushsearch.io/v1/search/ \
  -H "X-API-Key: $HUSHSEARCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "best open-source vector databases", "num_results": 5}'
```

Every response includes `credits_used`, `credits_remaining` and `response_time_ms`.

> Call paths exactly as documented, including the trailing slash (for example `/v1/search/`). The bare path answers with a redirect, which `curl -X POST` and browsers' CORS preflights do not follow.

## For AI agents

Paste the prompt into Claude Code, Cursor or any coding agent, or add HushSearch as an MCP server. The complete reference for language models is at [/llms.txt](http://localhost:3000/llms.txt).

Prompt for a coding agent:

```text
You have access to HushSearch, one API for all web data (search, scrape, crawl, browser, extract, research, documents).
Base URL: https://api.hushsearch.io
Authenticate every request with the header "X-API-Key: $HUSHSEARCH_API_KEY".
Every response includes credits_used, credits_remaining and response_time_ms.
Full endpoint reference for LLMs: http://localhost:3000/llms.txt
Start with POST /v1/search/ {"query": "..."}, POST /v1/scrape/ {"url": "..."} and POST /v1/answer/ {"query": "..."}.
Call paths exactly as documented, including the trailing slash, so no redirect is needed.
Prefer POST /v1/jobs/ for crawls and research that may take longer than 30 seconds.
On HTTP 402 the key is out of credits; on 429 back off and retry after the Retry-After header.
```

MCP server config:

```json
{
  "mcpServers": {
    "hushsearch": {
      "url": "https://api.hushsearch.io/v1/mcp/",
      "headers": {
        "X-API-Key": "hs_live_YOUR_KEY"
      }
    }
  }
}
```

## Endpoints

| Endpoint | Request | Credits |
| --- | --- | --- |
| [Web Search](http://localhost:3000/docs/endpoints/search) (Search) | `POST /v1/search/` | 1 credit |
| [Streaming Search](http://localhost:3000/docs/endpoints/streaming-search) (Search) | `POST /v1/search/stream` | 1 credit |
| [Batch Search](http://localhost:3000/docs/endpoints/search-batch) (Search) | `POST /v1/search/batch` | 1 credit / query |
| [Find Similar](http://localhost:3000/docs/endpoints/similar) (Search) | `POST /v1/search/similar` | 1 credit |
| [Cited Answer](http://localhost:3000/docs/endpoints/answer) (Answers & research) | `POST /v1/answer/` | 4 credits |
| [Deep Research](http://localhost:3000/docs/endpoints/research) (Answers & research) | `POST /v1/research/` | 8 credits |
| [Search & Summarize](http://localhost:3000/docs/endpoints/search-summarize) (Answers & research) | `POST /v1/search-and-summarize/` | 5 credits |
| [Context Pack](http://localhost:3000/docs/endpoints/context) (Answers & research) | `POST /v1/context/` | 2 credits |
| [Agent](http://localhost:3000/docs/endpoints/agent) (Answers & research) | `POST /v1/agent/` | 4 credits |
| [Scrape](http://localhost:3000/docs/endpoints/scrape) (Scrape & extract) | `POST /v1/scrape/` | 2 credits |
| [Extract](http://localhost:3000/docs/endpoints/extract) (Scrape & extract) | `POST /v1/extract/` | 3 credits |
| [Reader](http://localhost:3000/docs/endpoints/reader) (Scrape & extract) | `GET /v1/reader/` | 2 credits |
| [Contents](http://localhost:3000/docs/endpoints/contents) (Scrape & extract) | `POST /v1/contents/` | 2 credits / URL |
| [Structured Extract](http://localhost:3000/docs/endpoints/structured-extract) (Scrape & extract) | `POST /v1/structured-extract/` | 4 credits |
| [Search + Extract](http://localhost:3000/docs/endpoints/search-extract) (Scrape & extract) | `POST /v1/search-extract/` | 6 credits |
| [Multi-URL Extract](http://localhost:3000/docs/endpoints/multi-extract) (Scrape & extract) | `POST /v1/multi-extract/` | 4 credits |
| [Map](http://localhost:3000/docs/endpoints/map) (Crawl & map) | `POST /v1/map/` | 1 credit |
| [Crawl](http://localhost:3000/docs/endpoints/crawl) (Crawl & map) | `POST /v1/crawl/` | 3 credits |
| [Crawl Pipeline](http://localhost:3000/docs/endpoints/crawl) (Crawl & map) | `POST /v1/crawl/pipeline` | 4 credits |
| [Batch Scrape](http://localhost:3000/docs/endpoints/batch-scrape) (Crawl & map) | `POST /v1/batch-scrape/` | 2 credits / URL |
| [Screenshot](http://localhost:3000/docs/endpoints/screenshot) (Browsers) | `POST /v1/screenshot/` | 3 credits |
| [Browser Sessions](http://localhost:3000/docs/endpoints/browser) (Browsers) | `POST /v1/browser/sessions` | 3 credits |
| [Browser Execute](http://localhost:3000/docs/endpoints/browser-execute) (Browsers) | `POST /v1/browser-execute/` | 2 credits |
| [Agent Scrape](http://localhost:3000/docs/endpoints/agent-scrape) (Browsers) | `POST /v1/agent-scrape/` | 5 credits |
| [Render → Docling](http://localhost:3000/docs/endpoints/render-extract) (Documents) | `POST /v1/render-extract/` | 6 credits |
| [Docling Markdown](http://localhost:3000/docs/endpoints/docling-markdown) (Documents) | `POST /v1/docling-markdown/` | 4 credits |
| [Docling OCR](http://localhost:3000/docs/endpoints/docling-ocr) (Documents) | `POST /v1/docling-ocr/` | 3 credits |
| [Docling Structured](http://localhost:3000/docs/endpoints/docling-structured) (Documents) | `POST /v1/docling-structured/` | 6 credits |
| [Embeddings](http://localhost:3000/docs/endpoints/embeddings) (Platform) | `POST /v1/embeddings/` | 1 credit / input |
| [Rerank](http://localhost:3000/docs/endpoints/rerank) (Platform) | `POST /v1/rerank/` | 1 credit |
| [Async Jobs](http://localhost:3000/docs/endpoints/jobs) (Platform) | `POST /v1/jobs/` | 5 credits / job (research 8 · crawl 5 · batch 3 · multi-extract 4) |
| [Change Monitor](http://localhost:3000/docs/endpoints/change-monitor) (Platform) | `POST /v1/change-monitor/` | 2 credits |
| [Knowledge Lookup](http://localhost:3000/docs/endpoints/knowledge) (Platform) | `GET /v1/knowledge` | 1 credit |
| [Enrich](http://localhost:3000/docs/endpoints/knowledge) (Platform) | `POST /v1/enrich` | 4 credits |
| [MCP Server](http://localhost:3000/docs/endpoints/mcp) (Platform) | `POST /v1/mcp/` | billed per tool call |
