Skip to main content
PATCH
/
v2
/
memory-stores
/
{memory_store_key}
Update memory store
curl --request PATCH \
  --url https://api.orq.ai/v2/memory-stores/{memory_store_key} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "embedding_config": {
    "model": "cohere/embed-multilingual-v3.0"
  },
  "description": "<string>",
  "ttl": 123,
  "path": "Default"
}'
{
  "_id": "<string>",
  "key": "<string>",
  "project_id": "<string>",
  "description": "<string>",
  "created_by_id": "<string>",
  "updated_by_id": "<string>",
  "created": "<string>",
  "updated": "<string>",
  "ttl": 123,
  "embedding_config": {
    "model_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "integration_id": "<string>",
    "top_k": 123,
    "provider": "cohere"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

memory_store_key
string
required

The unique key identifier of the memory store

Body

application/json
embedding_config
object
required
description
string
required

The description of the memory store. Be as precise as possible to help the AI to understand the purpose of the memory store.

path
string
required

Entity storage path in the format: project/folder/subfolder/...

The first element identifies the project, followed by nested folders (auto-created as needed).

With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.

Example:

"Default"

ttl
number

The default time to live of every memory document created within the memory store. Useful to control if the documents in the memory should be store for short or long term.

Response

Memory store successfully updated.

_id
string
required

The unique identifier of the memory store

key
string
required

The unique key of the memory store. The key is unique and inmmutable and cannot be repeated within the same workspace.

project_id
string
required

The project unique identifier. This entity is assigned based on the provided path property

description
string
required

The description of the memory store. Be as precise as possible to help the AI to understand the purpose of the memory store.

created
string
required

The creation date of the memory store

updated
string
required

The last update date of the memory store

embedding_config
object
required
created_by_id
string

The user ID of the creator

updated_by_id
string

The user ID of the last updater

ttl
number

The default time to live of every memory document created within the memory store. Useful to control if the documents in the memory should be store for short or long term.