Skip to content

List facts

View .md
GET

Every fact in a scope, newest first. This is the bookkeeping view — to actually recall something, use POST /v1/memory/search, which ranks by meaning.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Query parameters

  • scopestring

    Which scope to address: contact:<contactId>, conversation:<conversationId>, or omitted for the project scope.

    Note the asymmetry with POST /v1/memory and POST /v1/memory/search, which take the scope in the request BODY as scope plus contactId/conversationId. Every other Memory endpoint takes it here.

  • limitinteger
    Default50
    Limitsmax 100
  • cursorstring

    Opaque cursor from a previous response's nextCursor. Do not construct it.

Responses

200Facts in the scope.
  • itemsobject[]required
    6 properties
    • idstringrequired
    • textstring

      The remembered text.

    • metadataobject
      1 properties
      • {key}string
    • scorenumber

      Cosine similarity to the query, 0 to 1, higher being closer. Present on search results only — a list or a single read has no query to score against.

    • createdAtstring<date-time>required
    • expiresAtstring<date-time>
  • nextCursorstringnullable
400Invalid scope or query parameters.
  • codestringrequired
  • messagestringrequired
  • detailsobject
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject