-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathopenapi.json
More file actions
8732 lines (8732 loc) · 255 KB
/
openapi.json
File metadata and controls
8732 lines (8732 loc) · 255 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"openapi": "3.1.0",
"info": {
"title": "Papr Memory API",
"description": "API for managing personal memory items with authentication and user-specific data.\n## Authentication\nThis API supports three authentication methods:\n- **API Key**: Include your API key in the `X-API-Key` header\n ```\n X-API-Key: <your-api-key>\n ```\n- **Session Token**: Include your session token in the `X-Session-Token` header\n ```\n X-Session-Token: <your-session-token>\n ```\n- **Bearer Token**: Include your OAuth2 token from Auth0 in the `Authorization` header\n ```\n Authorization: Bearer <token>\n ```\nAll endpoints require one of these authentication methods.",
"version": "1.0.0"
},
"paths": {
"/v1/memory": {
"post": {
"tags": [
"v1",
"Memory"
],
"summary": "Add Memory V1",
"description": "Add a new memory item to the system with size validation and background processing.\n \n **Authentication Required**:\n One of the following authentication methods must be used:\n - Bearer token in `Authorization` header\n - API Key in `X-API-Key` header\n - Session token in `X-Session-Token` header\n \n **Required Headers**:\n - Content-Type: application/json\n - X-Client-Type: (e.g., 'papr_plugin', 'browser_extension')\n \n **Role-Based Memory Categories**:\n - **User memories**: preference, task, goal, facts, context\n - **Assistant memories**: skills, learning\n \n **New Metadata Fields**:\n - `metadata.role`: Optional field to specify who generated the memory (user or assistant)\n - `metadata.category`: Optional field for memory categorization based on role\n - Both fields are stored within metadata at the same level as topics, location, etc.\n \n The API validates content size against MAX_CONTENT_LENGTH environment variable (defaults to 15000 bytes).",
"operationId": "add_memory",
"security": [
{
"X-API-Key": []
},
{
"Bearer": []
},
{
"X-API-Key": []
}
],
"parameters": [
{
"name": "skip_background_processing",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, skips adding background tasks for processing",
"default": false,
"title": "Skip Background Processing"
},
"description": "If True, skips adding background tasks for processing"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddMemoryRequest"
}
}
}
},
"responses": {
"200": {
"description": "Memory successfully added",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddMemoryResponse"
},
"example": {
"code": 200,
"status": "success",
"data": [
{
"id": "mem_123",
"content": "Sample memory content.",
"type": "text",
"metadata": {
"topics": "example, memory",
"role": "user",
"category": "task"
},
"createdAt": "2024-06-01T12:00:00Z"
}
]
}
}
}
},
"207": {
"description": "Memory added with degraded functionality",
"content": {
"application/json": {
"example": {
"code": 207,
"status": "success",
"data": [
{
"id": "mem_124",
"content": "Sample memory content.",
"type": "text",
"metadata": {
"topics": "example, memory"
},
"createdAt": "2024-06-01T12:01:00Z"
}
],
"details": {
"warning": "Neo4j unavailable, stored in Pinecone only."
}
},
"schema": {
"$ref": "#/components/schemas/AddMemoryResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"example": {
"code": 400,
"status": "error",
"error": "Invalid request payload.",
"details": {
"field": "content",
"reason": "Missing required field."
}
},
"schema": {
"$ref": "#/components/schemas/AddMemoryResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"example": {
"code": 401,
"status": "error",
"error": "Missing or invalid authentication."
},
"schema": {
"$ref": "#/components/schemas/AddMemoryResponse"
}
}
}
},
"403": {
"description": "Subscription limit reached",
"content": {
"application/json": {
"example": {
"code": 403,
"status": "error",
"error": "Subscription limit reached. Upgrade required.",
"details": {
"limit": "memory quota"
}
},
"schema": {
"$ref": "#/components/schemas/AddMemoryResponse"
}
}
}
},
"413": {
"description": "Content too large",
"content": {
"application/json": {
"example": {
"code": 413,
"status": "error",
"error": "Content size (16000 bytes) exceeds maximum limit of 15000 bytes.",
"details": {
"max_content_length": 15000
}
},
"schema": {
"$ref": "#/components/schemas/AddMemoryResponse"
}
}
}
},
"415": {
"description": "Unsupported Media Type",
"content": {
"application/json": {
"example": {
"code": 415,
"status": "error",
"error": "Unsupported media type. Use application/json."
},
"schema": {
"$ref": "#/components/schemas/AddMemoryResponse"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"example": {
"code": 500,
"status": "error",
"error": "Internal server error.",
"details": {
"trace_id": "abc123"
}
},
"schema": {
"$ref": "#/components/schemas/AddMemoryResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-openai-isConsequential": false
}
},
"/v1/memory/{memory_id}": {
"put": {
"tags": [
"v1",
"Memory"
],
"summary": "Update Memory V1",
"description": "Update an existing memory item by ID.\n \n **Authentication Required**:\n One of the following authentication methods must be used:\n - Bearer token in `Authorization` header\n - API Key in `X-API-Key` header\n - Session token in `X-Session-Token` header\n \n **Required Headers**:\n - Content-Type: application/json\n - X-Client-Type: (e.g., 'papr_plugin', 'browser_extension')\n \n The API validates content size against MAX_CONTENT_LENGTH environment variable (defaults to 15000 bytes).",
"operationId": "update_memory",
"security": [
{
"X-API-Key": []
},
{
"Bearer": []
},
{
"X-API-Key": []
}
],
"parameters": [
{
"name": "memory_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Memory Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateMemoryRequest"
}
}
}
},
"responses": {
"200": {
"description": "Memory successfully updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateMemoryResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateMemoryResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateMemoryResponse"
}
}
}
},
"404": {
"description": "Memory not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateMemoryResponse"
}
}
}
},
"413": {
"description": "Content too large",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateMemoryResponse"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateMemoryResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-openai-isConsequential": true
},
"delete": {
"tags": [
"v1",
"Memory"
],
"summary": "Delete Memory V1",
"description": "Delete a memory item by ID.\n \n **Authentication Required**:\n One of the following authentication methods must be used:\n - Bearer token in `Authorization` header\n - API Key in `X-API-Key` header\n - Session token in `X-Session-Token` header\n \n **Required Headers**:\n - X-Client-Type: (e.g., 'papr_plugin', 'browser_extension')",
"operationId": "delete_memory",
"security": [
{
"X-API-Key": []
},
{
"Bearer": []
},
{
"X-API-Key": []
}
],
"parameters": [
{
"name": "memory_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Memory Id"
}
},
{
"name": "skip_parse",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Skip Parse Server deletion",
"default": false,
"title": "Skip Parse"
},
"description": "Skip Parse Server deletion"
}
],
"responses": {
"200": {
"description": "Memory successfully deleted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteMemoryResponse"
}
}
}
},
"207": {
"description": "Partially successful deletion",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteMemoryResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteMemoryResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteMemoryResponse"
}
}
}
},
"404": {
"description": "Memory not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteMemoryResponse"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteMemoryResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-openai-isConsequential": true
},
"get": {
"tags": [
"v1",
"Memory"
],
"summary": "Get Memory V1",
"description": "Retrieve a memory item by ID.\n \n **Authentication Required**:\n One of the following authentication methods must be used:\n - Bearer token in `Authorization` header\n - API Key in `X-API-Key` header\n - Session token in `X-Session-Token` header\n \n **Required Headers**:\n - X-Client-Type: (e.g., 'papr_plugin', 'browser_extension')",
"operationId": "get_memory",
"security": [
{
"X-API-Key": []
},
{
"Bearer": []
},
{
"X-API-Key": []
}
],
"parameters": [
{
"name": "memory_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Memory Id"
}
}
],
"responses": {
"200": {
"description": "Memory successfully retrieved",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResponse"
}
}
}
},
"404": {
"description": "Memory not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResponse"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-openai-isConsequential": false
}
},
"/v1/memory/batch": {
"post": {
"tags": [
"v1",
"Memory"
],
"summary": "Add Memory Batch V1",
"description": "Add multiple memory items in a batch with size validation and background processing.\n \n **Authentication Required**:\n One of the following authentication methods must be used:\n - Bearer token in `Authorization` header\n - API Key in `X-API-Key` header\n - Session token in `X-Session-Token` header\n \n **Required Headers**:\n - Content-Type: application/json\n - X-Client-Type: (e.g., 'papr_plugin', 'browser_extension')\n \n The API validates individual memory content size against MAX_CONTENT_LENGTH environment variable (defaults to 15000 bytes).",
"operationId": "add_memory_batch",
"security": [
{
"X-API-Key": []
},
{
"Bearer": []
},
{
"X-API-Key": []
}
],
"parameters": [
{
"name": "skip_background_processing",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If True, skips adding background tasks for processing",
"default": false,
"title": "Skip Background Processing"
},
"description": "If True, skips adding background tasks for processing"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchMemoryRequest"
}
}
}
},
"responses": {
"200": {
"description": "Memories successfully added",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchMemoryResponse"
}
}
}
},
"207": {
"description": "Partial success - some memories failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchMemoryResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchMemoryResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchMemoryResponse"
}
}
}
},
"403": {
"description": "Subscription limit reached",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchMemoryResponse"
}
}
}
},
"413": {
"description": "Content too large",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchMemoryResponse"
}
}
}
},
"415": {
"description": "Unsupported Media Type",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchMemoryResponse"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchMemoryResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-openai-isConsequential": false
}
},
"/v1/memory/all": {
"delete": {
"tags": [
"v1",
"Memory"
],
"summary": "Delete All Memories V1",
"description": "Delete all memory items for a user.\n \n **Authentication Required**:\n One of the following authentication methods must be used:\n - Bearer token in `Authorization` header\n - API Key in `X-API-Key` header\n - Session token in `X-Session-Token` header\n \n **User Resolution**:\n - If only API key is provided: deletes memories for the developer\n - If user_id or external_user_id is provided: resolves and deletes memories for that user\n - Uses the same user resolution logic as other endpoints\n \n **Required Headers**:\n - X-Client-Type: (e.g., 'papr_plugin', 'browser_extension')\n \n **WARNING**: This operation cannot be undone. All memories for the resolved user will be permanently deleted.",
"operationId": "delete_all_memories",
"security": [
{
"X-API-Key": []
},
{
"Bearer": []
},
{
"X-API-Key": []
}
],
"parameters": [
{
"name": "user_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Optional user ID to delete memories for (if not provided, uses authenticated user)",
"title": "User Id"
},
"description": "Optional user ID to delete memories for (if not provided, uses authenticated user)"
},
{
"name": "external_user_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Optional external user ID to resolve and delete memories for",
"title": "External User Id"
},
"description": "Optional external user ID to resolve and delete memories for"
},
{
"name": "skip_parse",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Skip Parse Server deletion",
"default": false,
"title": "Skip Parse"
},
"description": "Skip Parse Server deletion"
}
],
"responses": {
"200": {
"description": "All memories successfully deleted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchMemoryResponse"
}
}
}
},
"207": {
"description": "Partial success - some memories failed to delete",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchMemoryResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchMemoryResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchMemoryResponse"
}
}
}
},
"404": {
"description": "No memories found for user",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchMemoryResponse"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchMemoryResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-openai-isConsequential": true
}
},
"/v1/memory/search": {
"post": {
"tags": [
"v1",
"Memory"
],
"summary": "Search V1",
"description": "Search through memories with authentication required.\n \n **Authentication Required**:\n One of the following authentication methods must be used:\n - Bearer token in `Authorization` header\n - API Key in `X-API-Key` header\n - Session token in `X-Session-Token` header\n \n **Custom Schema Support**:\n This endpoint supports both system-defined and custom user-defined node types:\n - **System nodes**: Memory, Person, Company, Project, Task, Insight, Meeting, Opportunity, Code\n - **Custom nodes**: Defined by developers via UserGraphSchema (e.g., Developer, Product, Customer, Function)\n \n When custom schema nodes are returned:\n - Each custom node includes a `schema_id` field referencing the UserGraphSchema\n - The response includes a `schemas_used` array listing all schema IDs used\n - Use `GET /v1/schemas/{schema_id}` to retrieve full schema definitions including:\n - Node type definitions and properties\n - Relationship type definitions and constraints\n - Validation rules and requirements\n \n **Recommended Headers**:\n ```\n Accept-Encoding: gzip\n ```\n \n The API supports response compression for improved performance. Responses larger than 1KB will be automatically compressed when this header is present.\n \n **HIGHLY RECOMMENDED SETTINGS FOR BEST RESULTS:**\n - Set `enable_agentic_graph: true` for intelligent, context-aware search that can understand ambiguous references\n - Use `max_memories: 15-20` for comprehensive memory coverage\n - Use `max_nodes: 10-15` for comprehensive graph entity relationships\n \n **Agentic Graph Benefits:**\n When enabled, the system can understand vague references by first identifying specific entities from your memory graph, then performing targeted searches. For example:\n - \"customer feedback\" \u2192 identifies your customers first, then finds their specific feedback\n - \"project issues\" \u2192 identifies your projects first, then finds related issues\n - \"team meeting notes\" \u2192 identifies your team members first, then finds meeting notes\n - \"code functions\" \u2192 identifies your functions first, then finds related code\n \n **Role-Based Memory Filtering:**\n Filter memories by role and category using metadata fields:\n - `metadata.role`: Filter by \"user\" or \"assistant\" \n - `metadata.category`: Filter by category (user: preference, task, goal, facts, context | assistant: skills, learning)\n \n **User Resolution Precedence:**\n - If both user_id and external_user_id are provided, user_id takes precedence.\n - If only external_user_id is provided, it will be resolved to the internal user.\n - If neither is provided, the authenticated user is used.",
"operationId": "search_memory",
"security": [
{
"X-API-Key": []
},
{
"Bearer": []
},
{
"X-API-Key": []
}
],
"parameters": [
{
"name": "max_memories",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 50,
"minimum": 10,
"description": "HIGHLY RECOMMENDED: Maximum number of memories to return. Use at least 15-20 for comprehensive results. Lower values (5-10) may miss relevant information. Default is 20 for optimal coverage.",
"default": 20,
"title": "Max Memories"
},
"description": "HIGHLY RECOMMENDED: Maximum number of memories to return. Use at least 15-20 for comprehensive results. Lower values (5-10) may miss relevant information. Default is 20 for optimal coverage."
},
{
"name": "max_nodes",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 50,
"minimum": 10,
"description": "HIGHLY RECOMMENDED: Maximum number of neo nodes to return. Use at least 10-15 for comprehensive graph results. Lower values may miss important entity relationships. Default is 15 for optimal coverage.",
"default": 15,
"title": "Max Nodes"
},
"description": "HIGHLY RECOMMENDED: Maximum number of neo nodes to return. Use at least 10-15 for comprehensive graph results. Lower values may miss important entity relationships. Default is 15 for optimal coverage."
},
{
"name": "enable_agentic_graph",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "HIGHLY RECOMMENDED: Enable agentic graph search for intelligent, context-aware results. Can be set via URL parameter or JSON body. URL parameter takes precedence if both are provided.",
"title": "Enable Agentic Graph"
},
"description": "HIGHLY RECOMMENDED: Enable agentic graph search for intelligent, context-aware results. Can be set via URL parameter or JSON body. URL parameter takes precedence if both are provided."
},
{
"name": "Accept-Encoding",
"in": "header",
"description": "Recommended to use 'gzip' for response compression",
"schema": {
"type": "string",
"default": "gzip"
},
"required": false
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successfully retrieved memories",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResponse"
},
"examples": {
"system_nodes_response": {
"summary": "Response with system nodes only",
"description": "Standard response when only system-defined node types are found",
"value": {
"code": 200,
"status": "success",
"data": {
"memories": [
{
"id": "mem-123",
"content": "John Doe completed the quarterly report",
"created_at": "2024-01-15T10:30:00Z"
}
],
"nodes": [
{
"label": "Person",
"properties": {
"id": "person-123",
"name": "John Doe",
"role": "Manager"
}
},
{
"label": "Task",
"properties": {
"id": "task-456",
"title": "Quarterly Report",
"status": "completed"
}
}
]
},
"search_id": "search-789"
}
},
"custom_schema_response": {
"summary": "Response with custom schema nodes",
"description": "Response when custom UserGraphSchema nodes are found",
"value": {
"code": 200,
"status": "success",
"data": {
"memories": [
{
"id": "mem-456",
"content": "Rachel Green implemented the validateForm() function",
"created_at": "2024-01-15T14:20:00Z"
}
],
"nodes": [
{
"label": "Developer",
"properties": {
"id": "dev-789",
"name": "Rachel Green",
"expertise": [
"React",
"TypeScript"
],
"years_experience": 5
},
"schema_id": "schema_abc123"
},
{
"label": "Function",
"properties": {
"id": "func-101",