Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Update a memory store

Updates a memory store.

Updates a memory store.

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 PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/memory_stores/memory-store
  • Scope agents:write
  • Effect write — a successful call changes state.
  • Collection memory_stores
  • Query update_mask, allow_missing, validate_only

#Request

FieldTypeWhat it is
memory_storeMemoryStoreThe memory store to update; name identifies it. Required.
update_maskfield_maskThe fields to write; unset writes every populated field.
allow_missingboolCreate the memory store when it does not exist (declarative upsert).
validate_onlyboolValidate and return the result without writing anything.

#MemoryStore

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/memory_stores/{memory_store}.
metaResourceMetaResource metadata.
specMemoryStoreSpecDesired state. Required.

#ResourceMeta

FieldTypeWhat it is
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.

#MemoryStoreSpec

FieldTypeWhat it is
descriptionstringWhat the store is for, shown to agents; at most 1024 characters.
scopeMemoryScopeWhose memories are kept apart. Required. One of project, agent, end_user.
retentiondurationMemories older than this since their last update are deleted, 1d to 3650d; unset keeps them until deleted.
agent_writesboolWhether agents write memories themselves after each turn; otherwise only callers write them.

#Response

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/memory_stores/{memory_store}.
uidstringmst_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specMemoryStoreSpecDesired state. Required.
statusMemoryStoreStatusObserved state. 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.

#MemoryStoreSpec

FieldTypeWhat it is
descriptionstringWhat the store is for, shown to agents; at most 1024 characters.
scopeMemoryScopeWhose memories are kept apart. Required. One of project, agent, end_user.
retentiondurationMemories older than this since their last update are deleted, 1d to 3650d; unset keeps them until deleted.
agent_writesboolWhether agents write memories themselves after each turn; otherwise only callers write them.

#MemoryStoreStatus

FieldTypeWhat it is
observed_generationint64The generation this status was computed from. Output only.
conditionsCondition[]Ready, Reconciling, Stalled. Output only.
memory_countint64The number of memories. Output only.
stored_bytesint64Bytes stored, content and index together; the billed quantity. Output only.

#Condition

FieldTypeWhat it is
typestringThe condition type, for example Ready.
statusConditionStatusWhether the condition holds. One of true, false, unknown.
observed_generationint64The generation this observation was made against.
reasonstringA machine-readable UpperCamelCase reason.
messagestringA customer-safe human-readable message.
severitySeverityHow severe a FALSE condition is. One of info, warning, error.
transition_timetimestampWhen status last changed.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl -X PATCH "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/memory_stores/memory-store" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"orgs/acme/projects/shop/envs/production/memory_stores/memory-store","spec":{"scope":"project"}}'