API reference

Every running project exposes a small built-in API under /api. As the database and schema layers land, collection endpoints are generated here automatically.

GET /api/health

Liveness and version. Used by the starter page's client script.

{ "framework": "AkurAI-Framework", "version": "0.0.1", "status": "ok" }

GET /api/_meta

The self-describing manifest — every route the framework exposes, so tools (and agents) can discover the whole surface in one call.

{
  "framework": "AkurAI-Framework",
  "routes": [
    { "method": "GET", "path": "/api/health" },
    { "method": "GET", "path": "/api/_meta" }
  ],
  "collections": []
}

Collection endpoints (planned)

Declaring a collection in backend/collections.toml will generate a full REST surface with no handwritten code:

GET    /api/collections/{name}/records
POST   /api/collections/{name}/records
GET    /api/collections/{name}/records/{id}
PATCH  /api/collections/{name}/records/{id}
DELETE /api/collections/{name}/records/{id}

Plus filtering, sorting, relation expansion, and ?search= semantic search on any text field marked embed = true.

These collection routes are the next milestone, built on the storage engine. Until then, collections in the manifest is an empty list.