Aionis Docs

Appearance

Quickstart

Quickstart

This page gets you to a working Aionis integration in minutes. Run one write, one recall, and leave with the identifiers you need for replay and debugging.

Health checkWrite memoryRecall context
/health
memory.write
memory.recall_text
commit.persist
tenant_idscoperequest_idcommit_uri

What you will do ​

  1. Run Aionis locally or point to a hosted environment.
  2. Write one recallable memory event.
  3. Recall that memory by text.
  4. Capture the identifiers you will need later for replay and debugging.
  5. Leave this page with one verified end-to-end success path.

Before you start ​

  1. Docker and Docker Compose for local setup.
  2. Node.js >=18 if you plan to run repository scripts.
  3. curl and jq for the validation steps below.

Choose your path ​

  1. Use the local quickstart if you want the fastest hands-on validation from this repository.
  2. Use the hosted quickstart if you already have a running Aionis environment and credentials.
  3. If you are evaluating the product instead of integrating today, read Overview first and come back here.

End-to-end flow ​

flowchart LR
  A["Developer"] --> B["Write memory"]
  B --> C["Recall context"]
  C --> D["Apply policy"]
  D --> E["Execute action"]
  E --> F["Persist decision"]

Local quickstart ​

Clone and configure the repository:

bash
git clone https://github.com/Cognary/Aionis.git
cd Aionis
cp .env.example .env

Use these local .env defaults for a first smoke path:

bash
PORT=3001
MEMORY_AUTH_MODE=off
EMBEDDING_PROVIDER=fake

Start the stack and confirm health:

bash
make stack-up
curl -fsS http://localhost:3001/health | jq

Write one recallable event and verify recall:

bash
curl -sS http://localhost:3001/v1/memory/write \
  -H 'content-type: application/json' \
  -d '{
    "tenant_id":"default",
    "scope":"default",
    "input_text":"Customer prefers email follow-up",
    "memory_lane":"shared",
    "nodes":[{"type":"event","memory_lane":"shared","text_summary":"Customer prefers email follow-up"}]
  }' | jq

curl -sS http://localhost:3001/v1/memory/recall_text \
  -H 'content-type: application/json' \
  -d '{"tenant_id":"default","scope":"default","query_text":"preferred follow-up channel","limit":5}' | jq

Stop services when finished:

bash
make stack-down

Hosted quickstart ​

If you already have a hosted Aionis environment, use the same validation path:

bash
export BASE_URL="https://api.your-domain.com"
export API_KEY="your_api_key"

curl -fsS "$BASE_URL/health" | jq

curl -sS "$BASE_URL/v1/memory/write" \
  -H 'content-type: application/json' \
  -H "X-Api-Key: $API_KEY" \
  -d '{
    "tenant_id":"default",
    "scope":"default",
    "input_text":"hosted onboarding write",
    "memory_lane":"shared",
    "nodes":[{"type":"event","memory_lane":"shared","text_summary":"hosted onboarding write"}]
  }' | jq

What success looks like ​

  1. /health returns healthy status.
  2. write returns request_id and commit fields.
  3. recall_text returns candidate or context data.
  4. You can identify which IDs to keep for later replay and debugging.

What to persist from your first run ​

  1. request_id
  2. tenant_id
  3. scope
  4. data.commit_id
  5. data.commit_uri
  1. Core Concepts
  2. Memory and Policy Loop
  3. API Guide
  4. SDK Guide if you do not want to stay at raw HTTP level