A.R.A.E Documentation

A.R.A.E — Autonomous Reasoning and Adaptive Evaluation. This guide covers Quickstart, public API endpoints, and a concise 90-second demo script.

Quickstart

Five steps to validate A.R.A.E end-to-end:

  1. Check service health — confirm the service is reachable and ready.
  2. Ingest example data — submit one or more observations to the engine.
  3. Query for context — retrieve the ingested state and verify it is present.
  4. Evaluate a decision — run the reasoning layer against a goal and context.
  5. Review diagnostics and metrics — confirm observability surfaces are populated.
# 1) Health check
curl -sS https://api.obsidiangenerations.com/health

# 2) Ingest  (Linux / Mac / Windows Git Bash)
curl -sS -X POST https://api.obsidiangenerations.com/ingest \
  -H "Content-Type: application/json" \
  -d '{"source":"demo","items":[{"id":"ex-1","kind":"observation","value":{"signal":"alpha","score":0.73}}]}'

# 2) Ingest  (Windows cmd / PowerShell -- single line)
curl -sS -X POST https://api.obsidiangenerations.com/ingest -H "Content-Type: application/json" -d "{\"source\":\"demo\",\"items\":[{\"id\":\"ex-1\",\"kind\":\"observation\",\"value\":{\"signal\":\"alpha\",\"score\":0.73}}]}"

# 3) Query
curl -sS -X POST https://api.obsidiangenerations.com/query \
  -H "Content-Type: application/json" \
  -d '{"filter":{"kind":"observation"},"limit":10}'

# 4) Decision evaluate
curl -sS -X POST https://api.obsidiangenerations.com/decision/evaluate \
  -H "Content-Type: application/json" \
  -d '{"goal":"select_action","context":{"situation":"demo"}}'

# 5) Diagnostics and metrics
curl -sS https://api.obsidiangenerations.com/diagnostics
curl -sS https://api.obsidiangenerations.com/metrics

All endpoints are designed for stability and observability. Use /diagnostics and /metrics to validate behavior during tests and demonstrations.

API Endpoints

Endpoint Method Description Response shape
/health GET Service liveness and readiness probe. Returns immediately; safe to poll. {"status":"ok","uptime_s":…}
/ingest POST Submit observations, facts, or events for reasoning.
Body: {"source":"…","items":[…]}
{"accepted":N,"rejected":0}
/query POST Retrieve contextual information or state from the engine.
Body: {"filter":{…},"limit":N}
{"results":[…],"total":N}
/decision/evaluate POST Run decision evaluation with an explicit goal and context.
Body: {"goal":"…","context":{…}}
{"decision":"…","rationale":"…","confidence":0.0–1.0}
/diagnostics GET Operational state, recent events, and trace-level indicators for debugging. {"state":"…","events":[…]}
/metrics GET Counters and gauges suitable for dashboards and automated monitors. {"requests_total":N,"latency_ms_p99":…}

90-Second Demo Script

A structured walkthrough you can deliver while running the commands live. Total elapsed time: approximately 90 seconds.

  1. Open the hosted demo — navigate to api.obsidiangenerations.com/demo or the local demo explainer.
  2. Show health — run GET /health; confirm "status":"ok" and note the uptime field.
  3. Ingest a small example — post one observation; confirm the response shows "accepted":1.
  4. Query for context — run POST /query; highlight the returned item and its fields.
  5. Evaluate a decision — run POST /decision/evaluate; point out the decision, rationale, and confidence fields.
  6. Show observability — open GET /diagnostics and GET /metrics; note counters and state fields.
  7. Close with the roadmap — mention upcoming layers: Perception, Memory, Planning, Execution, Oversight & Governance (all Coming Soon).
# Paste sequentially while narrating  (Linux / Mac / Git Bash)
curl -sS https://api.obsidiangenerations.com/health

curl -sS -X POST https://api.obsidiangenerations.com/ingest \
  -H "Content-Type: application/json" \
  -d '{"source":"demo","items":[{"id":"ex-1","kind":"observation","value":{"signal":"alpha","score":0.73}}]}'

curl -sS -X POST https://api.obsidiangenerations.com/query \
  -H "Content-Type: application/json" \
  -d '{"filter":{"kind":"observation"},"limit":5}'

curl -sS -X POST https://api.obsidiangenerations.com/decision/evaluate \
  -H "Content-Type: application/json" \
  -d '{"goal":"select_action","context":{"situation":"demo"}}'

curl -sS https://api.obsidiangenerations.com/diagnostics
curl -sS https://api.obsidiangenerations.com/metrics