# URL Reader

> Read any URL as LLM-ready Markdown with a simple GET.

Source: http://localhost:3000/docs/endpoints/reader

## Reader: `GET /v1/reader/`

Prefix-style URL → LLM-ready Markdown in a single GET. Cost: 2 credits. Available on the free demo.

```bash
curl 'https://api.hushsearch.io/v1/reader/?url=https%3A%2F%2Fexample.com%2F' \
  -H "X-API-Key: hs_live_YOUR_KEY"
```

A GET-friendly reader: pass the URL as a query parameter and get clean Markdown back. Add a `query` to get the most relevant sentences highlighted.

## Query parameters

| Parameter | Type | Default | Notes |
|---|---|---|---|
| `url` | string | — | **Required.** The page to read. |
| `query` | string | — | Rank and return highlight sentences for this query. |
| `highlight_sentences` | integer | `3` | 1–12 highlights when `query` is set. |

## Response

```json
{
  "code": 200,
  "status": "ok",
  "data": {
    "title": "Example Domain",
    "url": "https://example.com/",
    "content": "# Example Domain\n\nThis domain is for use in illustrative examples…",
    "highlights": null
  },
  "credits_used": 2,
  "credits_remaining": 498,
  "response_time_ms": 480
}
```
