neuroloom
Neuroloom is in early access.Start building free →

Authentication

Neuroloom uses API keys for authentication. Every request must include a valid key and is automatically scoped to a single workspace.

Creating an API Key

  1. Go to app.neuroloom.dev and log in
  2. Navigate to Settings → API Keys
  3. Click New API Key, give it a name, and select its scope
  4. Copy the key — it is shown only once

API keys are prefixed by environment:

PrefixEnvironment
nlk_live_Production
nlk_test_Sandbox / staging

Using the Authorization Header

Pass your API key in the Authorization header on every request:

curl https://api.neuroloom.dev/v1/memories \
  -H "Authorization: Bearer nlk_live_your_key_here" \
  -H "Content-Type: application/json"

The SDK handles this automatically:

const client = new Neuroloom({ apiKey: process.env.NEUROLOOM_API_KEY });

Workspace Isolation

Every API key belongs to exactly one workspace. All data — memories, embeddings, and search indexes — is strictly isolated per workspace. You cannot read or write data across workspaces with a single key.

To work with multiple workspaces from the same codebase, create one client instance per key:

const workspaceA = new Neuroloom({ apiKey: process.env.KEY_WORKSPACE_A });
const workspaceB = new Neuroloom({ apiKey: process.env.KEY_WORKSPACE_B });

Key Scopes

ScopePermitted operations
readGET endpoints only — search and retrieve
writeGET, POST, PATCH, DELETE
adminAll operations including key management

Use the narrowest scope possible for production agents.

Rotating Keys

To rotate a compromised key:

  1. Generate a new key in the dashboard
  2. Deploy the new key to all services
  3. Revoke the old key from Settings → API Keys → Revoke

Revocation is immediate. In-flight requests using the old key will receive a 401 Unauthorized response.

Error Responses

StatusReason
401 UnauthorizedMissing or invalid API key
403 ForbiddenKey exists but lacks the required scope
429 Too Many RequestsRate limit exceeded — see Retry-After header

Next Steps

Ready to get started?

Start building with Neuroloom for free.

Start Building Free