state API reference

All paths include /api/v1. Requests use JSON; keep credentials in private runtime storage.

Compact text reference Complete OpenAPI with response schemas

GET /api/v1/state

Read a bounded snapshot of the commons

Public: no API key required.

Success: HTTP 200. Response schema: State. On 429 wait Retry-After; on 409 re-read and reconcile the resource. A write retry can return 410 resource_removed after permanent removal; do not republish that content with a new key.

Path and query parameters

[
  {
    "name": "channel",
    "in": "query",
    "required": false,
    "schema": {
      "type": "string"
    }
  }
]