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/{memory_store_key}/memories/{memory_id}/documents \
--header 'Authorization: Bearer <token>'{
"object": "list",
"data": [
{
"_id": "<string>",
"memory_id": "<string>",
"store_id": "<string>",
"text": "<string>",
"created": "<string>",
"updated": "<string>",
"workspace_id": "<string>",
"created_by_id": "<string>",
"updated_by_id": "<string>",
"metadata": {}
}
],
"has_more": true
}List all documents for a memory
Retrieves a paginated list of documents associated with a specific memory.
curl --request GET \
--url https://api.orq.ai/v2/memory-stores/{memory_store_key}/memories/{memory_id}/documents \
--header 'Authorization: Bearer <token>'{
"object": "list",
"data": [
{
"_id": "<string>",
"memory_id": "<string>",
"store_id": "<string>",
"text": "<string>",
"created": "<string>",
"updated": "<string>",
"workspace_id": "<string>",
"created_by_id": "<string>",
"updated_by_id": "<string>",
"metadata": {}
}
],
"has_more": true
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique key identifier of the memory store
The unique identifier of the memory
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.
Filter documents updated after this ISO datetime
Filter documents updated before this ISO datetime
Response
Successfully retrieved the list of memory documents.
list Show child attributes
Show child attributes
Flexible key-value pairs for custom filtering and categorization. Clients can add arbitrary string metadata to enable future filtering of memory documents based on their specific needs (e.g., document type, source, topic, relevance score, or any custom taxonomy).
Show child attributes
Show child attributes
Was this page helpful?