VEvectorize
Entities

List entities

Changed on

List all entities (people, organizations, etc.) known by the bank, ordered by mention count. Supports pagination.

get/v1/default/banks/{bank_id}/entities

Request

Path parameters

bank_idstring required

Query parameters

limitinteger

Maximum number of entities to return

offsetinteger

Offset for pagination

tagsstring[] nullable

Only count memories carrying these tags. An entity is returned only when a matching memory mentions it, and its mention count and dates cover the matching memories only.

tags_match'any' | 'all' | 'any_strict' | 'all_strict' | 'exact'

How tags match (same modes as listing memories).

tag_groupsstring nullable

Compound tag filter as a JSON-encoded list of tag groups — the same shape tag_groups takes in a recall body (leaves {tags, match, resolve} and {and: [...]}, {or: [...]}, {not: ...}; groups are AND-ed). Mutually exclusive with tags.

Headers

authorizationstring nullable

Response

Successful Response

totalinteger required
limitinteger required
offsetinteger required

Example response

{
  "items": [
    {
      "canonical_name": "John",
      "first_seen": "2024-01-15T10:30:00Z",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "last_seen": "2024-02-01T14:00:00Z",
      "mention_count": 15
    }
  ],
  "limit": 100,
  "offset": 0,
  "total": 150
}

Changes

  • 4fda98b75f63Revision changes
    • warning

      for the query request parameter limit, the min was set to 0.00

    • warning

      for the query request parameter offset, the min was set to 0.00

    • warning

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

    • info

      added the new optional query request parameter tag_groups

    • info

      added the new optional query request parameter tags

    • info

      added the new optional query request parameter tags_match

    • info

      added the non-success response with the status

  • 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