Skip to content

Import bank template

POST /v1/default/banks/{bank_id}/import

Import a bank template manifest to create or update a bank's configuration, mental models, and directives. If the bank does not exist it is created. Config fields are applied as per-bank overrides. Mental models are matched by id, directives by name — existing ones are updated, new ones are created. Use dry_run=true to validate the manifest without applying changes.

Authentication required — include an Authorization: Bearer hsk_... header. See Authentication for details.

Path Parameters

NameTypeRequiredDescription
bank_idstringYes

Query Parameters

NameTypeRequiredDescription
dry_runbooleanNoValidate only, do not apply changes

Example Request

bash
curl -X POST 'https://api.hindsight.vectorize.io/v1/default/banks/your-bank-id/import' \
  -H 'Authorization: Bearer hsk_your_api_key'

Responses

200 — Successful Response

json
{
  "bank_id": "Bank Id",
  "config_applied": false,
  "mental_models_created": [],
  "mental_models_updated": [],
  "directives_created": [],
  "directives_updated": [],
  "operation_ids": [],
  "dry_run": false
}

422 — Validation Error

json
{
  "detail": [
    {
      "loc": [
        null
      ],
      "msg": "Message",
      "type": "Error Type",
      "input": null,
      "ctx": {},
      "url": "URL"
    }
  ]
}

Source: /v1/default/banks/{bank_id}/import