Retrieve a memory

GET

memory_stores

{memory_store_id}

memories

{memory_id}

Retrieve a memory

curl --request GET \
  --url http://localhost:38080/v1/memory_stores/{memory_store_id}/memories/{memory_id} \
  --header 'X-Api-Key: <api-key>'

import requests

url = "http://localhost:38080/v1/memory_stores/{memory_store_id}/memories/{memory_id}"

headers = {"X-Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('http://localhost:38080/v1/memory_stores/{memory_store_id}/memories/{memory_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:38080/v1/memory_stores/{memory_store_id}/memories/{memory_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "type": "memory",
  "id": "<string>",
  "memory_store_id": "<string>",
  "path": "<string>",
  "content_size_bytes": 123,
  "content_sha256": "<string>",
  "memory_version_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "content": "<string>"
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

Every request requires ?beta=true.

Authorizations

X-Api-Key

string

header

default:sk-ant-local-default

required

OMA workspace API key.

Headers

anthropic-version

string

anthropic-beta

string

Path Parameters

memory_store_id

string

required

Path parameter memory_store_id

memory_id

string

required

Path parameter memory_id

Query Parameters

beta

enum<boolean>

required

Selects the beta API contract for this endpoint. Must be true.

Available options:

true

view

enum<string>

Query parameter for view Selects which projection of a memory or memory_version the server returns. basic returns the object with content set to null; full populates content. When omitted, the default is endpoint-specific: retrieve operations default to full; list, create, and update operations default to basic. Listing with view=full caps limit at 20.

Available options:

basic,

full

Response

Successful response (OK)

A memory object: a single text document at a hierarchical path inside a memory store. The content field is populated when view=full and null when view=basic; the content_size_bytes and content_sha256 fields are always populated so sync clients can diff without fetching content. Memories are addressed by their mem_... ID; the path is the create key and can be changed via update.

type

enum<string>

required

Available options:

memory

string

required

Unique identifier for this memory (a mem_... value). Stable across renames; use this ID, not the path, to read, update, or delete the memory.

memory_store_id

string

required

ID of the memory store this memory belongs to (a memstore_... value).

path

string

required

Hierarchical path of the memory within the store, e.g. /projects/foo/notes.md. Always starts with /. Paths are case-sensitive and unique within a store. Maximum 1,024 bytes.

content_size_bytes

integer<int32>

required

Size of content in bytes (the UTF-8 plaintext length). Always populated, regardless of view.

content_sha256

string

required

Lowercase hex SHA-256 digest of the UTF-8 content bytes (64 characters). The server applies no normalization, so clients can compute the same hash locally for staleness checks and as the value for a content_sha256 precondition on update. Always populated, regardless of view.

memory_version_id

string

required

ID of the memory_version representing this memory's current content (a memver_... value). This is the authoritative head pointer; memory_version objects do not carry an is_latest flag, so compare against this field instead. Enumerate the full history via List memory versions.

created_at

string<date-time>

required

When this memory was created, in RFC 3339 format.

updated_at

string<date-time>

required

When this memory was last modified, in RFC 3339 format. Use this as a cheap freshness signal; for who made the change, look up the head version's created_by via List memory versions.

content

string | null

The memory's UTF-8 text content. Populated when view=full; null when view=basic. Maximum 100 kB (102,400 bytes).

Retrieve a memory

curl --request GET \
  --url http://localhost:38080/v1/memory_stores/{memory_store_id}/memories/{memory_id} \
  --header 'X-Api-Key: <api-key>'

import requests

url = "http://localhost:38080/v1/memory_stores/{memory_store_id}/memories/{memory_id}"

headers = {"X-Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('http://localhost:38080/v1/memory_stores/{memory_store_id}/memories/{memory_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:38080/v1/memory_stores/{memory_store_id}/memories/{memory_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "type": "memory",
  "id": "<string>",
  "memory_store_id": "<string>",
  "path": "<string>",
  "content_size_bytes": 123,
  "content_sha256": "<string>",
  "memory_version_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "content": "<string>"
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

{
  "type": "error",
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  }
}

Get started

Core API

Managed Agents

Webhooks

Authorizations

Headers

Path Parameters

Query Parameters

Response