Skip to content
Console
On this page

Memories

A Memory is one long-term memory record: a fact with its provenance.

A Memory is one long-term memory record: a fact with its provenance.

Service Sylphx Agents · Resource type agents.sylphx.com/Memory · Name pattern orgs/{org}/projects/{project}/envs/{env}/memory_stores/{memory_store}/memories/{memory} · Shape record

Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/memory_stores/{memory_store}/memories/{memory}.
uidstringmem_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
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.
provenanceMemoryProvenanceWhere it came from. Output only.
create_timetimestampWhen it was written. Output only.
update_timetimestampWhen it was last changed. Output only.

Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
GETgetGets a memory.
GETlistLists a store's memories, newest first. With a publishable key, only the caller's end user's memories.
POSTcreateWrites a memory.
PATCHupdateChanges a memory's content.
DELETEdeleteDeletes a memory. An end user may delete their own.
POSTsearchRecalls 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.

get

Gets a 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.

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

create

Writes a memory.

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

update

Changes a memory's 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

delete

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

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

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.

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