List Agent Memories
Beta/v1/ai/memoriesThis endpoint is idempotent. Learn more
Returns a paginated list of agent memories for the current account, newest first.
Memories whose expires_at has passed are excluded. The q search term matches against a memory's ID, category, content, and the ID of the record it is scoped to.
cursoroptional stringOpaque cursor token identifying where the page of results starts.
Use the cursor value embedded in a previous response's next_page_url or previous_page_url to fetch the adjacent page. Omit to start from the first page.
limitoptional integerMaximum number of results to return in a single page.
qoptional stringFree-text search term used to filter results.
Which fields are matched against the term varies by endpoint.
categoryoptional stringFilter to memories with this exact category (e.g. preference, fact).
entity_typeoptional stringFilter to memories scoped to this entity type (e.g. customer, product).
objectstringenumValues:listResource type identifier.
page_infoobjectPagination metadata.
next_page_urlstringnullableRelative URL that fetches the next page of results.
previous_page_urlstringnullableRelative URL that fetches the previous page of results.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of agent_memoryResources in this page.
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 List Agent Memories