MEmem0
memories

POST /v1/memories/search/

Changed on

Perform a semantic search on memories.

Request

  • Base URL
    https://api.mem0.ai
  • URL
    https://api.mem0.ai/v1/memories/search/
  • Auth
    API key in header Authorization

Request body

querystring required

The query to search for in the memory.

agent_idstring nullable

The agent ID associated with the memory.

user_idstring nullable

The user ID associated with the memory.

app_idstring nullable

The app ID associated with the memory.

run_idstring nullable

The run ID associated with the memory.

metadataobject nullable

Additional metadata associated with the memory.

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.

output_formatstring nullable

The search method supports two output formats: v1.0 (default) and v1.1. We recommend using v1.1 as v1.0 will be deprecated soon.

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.

filter_memoriesboolean

Whether to properly filter the memories according to the input.

categoriesstring[]

A list of categories to filter the memories by.

only_metadata_based_searchboolean

Whether to only search for memories based on metadata.

Response

Successfully retrieved search results.

OR

Changes

  • d8043b07769dRevision changes
    • breaking

      added subschema #1 subschema #2 to the response body oneOf list for the response status

    • breaking

      the response's body type changed from array to no type for status

    • info

      endpoint deprecated

    • info

      the request property default value changed from v1.1 to v1.0