@x12i/memorix-catalox-api
v1.33.0
Published
HTTP API for Memorix Catalox — metadata control plane (manage Catalox catalogs with scope, execute engines, Mappix BFF, abstraction).
Readme
@x12i/memorix-catalox-api
HTTP control plane for Memorix Catalox metadata — formerly @x12i/memorix-schema-api.
- Manage catalog items in
memorix-catalox(each item carriesscope: { domains, agents }) - Execute engines that consume that metadata (completion, inventory reconcile, abstract list/item) — execute requests do not take scope
- Also hosts Schema UI metadata routes, Mappix BFF, and abstraction routes
Default port 5180 (MEMORIX_CATALOX_API_PORT, falls back to SCHEMA_API_PORT / PORT).
Data consumption (lists, records, pipeline runtime) stays on memorix-explorer-api (:5181).
Quick start
cd memorix-catalox-api
npm install
npm run dev # tsx serve on :5180CLI: npx memorix-catalox-api serve
With Schema UI:
cd memorix-schema-ui && npm run dev # starts this API (:5180) + Vite (:5174)With Catalox Manager:
cd memorix-catalox-manager && npm run dev # this API (:5180) + Vite (:5177)Catalox routes (v1)
| Method | Path | Notes |
|--------|------|--------|
| GET | /api/catalox/health | Liveness |
| GET | /api/catalox/catalogs | All 13 kinds + counts (honest empty, not false unavailable) |
| GET | /api/catalox/catalogs/:id/items | List items; each includes scope |
| GET | /api/catalox/catalogs/:id/items/:itemId | Get item + scope |
| POST | /api/catalox/catalogs/:id/items | Create (body requires scope) |
| PUT | /api/catalox/catalogs/:id/items/:itemId | Upsert (body requires scope) |
| DELETE | /api/catalox/catalogs/:id/items/:itemId | Delete |
| POST | /api/catalox/execute/completion | Run completion mappings (no scope) |
| POST | /api/catalox/execute/inventory-reconcile | Reconcile vs Mongo (no scope) |
| POST | /api/catalox/execute/abstract/list | Abstract list (no scope) |
| POST | /api/catalox/execute/abstract/item | Abstract item (no scope) |
Writes require MEMORIX_SCHEMA_UI_ENABLE_METADATA_WRITES=true (or MEMORIX_EXPLORER_ENABLE_METADATA_WRITES=true).
Legacy Schema UI routes under /api/metadata/* and /api/abstraction/* remain for the existing UI.
Environment
| Variable | Default | Description |
|----------|---------|-------------|
| MEMORIX_CATALOX_API_PORT | 5180 | Listen port (SCHEMA_API_PORT still accepted) |
| MONGO_URI | — | Mongo |
| MEMORIX_CATALOX_DB | memorix-catalox | Catalox DB name |
| MEMORIX_SCHEMA_UI_ENABLE_METADATA_WRITES | off | Enable manage + execute writes |
Related
- Catalox Manager
- Explorer API (data plane)
- Gap inventory
