Skip to content

overview.mdx

Latest commit

 

History

History
72 lines (58 loc) · 2.8 KB

overview.mdx

File metadata and controls

72 lines (58 loc) · 2.8 KB
Raw
title API Overview
description Memongo HTTP API endpoint reference.
icon unplug

The Memongo API server runs at http://127.0.0.1:3847 by default (via apps/api).

The API is the app-facing surface of the Memongo Company Brain framework. It can be used directly from services or through the TypeScript client, AI SDK tools, and MCP server.

Endpoints

Method Path Description
GET /health Service health
GET /openapi.json OpenAPI document

Memory operations

Method Path Description
POST /v1/add Add content to memory
POST /v1/write-event Write a conversation event (any role)
POST /v1/write-structured Write a structured memory entry
POST /v1/write-procedure Write a procedure memory
POST /v1/search Search memory (hybrid vector + full-text)
POST /v1/search-detailed Search with passes, metadata, and evidence
POST /v1/search-kb Search the knowledge base
POST /v1/profile Synthesize a user profile from memory
POST /v1/context-bundle Build a prompt-ready context bundle
POST /v1/memory/feedback Confirm, correct, or reject memory relevance

Lifecycle operations

Method Path Description
POST /v1/lifecycle/get Get a structured or procedure memory by stable handle
POST /v1/lifecycle/update Update a structured or procedure memory by stable handle
POST /v1/lifecycle/delete Delete or invalidate a structured or procedure memory by stable handle
POST /v1/lifecycle/history Inspect lifecycle history by stable handle

System operations

Method Path Description
GET /v1/status Memory provider status and health
GET /v1/stats Memory statistics (counts, sizes)
POST /v1/sync Force a memory sync cycle
GET /v1/probes/embedding Probe embedding availability
GET /v1/probes/vector Probe vector availability
GET /v1/status/detailed Detailed status view
POST /v1/admin/relevance/explain Explain relevance for a query
POST /v1/admin/relevance/benchmark Run a relevance benchmark
GET /v1/admin/relevance/report Relevance report
GET /v1/admin/relevance/sample-rate Relevance sampling rate

Authentication

Set MEMONGO_API_KEY for every shared or network-exposed deployment. If no admin or scoped key is configured, /v1 routes stay open for trusted local development and the API logs a startup warning.

When MEMONGO_API_KEY is set, all requests must include a Bearer token:

http POST http://127.0.0.1:3847/v1/search \
  Authorization:"Bearer your-api-key" \
  query="search query" \
  sessionKey="user-123"