Get Session Memory

GET

Returns a memory for a given session.

Path parameters

sessionIdstringRequired

The ID of the session for which to retrieve memory.

Query parameters

lastnintegerOptional

The number of most recent memory entries to retrieve.

minRatingdoubleOptional

The minimum rating by which to filter relevant facts.

Response

contextstringOptional

Memory context containing relevant facts and entities for the session. Can be put into the prompt directly.

factslist of stringsOptional

Most recent list of facts derived from the session. Deprecated: Use relevant_facts instead.

messageslist of objectsOptional

A list of message objects, where each message contains a role and content. Only last_n messages will be returned

metadatamap from strings to anyOptional

Deprecated

relevant_factslist of objectsOptional

Most relevant facts to the recent messages in the session.

summaryobjectOptional

Deprecated: Use context string instead.

Errors

GET

1 curl https://api.getzep.com/api/v2/sessions/sessionId/memory \
2      -H "Authorization: Api-Key <apiKey>"

200Retrieved

1 {
2   "context": "context",
3   "facts": [
4     "facts"
5   ],
6   "messages": [
7     {
8       "content": "content",
9       "role_type": "norole",
10       "created_at": "created_at",
11       "metadata": {
12         "key": "value"
13       },
14       "role": "role",
15       "token_count": 1,
16       "updated_at": "updated_at",
17       "uuid": "uuid"
18     }
19   ],
20   "metadata": {
21     "key": "value"
22   },
23   "relevant_facts": [
24     {
25       "content": "content",
26       "created_at": "created_at",
27       "fact": "fact",
28       "uuid": "uuid",
29       "expired_at": "expired_at",
30       "invalid_at": "invalid_at",
31       "name": "name",
32       "rating": 1.1,
33       "source_node_name": "source_node_name",
34       "target_node_name": "target_node_name",
35       "valid_at": "valid_at"
36     }
37   ],
38   "summary": {
39     "content": "content",
40     "created_at": "created_at",
41     "metadata": {
42       "key": "value"
43     },
44     "related_message_uuids": [
45       "related_message_uuids"
46     ],
47     "token_count": 1,
48     "uuid": "uuid"
49   }
50 }

Built with

1	curl https://api.getzep.com/api/v2/sessions/sessionId/memory \
2	-H "Authorization: Api-Key <apiKey>"

1	{
2	"context": "context",
3	"facts": [
4	"facts"
5	],
6	"messages": [
7	{
8	"content": "content",
9	"role_type": "norole",
10	"created_at": "created_at",
11	"metadata": {
12	"key": "value"
13	},
14	"role": "role",
15	"token_count": 1,
16	"updated_at": "updated_at",
17	"uuid": "uuid"
18	}
19	],
20	"metadata": {
21	"key": "value"
22	},
23	"relevant_facts": [
24	{
25	"content": "content",
26	"created_at": "created_at",
27	"fact": "fact",
28	"uuid": "uuid",
29	"expired_at": "expired_at",
30	"invalid_at": "invalid_at",
31	"name": "name",
32	"rating": 1.1,
33	"source_node_name": "source_node_name",
34	"target_node_name": "target_node_name",
35	"valid_at": "valid_at"
36	}
37	],
38	"summary": {
39	"content": "content",
40	"created_at": "created_at",
41	"metadata": {
42	"key": "value"
43	},
44	"related_message_uuids": [
45	"related_message_uuids"
46	],
47	"token_count": 1,
48	"uuid": "uuid"
49	}
50	}