Skip to content
Console
Menu

Getting Started

Authentication

KV Store

sylphx agents memories

Every sylphx agents memories command: its argument, its flags and a run line.

The memories commands of Sylphx Agents, as the CLI spells them: the same calls as the memories API page, typed for the shell. Install, sign in and the grammar are on the CLI index.

Not available yet. Sylphx Agents is declared in the registry but no backend serves it: every command answers 501 with the problem code UNIMPLEMENTED.

#get

Gets a memory.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx agents memories get orgs/acme/projects/shop/envs/production/memory_stores/memory-store/memories/memory

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/memory_stores/memory-store/memories/memory · scope agents:sessions · effect read · Request, response and examples

#list

Lists a store's memories, newest first. With a publishable key, only the caller's end user's memories.

PARENT — optional: the CLI fills it from the linked project or the key's scope when it is left out.

CLI

Shell
sylphx agents memories list orgs/acme/projects/shop/envs/production/memory_stores/memory-store

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/memory_stores/memory-store/memories · scope agents:sessions · effect read · Request, response and examples

Flags

FlagTypeWhat it does
--page-sizeintAt most this many; default 50, clamped to 1000.
--page-tokenstringnext_page_token of the previous page.
--filterstringAIP-160 filter, limited to end_user and agent.

#create

Writes a memory.

ID — The id segment of the new Resource's name; the server assigns one when omitted.

CLI

Shell
sylphx agents memories create --parent orgs/acme/projects/shop/envs/production/memory_stores/memory-store --content …

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/memory_stores/memory-store/memories · scope agents:write · effect write · Request, response and examples

Flags

FlagTypeWhat it does
--parentstringThe parent to create in; defaults to the linked project or the key's scope.
--meta.labelskey=valueCaller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value.
--meta.annotationskey=valueCaller-writable, unindexed annotations. Repeat the flag for each value.
--meta.display-namestringCaller-writable human-readable name.
--contentstringThe memory, at most 16 KiB of text. Required.
--end-userstringThe end user it is about, for a store scoped to end users.
--agentstringThe agent it belongs to, for a store scoped to agents.
--dry-runboolValidate and print the result without writing (validate_only).

#update

Changes a memory's content.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx agents memories update orgs/acme/projects/shop/envs/production/memory_stores/memory-store/memories/memory --content …

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/memory_stores/memory-store/memories/memory · scope agents:write · effect write · Request, response and examples

Flags

FlagTypeWhat it does
--meta.labelskey=valueCaller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value.
--meta.annotationskey=valueCaller-writable, unindexed annotations. Repeat the flag for each value.
--meta.display-namestringCaller-writable human-readable name.
--contentstringThe memory, at most 16 KiB of text. Required.
--dry-runboolValidate and print the result without writing (validate_only).

#delete

Deletes a memory. An end user may delete their own.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx agents memories delete orgs/acme/projects/shop/envs/production/memory_stores/memory-store/memories/memory --yes

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/memory_stores/memory-store/memories/memory · scope agents:sessions · effect destructive · Request, response and examples

Flags

FlagTypeWhat it does
--etagstringDelete only if the current etag matches.
--allow-missingboolSucceed when the memory does not exist.
--dry-runboolValidate and print the result without writing (validate_only).
--yesboolDo not ask before this destructive call.

Recalls the memories that best match a query, by hybrid full-text and vector search. With a publishable key, only the caller's end user's memories. A read with a request body, like a query.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx agents memories search orgs/acme/projects/shop/envs/production/memory_stores/memory-store

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/memory_stores/memory-store/memories:search · scope agents:sessions · effect read · Request, response and examples

Flags

FlagTypeWhat it does
--querystringWhat to recall, 1 to 2000 characters. Required.
--end-userstringOnly memories about this end user.
--agentstringOnly memories of this agent.
--page-sizeintAt most this many; default 10, clamped to 100.
--page-tokenstringnext_page_token of the previous page.