Getting started

API

The Neutron AI API lets your platform remember, recall, cache, audit, and manage scoped memory for agents.

All authenticated requests use:

Authorization: Bearer <NEUTRON_API_TOKEN>

Base URL

https://neutronai.dev/api

Use your assigned API base URL if your workspace has a custom endpoint.

Response shape

Successful responses return an object with success: true and a data payload.

Errors return success: false with a stable error code and human-readable message.

{
  "success": false,
  "error": {
    "code": "bad_request",
    "message": "Human-readable message"
  }
}

Memory endpoints

  • GET /v1/nuclei
  • POST /v1/nuclei
  • GET /v1/nuclei/:nucleusId
  • POST /v1/memory/remember
  • POST /v1/memory/recall
  • POST /v1/memory/agent-context
  • POST /v1/memory/forget
  • GET /v1/memory/audit
  • POST /v1/memory/compact

Cache endpoints

  • GET /v1/memory/cache/stats
  • POST /v1/memory/cache/invalidate
  • POST /v1/memory/cache/warm

Agent endpoints

  • POST /v1/memory/reflect
  • POST /v1/memory/skills/learn
  • POST /v1/memory/kb/upsert

MCP endpoints

  • POST /mcp
  • GET /mcp/tools

MCP tools expose the same memory operations through a schema-compatible tool interface for agent clients.

Required fields

Most memory requests include:

  • nucleusId: the memory-bank boundary
  • scopeId or scopeIds: the user, project, team, agent, or session boundary
  • agentId: the calling agent or integration
  • task, query, or text: the external workflow input

tenantId remains a legacy alias for nucleusId. If both are supplied, they must match.

Workspace API keys can create Nuclei and access Nuclei linked to that workspace. Nucleus access tokens can access only their own Nucleus. Prefer Nucleus tokens for runtime memory calls.

Safe usage

Do not send provider API keys, session cookies, private credentials, or raw regulated data unless your contract and privacy configuration explicitly allow it.