v1

latestOpenAPI 3.0.1Apache 2.02026-07-135212282.4 KB
memories

Search memories based on a query and filters.

post/v2/memories/search/

Request body

querystring required

The query to search for in the memory.

versionstring

The version of the memory to use. This should always be v2.

top_kinteger

The number of top results to return.

fieldsstring[]

A list of field names to include in the response. If not provided, all fields will be returned.

rerankboolean

Whether to rerank the memories.

keyword_searchboolean

Whether to search for memories based on keywords.

filter_memoriesboolean

Whether to filter the memories.

thresholdnumber

The minimum similarity threshold for returned results.

org_idstring nullable

The unique identifier of the organization associated with the memory.

project_idstring nullable

The unique identifier of the project associated with the memory.

Response

Successfully retrieved search results.

idstring uuid required

Unique identifier for the memory.

memorystring required

The content of the memory

user_idstring required

The identifier of the user associated with this memory

metadataobject nullable

Additional metadata associated with the memory

categoriesstring[]

Categories associated with the memory

immutableboolean

Whether the memory is immutable.

expiration_datestring date nullable

The date when the memory will expire. Format: YYYY-MM-DD.

created_atstring date-time required

The timestamp when the memory was created.

updated_atstring date-time required

The timestamp when the memory was last updated.