Quickstart

Install the CLI, create an API key in the dashboard, ingest a memory, poll its Guardian job, and search it back.

Authenticate

1. 1

   Create an API key

   Sign in to the Memuron dashboard and open API Keys in the sidebar (or /keys). Keys look like arth_sk_… and are scoped to your active organization.

   shell

   # Create a key in the dashboard, then export it locally
   export MEMURON_API_KEY="arth_sk_…"

2. 2

   Install the CLI

   Memuron ships on PyPI. Point the CLI at the hosted API with your key.

   shell

   # Recommended: run without installing
   uvx memuron@0.1.2 config set \
     --base-url https://memuron-production.up.railway.app \
     --api-key "$MEMURON_API_KEY"
   
   uvx memuron@0.1.2 query --query "ls" --cwd /spaces/space.personal
   
   # Or install once
   uv tool install memuron==0.1.2 --python 3.14
   memuron config set \
     --base-url https://memuron-production.up.railway.app \
     --api-key "$MEMURON_API_KEY"

3. 3

   Ingest a memory

   Queue raw content for the Guardian. You get back a job_id immediately — ingestion is async.

   cURLPythonTypeScript

   curl -X POST https://memuron-production.up.railway.app/memuron/memories \
     -H "Authorization: Bearer $MEMURON_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "content": "User prefers dark mode in the editor.",
       "scope": ["space.work", "org:acme"]
     }'

   import requests, os
   
   res = requests.post(
       "https://memuron-production.up.railway.app/memuron/memories",
       headers={"Authorization": f"Bearer {os.environ['MEMURON_API_KEY']}"},
       json={
           "content": "User prefers dark mode in the editor.",
           "scope": ["space.work", "org:acme"],
       },
   )
   print(res.json()["job_id"])

   const res = await fetch("https://memuron-production.up.railway.app/memuron/memories", {
     method: "POST",
     headers: {
       Authorization: `Bearer ${process.env.MEMURON_API_KEY}`,
       "Content-Type": "application/json",
     },
     body: JSON.stringify({
       content: "User prefers dark mode in the editor.",
       scope: ["space.work", "org:acme"],
     }),
   });
   const { job_id } = await res.json();

4. 4

   Poll the job

   Watch the job move queued → processing → completed. The result tells you whether the Guardian created or updated a memory.

   shell

   curl https://memuron-production.up.railway.app/memuron/jobs/$JOB_ID \
     -H "Authorization: Bearer $MEMURON_API_KEY"

5. 5

   Search it back

   Run a hybrid semantic + lexical search. Results are ranked by both meaning and exact terms.

   shell

   curl -X POST https://memuron-production.up.railway.app/memuron/memories/search \
     -H "Authorization: Bearer $MEMURON_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{ "query": "editor preferences", "k": 5 }'