Authentication
REST
Using the REST API directly.
Most people should use the TypeScript SDK, which handles retries, timeouts and error shapes. The REST API is here for everything else.
Code
https://app.gethivemind.xyzEvery request carries a bearer token:
Terminal
curl https://app.gethivemind.xyz/v3/me \
-H "Authorization: Bearer hm_live_..."Create a key under Connected tools in the dashboard. It is shown once.
Responses
JSON throughout. Errors carry a message field and, where it helps, a code:
json
{ "error": "You have stored 500 memories this month, the Free plan's limit.",
"code": "quota_exceeded" }| Status | |
|---|---|
| 401 | Missing, malformed or revoked key |
| 402 | Monthly allowance spent, writes stop, reads continue |
| 404 | Not found, or not yours. The two are deliberately indistinguishable |
| 429 | Rate limited |
Note
A resource belonging to another account returns 404, not 403. Confirming that an id exists would be a way to enumerate other people's data.
Rate limits
60 writes and 600 reads per minute. Writes are lower because each one runs an embedding.