API Reference

Explore the full BrewPage REST API — 8 tags, 15+ endpoints, all publicly accessible.

Interactive Explorer

Loading API Reference...

Viewer	URL
Swagger UI (live on server)	brewpage.app/swagger-ui/index.html
Scalar (this page)	Embedded above
OpenAPI JSON	brewpage.app/v3/api-docs

Download the full OpenAPI 3.1 spec:

Tag	Description	Key Endpoints
HTML	HTML/Markdown page hosting	`POST /api/html`, `GET /api/html/{ns}/{id}`
KV	Key-value store (1000 keys/ns)	`PUT /api/kv/{ns}/{id}/{key}`, `GET /api/kv/{ns}/{id}/{key}`
JSON	JSON document store (10K docs)	`POST /api/json/{ns}/{collection}`, `GET /api/json/{ns}/{collection}/{id}`
Files	File hosting (5 MB/file)	`POST /api/files`, `GET /api/files/{ns}/{id}`, `DELETE /api/files/{ns}/{id}`
Sites	Multi-file HTML site hosting	`POST /api/sites`, `GET /api/sites/{ns}/{id}`, `GET /api/sites/{ns}/{id}/files/{filePath}`, `DELETE /api/sites/{ns}/{id}`
Gallery	Public content browser	`GET /api/gallery/pages`, `GET /api/gallery/files`
Stats	Platform statistics	`GET /api/stats`
Short Links	URL shortener	`GET /s/{code}`
SEO	Search engine support	`GET /sitemap.xml`, `GET /robots.txt`

Most read endpoints are public — no auth required.

Write operations use owner tokens returned in create responses:

Method	Example
Header	`X-Owner-Token: tok_xxx`
Query param	`?token=tok_xxx`

Password-protected content:

Method	Example
Header	`X-Password: secret`
Query param	`?p=secret`

Operation	Limit
Uploads (POST)	60/hour/IP
Reads (GET)	300/min/IP

curl https://brewpage.app/api/stats

curl -X POST https://brewpage.app/api/html \
  -H "Content-Type: application/json" \
  -d '{"content":"<h1>Hello!</h1>","format":"HTML"}'