Skip to content
DashboardGet API key

Get a fact

View .md
GET

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Path parameters

  • memoryIdstringrequired

    Memory (fact) ID.

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.

Responses

200The fact.
  • memoryobjectrequired

    A stored fact as returned by a read. score appears only on search results.

    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>
400Malformed memory id or `scope`.
  • codestringrequired
  • messagestringrequired
  • detailsobject
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject
404No such fact in that scope. A fact stored under `contact` is not found by a project-scoped read — pass the same `?scope=` it was written with.
  • codestringrequired
  • messagestringrequired
  • detailsobject