> ## Documentation Index
> Fetch the complete documentation index at: https://cadenya.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# List memory entries
> Browse a layer by key prefix or search its keys and descriptions. Bodies stay behind.
Every entry in one [layer](/docs/api-reference/memoryservice/create-a-new-memory-layer), with `key` and `description` but never `content`.
```typescript TypeScript theme={null}
const entries = await client.memoryLayers.entries.list(layerId, { workspaceId });
for await (const entry of entries) {
console.log(entry.spec.key, entry.spec.description);
}
// policies/us/refunds US refund window
// policies/us/returns desc for policies/us/returns
// runbooks/deploy desc for runbooks/deploy
```
```go Go theme={null}
entries := client.MemoryLayers.Entries.ListAutoPaging(ctx, layerID,
cadenya.MemoryLayerEntryListParams{
WorkspaceID: cadenya.String(workspaceID),
})
for entries.Next() {
entry := entries.Current()
fmt.Println(entry.Spec.Key, entry.Spec.Description)
}
// policies/us/refunds US refund window
// policies/us/returns desc for policies/us/returns
// runbooks/deploy desc for runbooks/deploy
```
```ruby Ruby theme={null}
entries = cadenya.memory_layers.entries.list(layer_id, workspace_id: workspace_id)
entries.auto_paging_each do |entry|
puts "#{entry.spec.key} #{entry.spec.description}"
end
# policies/us/refunds US refund window
# policies/us/returns desc for policies/us/returns
# runbooks/deploy desc for runbooks/deploy
```
```bash cURL theme={null}
curl "https://api.cadenya.com/v1/workspaces/${WORKSPACE_ID}/memory_layers/${MEMORY_LAYER_ID}/entries" \
-H "Authorization: Bearer ${CADENYA_API_KEY}"
```
Item keys are `metadata`, `spec`, `info`. Fetch one entry to get its body: [get by id](/docs/api-reference/memoryservice/get-a-memory-entry-by-id) returns `content` at the top level. Listing a large layer therefore stays cheap no matter how big the bodies are.
## `prefix` walks the key path
Keys behave like file paths, and `prefix` treats them that way. Prefix-only, and **case-sensitive**.
```
?prefix=policies/ → 3 policies/us/refunds, policies/us/returns, policies/eu/refunds
?prefix=policies/us → 2 policies/us/refunds, policies/us/returns
?prefix=POLICIES/ → 0 ← case matters here
?prefix=olicies → 0 ← a prefix, not a substring
```
That makes a namespaced key scheme worth the trouble. `policies/us/...` and `runbooks/...` become browsable directories.
## `query` searches keys and descriptions, folding case
```
?query=refunds → 2 policies/us/refunds, policies/eu/refunds (matched the key)
?query=REFUNDS → 2 (case folded)
?query=deploy → 1 runbooks/deploy
?query=body → 0 ← content is never searched
```
Descriptions are searched too, which is the reason to write one. The agent's `search_memory` tool scores trigram similarity over the same two fields, `key` and `description`, so a good description is how an agent finds an entry whose key it cannot guess.
`content` is searched by neither. A phrase that appears only in the body finds nothing, here or from the agent.
Neither filter survives a space. `?query=desc for` returns nothing, and so does `?prefix=policies/ x`, even though both match entries. Search on a single token.
This is the same defect as the [tool search](/docs/api-reference/searchservice/search-for-tools-or-tool-sets) and [models](/docs/api-reference/modelservice/list-models) filters.
The two filters also disagree on case: `prefix` is case-sensitive, `query` is not.
## Paging
`limit` is a page size, and `pagination.nextCursor` appears only when another page exists. The SDK iterator follows it for you, so `limit` never caps what you receive.
```typescript theme={null}
const page = await client.memoryLayers.entries.list(layerId, { workspaceId, limit: 2 });
page.items.length; // 2
page.pagination?.nextCursor; // present
```
`sortOrder=desc` reverses. The default is `asc`, oldest key first by creation.
```
?sortOrder=desc → runbooks/deploy, policies/eu/refunds, policies/us/returns, policies/us/refunds
```
`pagination` is omitted entirely from the response when there is no next page, so read it defensively.
## Related
Keys, uniqueness, and why `description` earns its place.
The only read that returns `content`.
The cascade, and which layer wins a key.
Where these entries live, and what `type` means.
## OpenAPI
````yaml get /v1/workspaces/{workspaceId}/memory_layers/{memoryLayerId}/entries
openapi: 3.1.0
info:
title: Cadenya API
description: API for the Cadenya Agent Runtime platform.
version: '1.0'
servers:
- url: https://api.cadenya.com
description: Production server
security:
- bearerAuth: []
tags:
- name: AIProviderKeyService
- name: APIKeyService
description: |-
Issue, rotate, disable, and revoke a workspace's API keys. Every key
belongs to exactly one workspace; the system-managed global account key is
managed via GlobalAPIKeyService instead.
- name: AccountService
description: >-
Manage the authenticated account. Accounts are the top-level
organizational
unit and contain one or more workspaces.
- name: AgentScheduleService
description: >-
Manage recurring schedules attached to agents. Schedules trigger
objectives
on a cadence defined by AgentScheduleSpec.Schedule.
- name: AgentService
description: >-
Manage AI agents within a workspace. Agents define AI behavior and tool
access.
- name: AgentVariationService
description: >-
Manage variations of an agent and their tool, sub-agent, and memory layer
assignments.
- name: GlobalAPIKeyService
description: |-
Manage the account's system-provisioned global API key. The global key is
the only key that spans every workspace; it is created by the system and
cannot be deleted, so the surface is retrieve, rotate, and the
disable/enable kill switch.
- name: MemoryService
description: >-
Manage memory layers and their entries. Layers are named containers that
can
be composed into an objective's memory cascade; entries are the keyed values
within a layer. System-managed layers (e.g., episodic layers created by the
runtime) cannot be mutated through this API.
- name: ModelService
description: |-
Manage LLM models available to a workspace. Models represent provider and
family pairs (e.g., "anthropic/claude-sonnet-4.6"). Workspaces are seeded
with the supported models and you can enable or disable each one.
- name: ObjectiveEventStreamsService
- name: ObjectiveService
- name: ProfilesService
description: |-
Operations on profiles, the account-level principals (users, API keys,
system) that authenticate against the API.
- name: SearchService
- name: TenantService
description: >-
Read and erase tenants and the subjects under them. Tenants and subjects
are
created by assertion — on objective creation or widget session mint — never
directly, so this service has no create or update: it exists to enumerate what
assertions have produced, and to destroy it on request.
- name: ToolService
description: >-
Manage tool sets and the tools they contain. Tool sets group related
tools,
and tools define specific capabilities available to agents.
When a tool set is managed, only API key actors can modify its tools; human
(profile) actors cannot.
- name: UploadService
description: |-
Issue short-lived presigned URLs for direct client-to-object-storage
uploads. Created uploads can be referenced by id when creating or updating
resources that accept binary content (e.g., MemoryEntry).
- name: WidgetService
description: |-
Manage embeddable chat widgets. A widget binds an agent to a globally
unique hostname with a per-widget origin allowlist; browsers reach it with
session tokens minted via WidgetSessionService.
- name: WidgetSessionService
description: >-
Mint and manage widget sessions. Session creation is server-to-server
only:
the customer's backend authenticates its visitor, asserts tenant/subject
context, attaches any per-visitor secrets, and receives a short-lived
bearer token the browser uses against the widget host.
- name: WorkspaceAdminService
description: >-
Administer workspaces across the account: create and archive workspaces
and
manage their membership. These operations are account-scoped and require the
admin role (a token whose profile holds the WorkOS admin role); they live
under /v1/account/workspaces rather than the workspace-scoped /v1/workspaces
tree so an admin can manage any workspace in the account, including ones they
are not themselves a member of.
- name: WorkspaceSecretService
- name: WorkspaceService
description: |-
Manage workspaces within an account. Workspaces provide organizational
grouping and isolation for resources such as agents, tools, and API keys.
This is the workspace-scoped, end-user surface. Administrative operations
(create / archive workspaces, manage members) live in WorkspaceAdminService
under /v1/account/workspaces and require the admin role.
paths:
/v1/workspaces/{workspaceId}/memory_layers/{memoryLayerId}/entries:
get:
tags:
- MemoryService
- Memory Entries
summary: List memory entries
description: Lists all entries in a memory layer
operationId: MemoryService_ListMemoryEntries
parameters:
- name: workspaceId
in: path
required: true
schema:
type: string
example: workspace_01HXKD2E5NQM3T9AYWCF133E3Q
- name: memoryLayerId
in: path
description: >-
Memory layer ID. Accepts canonical memlyr_… form or
external_id: form.
required: true
schema:
example: memlyr_01HXKD2E5NQM3T9AYWCFFFBMJH
type: string
- name: limit
in: query
description: Maximum number of results to return
schema:
type: integer
format: int32
- name: cursor
in: query
description: Pagination cursor from previous response
schema:
type: string
- name: prefix
in: query
description: |-
Filter by key prefix (e.g., "skills/postmortem/" to list all entries
under that hierarchy). Matches against the entry's key, not its name.
schema:
type: string
- name: query
in: query
description: Free-form search query
schema:
type: string
- name: labels
in: query
description: |-
Filters by metadata labels. Comma-separated key=value pairs,
e.g. "env=prod,team=ai". A resource matches only if every pair
matches exactly (AND semantics).
schema:
type: string
- name: sortOrder
in: query
description: Sort order for results (asc or desc by creation time)
schema:
type: string
- name: includeInfo
in: query
description: When set to true you may use more of your alloted API rate-limit
schema:
type: boolean
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ListMemoryEntriesResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
x-codeSamples:
- lang: JavaScript
source: |-
import Cadenya from '@cadenya/cadenya';
const client = new Cadenya({
apiKey: process.env['CADENYA_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const memoryEntry of client.memoryLayers.entries.list(
'memlyr_01HXKD2E5NQM3T9AYWCFFFBMJH',
{ workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q' },
)) {
console.log(memoryEntry.metadata);
}
- lang: Python
source: |-
import os
from cadenya import Cadenya
client = Cadenya(
api_key=os.environ.get("CADENYA_API_KEY"), # This is the default and can be omitted
)
page = client.memory_layers.entries.list(
memory_layer_id="memlyr_01HXKD2E5NQM3T9AYWCFFFBMJH",
workspace_id="workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
)
page = page.items[0]
print(page.metadata)
- lang: Go
source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"go.cadenya.com/cadenya-go\"\n\t\"go.cadenya.com/cadenya-go/option\"\n)\n\nfunc main() {\n\tclient := cadenya.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.MemoryLayers.Entries.List(\n\t\tcontext.TODO(),\n\t\t\"memlyr_01HXKD2E5NQM3T9AYWCFFFBMJH\",\n\t\tcadenya.MemoryLayerEntryListParams{\n\t\t\tWorkspaceID: cadenya.String(\"workspace_01HXKD2E5NQM3T9AYWCF133E3Q\"),\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n"
- lang: Ruby
source: |-
require "cadenya"
cadenya = Cadenya::Client.new(api_key: "My API Key")
page = cadenya.memory_layers.entries.list(
"memlyr_01HXKD2E5NQM3T9AYWCFFFBMJH",
workspace_id: "workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
)
puts(page)
- lang: CLI
source: |-
cadenya memory-layers:entries list \
--api-key 'My API Key' \
--workspace-id workspace_01HXKD2E5NQM3T9AYWCF133E3Q \
--memory-layer-id memlyr_01HXKD2E5NQM3T9AYWCFFFBMJH
components:
schemas:
ListMemoryEntriesResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MemoryEntry'
pagination:
$ref: '#/components/schemas/Page'
Status:
type: object
properties:
code:
type: integer
description: >-
The status code, which should be an enum value of
[google.rpc.Code][google.rpc.Code].
format: int32
message:
type: string
description: >-
A developer-facing error message, which should be in English. Any
user-facing error message should be localized and sent in the
[google.rpc.Status.details][google.rpc.Status.details] field, or
localized by the client.
details:
type: array
items:
$ref: '#/components/schemas/GoogleProtobufAny'
description: >-
A list of messages that carry the error details. There is a common
set of message types for APIs to use.
description: >-
The `Status` type defines a logical error model that is suitable for
different programming environments, including REST APIs and RPC APIs. It
is used by [gRPC](https://github.com/grpc). Each `Status` message
contains three pieces of data: error code, error message, and error
details. You can find out more about this error model and how to work
with it in the [API Design
Guide](https://cloud.google.com/apis/design/errors).
MemoryEntry:
required:
- metadata
- spec
type: object
properties:
metadata:
$ref: '#/components/schemas/ResourceMetadata'
spec:
$ref: '#/components/schemas/MemoryEntrySpec'
info:
$ref: '#/components/schemas/MemoryEntryInfo'
description: |-
MemoryEntry is a single keyed value within a MemoryLayer. Entries are
addressed by their key, which follows the S3 object key safe-character
convention (see MemoryEntrySpec.key for the full rule). Keys are unique
within a single layer; the same key may appear in multiple layers, in which
case the cascade walk determines which one wins for a given objective (most
specific layer first).
MemoryEntry is the summary shape, returned by ListMemoryEntries. It does
not carry the entry body — callers that need the body must fetch the entry
individually via GetMemoryEntry, which returns a MemoryEntryDetail.
Page:
type: object
properties:
nextCursor:
type: string
description: >-
Page carries cursor-based pagination state. There is no total: the
cursor
walks the result set without ever counting it, and a count would cost a second
query on every list.
GoogleProtobufAny:
type: object
properties:
'@type':
type: string
description: The type of the serialized message.
additionalProperties: true
description: >-
Contains an arbitrary serialized message along with a @type that
describes the type of the serialized message.
ResourceMetadata:
required:
- id
- accountId
- workspaceId
- name
- profileId
- createdAt
type: object
properties:
id:
readOnly: true
type: string
description: >-
Unique identifier for the resource (prefixed ULID, e.g.,
"agent_01HXK...")
accountId:
readOnly: true
example: account_01HXKD2E5NQM3T9AYWCFTJHJVF
type: string
description: >-
Account this resource belongs to for multi-tenant isolation
(prefixed ULID)
workspaceId:
readOnly: true
example: workspace_01HXKD2E5NQM3T9AYWCF133E3Q
type: string
description: >-
Workspace this resource belongs to for organizational grouping
(prefixed ULID)
name:
type: string
description: >-
Human-readable name for the resource (e.g., "Customer Support
Agent", "Email Tool")
Required for resources that users interact with directly
externalId:
type: string
description: >-
External ID for the resource (e.g., a workflow ID from an external
system)
labels:
type: object
additionalProperties:
type: string
description: |-
Key-value pairs for categorization and filtering. Values are 0-63
alphanumeric characters with "-", "_", or "." allowed between; keys
follow the same shape and additionally accept an optional DNS-subdomain
prefix (e.g. "cadenya.com/") of at most 253 characters.
Examples: {"environment": "production", "team": "platform", "version": "v2"}
profileId:
readOnly: true
example: profile_01HXKD2E5NQM3T9AYWCFS0AP08
type: string
description: ID of the actor (user or service account) that created this resource
createdAt:
readOnly: true
type: string
description: Timestamp when this resource was created
format: date-time
updatedAt:
readOnly: true
type: string
description: Timestamp when this resource was last updated
format: date-time
description: >-
Standard metadata for persistent, named resources (e.g., agents, tools,
prompts)
MemoryEntrySpec:
required:
- key
type: object
properties:
key:
type: string
description: >-
The lookup key for this entry within its layer. Must conform to the
S3
object key safe-characters spec: ASCII alphanumerics and the special
characters !, -, _, ., *, ', (, ), and /. Forward slashes may be used to
suggest hierarchy (e.g., "skills/postmortem/write"), but lookups are flat
— the key is a single opaque string, not a path.
Additional rules enforced by the service:
- May not begin or end with /
- May not contain consecutive slashes (//)
- May not begin with reserved prefixes (cadenya/, system/)
- Case-sensitive
- Unique within the parent layer
For skills entries, this key is what the model passes to get_memory to
load the entry's content.
description:
type: string
description: >-
One-line "when to use this" hint shown in the frontmatter manifest
for
skills entries. The model uses this to decide whether to load the body,
so it should be written for the model as the audience. Ignored for layer
types that do not advertise frontmatter.
description: |-
MemoryEntrySpec is the metadata portion of an entry — the fields that
identify and describe it, without the body. It appears on both the summary
(MemoryEntry) and detail (MemoryEntryDetail) views.
MemoryEntryInfo:
type: object
properties:
memoryLayer:
readOnly: true
allOf:
- $ref: '#/components/schemas/ResourceMetadata'
description: The layer this entry belongs to.
createdBy:
$ref: '#/components/schemas/Profile'
Profile:
required:
- metadata
- spec
type: object
properties:
metadata:
$ref: '#/components/schemas/AccountResourceMetadata'
spec:
$ref: '#/components/schemas/ProfileSpec'
description: |-
A profile identifies a user or non-human principal (such as an API key)
at the account level. Profiles are account-scoped and can be granted access
to multiple workspaces.
AccountResourceMetadata:
required:
- id
- accountId
- name
- profileId
type: object
properties:
id:
readOnly: true
type: string
description: >-
Unique identifier for the resource (prefixed ULID, e.g.,
"apikey_01HXK...")
accountId:
readOnly: true
example: account_01HXKD2E5NQM3T9AYWCFTJHJVF
type: string
description: >-
Account this resource belongs to for multi-tenant isolation
(prefixed ULID)
name:
type: string
description: >-
Human-readable name for the resource (e.g., "Customer Support
Agent", "Email Tool")
Required for resources that users interact with directly
externalId:
type: string
description: >-
External ID for the resource (e.g., a workflow ID from an external
system)
labels:
type: object
additionalProperties:
type: string
description: |-
Key-value pairs for categorization and filtering. Values are 0-63
alphanumeric characters with "-", "_", or "." allowed between; keys
follow the same shape and additionally accept an optional DNS-subdomain
prefix (e.g. "cadenya.com/") of at most 253 characters.
Examples: {"environment": "production", "team": "platform", "version": "v2"}
profileId:
readOnly: true
example: profile_01HXKD2E5NQM3T9AYWCFS0AP08
type: string
createdAt:
readOnly: true
type: string
format: date-time
description: >-
AccountResourceMetadata is used to represent a resource that is
associated to an account but not to a workspace.
ProfileSpec:
required:
- type
type: object
properties:
email:
type: string
description: >-
Email address of the profile. Required and unique within an account
for
user profiles.
name:
type: string
description: Display name (e.g., "Bobby Tables").
type:
enum:
- PROFILE_TYPE_UNSPECIFIED
- PROFILE_TYPE_USER
- PROFILE_TYPE_API_KEY
- PROFILE_TYPE_SYSTEM
type: string
description: >-
Whether this profile represents a human user, an API key, or a
system
principal.
format: enum
description: Configuration for a profile.
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
````