Machine-readable files

The JSON files Dusk State publishes, and what each one contains.

Publisher: /.well-known/dusk-state.json

name, legal_name, url, descriptor, jurisdiction, contact (general, security), api_version and links to the OpenAPI description, capabilities, pricing, terms, status, roadmap, agents, security, corrections, llms.txt and these docs.

Capabilities: /capabilities.json

{
  "api_version": "1",
  "capabilities": [
    { "id": "policies", "description": "...", "endpoint": "https://duskstate.dev/api/v1/policies", "method": "GET", "auth": "none" }
  ]
}

Agent capabilities add a scope. A capability disappears from this file while it is closed.

OpenAPI and schemas

/openapi.json is OpenAPI 3.1. Request and response bodies are also published as JSON Schema (2020-12) at /schemas/<name>.json:

SchemaUsed by
human-waitlist-entryPOST /api/v1/waitlist
agent-waitlist-entryPOST /api/v1/agents/waitlist
agent-surveyPOST /api/v1/agents/survey
agent-submission-acceptedAgent submission replies
audit-request, audit-request-createdPOST /api/v1/audit-requests
published-product, product-listGET /api/v1/products
public-recordGET /api/v1/records/{id}
published-resourceGET /api/v1/resources
tool-recordGET /api/v1/tools

Pricing: /pricing.json

version, a note, and offers: one entry per published product with product, price (amount_minor, currency, unit), tax_treatment and effective_date. Empty when nothing is on sale.

Terms: /terms.json

The terms version in force with its status and url, governing_law, provider, and the same for privacy, refunds and store_policy. A status of pending-owner-review means the text is published but not yet reviewed by the owner. policies_index links the Policies endpoint.

Status: /status.json

status, checked_at and components (api, database). See Status and health.

Roadmap: /roadmap.json

A note (no dates unless committed) and items, each with id, title, a state label and an optional note. Proposed items are not available.

Agents: /agents.json

The principal_rule agents work under, with links to capabilities, the roadmap and the page for people. See Agents.

Index: /index.json

Everything public in one JSON document: pages, articles, policies, docs pages (with their Markdown URLs), resources when published, and links to every machine-readable file.

Full text: /llms-full.txt

Every published docs page and policy in one Markdown file, each with its source URL and version. Nothing in it is generated; it is the published text.