VEvectorize
Banks

Create or update memory bank

Changed on

Create a new agent or update existing agent with disposition and mission. Auto-fills missing fields with defaults.

put/v1/default/banks/{bank_id}

Request

Path parameters

bank_idstring required

Headers

authorizationstring nullable

Request body

namestring nullable

Deprecated: display label only, not advertised

disposition_skepticisminteger nullable

Deprecated: use update_bank_config instead

disposition_literalisminteger nullable

Deprecated: use update_bank_config instead

disposition_empathyinteger nullable

Deprecated: use update_bank_config instead

missionstring nullable

Deprecated: use update_bank_config with reflect_mission instead

backgroundstring nullable

Deprecated: use update_bank_config with reflect_mission instead

reflect_missionstring nullable

Mission/context for Reflect operations. Guides how Reflect interprets and uses memories.

retain_missionstring nullable

Steers what gets extracted during retain(). Injected alongside built-in extraction rules.

retain_extraction_modestring nullable

Fact extraction mode: 'concise' (default), 'verbose', 'custom', 'verbatim', or 'chunks'.

retain_custom_instructionsstring nullable

Custom extraction prompt. Only active when retain_extraction_mode is 'custom'.

retain_chunk_sizeinteger nullable

Target maximum characters for each content chunk during retain.

retain_structured_chunk_sizeinteger nullable

Maximum characters for a single JSONL line or conversation turn to keep whole during retain. Defaults to retain_chunk_size when unset.

retain_max_attachments_per_chunkinteger nullable

Maximum inline attachments one extraction chunk may carry. retain_chunk_size budgets text only — a placeholder costs the characters it occupies and nothing more — so this is what bounds attachments. Match it to the provider's per-request limit.

enable_observationsboolean nullable

Toggle automatic observation consolidation after retain().

observations_missionstring nullable

Controls what gets synthesised into observations. Replaces built-in consolidation rules entirely.

enable_text_searchboolean nullable

Toggle the keyword (BM25) retrieval arm during recall. Disabling leaves pure vector search: the arm is left out of the query entirely rather than filtered to nothing, so none of its cost is paid. Also drops the keyword arm from knowledge-page search.

enable_temporal_retrievalboolean nullable

Toggle the temporal retrieval arm during recall, together with the date-aware query analysis that feeds it. Useful for banks whose content carries no meaningful dates.

enable_graph_retrievalboolean nullable

Toggle the entity/link graph traversal arm during recall. Disabling trades relational recall for latency on banks whose content has little entity structure.

enable_rerankingboolean nullable

Toggle cross-encoder reranking during recall. Disabling returns the RRF-fused ordering directly, which is faster but less precise.

Example request

{
  "observations_mission": "Observations are stable facts about people and projects. Always include preferences and skills.",
  "retain_mission": "Always include technical decisions and architectural trade-offs. Ignore meeting logistics."
}

Response

Successful Response

bank_idstring required
namestring required
missionstring required

The agent's mission - who they are and what they're trying to accomplish

backgroundstring nullable

Deprecated: use mission instead

Example response

{
  "bank_id": "user123",
  "disposition": {
    "empathy": 3,
    "literalism": 3,
    "skepticism": 3
  },
  "mission": "I am a software engineer helping my team stay organized and ship quality code",
  "name": "Alice"
}

Changes

  • 4fda98b75f63Revision changes
    • warning

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

    • 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

  • 0d08f271b9dbRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status