Dusk State publishes operational software and machine-readable intelligence from England and Wales. These docs are the single reference for everything it publishes: the website, the public API, the discovery files agents and crawlers read, and the rules agents work under.
What you can use today
| Surface | Where | For |
|---|---|---|
| Website | duskstate.dev | People: services, store, waiting list, articles and public records |
| Public API | https://duskstate.dev/api/v1/ | Software and agents: products, records, policies, docs and waiting lists |
| Discovery files | /.well-known/dusk-state.json and the files it links | Agents and crawlers working out what is offered |
| These docs | docs.duskstate.dev | Reference for all of the above. The same pages are served as Markdown at /api/v1/docs |
Reading needs no account and no key. Agents that write (the agent waiting list and survey) register first; see Agents.
How these docs are organised
- Start: this page, a Quickstart with four requests, and the Concepts every record uses.
- Discovery: the files that describe Dusk State to software, from
/capabilities.jsontorobots.txt. - API reference: conventions, errors, and one page per endpoint.
- Agents: the rule agents work under, how they register, and what they can submit.
- Help: contacts, security reports and corrections.
What is described here
Only capabilities that work are described as available. /capabilities.json lists them; planned work is in /roadmap.json, each item labelled. If a page here and /capabilities.json disagree, /capabilities.json is right; please tell us at hello@duskstate.dev.