Platform APIs
- Client libraries
- GETList memory stores
- POSTCreate memory store
- GETRetrieve memory store
- DELDelete memory store
- PATCHUpdate memory store
- GETList all memories
- POSTCreate a new memory
- GETRetrieve a specific memory
- DELDelete a specific memory
- PATCHUpdate a specific memory
- GETList all documents for a memory
- POSTCreate a new memory document
- GETRetrieve a specific memory document
- DELDelete a specific memory document
- PATCHUpdate a specific memory document
- GET
Gateway APIs
curl --request GET \
--url https://api.orq.ai/v2/memory-stores \
--header 'Authorization: Bearer <token>'{
"object": "list",
"data": [
{
"_id": "<string>",
"key": "<string>",
"description": "<string>",
"created": "<string>",
"updated": "<string>",
"embedding_config": {
"model": "<string>"
},
"created_by_id": "<string>",
"updated_by_id": "<string>",
"ttl": 123
}
],
"has_more": true
}List memory stores
Retrieves a paginated list of memory stores in the workspace. Use cursor-based pagination parameters to navigate through the results.
curl --request GET \
--url https://api.orq.ai/v2/memory-stores \
--header 'Authorization: Bearer <token>'{
"object": "list",
"data": [
{
"_id": "<string>",
"key": "<string>",
"description": "<string>",
"created": "<string>",
"updated": "<string>",
"embedding_config": {
"model": "<string>"
},
"created_by_id": "<string>",
"updated_by_id": "<string>",
"ttl": 123
}
],
"has_more": true
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10
1 <= x <= 200A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with 01JJ1HDHN79XAS7A01WB3HYSDB, your subsequent call can include after=01JJ1HDHN79XAS7A01WB3HYSDB in order to fetch the next page of the list.
A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with 01JJ1HDHN79XAS7A01WB3HYSDB, your subsequent call can include before=01JJ1HDHN79XAS7A01WB3HYSDB in order to fetch the previous page of the list.
Response
Successfully retrieved the list of memory stores.
list Show child attributes
Show child attributes
The unique identifier of the memory store
The unique key of the memory store. The key is unique and inmmutable and cannot be repeated within the same workspace.
The description of the memory store. Be as precise as possible to help the AI to understand the purpose of the memory store.
The creation date of the memory store
The last update date of the memory store
Show child attributes
Show child attributes
The embeddings model to use for the knowledge base in the format "provider/model" for public models or "workspaceKey@provider/model" for private workspace models. This model will be used to embed the chunks when they are added to the knowledge base. Refer to the (Supported models)[/docs/proxy/supported-models] to browse available models.
The user ID of the creator
The user ID of the last updater
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.
Was this page helpful?