Skip to main content
The Brain API is mounted at /v1/brain (company-scoped) and /v1/users/{user_id}/brain (per-tenant). All routes require authentication (session cookie or Authorization: Bearer nv_sk_...) and the brain primitive to be enabled on the AccountKit — otherwise they return 403 primitive_disabled_by_kit.

Auth & gating

  • Auth: session or API key.
  • Entitlement: brain is an opt-in primitive (default off). Enable it in the AccountKit.
  • Metering: per-tenant plan quota is enforced on each call (except GET /status). Credit costs apply per operation (see below).
  • Idempotency: mutating routes accept an Idempotency-Key header.

Credits

Endpoint groups

Deletion receipts

Destructive routes (DELETE /:id, DELETE /documents/:id, POST /forget) are approval-gated for agent callers (return 202 pending) and return a deletion receipt on completion:
verified: true means emptiness was confirmed post-purge; provider_confirmed alone means the purge call ran.