API reference · Memory

Retrieve a memory

GET/v1/memory/{id}

Read one memory by id.

Open Memtro

One memory, in the same shape as the list. A memory this key cannot read answers exactly as one that does not exist.

Example

Against https://platform.memtro.com, with your key in MEMTRO_API_KEY.

curl https://platform.memtro.com/v1/memory/6f1c… \
  -H "Authorization: Bearer $MEMTRO_API_KEY"

Authentication

An API key, as Authorization: Bearer or x-api-key. Read-only keys may call it.

  • Every reply, errors included, carries x-request-id and request-id headers with the same id, starting req-. Quote it to support.
  • Browsers may call it from any origin: it answers CORS preflights and allows the Authorization, x-api-key and Anthropic version headers.

Path parameters

idstringRequired

The memory's id.

Response

200application/json

A memory object.

object"memory"Optional

Always memory.

idstringOptional

The memory's id.

contentstringOptional

The statement, as remembered.

kindstringOptional

What sort of statement it is.

One of fact, decision, preference, event or procedure.

scopestringOptional

Who it belongs to: the organisation, a team, or one person.

One of shared, team or personal.

sourcestringOptional

Where it came from, such as chat, sync or import.

systemstring or nullOptional

The connected system it was read from, if any.

urlstring or nullOptional

A link to the record it came from, if one was kept.

confidencenumberOptional

How sure the extractor was.

importancenumberOptional

How much it matters, as the extractor judged it.

truststring or nullOptional

Whether it is believed outright or waiting to be confirmed.

taintstring or nullOptional

Set when it was learned from outside content.

corroborationsintegerOptional

How many times something independent has confirmed it.

valid_fromstring or nullOptional

Start of the period the statement is about.

valid_tostring or nullOptional

End of that period, if it has one.

superseded_bystring or nullOptional

The id of the memory that replaced it.

superseded_atstring or nullOptional

When it was replaced.

subject_entity_idstring or nullOptional

The entity the statement is about.

entity_idsarray of stringsOptional

Every entity it mentions.

connection_idstring or nullOptional

The connection it was synced through.

episode_idstring or nullOptional

The exchange or import it was learned from.

created_atstringOptional

When it was recorded.

Errors

In the OpenAI envelope, {"error": {"message", "type", "param", "code"}}. What each code means and what to do about it is in the error catalogue.

StatusCodeWhen
401invalid_api_key

The key is missing, malformed, revoked or expired.

402subscription_inactive

The organisation has no active subscription.

404not_found

No such memory, or not one this key can read.

Where agents remember your company

Sign in, add a provider key, create an API key and point your tools at Memtro. It takes about five minutes.

7-day free trial · card on file, nothing charged until it ends · cancel any time