Skip to main content

Authentication

The Lore API uses workspace-scoped API keys for authentication. These keys are used by the REST API and the MCP server.


Generate an API key

  1. Open Settings > API in your Lore dashboard
  2. Click Create API key
  3. Copy the key — it is only shown once

API keys are hashed (SHA-256) before storage. Lore never stores the raw key.


Usage

Include the key as a Bearer token in the Authorization header:

curl -H "Authorization: Bearer YOUR_API_KEY" \
https://lorehq.co/api/v1/documents

Scope

Each API key is tied to a single workspace. It can only access documents within that workspace. There are no per-key permission scopes — all API keys have read access to the workspace's documents and search.


Personal Access Tokens

The CLI uses a separate authentication mechanism: Personal Access Tokens (PATs). These are user-scoped (not workspace-scoped) and are generated automatically during the lore login flow.

PATs authenticate CLI requests via the same Authorization: Bearer header, with the workspace specified in an x-lore-workspace header.

For automation and CI/CD, you can set environment variables instead of running the login flow:

export LORE_PAT=your_personal_access_token
export LORE_WORKSPACE=your-workspace-slug
export LORE_API_URL=https://lorehq.co

API keys vs. PATs

API KeyPersonal Access Token
ScopeSingle workspaceUser (any workspace the user belongs to)
Created viaDashboard (Settings > API)lore login browser flow
Used byREST API, MCP serverCLI
Workspace selectionImplicit (key is workspace-bound)Explicit (x-lore-workspace header or LORE_WORKSPACE env var)