Skip to Content

Memory

Search many memory spaces

Recall from up to 10 memory spaces in one call, merged into one ranked list.

POST/v1/dum/federated-search

Searches several memory spaces at once and merges the results, best match first. Spaces the key can't reach, or that don't exist, are skipped, and the rest are still searched.

Body

memory_space_idsstring<uuid>[]required

The memory spaces to search, from 1 to 10.

querystringrequired

The question, in plain words.

top_kintegerdefault: 5

How many memories to return in total, from 1 to 20.

end_userstring | null

Returns only this person's memories, in every space searched.

Response

A list of memories from every space searched, best match first.

[].idstring<uuid>required

The memory's ID.

[].contentstringrequired

The remembered text.

[].memory_typestringrequired

The storage class.

[].confidence_scorenumber | nullrequired

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

[].memory_space_idstring<uuid>required

The memory space the memory came from.

Status codes

StatusMeaning
200The search ran across every space the key can reach.
401The key is missing, malformed, or revoked.
422A field is missing or invalid, such as more than 10 spaces.
429The read rate limit was hit.

One federated search counts as one read, however many spaces it covers.