Getting an API key
Sign up
Create an account at memorycrystal.ai if you don’t have one.
Open the dashboard
Go to memorycrystal.ai/dashboard and sign in.
Create an API key
Navigate to Settings → API Keys and click New key. Give it a descriptive name (for example,
production or my-agent).Copy the key immediately — it is shown only once. Memory Crystal stores only a SHA-256 hash of the plaintext key, so it cannot be retrieved again after you close the dialog.Passing the key
Include the key in theAuthorization header of every request using the Bearer scheme:
401 Unauthorized response.
Legacy alias
If you are migrating from an earlier version of Memory Crystal, the environment variableCRYSTAL_API_KEY is accepted alongside MEMORY_CRYSTAL_API_KEY in the MCP server and plugin. The HTTP header name is always Authorization: Bearer.
Security properties
- Hashed at rest — the plaintext key is never stored. Only its SHA-256 hash is written to the database.
- Shown once — the dashboard displays the key immediately after creation and never again.
- Per-key rate limiting — rate limits are enforced separately for each API key on all endpoints. The Knowledge Base endpoints allow up to 60 requests per minute per key. If you exceed the limit, the API returns
429 Too Many Requests.
Example request
The example below creates a memory directly using the capture endpoint. Replacemc_your_api_key with your actual key and your-deployment.convex.site with your backend URL.
