VEvectorize
Entities

Get entity details

Changed on

Get detailed information about an entity including observations (mental model).

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

Request

Path parameters

bank_idstring required
entity_idstring required

Query parameters

tagsstring[] nullable

Only count memories carrying these tags. The entity is a 404 when no matching memory mentions it; 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

idstring required
canonical_namestring required
mention_countinteger required
first_seenstring nullable
last_seenstring nullable
metadataobject nullable

Example response

{
  "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,
  "observations": [
    {
      "mentioned_at": "2024-01-15T10:30:00Z",
      "text": "John works at Google"
    }
  ]
}

Changes

  • 4fda98b75f63Revision changes
    • 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

  • 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