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.
get
Gets a memory.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx agents memories get orgs/acme/projects/shop/envs/production/memory_stores/memory-store/memories/memoryGET 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
sylphx agents memories list 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/memories · scope agents:sessions · 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, 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
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
| 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. |
--content | string | The memory, at most 16 KiB of text. Required. |
--end-user | string | The end user it is about, for a store scoped to end users. |
--agent | string | The agent it belongs to, for a store scoped to agents. |
--dry-run | bool | Validate 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
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
| 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. |
--content | string | The memory, at most 16 KiB of text. Required. |
--dry-run | bool | Validate 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
sylphx agents memories delete orgs/acme/projects/shop/envs/production/memory_stores/memory-store/memories/memory --yesDELETE 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
| Flag | Type | What it does |
|---|---|---|
--etag | string | Delete only if the current etag matches. |
--allow-missing | bool | Succeed when the memory does not exist. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
--yes | bool | Do not ask before this destructive call. |
search
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
sylphx agents memories search orgs/acme/projects/shop/envs/production/memory_stores/memory-storePOST 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
| Flag | Type | What it does |
|---|---|---|
--query | string | What to recall, 1 to 2000 characters. Required. |
--end-user | string | Only memories about this end user. |
--agent | string | Only memories of this agent. |
--page-size | int | At most this many; default 10, clamped to 100. |
--page-token | string | next_page_token of the previous page. |