Reference

Memory Runtime API

Default address http://127.0.0.1:18960. Once storage.token, MEMMY_MEMORY_TOKEN, or MEMORY_SERVICE_TOKEN is set, all endpoints except the health check require a bearer token.

MethodPathDescription
GET/api/v1/healthHealth check
POST/api/v1/sessions/openOpen an Agent session
POST/api/v1/sessions/:sessionId/closeClose a session
POST/api/v1/turns/startRecord a turn start
POST/api/v1/turns/:turnId/completeRecord a turn completion
POST/api/v1/memory/searchSearch memories
POST/api/v1/memory/addWrite a memory
GET/api/v1/memory/:idMemory details
DELETE/api/v1/memory/:idDelete a memory
GET/api/v1/panel/overviewPanel overview
GET/api/v1/panel/analysisMemory analytics
GET/api/v1/panel/itemsEntry list

Local Storage Configuration

memmyMemory:
  version: 1
  activeProfile: byok
  storage:
    mode: local
    backend: sqlite
    sqlitePath: ~/.memmy/memory-service/memory.sqlite
    endpoint: http://127.0.0.1:18960
    token: local-token
  profiles:
    byok:
      embedding:
        provider: local

On this page