## Update a memory layer `memory_layers.update(id, **kwargs) -> MemoryLayer` **patch** `/v1/workspaces/{workspaceId}/memory_layers/{id}` Updates a memory layer in the workspace ### Parameters - `workspace_id: String` - `id: String` - `metadata: UpdateResourceMetadata` UpdateResourceMetadata contains the user-provided fields for updating a workspace-scoped resource. Read-only fields (id, account_id, workspace_id, profile_id, created_at) are excluded since they are set by the server. - `name: String` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") - `bundle_key: String` Optional bundle ownership key. See ResourceMetadata.bundle_key. - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: MemoryLayerSpec` - `type: :MEMORY_LAYER_TYPE_UNSPECIFIED | :MEMORY_LAYER_TYPE_EPISODIC | :MEMORY_LAYER_TYPE_SKILLS` - `: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. - `expires_at: Time` 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. - `system_managed: bool` 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. - `update_mask: String` ### Returns - `class MemoryLayer` 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. See "Memory stack composition" above for how layers compose at lookup time. - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `id: String` Unique identifier for the resource (prefixed ULID, e.g., "agent_01HXK...") - `account_id: String` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `created_at: Time` Timestamp when this resource was created - `name: String` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profile_id: String` ID of the actor (user or service account) that created this resource - `workspace_id: String` Workspace this resource belongs to for organizational grouping (prefixed ULID) - `bundle_key: String` Optional bundle ownership key. When set, indicates the resource is managed by a configuration bundle identified by this key. Used by BulkWorkspaceResources.Apply to track which resources belong to which bundle for reconciliation / soft-delete on re-apply. - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: MemoryLayerSpec` - `type: :MEMORY_LAYER_TYPE_UNSPECIFIED | :MEMORY_LAYER_TYPE_EPISODIC | :MEMORY_LAYER_TYPE_SKILLS` - `: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. - `expires_at: Time` 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. - `system_managed: bool` 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` - `created_by: Profile` 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. - `metadata: AccountResourceMetadata` 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...") - `account_id: 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 - `profile_id: String` - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: ProfileSpec` Configuration for a profile. - `type: :PROFILE_TYPE_UNSPECIFIED | :PROFILE_TYPE_USER | :PROFILE_TYPE_API_KEY | :PROFILE_TYPE_SYSTEM` Whether this profile represents a human user, an API key, or a system principal. - `:PROFILE_TYPE_UNSPECIFIED` - `:PROFILE_TYPE_USER` - `:PROFILE_TYPE_API_KEY` - `:PROFILE_TYPE_SYSTEM` - `email: String` Email address of the profile. Required and unique within an account for user profiles. - `name: String` Display name (e.g., "Bobby Tables"). - `entry_count: Integer` Number of entries currently in this layer. - `last_used_at: Time` Timestamp of the most recent objective that resolved against this layer. Useful for surfacing unused layers in the dashboard. ### Example ```ruby require "cadenya" cadenya = Cadenya::Client.new(api_key: "My API Key") memory_layer = cadenya.memory_layers.update("id", workspace_id: "workspaceId") puts(memory_layer) ``` #### Response ```json { "metadata": { "id": "id", "accountId": "accountId", "createdAt": "2019-12-27T18:11:19.117Z", "name": "name", "profileId": "profileId", "workspaceId": "workspaceId", "bundleKey": "bundleKey", "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_UNSPECIFIED", "email": "email", "name": "name" } }, "entryCount": 0, "lastUsedAt": "2019-12-27T18:11:19.117Z" } } ```