sylphx agents memory_stores
Every sylphx agents memory_stores command: its argument, its flags and a run line.
The memory_stores commands of Sylphx Agents, as the CLI spells them: the same
calls as the memory_stores API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
get
Gets a memory store.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx agents memory-stores get orgs/acme/projects/shop/envs/production/memory_stores/memory-storeGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/memory_stores/memory-store · scope agents:read · effect read · Request, response and examples
list
Lists memory stores.
PARENT — optional: the CLI fills it from the linked project or the
key's scope when it is left out.
CLI
sylphx agents memory-stores list orgs/acme/projects/shop/envs/productionGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/memory_stores · scope agents:read · effect read · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--page-size | int | At most this many; default 50, clamped to 1000. |
--page-token | string | next_page_token of the previous page. |
--filter | string | AIP-160 filter over labels and filterable fields. |
--order-by | string | AIP-132 ordering over filterable fields. |
create
Creates a memory store.
ID — The id segment of the new Resource's name; the server assigns one when omitted.
CLI
sylphx agents memory-stores create --parent orgs/acme/projects/shop/envs/production --spec.scope projectPOST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/memory_stores · scope agents:write · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--parent | string | The parent to create in; defaults to the linked project or the key's scope. |
--meta.labels | key=value | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
--meta.annotations | key=value | Caller-writable, unindexed annotations. Repeat the flag for each value. |
--meta.display-name | string | Caller-writable human-readable name. |
--spec.description | string | What the store is for, shown to agents; at most 1024 characters. |
--spec.scope | enum | Whose memories are kept apart. Required. One of project, agent, end_user. |
--spec.retention | duration | Memories older than this since their last update are deleted, 1d to 3650d; unset keeps them until deleted. Not accepted yet: memories are Knowledge episodes and Knowledge has no time-based deletion, so a set value is refused with INVALID_FIELD. |
--spec.agent-writes | bool | Whether agents write memories themselves after each turn; otherwise only callers write them. Not accepted yet: the turn runtime has no after-turn memory hook, so true is refused with INVALID_FIELD. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
update
Updates a memory store.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx agents memory-stores update orgs/acme/projects/shop/envs/production/memory_stores/memory-store --spec.scope projectPATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/memory_stores/memory-store · scope agents:write · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--meta.labels | key=value | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
--meta.annotations | key=value | Caller-writable, unindexed annotations. Repeat the flag for each value. |
--meta.display-name | string | Caller-writable human-readable name. |
--spec.description | string | What the store is for, shown to agents; at most 1024 characters. |
--spec.scope | enum | Whose memories are kept apart. Required. One of project, agent, end_user. |
--spec.retention | duration | Memories older than this since their last update are deleted, 1d to 3650d; unset keeps them until deleted. Not accepted yet: memories are Knowledge episodes and Knowledge has no time-based deletion, so a set value is refused with INVALID_FIELD. |
--spec.agent-writes | bool | Whether agents write memories themselves after each turn; otherwise only callers write them. Not accepted yet: the turn runtime has no after-turn memory hook, so true is refused with INVALID_FIELD. |
--allow-missing | bool | Create the memory store when it does not exist (declarative upsert). |
--dry-run | bool | Validate and print the result without writing (validate_only). |
delete
Deletes a memory store. A store an agent names is refused with RESOURCE_IN_USE; a store with memories is refused with INVALID_STATE unless force is set, which deletes them too.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx agents memory-stores delete orgs/acme/projects/shop/envs/production/memory_stores/memory-store --yesDELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/memory_stores/memory-store · scope agents:write · effect destructive · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--etag | string | Delete only if the current etag matches. |
--allow-missing | bool | Succeed when the memory store does not exist. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
--force | bool | Also delete the store's memories; without it, a store with memories is refused with INVALID_STATE. |
--yes | bool | Do not ask before this destructive call. |