# Introduction

> What HushSearch is, how requests work, and where to start.

Source: http://localhost:3000/docs/getting-started

**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](http://localhost:3000/docs/getting-started/authentication).
- **Credits per call.** Each endpoint has a fixed credit price. Every response reports `credits_used`, `credits_remaining` and `response_time_ms`. See [Credits](http://localhost:3000/docs/getting-started/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](http://localhost:3000/docs/endpoints/jobs) with [webhooks](http://localhost:3000/docs/endpoints/webhooks).

## 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 |

## 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:

```bash
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:

```bash
# .env.local
NEXT_PUBLIC_API_URL=http://127.0.0.1:8000
NEXT_PUBLIC_USE_MOCK_API=false
npm run dev
```

See the [Quickstart](http://localhost:3000/docs/getting-started/quickstart) and [Self-hosting](http://localhost:3000/self-host) 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](http://localhost:3000/trust).
