Skip to main content
POST
/
open
/
v1
/
memory
/
retrieve
Retrieve Memory
curl --request POST \
  --url https://api.example.com/open/v1/memory/retrieve \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": "<string>",
  "agentId": "<string>",
  "query": "<string>",
  "strategy": "SIMPLE",
  "trace": true
}
'
{
  "data": {
    "status": "<string>",
    "items": [
      {
        "id": "<string>",
        "text": "<string>",
        "vectorScore": 123,
        "finalScore": 123,
        "occurredAt": "2023-11-07T05:31:56Z"
      }
    ],
    "insights": [
      {
        "id": "<string>",
        "text": "<string>",
        "tier": "<string>"
      }
    ],
    "rawData": [
      {
        "rawDataId": "<string>",
        "caption": "<string>",
        "maxScore": 123,
        "itemIds": [
          "<string>"
        ]
      }
    ],
    "evidences": [
      "<string>"
    ],
    "strategy": "<string>",
    "query": "<string>",
    "trace": {
      "traceId": "<string>",
      "startedAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z",
      "truncated": true,
      "stages": [
        {
          "stage": "<string>",
          "tier": "<string>",
          "method": "<string>",
          "status": "<string>",
          "inputCount": 123,
          "candidateCount": 123,
          "resultCount": 123,
          "degraded": true,
          "skipped": true,
          "startedAt": "2023-11-07T05:31:56Z",
          "durationMillis": 123,
          "attributes": {},
          "candidates": [
            {
              "sourceType": "<string>",
              "rank": 123,
              "finalScore": 123,
              "vectorScore": 123,
              "textPreview": "<string>"
            }
          ]
        }
      ],
      "merge": {
        "inputCount": 123,
        "outputCount": 123,
        "deduplicatedCount": 123,
        "sourceCount": 123,
        "status": "<string>"
      },
      "finalResults": {
        "strategy": "<string>",
        "status": "<string>",
        "itemCount": 123,
        "insightCount": 123,
        "rawDataCount": 123,
        "evidenceCount": 123
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.openmemind.com/llms.txt

Use this file to discover all available pages before exploring further.

The API Reference is under active development. Request and response schemas may change before a stable release.

Body

application/json
userId
string
required
Minimum string length: 1
agentId
string
required
Minimum string length: 1
query
string
required
Minimum string length: 1
strategy
enum<string>
required
Available options:
SIMPLE,
DEEP
trace
boolean

Response

200 - */*

OK

data
object