Hindsight Cloud API Reference

Base URL: https://api.hindsight.vectorize.io

Authentication: Authorization: Bearer your-api-key (keys start with hsk_)

OpenAPI version: 3.1.0 · API version: 0.5.6

66 endpoints across 12 resource groups.

Resource Groups

Audit

Method	Endpoint	Description
GET	/v1/default/banks/{bank_id}/audit-logs/stats	Audit log statistics
GET	/v1/default/banks/{bank_id}/audit-logs	List audit logs

Bank Templates

Method	Endpoint	Description
GET	/v1/default/banks/{bank_id}/export	Export bank template
GET	/v1/bank-template-schema	Get bank template JSON Schema
POST	/v1/default/banks/{bank_id}/import	Import bank template

Banks

Method	Endpoint	Description
POST	/v1/default/banks/{bank_id}/background	Add/merge memory bank background (deprecated)
DELETE	/v1/default/banks/{bank_id}/observations	Clear all observations
PUT	/v1/default/banks/{bank_id}	Create or update memory bank
DELETE	/v1/default/banks/{bank_id}	Delete memory bank
GET	/v1/default/banks/{bank_id}/config	Get bank configuration
GET	/v1/default/banks/{bank_id}/profile	Get memory bank profile
GET	/v1/default/banks/{bank_id}/stats	Get statistics for memory bank
GET	/v1/default/banks	List all memory banks
GET	/v1/default/banks/{bank_id}/stats/memories-timeseries	Memory ingestion time-series
PATCH	/v1/default/banks/{bank_id}	Partial update memory bank
POST	/v1/default/banks/{bank_id}/consolidation/recover	Recover failed consolidation
DELETE	/v1/default/banks/{bank_id}/config	Reset bank configuration
POST	/v1/default/banks/{bank_id}/consolidate	Trigger consolidation
PATCH	/v1/default/banks/{bank_id}/config	Update bank configuration
PUT	/v1/default/banks/{bank_id}/profile	Update memory bank disposition

Directives

Method	Endpoint	Description
POST	/v1/default/banks/{bank_id}/directives	Create directive
DELETE	/v1/default/banks/{bank_id}/directives/{directive_id}	Delete directive
GET	/v1/default/banks/{bank_id}/directives/{directive_id}	Get directive
GET	/v1/default/banks/{bank_id}/directives	List directives
PATCH	/v1/default/banks/{bank_id}/directives/{directive_id}	Update directive

Documents

Method	Endpoint	Description
DELETE	/v1/default/banks/{bank_id}/documents/{document_id}	Delete a document
GET	/v1/default/chunks/{chunk_id}	Get chunk details
GET	/v1/default/banks/{bank_id}/documents/{document_id}	Get document details
GET	/v1/default/banks/{bank_id}/documents/{document_id}/chunks	List document chunks
GET	/v1/default/banks/{bank_id}/documents	List documents
POST	/v1/default/banks/{bank_id}/documents/{document_id}/reprocess	Reprocess document
PATCH	/v1/default/banks/{bank_id}/documents/{document_id}	Update document

Entities

Method	Endpoint	Description
GET	/v1/default/banks/{bank_id}/entities/graph	Get entity co-occurrence graph
GET	/v1/default/banks/{bank_id}/entities/{entity_id}	Get entity details
GET	/v1/default/banks/{bank_id}/entities	List entities
POST	/v1/default/banks/{bank_id}/entities/{entity_id}/regenerate	Regenerate entity observations (deprecated)

Files

Method	Endpoint	Description
POST	/v1/default/banks/{bank_id}/files/retain	Convert files to memories

Memory

Method	Endpoint	Description
DELETE	/v1/default/banks/{bank_id}/memories	Clear memory bank memories
DELETE	/v1/default/banks/{bank_id}/memories/{memory_id}/observations	Clear observations for a memory
GET	/v1/default/banks/{bank_id}/graph	Get memory graph data
GET	/v1/default/banks/{bank_id}/memories/{memory_id}	Get memory unit
GET	/v1/default/banks/{bank_id}/memories/{memory_id}/history	Get observation history
GET	/v1/default/banks/{bank_id}/memories/list	List memory units
GET	/v1/default/banks/{bank_id}/tags	List tags
POST	/v1/default/banks/{bank_id}/memories/recall	Recall memory
POST	/v1/default/banks/{bank_id}/reflect	Reflect and generate answer
POST	/v1/default/banks/{bank_id}/memories	Retain memories

Mental Models

Method	Endpoint	Description
POST	/v1/default/banks/{bank_id}/mental-models	Create mental model
DELETE	/v1/default/banks/{bank_id}/mental-models/{mental_model_id}	Delete mental model
GET	/v1/default/banks/{bank_id}/mental-models/{mental_model_id}	Get mental model
GET	/v1/default/banks/{bank_id}/mental-models/{mental_model_id}/history	Get mental model history
GET	/v1/default/banks/{bank_id}/mental-models	List mental models
POST	/v1/default/banks/{bank_id}/mental-models/{mental_model_id}/refresh	Refresh mental model
PATCH	/v1/default/banks/{bank_id}/mental-models/{mental_model_id}	Update mental model

Operations

Method	Endpoint	Description
DELETE	/v1/default/banks/{bank_id}/operations/{operation_id}	Cancel a pending async operation
GET	/v1/default/banks/{bank_id}/operations/{operation_id}	Get operation status
GET	/v1/default/banks/{bank_id}/operations	List async operations
POST	/v1/default/banks/{bank_id}/operations/{operation_id}/retry	Retry a failed async operation

Scoped API Keys

Method	Endpoint	Description
POST	/v1/api-keys/scoped	Create Scoped Api Key
GET	/v1/api-keys/scoped	List Scoped Api Keys
DELETE	/v1/api-keys/scoped/{key_id}	Revoke Scoped Api Key

Webhooks

Method	Endpoint	Description
DELETE	/v1/default/banks/{bank_id}/webhooks/{webhook_id}	Delete webhook
GET	/v1/default/banks/{bank_id}/webhooks/{webhook_id}/deliveries	List webhook deliveries
GET	/v1/default/banks/{bank_id}/webhooks	List webhooks
POST	/v1/default/banks/{bank_id}/webhooks	Register webhook
PATCH	/v1/default/banks/{bank_id}/webhooks/{webhook_id}	Update webhook