Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Get a memory

Gets a memory.

Gets a memory.

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

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/memory_stores/memory-store/memories/memory
  • Scope agents:sessions
  • Effect read — nothing is written.
  • Collection memories

#Request

FieldTypeWhat it is
namestringThe name of the memory to get. Required.

#Response

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.

#ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

#MemoryProvenance

FieldTypeWhat it is
sourceMemorySourceWho wrote it. Output only. One of agent, api, import.
sessionstringThe session it was learned in, when an agent wrote it. Output only.
eventstringThe event it was learned from, when an agent wrote it. Output only.
principalstringThe principal that wrote it, when a caller did. Output only.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/memory_stores/memory-store/memories/memory" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"