Skip to content

Summary

What one app user's memory holds, in a few lines - how many items, the first and last dates, the connected apps, and what memory knows now.

POST/v2/memory/summaryReads memoryTry it in the Playground
Auth
read key
Cost
free; never refused for your plan

A search against a memory you cannot see is a guess, and an empty answer to a guess reads like an absence. Summary is the first call an agent that has never looked should make. It takes no arguments; send {}.

Headers

Authorizationstringrequired

Bearer tm_…. A read key is enough.

X-Alexein-Userstringrequired

The app user whose memory to describe. See App users.

X-Request-Idstring

Your id for this request, echoed on the response.

Body

{}objectrequired

An empty object.

Response

itemsinteger

How many items memory holds for this app user, added and from connected apps.

firstdate | null

When the oldest of them was said or written. null for an empty memory.

lastdate | null

When the newest was. null for an empty memory.

sourcesobject[]

The connected apps this memory holds, each with provider, source, connection, items (how many), ended (how many of those items the app has since reported gone, such as deleted or archived; memory keeps them) and newest (its newest item's date). See Sources.

knownstring[]

What memory holds to be true now, as lines for a model to read first. Can be empty, as for a new memory.

For an app user with no memory yet it answers 200 with items: 0 and every list empty.

Errors

400bad request

X-Alexein-User is missing or not a usable id.

401unauthorized

The bearer is not a key this service issued.

403forbidden

The organisation has been closed in the console.

429too many requests

Too many requests in flight, or reads too fast. Retry after Retry-After seconds. See Limits.

503unavailable

The service is busy or briefly unavailable. Retry after Retry-After seconds, or with backoff when there is none.

Request
curl https://api.alexein.ai/v2/memory/summary \
  -H "Authorization: Bearer $ALEXEIN_API_KEY" \
  -H "X-Alexein-User: user_42" \
  -H "Content-Type: application/json" \
  -d '{}'
200 OK (shortened)
{
  "items": 214,
  "first": "2024-06-01T10:02:00+00:00",
  "last": "2026-10-03T08:00:00+00:00",
  "sources": [
    {
      "provider": "github",
      "source": "items",
      "connection": "acme-org",
      "items": 96,
      "ended": 3,
      "newest": "2026-10-02T17:21:40+00:00"
    }
  ],
  "known": [
    "Alice Chen · home city: Lisbon (said 2026-10-01); Berlin (said 2024-06-01)",
    "Alice Chen · diet: vegan (said 2026-10-02)"
  ]
}