Skip to content

§ Interfaces

REST API. Plain HTTP, three endpoints.

Call OctaMem over the web using simple HTTP requests. Every request needs your API key in the Authorization header and JSON in the body.

Host

platform.octamem.com

Auth

Bearer API key

Format

application/json

Authentication

Every request needs your API key in the header: Authorization: Bearer YOUR_API_KEY. All calls go to https://platform.octamem.com and use JSON, set Content-Type: application/json.

POST /api/memory/details

Check your account, not what you have saved in memory. Use this to see if your key is valid, how much storage you are using, and what your plan allows (including usage and balance). It does not return the text of your memories.

POST /api/memory/detailsbash
curl --location 'https://platform.octamem.com/api/memory/details' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --data '{}'

Body

  • {}: send an empty object. Your API key in the header is what identifies you.

POST /api/memory/add

Save new information to memory. Optional previousContext is like a label for this conversation or customer, use the same label when you search so answers stay tied to that topic.

POST /api/memory/addbash
curl -X POST 'https://platform.octamem.com/api/memory/add' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -d '{
    "content": "Customer prefers email updates on Monday mornings only.",
    "previousContext": "Onboarding — Acme Corp"
  }'

Fields

  • content: string · required. The note, decision, or fact you want remembered or stored.
  • previousContext: string · optional. Label (e.g. chat or client). Use the same text when you search to pull only related memories.

Look something up in what you saved. Ask in normal language. Add the same previousContext as when you saved if you only want results from one chat, customer, or project.

POST /api/memory/searchbash
curl -X POST 'https://platform.octamem.com/api/memory/search' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -d '{
    "query": "How does this customer want to be contacted?",
    "previousContext": "Onboarding — Acme Corp"
  }'

Fields

  • query: string · required. What you are trying to find, written like a question or short phrase.
  • previousContext: string · optional. Same label you used when saving, to narrow results to that thread.