Skip to content
Console
On this page

Create a memory store

Creates a memory store.

Creates a memory store.

  • Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/memory_stores
  • Scope agents:write
  • Effect write — a successful call changes state.
  • Collection memory_stores
  • Query memory_store_id, validate_only

Request

FieldTypeWhat it is
parentstringThe parent to create in. Required.
memory_store_idstringThe memory store id, the final name segment; the server assigns one when empty.
memory_storeMemoryStoreThe memory store to create; only caller-writable fields are read. Required.
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. Not accepted yet: memories are Knowledge episodes and Knowledge has no time-based deletion, so a set value is refused with INVALID_FIELD.
agent_writesboolWhether 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.

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. Not accepted yet: memories are Knowledge episodes and Knowledge has no time-based deletion, so a set value is refused with INVALID_FIELD.
agent_writesboolWhether 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.

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 of the memories' current content. Knowledge meters their storage. 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 POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/memory_stores" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"spec":{"scope":"project"}}'