Skip to main content
POST
/
v2
/
memory-stores
Create memory store
curl --request POST \
  --url https://api.orq.ai/v2/memory-stores \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "<string>",
  "embedding_config": {
    "model": "<string>"
  },
  "description": "<string>",
  "path": "Default",
  "ttl": 123
}
'
{
  "_id": "<string>",
  "key": "<string>",
  "description": "<string>",
  "created": "<string>",
  "updated": "<string>",
  "embedding_config": {
    "model": "<string>"
  },
  "created_by_id": "<string>",
  "updated_by_id": "<string>",
  "ttl": 123
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
key
string
required

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

Required string length: 1 - 255
Pattern: ^[A-Za-z]([A-Za-z0-9]*([._][A-Za-z0-9]+)*)?$
​
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.

With workspace-level API keys, use the format project/folder/subfolder/.... The first element identifies the project, followed by nested folders (auto-created as needed). Example: Default/agents.

With project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: agents. For backward compatibility, a leading project name is ignored when it matches the scoped project.

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

201 - application/json

Memory store successfully created with the specified configuration.

​
_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.

Required string length: 1 - 255
Pattern: ^[A-Za-z]([A-Za-z0-9]*([._][A-Za-z0-9]+)*)?$
​
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 | null

The user ID of the creator

​
updated_by_id
string | null

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.