Skip to content
cadenya
Get started
API Reference
Memory Layers

Get a memory layer by ID

client.memoryLayers.retrieve(stringid, RequestOptionsoptions?): MemoryLayer { metadata, spec, info }
GET/v1/memory_layers/{id}

Retrieves a memory layer by ID from the workspace

ParametersExpand Collapse
id: string
ReturnsExpand Collapse
MemoryLayer { metadata, spec, info }

MemoryLayer is a named container of memory entries that can be composed into an objective's memory stack. Layers are workspace-scoped resources. The layer type controls how its entries participate in the agent loop — see MemoryLayerType for details.

Memory stacks are LIFO: when an objective resolves a key, layers are walked from the top of the stack downward, and the first matching entry wins.

metadata: ResourceMetadata { id, accountId, createdAt, 5 more }

Standard metadata for persistent, named resources (e.g., agents, tools, prompts)

id: string

Unique identifier for the resource (prefixed ULID, e.g., "agent_01HXK...")

accountId: string

Account this resource belongs to for multi-tenant isolation (prefixed ULID)

createdAt: string

Timestamp when this resource was created

formatdate-time
name: string

Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly

profileId: string

ID of the actor (user or service account) that created this resource

workspaceId: string

Workspace this resource belongs to for organizational grouping (prefixed ULID)

externalId?: string

External ID for the resource (e.g., a workflow ID from an external system)

labels?: Record<string, string>

Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"}

spec: MemoryLayerSpec { type, description, expiresAt, systemManaged }
type: "MEMORY_LAYER_TYPE_UNSPECIFIED" | "MEMORY_LAYER_TYPE_EPISODIC" | "MEMORY_LAYER_TYPE_SKILLS"
formatenum
One of the following:
"MEMORY_LAYER_TYPE_UNSPECIFIED"
"MEMORY_LAYER_TYPE_EPISODIC"
"MEMORY_LAYER_TYPE_SKILLS"
description?: string

Human-readable description of the layer's purpose. Encouraged for user-created layers; system-managed layers may have a generated description.

expiresAt?: string

For layers with a finite lifetime (e.g., episodic), the time at which the layer becomes eligible for cleanup. Set by the system; unset for persistent layers.

formatdate-time
systemManaged?: boolean

Server-set. True for layers managed by the system (e.g., episodic layers created automatically when an objective uses an episodic_key). System-managed layers cannot be assigned to objective stacks via the API and cannot be mutated by clients — their lifecycle is controlled entirely by the runtime.

info?: MemoryLayerInfo { createdBy, entryCount, lastUsedAt }
createdBy?: Profile { metadata, spec }

Profile represents a human user at the account level. Profiles are account-scoped resources that can be associated with multiple workspaces through the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS).

metadata: AccountResourceMetadata { id, accountId, name, 3 more }

AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.

id: string

Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...")

accountId: string

Account this resource belongs to for multi-tenant isolation (prefixed ULID)

name: string

Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly

profileId: string
externalId?: string

External ID for the resource (e.g., a workflow ID from an external system)

labels?: Record<string, string>

Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"}

spec: ProfileSpec { type, email, name }

ProfileSpec contains the profile-specific fields

type: "PROFILE_TYPE_USER" | "PROFILE_TYPE_API_KEY" | "PROFILE_TYPE_SYSTEM"

Type is the type of profile. User's are humans, API keys are computers. You know the deal.

formatenum
One of the following:
"PROFILE_TYPE_USER"
"PROFILE_TYPE_API_KEY"
"PROFILE_TYPE_SYSTEM"
email?: string

Email address of the user (required, unique per account)

name?: string

Display name for the user (e.g., "Bobby Tables")

entryCount?: number

Number of entries currently in this layer.

formatint32
lastUsedAt?: string

Timestamp of the most recent objective that resolved against this layer. Useful for surfacing unused layers in the dashboard.

formatdate-time

Get a memory layer by ID

import Cadenya from '@cadenya/cadenya';

const client = new Cadenya({
  apiKey: process.env['CADENYA_API_KEY'], // This is the default and can be omitted
});

const memoryLayer = await client.memoryLayers.retrieve('id');

console.log(memoryLayer.metadata);
{
  "metadata": {
    "id": "id",
    "accountId": "accountId",
    "createdAt": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "profileId": "profileId",
    "workspaceId": "workspaceId",
    "externalId": "externalId",
    "labels": {
      "foo": "string"
    }
  },
  "spec": {
    "type": "MEMORY_LAYER_TYPE_UNSPECIFIED",
    "description": "description",
    "expiresAt": "2019-12-27T18:11:19.117Z",
    "systemManaged": true
  },
  "info": {
    "createdBy": {
      "metadata": {
        "id": "id",
        "accountId": "accountId",
        "name": "name",
        "profileId": "profileId",
        "externalId": "externalId",
        "labels": {
          "foo": "string"
        }
      },
      "spec": {
        "type": "PROFILE_TYPE_USER",
        "email": "email",
        "name": "name"
      }
    },
    "entryCount": 0,
    "lastUsedAt": "2019-12-27T18:11:19.117Z"
  }
}
Returns Examples
{
  "metadata": {
    "id": "id",
    "accountId": "accountId",
    "createdAt": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "profileId": "profileId",
    "workspaceId": "workspaceId",
    "externalId": "externalId",
    "labels": {
      "foo": "string"
    }
  },
  "spec": {
    "type": "MEMORY_LAYER_TYPE_UNSPECIFIED",
    "description": "description",
    "expiresAt": "2019-12-27T18:11:19.117Z",
    "systemManaged": true
  },
  "info": {
    "createdBy": {
      "metadata": {
        "id": "id",
        "accountId": "accountId",
        "name": "name",
        "profileId": "profileId",
        "externalId": "externalId",
        "labels": {
          "foo": "string"
        }
      },
      "spec": {
        "type": "PROFILE_TYPE_USER",
        "email": "email",
        "name": "name"
      }
    },
    "entryCount": 0,
    "lastUsedAt": "2019-12-27T18:11:19.117Z"
  }
}