Update Agent Memory
Beta/v1/ai/memories/{id}Idempotent with Idempotency-Key header. Learn more
Updates an agent memory.
Only the fields included in the request are changed; everything else keeps its current value.
idstringMemory ID.
categoryoptional stringThe kind of information this memory holds, used to group related memories.
preference: how someone likes things done, such as a customer who always wants express shipping.fact: a durable detail worth remembering about the account or one of its records, such as a customer's typical order size.instruction: standing guidance for agents to follow, such as always confirming freight before issuing an order.
contentoptional stringThe information to remember, written as plain text for an agent to read.
metadataoptional objectnullableArbitrary metadata as JSON.
Replaces the stored metadata outright rather than merging into it.
Encoded as a JSON value (object, array, string, number, boolean, or null), not a JSON-encoded string. Send null to clear.
entity_typeoptional stringnullableType of platform record this memory is scoped to (e.g. customer, product).
Provide together with entity_id to scope the memory to a specific record; send null (on either entity field) to unscope the memory. Send null to clear.
entity_idoptional stringnullableID of the platform record this memory is scoped to.
Provide together with entity_type; send null to unscope the memory. Send null to clear.
importanceoptional numberRelative importance from 0 to 1 in increments of 0.1, used to prioritize which memories the agent recalls.
An agent takes in only a limited number of memories per run and recalls the highest-importance ones first.
expires_atoptional stringnullableWhen this memory should stop being used, as an ISO 8601 timestamp (e.g. 2026-01-02T15:04:05Z).
Past this time the memory is no longer recalled by agents and is omitted from list results, but it is not deleted. Send null so the memory is used indefinitely. Send null to clear.
idstringMemory ID.
objectstringenumValues:agent_memoryResource type identifier.
categorystringThe kind of information this memory holds, used to group related memories.
preference: how someone likes things done, such as a customer who always wants express shipping.fact: a durable detail worth remembering about the account or one of its records, such as a customer's typical order size.instruction: standing guidance for agents to follow, such as always confirming freight before issuing an order.
contentstringThe information itself, written as plain text for an agent to read.
metadataobjectnullableArbitrary metadata as JSON.
Encoded as a JSON value (object, array, string, number, boolean, or null), not a JSON-encoded string.
entityentitynullableThe platform record this memory is about (e.g. a specific customer or product).
idstringUnique identifier for the entity.
objectstringenumValues:entityResource type identifier.
typestringenumValues:accountactorentityThe resource kind that this entity references, as an object-type value (e.g. user, account).
Unlike object — which is always entity — this names the underlying resource the id points to.
namestringnullableHuman-readable display name for the entity (e.g. a user's full name, a sales order number).
handlestringnullableSecondary human-readable identifier (e.g. email address, username, redacted API key value).
importancenumberRelative importance from 0 to 1, used to prioritize which memories the agent recalls.
An agent takes in only a limited number of memories per run, and the highest-importance ones are recalled first.
expires_atstring (date-time)nullableWhen this memory stops being used.
Past this time the memory is no longer recalled by agents and is omitted from list results, but it is not deleted and can still be retrieved by ID. A memory with no expiration is used indefinitely.
created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last updated timestamp.
Responses
Successful response for Update Agent Memory