Skip to main content
POST
/
v1
/
sdk
/
recall
Recall memories semantically or by neighborhood walk.
curl --request POST \
  --url https://api.reload.chat/v1/sdk/recall \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "seed_id": "<string>",
  "depth": 2,
  "scope_id": "<string>",
  "expand": [
    "provenance",
    "related"
  ],
  "filters": {
    "include_superseded": false,
    "include_invalidated": false,
    "include_expired": false,
    "min_confidence": 0.5,
    "min_similarity": 0.5
  },
  "metadata_filter": {},
  "limit": 20
}
'
{
  "data": {
    "hits": [
      {
        "id": "<string>",
        "org_id": "<string>",
        "content": "<string>",
        "confidence": 123,
        "version": 123,
        "ttl_seconds": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "last_reinforced_at": "2023-11-07T05:31:56Z",
        "expires_at": "2023-11-07T05:31:56Z",
        "invalidated_at": "2023-11-07T05:31:56Z",
        "invalidated_by": "<string>",
        "invalidated_reason": "<string>",
        "content_hash": "<string>",
        "metadata": {}
      }
    ],
    "edges": [
      {
        "id": "<string>",
        "from_id": "<string>",
        "from_type": "<string>",
        "to_id": "<string>",
        "to_type": "<string>",
        "properties": {},
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "scores": [
      {
        "memory_id": "<string>",
        "total": 123,
        "similarity": 123,
        "confidence_bonus": 123,
        "recency_penalty": 123,
        "supersession_penalty": 123
      }
    ],
    "messages": [
      {
        "id": "<string>",
        "channel_id": "<string>",
        "thread_id": "<string>",
        "author_identity_id": "<string>",
        "kind": "<string>",
        "content": "<string>",
        "metadata": {},
        "created_at": "2023-11-07T05:31:56Z",
        "version": 123
      }
    ]
  },
  "meta": {
    "requestId": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "pagination": {
      "hasMore": true,
      "cursor": "<string>",
      "total": 123,
      "historyCutoff": {
        "beyondCount": 123,
        "cutoffAt": "2023-11-07T05:31:56Z"
      }
    }
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/json
query
string

Semantic query. Provide exactly one of query or seed_id.

seed_id
string

Neighborhood-walk seed. Provide exactly one of query or seed_id.

depth
integer

BFS walk depth (with seed_id).

Required range: 1 <= x <= 3
scope_id
string
expand
enum<string>[]

Edge-expansion mode for recall.

Available options:
provenance,
related
filters
object
metadata_filter
object
limit
integer
default:20
Required range: 1 <= x <= 100

Response

Success

success
enum<boolean>
required
Available options:
true
data
object
required
meta
object