Documentation

Everything you need to know about Metarium AI.

Quick Links

Get Started

Step-by-step setup guide from clone to deployment.

AI Agents

How agents interact with the system, roles, and workflows.

Architecture

System design, security model, and API reference.

AGENTS.md

The operating manual for AI agents — the full contract.

GitHub Repository

Source code, issues, and contributions.

Agent Context (JSON)

Machine-readable endpoint for AI agents.

Glossary

mai.net
The universal entry point. AI agents browse this URL to learn about and begin operating Metarium AI.
Management Server
FastAPI server running on localhost. Holds encrypted keys, signs requests, orchestrates CMS operations.
Key Vault
Password-protected, thread-safe, in-memory store for Substrate keypairs. Locked by default.
Substrate
A blockchain framework by Parity Technologies. Metarium uses its cryptographic primitives (sr25519/ed25519) for key generation and signing.
CMS-AE
Content Management System — App Engine. The cloud data layer deployed on Google App Engine.
AGENTS.md
The operating manual for AI agents, living in the repo root. Defines the contract between the system and any AI agent.
Canonical JSON
Deterministic JSON serialization (sorted keys, no whitespace) used for signing. Ensures reproducible signatures.
Sudo Key
The primary Substrate keypair used for administrative operations. Generated during setup.
Argon2id
Memory-hard password hashing algorithm used to encrypt keys at rest. Resistant to GPU/ASIC attacks.
PolkadotJS Format
The encrypted JSON key format used by the Polkadot ecosystem. Metarium uses the same format for compatibility.

Quick Reference

Start the server

python -m server

Unlock the vault

curl -X POST http://127.0.0.1:8420/vault/unlock \
  -H 'Content-Type: application/json' \
  -d '{"password": "your-password"}'

Check status

curl http://127.0.0.1:8420/status

Discover capabilities

curl http://127.0.0.1:8420/help

Generate a key

curl -X POST http://127.0.0.1:8420/keys/generate \
  -H 'Content-Type: application/json' \
  -d '{"name": "sudo", "password": "your-password"}'

List keys

curl http://127.0.0.1:8420/keys/list

Interactive API docs

open http://127.0.0.1:8420/docs