Hindsight Cloud API
The Hindsight Cloud API is the HTTP interface for working with memory banks, operations, documents, mental models, and the full set of Vectorize Hindsight features.
- Base URL:
https://api.hindsight.vectorize.io - OpenAPI version:
3.1.0 - API version:
0.5.6 - Total endpoints: 66 across 12 resource groups
- Spec: openapi.json
See the API Reference index for the full endpoint list.
Authentication
The API uses Bearer token authentication with Hindsight API keys.
- API keys are prefixed with
hsk_ - Include the key in the
Authorizationheader on every request
curl -X GET 'https://api.hindsight.vectorize.io/v1/banks' \
-H 'Authorization: Bearer hsk_your_api_key'Keys can be created in the Hindsight dashboard (account-scoped) or programmatically via the Scoped API Keys endpoints — bank-scoped keys with cascade revocation.
See API Keys for full key management.
Resource Groups
| Group | Endpoints | Purpose |
|---|---|---|
| Memory | 10 | Retain, recall, reflect, list, get, clear memories |
| Banks | 15 | Create, update, delete memory banks; config; profile |
| Entities | 4 | List entities, entity graphs, observation regeneration |
| Mental Models | 7 | Pre-computed reflections with auto-refresh |
| Directives | 5 | Recall and retain directives |
| Documents | 7 | Upload, reprocess, chunk-level retrieval |
| Operations | 4 | Async operation tracking, retry, cancel |
| Bank Templates | 3 | Export, import, schema |
| Webhooks | 5 | Event delivery |
| Files | 1 | File-based memory retain |
| Audit | 2 | Audit log listing and stats |
| Scoped API Keys | 3 | Programmatic key management |
Browse the full endpoint list for direct links to each operation.
Error Format
Hindsight uses standard HTTP status codes. Errors are returned as JSON with a detail field describing the failure. Common codes:
| Code | Meaning |
|---|---|
400 | Bad request — invalid payload or query |
401 | Unauthorized — missing or invalid API key |
403 | Forbidden — key lacks the required scope |
404 | Not found — bank, memory, document, or operation does not exist |
409 | Conflict — concurrent modification or duplicate resource |
422 | Unprocessable entity — schema validation failed |
429 | Rate limit exceeded |
5xx | Server error |
See Error Codes for the full table.
Versioning
The current API version is 0.5.6. Paths are prefixed with /v1. Breaking changes are announced on What's New. The OpenAPI specification is the authoritative source.
SDKs
| Language | Package | Docs |
|---|---|---|
| Python | hindsight-client | Python SDK |
| TypeScript / JavaScript | @vectorize-io/hindsight-client | TypeScript SDK |
| cURL | — | cURL Examples |
Related
- Getting Started — provision a bank and make a first call
- Memory Operations — conceptual guide to Retain, Recall, Reflect, Mental Models
- MCP Integration — connect to Claude, Cursor, ChatGPT, VS Code
- What's New — release notes
Source: docs.hindsight.vectorize.io/api-reference/hindsight-cloud-api