Skip to main content

Bank Templates

Declarative JSON manifests for creating pre-configured memory banks with a single API call.

Overview

A bank template is a JSON manifest that describes a bank's full setup: configuration overrides, mental models, directives, and more. Instead of making multiple API calls to configure a bank, you submit one manifest and the API provisions everything.

Templates are useful for:

  • Replication — stamp out identically-configured banks for multiple users or agents
  • Onboarding — new users start with a known-good configuration instead of configuring from scratch
  • Sharing — distribute recommended setups as portable JSON files
  • Framework integrations — ship a recommended template alongside your integration

Browse the Bank Templates Hub for ready-to-use templates.

Manifest Schema

{
"version": "1",
"bank": {
"reflect_mission": "...",
"retain_mission": "...",
"retain_extraction_mode": "concise | verbose | custom | chunks",
"retain_custom_instructions": "...",
"retain_chunk_size": 2048,
"disposition_skepticism": 3,
"disposition_literalism": 3,
"disposition_empathy": 3,
"enable_observations": true,
"observations_mission": "...",
"entity_labels": ["PERSON", "ORGANIZATION"],
"entities_allow_free_form": true
},
"mental_models": [
{
"id": "unique-lowercase-id",
"name": "Human-Readable Name",
"source_query": "The query that generates this mental model's content",
"tags": ["optional", "tags"],
"max_tokens": 2048,
"trigger": {
"refresh_after_consolidation": false,
"fact_types": ["world", "experience", "observation"],
"exclude_mental_models": false,
"exclude_mental_model_ids": []
}
}
],
"directives": [
{
"name": "directive-name",
"content": "The directive instruction text",
"priority": 0,
"is_active": true,
"tags": ["optional", "tags"]
}
]
}

Fields

FieldRequiredDescription
versionYesSchema version. Currently "1".
bankNoBank configuration overrides. Omit to leave config unchanged.
mental_modelsNoMental models to create or update. Omit to leave unchanged.
directivesNoDirectives to create or update. Omit to leave unchanged.

All of bank, mental_models, and directives are optional. Omit any section to leave that part of the bank unchanged.

Bank Config Fields

All fields in bank are optional. Only the fields you include will be set as per-bank overrides — everything else inherits from the server/tenant defaults.

FieldTypeDescription
reflect_missionstringMission/context for reflect operations
retain_missionstringSteers what gets extracted during retain
retain_extraction_modestringconcise, verbose, custom, or chunks
retain_custom_instructionsstringCustom extraction prompt (requires mode=custom)
retain_chunk_sizeintegerMax token size per content chunk
disposition_skepticisminteger (1-5)How skeptical the disposition is
disposition_literalisminteger (1-5)How literal the disposition is
disposition_empathyinteger (1-5)How empathetic the disposition is
enable_observationsbooleanToggle observation consolidation
observations_missionstringControls what gets synthesised into observations
entity_labelsstring[]Controlled vocabulary for entity labels
entities_allow_free_formbooleanAllow entities outside the label vocabulary

Mental Model Fields

FieldRequiredDescription
idYesUnique ID (lowercase alphanumeric with hyphens). Used to match on re-import.
nameYesHuman-readable name
source_queryYesThe query that generates this model's content via reflect
tagsNoTags for scoped visibility. Default: []
max_tokensNoMax tokens for generated content (256-8192). Default: 2048
triggerNoTrigger settings for auto-refresh

Directive Fields

FieldRequiredDescription
nameYesDirective name. Used as the match key on re-import.
contentYesThe directive instruction text.
priorityNoPriority value (higher = more important). Default: 0
is_activeNoWhether the directive is active. Default: true
tagsNoTags for categorization. Default: []

Import

Import a manifest into a bank. If the bank doesn't exist, it's created automatically.

template = {
"version": "1",
"bank": {
"retain_mission": "Extract customer issues, resolutions, and sentiment.",
"enable_observations": True,
"observations_mission": "Track recurring customer pain points.",
},
"mental_models": [
{
"id": "sentiment-overview",
"name": "Customer Sentiment Overview",
"source_query": "What is the overall sentiment trend?",
"trigger": {"refresh_after_consolidation": True},
}
],
"directives": [
{
"name": "Acknowledge frustration",
"content": "Always acknowledge frustration before offering solutions.",
"priority": 10,
}
],
}

response = requests.post(
f"{HINDSIGHT_URL}/v1/default/banks/my-bank/import",
json=template,
)
result = response.json()
print(f"Config applied: {result['config_applied']}")
print(f"Mental models created: {result['mental_models_created']}")
print(f"Directives created: {result['directives_created']}")

Behavior

  • Config: all bank fields are applied as per-bank config overrides
  • Mental models: matched by id — existing models are updated, new ones are created
  • Directives: matched by name — existing directives are updated, new ones are created
  • Async: mental model content is generated asynchronously. The response includes operation_ids to track progress.

Dry Run

Validate a manifest without applying changes:

response = requests.post(
f"{HINDSIGHT_URL}/v1/default/banks/my-bank/import",
params={"dry_run": "true"},
json=template,
)
result = response.json()
print(f"Dry run: {result['dry_run']}")
print(f"Would apply config: {result['config_applied']}")

Returns what would happen (which config would be applied, which mental models would be created) without making any changes. Returns HTTP 400 with a detailed error message if the manifest is invalid.

Export

Export a bank's current config overrides, mental models, and directives as a manifest:

response = requests.get(
f"{HINDSIGHT_URL}/v1/default/banks/my-bank/export"
)
exported = response.json()
print(json.dumps(exported, indent=2))

The exported manifest only includes config fields that were explicitly set as per-bank overrides — not the fully resolved config (which includes server/tenant defaults). This means the exported manifest is portable: importing it into a new bank only overrides the fields that were intentionally customized.

Round-trip

Export from one bank and import into another to replicate the setup:

# Export from source bank
response = requests.get(
f"{HINDSIGHT_URL}/v1/default/banks/source-bank/export"
)
exported = response.json()

# Import into a new bank
response = requests.post(
f"{HINDSIGHT_URL}/v1/default/banks/new-bank/import",
json=exported,
)

JSON Schema

The manifest format is defined by a JSON Schema. Fetch the live schema from your server:

response = requests.get(
f"{HINDSIGHT_URL}/v1/bank-template-schema"
)
schema = response.json()
print(json.dumps(schema, indent=2))

The static schema is also available at bank-template-schema.json.

Control Plane

The control plane bank creation dialog includes an optional "Import from template" toggle. Enable it to paste a manifest JSON and pre-configure the bank on creation.

You can also export any bank's template from the bank Settings page via Actions → Export Template, which copies the manifest JSON to your clipboard.

Versioning

The version field enables forward-compatible schema evolution. The current version is "1".

When future versions are released:

  • Older manifests are automatically upgraded to the current schema on import
  • Export always produces the latest version
  • The API rejects manifests with a version newer than what the server supports (with a clear error message suggesting an upgrade)

This means old templates keep working indefinitely — no need to manually update them.