Public API
Last updated: 25 September 2026
Nemudoro is a cozy focus companion. A few read-only endpoints serve its public content and its health, and anyone may call them without signing in. Everything a signed-in person does goes through the app's own API, which is not offered to other clients and may change at any time.
Endpoints
All on https://nemudoro.com, all GET, all answering JSON.
| Path | What it returns |
|---|---|
/healthz | {"status":"ok"} with 200 when the service and its database answer, "unavailable" with 503 when not. Add ?deep=1 to also check the media store and the timer service; the deep check is rate-limited. |
/api/quests | The one-minute wellness quests offered during a short break: id, name, emoji, short, guidance. |
/api/whispers | The companion's lines, as lists of strings keyed by the moment they belong to. |
/api/story | Nemudoro's story: a title and paragraphs, each with its text and the stage art beside it. |
Machine-readable descriptions
- /openapi.json: the endpoints above, as an OpenAPI 3.1 description.
- /.well-known/api-catalog: the API catalog (RFC 9727), linking this page, the description and the health endpoint.
Using it
No key and no sign-in. Please be gentle: cache what you fetch (the content changes rarely), and expect 429 with a
Retry-After header if you ask too often. The content is Nemudoro's own; quoting a line or two with a link back is
welcome, republishing it wholesale is not.
Contact
Questions or ideas: hello@nemudoro.com.