Memory Stores

Update a memory store

POST /memory_stores/{name}

Updates the specified memory store with the supplied configuration changes.

Header parameters

Foundry-Features enum required

A feature flag opt-in required when using preview operations or modifying persisted preview resources.

MemoryStores=V1Preview

Path parameters

name string required

The name of the memory store to update.

Query parameters

api-version string required

The API version to use for this operation.

Request Body

Content-Type: application/json

description string

A human-readable description of the memory store.

metadata object

Arbitrary key-value metadata to associate with the memory store.

[key: string] string

Responses

The request has succeeded.

Body

Content-Type: application/json

object enum required

The object type, which is always 'memory_store'.

memory_store

id string required

The unique identifier of the memory store.

created_at integer required

updated_at integer required

name string required

The name of the memory store.

description string

A human-readable description of the memory store.

metadata object

Arbitrary key-value metadata to associate with the memory store.

[key: string] string

definition default required

Base definition for memory store configurations.

One of the following:

default MemoryStoreDefaultDefinition

Default memory store implementation.

kind enum required

The kind of the memory store.

default

chat_model string required

The name or identifier of the chat completion model deployment used for memory processing.

embedding_model string required

The name or identifier of the embedding model deployment used for memory processing.

options MemoryStoreDefaultOptions

Default memory store configurations.

user_profile_enabled boolean required

Whether to enable user profile extraction and storage. Default is true.

user_profile_details string

Specific categories or types of user profile information to extract and store.

chat_summary_enabled boolean required

Whether to enable chat summary extraction and storage. Defaults to true.

procedural_memory_enabled boolean

Whether to enable procedural memory extraction and storage. The service defaults to true if a value is not specified by the caller.

default_ttl_seconds integer

The default time-to-live for memories in seconds. A value of 0 indicates that memories do not expire. Defaults to 0.