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
- Go to app.neuroloom.dev and log in
- Navigate to Settings → API Keys
- Click New API Key, give it a name, and select its scope
- Copy the key — it is shown only once
API keys are prefixed by environment:
| Prefix | Environment |
|---|---|
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
| Scope | Permitted operations |
|---|---|
read | GET endpoints only — search and retrieve |
write | GET, POST, PATCH, DELETE |
admin | All operations including key management |
Use the narrowest scope possible for production agents.
Rotating Keys
To rotate a compromised key:
- Generate a new key in the dashboard
- Deploy the new key to all services
- 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
| Status | Reason |
|---|---|
401 Unauthorized | Missing or invalid API key |
403 Forbidden | Key exists but lacks the required scope |
429 Too Many Requests | Rate limit exceeded — see Retry-After header |
Next Steps
- Memories API — Start creating and searching memories
- MCP Integration — Use Neuroloom as an MCP tool server