List memory entries

JavaScript

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);
}

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)

package main

import (
	"context"
	"fmt"
	"go.cadenya.com/cadenya-go"
	"go.cadenya.com/cadenya-go/option"
)

func main() {
	client := cadenya.NewClient(
		option.WithAPIKey("My API Key"),
	)
	page, err := client.MemoryLayers.Entries.List(
		context.TODO(),
		"memlyr_01HXKD2E5NQM3T9AYWCFFFBMJH",
		cadenya.MemoryLayerEntryListParams{
			WorkspaceID: cadenya.String("workspace_01HXKD2E5NQM3T9AYWCF133E3Q"),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

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)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cadenya.com/v1/workspaces/{workspaceId}/memory_layers/{memoryLayerId}/entries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "items": [
    {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
        "name": "<string>",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "createdAt": "2023-11-07T05:31:56Z",
        "externalId": "<string>",
        "labels": {},
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "key": "<string>",
        "description": "<string>"
      },
      "info": {
        "memoryLayer": {
          "id": "<string>",
          "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
          "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
          "name": "<string>",
          "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
          "createdAt": "2023-11-07T05:31:56Z",
          "externalId": "<string>",
          "labels": {},
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "createdBy": {
          "metadata": {
            "id": "<string>",
            "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
            "name": "<string>",
            "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
            "externalId": "<string>",
            "labels": {},
            "createdAt": "2023-11-07T05:31:56Z"
          },
          "spec": {
            "email": "<string>",
            "name": "<string>"
          }
        }
      }
    }
  ],
  "pagination": {
    "nextCursor": "<string>"
  }
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

GET

workspaces

{workspaceId}

memory_layers

{memoryLayerId}

entries

JavaScript

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);
}

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)

package main

import (
	"context"
	"fmt"
	"go.cadenya.com/cadenya-go"
	"go.cadenya.com/cadenya-go/option"
)

func main() {
	client := cadenya.NewClient(
		option.WithAPIKey("My API Key"),
	)
	page, err := client.MemoryLayers.Entries.List(
		context.TODO(),
		"memlyr_01HXKD2E5NQM3T9AYWCFFFBMJH",
		cadenya.MemoryLayerEntryListParams{
			WorkspaceID: cadenya.String("workspace_01HXKD2E5NQM3T9AYWCF133E3Q"),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

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)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cadenya.com/v1/workspaces/{workspaceId}/memory_layers/{memoryLayerId}/entries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "items": [
    {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
        "name": "<string>",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "createdAt": "2023-11-07T05:31:56Z",
        "externalId": "<string>",
        "labels": {},
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "key": "<string>",
        "description": "<string>"
      },
      "info": {
        "memoryLayer": {
          "id": "<string>",
          "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
          "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
          "name": "<string>",
          "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
          "createdAt": "2023-11-07T05:31:56Z",
          "externalId": "<string>",
          "labels": {},
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "createdBy": {
          "metadata": {
            "id": "<string>",
            "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
            "name": "<string>",
            "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
            "externalId": "<string>",
            "labels": {},
            "createdAt": "2023-11-07T05:31:56Z"
          },
          "spec": {
            "email": "<string>",
            "name": "<string>"
          }
        }
      }
    }
  ],
  "pagination": {
    "nextCursor": "<string>"
  }
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

Every entry in one layer, with key and description but never content.

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

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

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

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 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 and 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.

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.

Create a memory entry

Keys, uniqueness, and why description earns its place.

Get a memory entry

The only read that returns content.

Memory layers

The cascade, and which layer wins a key.

Create a memory layer

Where these entries live, and what type means.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId

string

required

Example:

"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"

memoryLayerId

string

required

Memory layer ID. Accepts canonical memlyr_… form or external_id: form.

Example:

"memlyr_01HXKD2E5NQM3T9AYWCFFFBMJH"

Query Parameters

limit

integer<int32>

Maximum number of results to return

cursor

string

Pagination cursor from previous response

prefix

string

Filter by key prefix (e.g., "skills/postmortem/" to list all entries under that hierarchy). Matches against the entry's key, not its name.

query

string

Free-form search query

labels

string

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).

sortOrder

string

Sort order for results (asc or desc by creation time)

includeInfo

boolean

When set to true you may use more of your alloted API rate-limit

Response

items

object[]

Show child attributes

pagination

object

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.

Show child attributes

​prefix walks the key path

​query searches keys and descriptions, folding case

​Paging

​Related

Create a memory entry

Get a memory entry

Memory layers

Create a memory layer

Authorizations

Path Parameters

Query Parameters

Response

`prefix` walks the key path

`query` searches keys and descriptions, folding case

Paging

Related