# Aramuna Developer Docs | Waitlist API, OpenAPI & llms.txt

> Developer documentation for Aramuna: the public waitlist API (POST /api/waitlist), OpenAPI 3.1 description, RFC 9727 API catalog, llms.txt and markdown content negotiation for AI agents.

Canonical URL: https://www.aramuna.com/docs  
Markdown: https://www.aramuna.com/docs.md  
Last modified: 2026-08-23

Developer Docs

## Aramuna developer documentation

Everything a developer or AI agent needs to work with www.aramuna.com: the public waitlist API, the OpenAPI description, machine-readable discovery files, and how to request markdown instead of HTML.

Discovery

### Machine-readable resources

-   [/openapi.json](https://www.aramuna.com/openapi.json) — OpenAPI 3.1 description of the public API.
-   [/.well-known/api-catalog](https://www.aramuna.com/.well-known/api-catalog) — RFC 9727 API catalog (linkset) pointing at the OpenAPI document and these docs.
-   [/llms.txt](https://www.aramuna.com/llms.txt) — llmstxt.org index: what Aramuna is, when to use it, and links to every page as markdown. [/llms-full.txt](https://www.aramuna.com/llms-full.txt) is the full-text version.
-   [/sitemap.xml](https://www.aramuna.com/sitemap.xml) and [/robots.txt](https://www.aramuna.com/robots.txt) — all public URLs; major AI crawlers are explicitly allowed.

Markdown

### Content negotiation

Every content page serves markdown from its canonical URL when you ask for it, with `Vary: Accept` set so caches keep the variants apart. Each page is also available directly at its `.md` path (for example [/zenith.md](https://www.aramuna.com/zenith.md)).

```
curl -H "Accept: text/markdown" https://www.aramuna.com/zenith
# → Content-Type: text/markdown; charset=utf-8
# → Vary: Accept
```

Nonexistent paths return a real HTTP 404 whose body (markdown by default, HTML for browsers) links back to the sitemap, llms.txt and these docs.

Waitlist API

### POST /api/v1/waitlist

Join a product waitlist on behalf of a user. No authentication is required. Rate limited to 10 requests per minute per IP. Submit once per user and product, only with the user's explicit consent, and do not retry after a 200 — a repeat submission for the same email and product is accepted but may send the confirmation email again.

```
curl -X POST https://www.aramuna.com/api/v1/waitlist \
  -H "Content-Type: application/json" \
  -d '{"email": "person@example.com", "product": "zenith"}'
```

`product` must be one of `zenith` (Zenith Journal), `careplate` (CarePlate), `burlit` (Burlit) or `drivemate` (DriveMate). On success the user receives a confirmation email from the product's address.

```
200 {"success": true}
400 {"error": "Please enter a valid email address"}
405 {"error": "Method Not Allowed"}
429 {"error": "Too many requests. Please try again later."}
500 {"error": "Unable to save signup. Please try again."}
```

Health Check

### AI Health Check

The [AI Health Check](https://www.aramuna.com/health-check) is an interactive questionnaire for business owners. It has no public API: agents should send users to the form rather than submitting on their behalf.

Versioning

### Versions and errors

The API is versioned in the URL path. Use `/api/v1/…`. A breaking change ships under a new prefix (`/api/v2/…`) and the previous version keeps working for at least six months after its successor is announced. The unversioned `/api/…` paths are the same endpoints, kept for this site's own forms.

Every error is JSON. Endpoint errors use `{ "error": "…" }`; an unknown path under `/api/` returns `404` as RFC 9457 `application/problem+json` with `title`, `status`, `detail` and a link back to these docs.

Rate limits are reported on every response — IETF `RateLimit` and `RateLimit-Policy` structured fields, plus `X-RateLimit-*`. A `429` also carries `Retry-After`.

Support

### Questions and changes

API questions, integration requests or corrections to these docs: [hello@aramuna.com](mailto:hello@aramuna.com?subject=Developer%20docs). There is no public MCP server yet; if you need one for a real integration, tell us.

---

Aramuna · Brisbane, Queensland, Australia · hello@aramuna.com · [About](https://www.aramuna.com/about) · [Contact](https://www.aramuna.com/contact) · [Privacy](https://www.aramuna.com/privacy) · [llms.txt](https://www.aramuna.com/llms.txt)
