Memory

Create a collection

Changed on

Declare a collection of JSON documents addressed by key. This is the counterpart to facts: POST /v1/memory recalls by meaning, a collection recalls by key.

Create it explicitly when you need query. Writing to an unknown collection creates it implicitly, but with no indexes — and indexes cannot be added afterwards. If you will ever look items up by a field rather than by key, declare that field here, before the first write.

A collection is defined once for the project. Its ITEMS are per-scope, so the same collection holds a separate set of documents for the project, for each contact, and for each conversation.

post/v1/memory/collections

Request

  • Base URL
    https://api.zavu.dev
  • URL
    https://api.zavu.dev/v1/memory/collections
  • Auth
    HTTP bearer

Request body

namestring required

1-63 chars: lowercase letters, digits, - and _, starting with a letter or digit.

defaultTtlSecondsinteger

Example request

{
  "name": "orders",
  "indexes": [
    {
      "field": "status"
    }
  ]
}

Response

Collection created.

Example response

{
  "collection": {
    "name": "orders"
  }
}

Changes