Bank Templates

Import bank template

Changed on

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.

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

Request

Path parameters

bank_idstring required

Query parameters

dry_runboolean

Validate only, do not apply changes

Headers

authorizationstring nullable

Request body

versionstring required

Manifest schema version (currently '1')

Example request

{
  "bank": {
    "disposition_empathy": 5,
    "enable_observations": true,
    "reflect_mission": "You are helping a support agent remember customer interactions.",
    "retain_mission": "Extract customer issues, resolutions, and sentiment."
  },
  "directives": [
    {
      "content": "Always respond with empathy and understanding.",
      "name": "Always be empathetic",
      "priority": 10
    }
  ],
  "mental_models": [
    {
      "id": "sentiment-overview",
      "name": "Customer Sentiment Overview",
      "source_query": "What is the overall sentiment trend?",
      "trigger": {
        "refresh_after_consolidation": true
      }
    }
  ],
  "version": "1"
}

Response

Successful Response

bank_idstring required

Bank that was imported into

config_appliedboolean required

Whether bank config was updated

mental_models_createdstring[]

IDs of newly created mental models

mental_models_updatedstring[]

IDs of updated mental models

directives_createdstring[]

Names of newly created directives

directives_updatedstring[]

Names of updated directives

operation_idsstring[]

Operation IDs for mental model content generation (async)

dry_runboolean

True if this was a validation-only run

Changes

    • warning

      the /// request property's max was set to 2147483647.00

    • warning

      the /// request property's min was set to -2147483648.00

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property ////

    • breaking

      added required request body

    • warning

      removed the optional property // from the response with the status