Archives a memory store. Archiving is irreversible: the store can no longer be written or bound to new sessions, and existing session mounts become read-only. Repeated calls are idempotent.
Prerequisites
Endpoint and authentication configured. For details, see Overview and authentication.
Endpoint
POST /memory_stores/{memory_store_id}/archive
Path parameters
| Field | Required | Type | Description |
|---|---|---|---|
memory_store_id | Yes | string | Memory store ID |
Request example
Response example
Response fields
| Field | Type | Description |
|---|---|---|
id | string | Memory store ID, format memstore_xxx |
type | string | Always memory_store |
name | string | Memory store name |
description | string | Purpose description |
metadata | object | Custom key-value pairs |
archived_at | string | null | Archive time; omitted or null when not archived |
created_at | string | Creation time, ISO 8601 UTC |
updated_at | string | Last update time, ISO 8601 UTC |
Error codes
| HTTP status | Error code | Description |
|---|---|---|
| 401 | InvalidApiKey | API key missing, invalid, or expired |
| 403 | permission_error | Insufficient identity or resource access permissions |
| 404 | not_found_error | Resource does not exist or does not belong to the current workspace |