veilrender 0.3.0

Headless browser rendering API — self-hostable on HF Spaces, Docker, or bare metal

VeilRender

中文 | English

Headless browser rendering API — self-hostable on HF Spaces, Docker, or bare metal.

Try it now (no auth needed)

curl -X POST https://oaklight-veilrender-public.hf.space/render \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com"}'

VeilRender accepts a URL and returns the fully rendered page content (HTML, Markdown, readability-extracted article) using a headless Chromium browser. Designed as a fallback for fetch tools that fail on JavaScript-rendered pages.

Quick Start

Docker

docker run -p 7860:7860 -e VEILRENDER_API_TOKEN=your-secret oaklight/veilrender

Local Development

pip install -e ".[dev]"
playwright install chromium
python -m veilrender

API

GET /health

Returns {"status": "ok"} if the service is running.

POST /render

Render a URL and return the page content.

curl -X POST http://localhost:7860/render \
  -H "Authorization: Bearer your-secret" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com"}'

Response:

{
  "content": {
    "html": "...",
    "markdown": "...",
    "readability": "..."
  },
  "metadata": {
    "title": "Example Domain",
    "url": "https://example.com",
    "status_code": 200
  },
  "links": [{"url": "https://www.iana.org/domains/example", "text": "More information..."}]
}

POST /screenshot

Capture a screenshot of a URL.

curl -X POST http://localhost:7860/screenshot \
  -H "Authorization: Bearer your-secret" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com"}' \
  -o screenshot.png

Configuration

All settings are configured via environment variables with the VEILRENDER_ prefix:

Variable	Default	Description
VEILRENDER_API_TOKEN	(none)	API token for authentication. If unset, auth is disabled.
VEILRENDER_PORT	7860	Server port
VEILRENDER_HOST	0.0.0.0	Server bind address
VEILRENDER_TIMEOUT	30000	Browser navigation timeout (ms)
VEILRENDER_VIEWPORT_WIDTH	1280	Browser viewport width
VEILRENDER_VIEWPORT_HEIGHT	720	Browser viewport height
VEILRENDER_MAX_CONCURRENT	3	Max concurrent browser contexts

Benchmark

Tested on HF Spaces (free tier, 2 vCPU) and a self-hosted VPS (3 vCPU, 1 GB container). 100% success rate across all 46 requests per target.

Test	HF Spaces	Self-hosted
Sequential × 5 (mixed URLs)	8.72 s total	11.81 s total
Concurrent × 10 (mixed URLs)	1.40 – 9.37 s	1.29 – 13.45 s
Rapid-fire × 20 (sequential)	0.885 s avg	1.029 s avg
Peak container memory	—	614 MiB / 1 GB

Full results: BENCHMARK.md

License

MIT