Skip to Content

Memory

Search memories

Recall the memories in one memory space that best answer a question.

POST/v1/dum/search

Searches one memory space and returns the most relevant, current memories, best match first. lynk.recall calls it for you.

Body

memory_space_idstring<uuid>required

The memory space to search.

querystringrequired

The question, in plain words.

top_kintegerdefault: 5

How many memories to return, from 1 to 50.

end_userstring | null

Returns only this person's memories, up to 255 characters. Required in a multi-user space, where a search without it returns []. See End users.

Response

A list of memories, best match first.

[].idstring<uuid>required

The memory's ID.

[].contentstringrequired

The remembered text.

[].memory_typestringrequired

The storage class. See Memory types.

[].confidence_scorenumber | nullrequired

How strongly the memory answers the query, from 0 to 1.

Status codes

StatusMeaning
200The search ran. An empty list means nothing matched.
401The key is missing, malformed, or revoked.
403The key's capability or scope doesn't allow searching this memory space.
404The memory space doesn't exist in the key's workspace.
422A field is missing or invalid, such as top_k above 50.
429The read rate limit was hit.