v1

OpenAPI 3.0.1Apache 2.02026-07-135212282.4 KB
memories

Perform a semantic search on memories.

post/v1/memories/search/

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.

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.