Memory Stores API (Beta)

Overview

A memory store is a named, user-scoped container that agents can read from and write to for long-term memory. Each store carries a redaction_policy that is applied to content before it is persisted or surfaced to a model. A memory store is a named container of key/value entries. The API covers the store record (create, list, get, delete) and its entries (list, get, upsert, delete, and text search). Memory stores are scoped to the authenticated user. The organization_id is captured at creation time for billing and audit grouping.

Base URL

https://api.allternit.com/api/v1/beta/memory-stores

All requests require a Bearer token. See Authentication.

The memory store object

{
  "id": "ms_9a8b7c6d",
  "organization_id": "org_1",
  "name": "product-docs",
  "redaction_policy": {
    "pii": true,
    "mask_emails": true
  },
  "metadata": {
    "department": "engineering",
    "domain": "support"
  },
  "created_at": "2026-08-13T10:00:00Z",
  "updated_at": "2026-08-13T10:00:00Z"
}

Field	Type	Description
`id`	string	Unique store identifier.
`organization_id`	string?	Organization captured at creation.
`name`	string	Human-readable, unique name per user.
`redaction_policy`	object	Policy applied to stored or retrieved content.
`metadata`	object	Caller-provided key/value object.
`created_at`	string	ISO 8601 timestamp.
`updated_at`	string	ISO 8601 timestamp.

Endpoints

Method	Path	Description
GET	`/api/v1/beta/memory-stores`	List memory stores.
POST	`/api/v1/beta/memory-stores`	Create a memory store.
GET	`/api/v1/beta/memory-stores/:id`	Get a memory store.
DELETE	`/api/v1/beta/memory-stores/:id`	Delete a memory store.
GET	`/api/v1/beta/memory-stores/:id/entries`	List entries in a store.
GET	`/api/v1/beta/memory-stores/:id/entries/:key`	Get one entry.
PUT	`/api/v1/beta/memory-stores/:id/entries/:key`	Create or replace an entry. Body: `{ "value": string, "namespace"?: string }`.
DELETE	`/api/v1/beta/memory-stores/:id/entries/:key`	Delete an entry.
GET	`/api/v1/beta/memory-stores/:id/search`	Search entries. Query: `q`, `limit`.

List memory stores

curl https://api.allternit.com/api/v1/beta/memory-stores \
  -H "Authorization: Bearer $ALLTERNIT_API_KEY"

Response

{
  "memory_stores": [
    {
      "id": "ms_9a8b7c6d",
      "organization_id": "org_1",
      "name": "product-docs",
      "redaction_policy": { "pii": true },
      "metadata": { "department": "engineering" },
      "created_at": "2026-08-13T10:00:00Z",
      "updated_at": "2026-08-13T10:00:00Z"
    }
  ]
}

Create a memory store

curl -X POST https://api.allternit.com/api/v1/beta/memory-stores \
  -H "Authorization: Bearer $ALLTERNIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "product-docs",
    "redaction_policy": {
      "pii": true,
      "mask_emails": true
    },
    "metadata": {
      "department": "engineering",
      "domain": "support"
    }
  }'

Request body

Field	Type	Description
`name`	string	Store name. Must be non-empty and unique for the user.
`redaction_policy`	object	Defaults to `{}`. Must be an object.
`metadata`	object	Defaults to `{}`. Must be an object.

Response

{
  "memory_store": {
    "id": "ms_9a8b7c6d",
    "organization_id": "org_1",
    "name": "product-docs",
    "redaction_policy": { "pii": true, "mask_emails": true },
    "metadata": { "department": "engineering", "domain": "support" },
    "created_at": "2026-08-13T10:00:00Z",
    "updated_at": "2026-08-13T10:00:00Z"
  },
  "id": "ms_9a8b7c6d"
}

Duplicate names for the same user return 400 Bad Request.

Get a memory store

curl https://api.allternit.com/api/v1/beta/memory-stores/ms_9a8b7c6d \
  -H "Authorization: Bearer $ALLTERNIT_API_KEY"

Response

{
  "memory_store": { ... }
}

Delete a memory store

curl -X DELETE https://api.allternit.com/api/v1/beta/memory-stores/ms_9a8b7c6d \
  -H "Authorization: Bearer $ALLTERNIT_API_KEY"

Returns 204 No Content.

Deleting a memory store removes its record. Ensure any entries relying on the store have been migrated or are no longer needed.

Redaction policy

The redaction_policy object is interpreted by the agent runtime before memory is persisted or returned to a model. Common fields include:

Field	Type	Description
`pii`	boolean?	Whether to detect and redact personally identifiable information.
`mask_emails`	boolean?	Whether to mask email addresses.
`mask_phone_numbers`	boolean?	Whether to mask phone numbers.

The exact set of supported keys depends on the configured memory pipeline. Unknown keys are ignored.

Error codes

Status	Meaning	Typical cause
200 OK	Success	Request succeeded.
201 Created	Created	Store created.
204 No Content	No content	Store deleted.
400 Bad Request	Invalid request	Empty name, duplicate name, `redaction_policy`/`metadata` not objects.
401 Unauthorized	Unauthorized	Missing or invalid bearer token.
404 Not Found	Not found	Unknown store or access to another user’s store.
429 Too Many Requests	Rate limited	Exceeded the request rate limit for the key.
500 Internal Server Error	Server error	Contact support.

Platform API

Legal

Overview

Agency API (Preview)

LLM Gateway

Agents & Runtime

Work Queue & Deployments

Files, Webhooks & Sandbox

Tools & Connectors

Collaboration & Workflows

Infrastructure & Platform

Canvases

Onboarding

A Labs

Playground

Users & Profiles

Overview

Base URL

The memory store object

Endpoints

List memory stores

Response

Create a memory store

Request body

Response

Get a memory store

Response

Delete a memory store

Redaction policy

Error codes

​Overview

​Base URL

​The memory store object

​Endpoints

​List memory stores

​Response

​Create a memory store

​Request body

​Response

​Get a memory store

​Response

​Delete a memory store

​Redaction policy

​Error codes

​Related pages

Overview

Base URL

The memory store object

Endpoints

List memory stores

Response

Create a memory store

Request body

Response

Get a memory store

Response

Delete a memory store

Redaction policy

Error codes

Related pages