Create Agent Memory
Beta/v1/ai/memoriesIdempotent with Idempotency-Key header. Learn more
Saves a piece of information for agents to recall on future runs.
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 to remember, written as plain text for an agent to read.
metadataoptional objectnullableArbitrary metadata as JSON.
Encoded as a JSON value (object, array, string, number, boolean, or null), not a JSON-encoded string. Send null to clear.
entity_typeoptional stringType 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; omit both for a memory that is not tied to any particular record.
entity_idoptional stringID of the platform record this memory is scoped to.
Provide together with entity_type.
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, so a memory created without an importance is stored at 0 and is the first to be left out.
expires_atoptional stringWhen 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. Omit it for a memory that should be used indefinitely.
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 Create Agent Memory