Skip to main content

Conventions

General conventions that apply across every /v1/memories/* and /v1/agents/* route.

Request and response format

  • Base URL defaults to http://localhost:3050 for local runs.
  • Request and response bodies are JSON.
  • Field names use snake_case (e.g. user_id, source_site).

Error responses

All endpoints return errors in a consistent format:

{ "error": "user_id (string) is required" }
StatusMeaning
400Invalid input (missing/malformed fields)
404Resource not found (e.g. GET /v1/memories/:id with an unknown id)
410Gone — the route is deprecated in the current mode (e.g. PUT /v1/memories/config in production)
500Internal server error

CORS

The server allows requests from:

  • http://localhost:3050
  • http://localhost:3081

Preflight OPTIONS requests are handled automatically.