Create a memory
Writes a memory.
Writes a memory.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/memory_stores/memory-store/memories - Scope
agents:write - Effect
write— a successful call changes state. - Collection memories
- Query
memory_id,validate_only
Request
| Field | Type | What it is |
|---|---|---|
parent | string | The memory store to create in. Required. |
memory_id | string | The memory id, the final name segment; the server assigns one when empty. |
memory | Memory | The memory to create; only caller-writable fields are read. Required. |
validate_only | bool | Validate and return the result without writing anything. |
Memory
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/memory_stores/{memory_store}/memories/{memory}. |
meta | ResourceMeta | Resource metadata. |
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. |
ResourceMeta
| Field | Type | What it is |
|---|---|---|
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/memory_stores/{memory_store}/memories/{memory}. |
uid | string | mem_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
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. |
provenance | MemoryProvenance | Where it came from. Output only. |
create_time | timestamp | When it was written. Output only. |
update_time | timestamp | When it was last changed. Output only. |
ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong 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_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
MemoryProvenance
| Field | Type | What it is |
|---|---|---|
source | MemorySource | Who wrote it. Output only. One of agent, api, import. |
session | string | The session it was learned in, when an agent wrote it. Output only. |
event | string | The event it was learned from, when an agent wrote it. Output only. |
principal | string | The principal that wrote it, when a caller did. Output only. |
Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.UNKNOWN_FIELD— The request has a field the schema does not know.INVALID_FIELD— A field failed validation.RESOURCE_ALREADY_EXISTS— A Resource with this name exists.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.PLAN_LIMIT_REACHED— The plan's limit is reached.
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/memory-store/memories" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"content":"…"}'