Retrieve a memory version

GET

memory_stores

{memory_store_id}

memory_versions

{memory_version_id}

Retrieve a memory version

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

import requests

url = "http://localhost:38080/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_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}/memory_versions/{memory_version_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}/memory_versions/{memory_version_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_version",
  "id": "<string>",
  "memory_store_id": "<string>",
  "memory_id": "<string>",
  "operation": "created",
  "created_at": "2023-11-07T05:31:56Z",
  "path": "<string>",
  "content": "<string>",
  "content_size_bytes": 123,
  "content_sha256": "<string>",
  "created_by": {
    "type": "session_actor",
    "session_id": "<string>"
  },
  "redacted_at": "2023-11-07T05:31:56Z",
  "redacted_by": {
    "type": "session_actor",
    "session_id": "<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_version_id

string

required

Path parameter memory_version_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_version object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with content, path, content_size_bytes, and content_sha256 set to null; branch on redacted_at, not HTTP status.

type

enum<string>

required

Available options:

memory_version

string

required

Unique identifier for this version (a memver_... value).

memory_store_id

string

required

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

memory_id

string

required

ID of the memory this version snapshots (a mem_... value). Remains valid after the memory is deleted; pass it as memory_id to List memory versions to retrieve the full lineage including the deleted row.

operation

enum<string>

required

The kind of mutation this version records: created, modified, or deleted.

Available options:

created,

modified,

deleted

created_at

string<date-time>

required

When this version was written, in RFC 3339 format.

path

string | null

The memory's path at the time of this write. null if and only if redacted_at is set.

content

string | null

The memory's UTF-8 text content as of this version. null when view=basic, when operation is deleted, or when redacted_at is set.

content_size_bytes

integer<int32> | null

Size of content in bytes as of this version. null when redacted_at is set or operation is deleted. Populated regardless of view otherwise.

content_sha256

string | null

Lowercase hex SHA-256 digest of content as of this version (64 characters). null when redacted_at is set or operation is deleted. Populated regardless of view otherwise.

created_by

object

Who performed this write: a session_actor, api_actor, or user_actor. Captured at write time and preserved through redaction.

Option 1
Option 2
Option 3

Show child attributes

redacted_at

string<date-time> | null

When this version was redacted, in RFC 3339 format, or null if it has not been redacted. When set, content, path, content_size_bytes, and content_sha256 are all null. See Redact a memory version.

redacted_by

object

Who redacted this version, or null if it has not been redacted. In practice always an api_actor or user_actor (agents do not have a redact capability).

Option 1
Option 2
Option 3

Show child attributes

Retrieve a memory version

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

import requests

url = "http://localhost:38080/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_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}/memory_versions/{memory_version_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}/memory_versions/{memory_version_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_version",
  "id": "<string>",
  "memory_store_id": "<string>",
  "memory_id": "<string>",
  "operation": "created",
  "created_at": "2023-11-07T05:31:56Z",
  "path": "<string>",
  "content": "<string>",
  "content_size_bytes": 123,
  "content_sha256": "<string>",
  "created_by": {
    "type": "session_actor",
    "session_id": "<string>"
  },
  "redacted_at": "2023-11-07T05:31:56Z",
  "redacted_by": {
    "type": "session_actor",
    "session_id": "<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