Archive a memory store

Archive a memory store through the OMA API.

POST /v1/memory_stores/{memory_store_id}/archive

Archive a memory store

cURL

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

200

{
  "type": "memory_store",
  "id": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "metadata": {},
  "archived_at": "2023-11-07T05:31:56Z"
}

Every request requires ?beta=true.

Authorizations

omaApiKeyomaBearer

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

Query Parameters

beta · enum<boolean> · required

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

Available options: true

Response

200

application/json

Successful response (OK)

Response from archiving a memory_store. Returns the store with archived_at set.

type · enum<string> · required

Available options: memory_store

id · string · required

Unique identifier for the memory store (a memstore_... tagged ID). Use this when attaching the store to a session, or in the {memory_store_id} path parameter of subsequent calls.

name · string · required

Human-readable name for the store. 1–255 characters. The store's mount-path slug under /mnt/memory/ is derived from this name.

created_at · string<date-time> · required

Timestamp when the store was created.

updated_at · string<date-time> · required

Timestamp when the store's name, description, or metadata was last modified. Memory writes inside the store do not advance this.

description · string

Free-text description of what the store contains, up to 1024 characters. Included in the agent's system prompt when the store is attached, so word it to be useful to the agent. Empty string when unset.

metadata · object

Arbitrary key-value tags for your own bookkeeping (such as the end user a store belongs to). Up to 16 pairs; keys 1–64 characters; values up to 512 characters. Returned on retrieve/list but not filterable.

Show child attributes

archived_at · string<date-time> | null

Timestamp when the store was archived, or null if active. Set once and never cleared; archiving is one-way. Archived stores are read-only and cannot be attached to new sessions.