-
Notifications
You must be signed in to change notification settings - Fork 159
Expand file tree
/
Copy pathplatform.openapi.json
More file actions
1297 lines (1297 loc) · 44.8 KB
/
platform.openapi.json
File metadata and controls
1297 lines (1297 loc) · 44.8 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
{
"components": {
"responses": {
"UnexpectedError": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unexpected error."
}
},
"schemas": {
"AddMemoriesResponse": {
"description": "Response model for adding memories.",
"properties": {
"results": {
"description": "The list of results for each added memory message.",
"items": {
"$ref": "#/components/schemas/AddMemoryResult"
},
"title": "Results",
"type": "array"
}
},
"required": [
"results"
],
"title": "AddMemoriesResponse",
"type": "object"
},
"AddMemoriesSpec": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectScope"
},
{
"properties": {
"messages": {
"description": "A list of messages to be added (batch input).\nMust contain at least one message.\n",
"items": {
"$ref": "#/components/schemas/MemoryMessage"
},
"minItems": 1,
"title": "Messages",
"type": "array"
},
"types": {
"description": "A list of memory types to add (e.g., episodic, semantic).\nIf empty, all available types are added.\n",
"example": [
"episodic",
"semantic"
],
"items": {
"$ref": "#/components/schemas/MemoryType"
},
"title": "Types",
"type": "array"
}
},
"required": [
"messages"
],
"type": "object"
}
],
"description": "Specification model for adding memories.",
"title": "AddMemoriesSpec"
},
"AddMemoryResult": {
"description": "Response model for adding memories.",
"properties": {
"uid": {
"description": "The unique identifier of the memory message.",
"title": "Uid",
"type": "string"
}
},
"required": [
"uid"
],
"title": "AddMemoryResult",
"type": "object"
},
"ContentType": {
"default": "string",
"description": "Enumeration for the type of content within an Episode.",
"enum": [
"string"
],
"title": "ContentType",
"type": "string"
},
"CreateProjectSpec": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectScope"
},
{
"properties": {
"description": {
"default": "",
"description": "A human-readable description of the project.\nUsed for display purposes in UIs and dashboards.\nOptional; defaults to an empty string.\n",
"example": "Test project for RAG pipeline",
"title": "Description",
"type": "string"
}
},
"type": "object"
}
],
"description": "Specification model for creating a new project.\n\nThe project ID must be unique for the authenticated user.\n",
"title": "CreateProjectSpec"
},
"DeleteEpisodicMemorySpec": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectScope"
},
{
"properties": {
"episodic_ids": {
"description": "A list of unique IDs of episodic memories to delete.\n",
"example": [
"123",
"345"
],
"items": {
"type": "string"
},
"minItems": 1,
"title": "Episodic Ids",
"type": "array"
}
},
"required": [
"episodic_ids"
],
"type": "object"
}
],
"description": "Specification model for deleting episodic memories.",
"title": "DeleteEpisodicMemorySpec"
},
"DeleteProjectSpec": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectScope"
}
],
"description": "Specification model for deleting a project.\n\nDeletion is irreversible and removes the project and all associated\ndata permanently.\n",
"title": "DeleteProjectSpec"
},
"DeleteSemanticMemorySpec": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectScope"
},
{
"properties": {
"semantic_ids": {
"description": "A list of unique IDs of semantic memories to delete.\n",
"example": [
"123",
"345"
],
"items": {
"type": "string"
},
"minItems": 1,
"title": "Semantic Ids",
"type": "array"
}
},
"required": [
"semantic_ids"
],
"type": "object"
}
],
"description": "Specification model for deleting semantic memories.",
"title": "DeleteSemanticMemorySpec"
},
"Episode": {
"description": "Episode data returned in list responses.",
"properties": {
"content": {
"description": "The content payload of the episode.",
"title": "Content",
"type": "string"
},
"content_type": {
"$ref": "#/components/schemas/ContentType"
},
"created_at": {
"description": "Timestamp when the episode was created.",
"format": "date-time",
"title": "Created At",
"type": "string"
},
"episode_type": {
"$ref": "#/components/schemas/EpisodeType"
},
"filterable_metadata": {
"additionalProperties": true,
"description": "Metadata indexed for filtering.",
"nullable": true,
"title": "Filterable Metadata",
"type": "object"
},
"metadata": {
"additionalProperties": true,
"description": "Optional metadata associated with the episode.",
"nullable": true,
"title": "Metadata",
"type": "object"
},
"produced_for_id": {
"description": "Identifier of the intended recipient of the episode.",
"nullable": true,
"title": "Produced For Id",
"type": "string"
},
"producer_id": {
"description": "Identifier of the episode producer.",
"title": "Producer Id",
"type": "string"
},
"producer_role": {
"description": "Role of the producer (e.g., user/assistant/system).",
"title": "Producer Role",
"type": "string"
},
"sequence_num": {
"default": 0,
"description": "Sequence number within the session.",
"title": "Sequence Num",
"type": "integer"
},
"session_key": {
"description": "Session key associated with the episode.",
"title": "Session Key",
"type": "string"
},
"uid": {
"description": "Unique identifier for the episode.",
"title": "Uid",
"type": "string"
}
},
"required": [
"uid",
"content",
"session_key",
"created_at",
"producer_id",
"producer_role"
],
"title": "Episode",
"type": "object"
},
"EpisodeCountResponse": {
"description": "Response model representing the number of episodes associated with a project.\n\nThis model is typically returned by analytics or monitoring endpoints\nthat track usage activity (e.g., number of computation episodes, workflow\nruns, or operational cycles).\n\nThe count reflects the current recorded total at the time of the request.\n",
"properties": {
"count": {
"description": "The total number of episodic memories in the project.",
"minimum": 0,
"title": "Count",
"type": "integer"
}
},
"required": [
"count"
],
"title": "EpisodeCountResponse",
"type": "object"
},
"EpisodeResponse": {
"description": "Episode data returned in search responses.",
"properties": {
"content": {
"description": "The content payload of the episode.",
"title": "Content",
"type": "string"
},
"created_at": {
"description": "Timestamp when the episode was created.",
"format": "date-time",
"nullable": true,
"title": "Created At",
"type": "string"
},
"episode_type": {
"$ref": "#/components/schemas/EpisodeType"
},
"metadata": {
"additionalProperties": true,
"description": "Optional metadata associated with the episode.",
"nullable": true,
"title": "Metadata",
"type": "object"
},
"produced_for_id": {
"description": "Identifier of the intended recipient of the episode.",
"nullable": true,
"title": "Produced For Id",
"type": "string"
},
"producer_id": {
"description": "Identifier of the episode producer.",
"title": "Producer Id",
"type": "string"
},
"producer_role": {
"description": "Role of the producer (e.g., user/assistant/system).",
"title": "Producer Role",
"type": "string"
},
"score": {
"description": "Optional relevance score for the episode.",
"nullable": true,
"title": "Score",
"type": "number"
},
"uid": {
"description": "Unique identifier for the episode.",
"title": "Uid",
"type": "string"
}
},
"required": [
"content",
"producer_id",
"producer_role",
"uid"
],
"title": "EpisodeResponse",
"type": "object"
},
"EpisodeType": {
"default": "message",
"description": "Episode type.",
"enum": [
"message"
],
"title": "EpisodeType",
"type": "string"
},
"EpisodicSearchLongTermMemory": {
"description": "Long-term episodic memory search results.",
"properties": {
"episodes": {
"description": "Matched long-term episodic entries.",
"items": {
"$ref": "#/components/schemas/EpisodeResponse"
},
"title": "Episodes",
"type": "array"
}
},
"required": [
"episodes"
],
"title": "EpisodicSearchLongTermMemory",
"type": "object"
},
"EpisodicSearchResult": {
"description": "Episodic payload returned by `/memories/search`.",
"properties": {
"long_term_memory": {
"$ref": "#/components/schemas/EpisodicSearchLongTermMemory"
},
"short_term_memory": {
"$ref": "#/components/schemas/EpisodicSearchShortTermMemory"
}
},
"required": [
"long_term_memory",
"short_term_memory"
],
"title": "EpisodicSearchResult",
"type": "object"
},
"EpisodicSearchShortTermMemory": {
"description": "Short-term episodic memory search results.",
"properties": {
"episode_summary": {
"description": "Summaries of matched short-term episodes.",
"items": {
"type": "string"
},
"title": "Episode Summary",
"type": "array"
},
"episodes": {
"description": "Matched short-term episodic entries.",
"items": {
"$ref": "#/components/schemas/EpisodeResponse"
},
"title": "Episodes",
"type": "array"
}
},
"required": [
"episodes",
"episode_summary"
],
"title": "EpisodicSearchShortTermMemory",
"type": "object"
},
"Error": {
"properties": {
"code": {
"description": "Error code.",
"format": "int32",
"type": "integer"
},
"message": {
"description": "Error message.",
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object"
},
"GetProjectSpec": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectScope"
}
],
"description": "Specification model for retrieving a project.\n\nThe `project_id` uniquely identifies the project to retrieve.\n",
"title": "GetProjectSpec"
},
"ListMemoriesSpec": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectScope"
},
{
"properties": {
"filter": {
"default": "",
"description": "An optional string filter applied to the memory metadata. This uses a\nsimple query language (e.g., 'metadata.user_id=123') for exact matches.\nMultiple conditions can be combined using AND operators. The metadata\nfields are prefixed with 'metadata.' to distinguish them from other fields.\n",
"example": "metadata.user_id=123 AND metadata.session_id=abc",
"title": "Filter",
"type": "string"
},
"page_num": {
"default": 0,
"description": "The zero-based page number to retrieve. Use this for pagination.\n",
"example": 0,
"title": "Page Num",
"type": "integer"
},
"page_size": {
"default": 100,
"description": "The maximum number of memories to return per page. Use this for pagination.\n",
"example": 50,
"title": "Page Size",
"type": "integer"
},
"set_metadata": {
"additionalProperties": true,
"description": "Optional metadata key-value pairs used to filter or identify\na specific semantic memory set. Applies only when listing\nsemantic memories.\n",
"nullable": true,
"title": "Set Metadata",
"type": "object"
},
"type": {
"$ref": "#/components/schemas/MemoryType"
}
},
"type": "object"
}
],
"description": "Specification model for listing memories.",
"title": "ListMemoriesSpec"
},
"ListResult": {
"description": "Response model for memory list results.",
"properties": {
"content": {
"$ref": "#/components/schemas/ListResultContent"
},
"status": {
"default": 0,
"description": "The status code of the search operation. 0 typically indicates success.\n",
"example": 0,
"title": "Status",
"type": "integer"
}
},
"required": [
"content"
],
"title": "ListResult",
"type": "object"
},
"ListResultContent": {
"additionalProperties": false,
"description": "Payload for ListResult.content returned by `/memories/list`.",
"properties": {
"episodic_memory": {
"description": "Listed episodic memory entries.",
"items": {
"$ref": "#/components/schemas/Episode"
},
"nullable": true,
"title": "Episodic Memory",
"type": "array"
},
"semantic_memory": {
"description": "Listed semantic memory entries.",
"items": {
"$ref": "#/components/schemas/SemanticFeature"
},
"nullable": true,
"title": "Semantic Memory",
"type": "array"
}
},
"title": "ListResultContent",
"type": "object"
},
"MemoryMessage": {
"description": "Model representing a memory message.",
"properties": {
"content": {
"description": "The content or text of the message.",
"title": "Content",
"type": "string"
},
"episode_type": {
"$ref": "#/components/schemas/EpisodeType"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Additional metadata associated with the message, represented as key-value\npairs. Optional; defaults to an empty object.\nRetrieval operations may utilize this metadata for filtering.\nUse 'metadata.{key}' to filter based on specific metadata keys.\n",
"title": "Metadata",
"type": "object"
},
"produced_for": {
"default": "",
"description": "The intended recipient of the message. This is a user-friendly name for\nthe LLM to understand the message context. Defaults to an empty string.\n",
"title": "Produced For",
"type": "string"
},
"producer": {
"default": "user",
"description": "The sender of the message. This is a user-friendly name for\nthe LLM to understand the message context. Defaults to 'user'.\n",
"title": "Producer",
"type": "string"
},
"role": {
"default": "",
"description": "The role of the message in a conversation (e.g., 'user', 'assistant',\n'system'). Optional; defaults to an empty string.\n",
"title": "Role",
"type": "string"
},
"timestamp": {
"description": "The timestamp when the message was created, in ISO 8601 format.\nThe formats supported are:\n- ISO 8601 string (e.g., '2023-10-01T12:00:00Z' or '2023-10-01T08:00:00-04:00')\n- Unix epoch time in seconds (e.g., 1633072800)\n- Unix epoch time in milliseconds (e.g., 1633072800000)\nIf not provided, the server assigns the current time.\nIf the format is unrecognized, an error is returned.\n",
"format": "date-time",
"title": "Timestamp",
"type": "string"
}
},
"required": [
"content"
],
"title": "MemoryMessage",
"type": "object"
},
"MemoryType": {
"description": "Memory type.",
"enum": [
"semantic",
"episodic"
],
"title": "MemoryType",
"type": "string"
},
"Metadata": {
"description": "Storage metadata for a semantic feature, including id and citations.",
"properties": {
"citations": {
"description": "Episode IDs cited by this semantic feature.",
"items": {
"type": "string"
},
"nullable": true,
"title": "Citations",
"type": "array"
},
"id": {
"description": "Identifier for the semantic feature.",
"nullable": true,
"title": "Id",
"type": "string"
},
"other": {
"additionalProperties": true,
"description": "Additional storage metadata for the semantic feature.",
"nullable": true,
"title": "Other",
"type": "object"
}
},
"title": "Metadata",
"type": "object"
},
"ProjectConfig": {
"description": "Project configuration model.\n\nThis section defines which reranker and embedder models should be used for\nthe project. If any field is left empty (\"\"), the system automatically falls\nback to the globally configured defaults in the server configuration file.\n",
"properties": {
"embedder": {
"default": "",
"description": "The name of the embedder model to use for this project.\n\n- Must refer to an embedder model defined in the system configuration.\n- If set to an empty string (default), the globally configured embedder will\n be used.\n\nEmbedders generate vector embeddings for text to support semantic search and\nsimilarity operations.\n",
"example": "bge-base-en",
"title": "Embedder",
"type": "string"
},
"reranker": {
"default": "",
"description": "The name of the reranker model to use for this project.\n\n- Must refer to a reranker model defined in the system configuration.\n- If set to an empty string (default), the globally configured reranker will\n be used.\n\nRerankers typically re-score retrieved documents to improve result quality.\n",
"example": "bge-reranker-large",
"title": "Reranker",
"type": "string"
}
},
"title": "ProjectConfig",
"type": "object"
},
"ProjectResponse": {
"description": "Response model returned after project operations (e.g., creation, update, fetch).\n\nContains the resolved identifiers and configuration of the project as stored\nin the system. Field formats follow the same validation rules as in\n`CreateProjectSpec`.\n",
"properties": {
"config": {
"$ref": "#/components/schemas/ProjectConfig"
},
"description": {
"default": "",
"description": "A human-readable description of the project.\nUsed for display purposes in UIs and dashboards.\nOptional; defaults to an empty string.\n",
"title": "Description",
"type": "string"
},
"org_id": {
"description": "The unique identifier of the organization this project belongs to.\n\nReturned exactly as stored by the system.\n",
"maxLength": 255,
"title": "Org Id",
"type": "string"
},
"project_id": {
"description": "The identifier of the project.\n\nThis value uniquely identifies the project within the organization.\n",
"maxLength": 255,
"title": "Project Id",
"type": "string"
}
},
"required": [
"org_id",
"project_id"
],
"title": "ProjectResponse",
"type": "object"
},
"ProjectScope": {
"properties": {
"project_id": {
"default": "",
"description": "The identifier of the project. If empty, the user's default project is used.",
"maxLength": 255,
"pattern": "^[\\p{L}\\p{N}_:-]*$",
"title": "Project Id",
"type": "string",
"x-go-type-skip-optional-pointer": true
}
},
"type": "object"
},
"SearchMemoriesSpec": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectScope"
},
{
"properties": {
"agent_mode": {
"default": false,
"description": "Whether to enable top-level retrieval-agent orchestration for episodic search.\nWhen false, episodic search uses direct memory retrieval.\n",
"example": false,
"title": "Agent Mode",
"type": "boolean"
},
"expand_context": {
"default": 0,
"description": "The number of additional episodes to include around each matched\nepisode from long term memory for better context.\n",
"example": 0,
"title": "Expand Context",
"type": "integer"
},
"filter": {
"default": "",
"description": "An optional string filter applied to the memory metadata. This uses a\nsimple query language (e.g., 'metadata.user_id=123') for exact matches.\nMultiple conditions can be combined using AND operators. The metadata\nfields are prefixed with 'metadata.' to distinguish them from other fields.\n",
"example": "metadata.user_id=123 AND metadata.session_id=abc",
"title": "Filter",
"type": "string"
},
"query": {
"description": "The natural language query used for semantic memory search. This should be\na descriptive string of the information you are looking for.\n",
"example": "What was the user's last conversation about finance?",
"title": "Query",
"type": "string"
},
"score_threshold": {
"description": "The minimum score for a memory to be included in the search results.\nDefaults to -inf (no threshold) represented as None.\nMeaningful only for certain ranking methods.\n",
"example": 0,
"nullable": true,
"title": "Score Threshold",
"type": "number"
},
"set_metadata": {
"additionalProperties": true,
"description": "Optional metadata key-value pairs used to filter or identify\na specific semantic memory set. Applies only when searching\nsemantic memories.\n",
"nullable": true,
"title": "Set Metadata",
"type": "object"
},
"top_k": {
"default": 10,
"description": "The maximum number of memories to return in the search results.\n",
"example": 5,
"title": "Top K",
"type": "integer"
},
"types": {
"description": "A list of memory types to include in the search (e.g., episodic, semantic).\nIf empty, all available types are searched.\n",
"example": [
"episodic",
"semantic"
],
"items": {
"$ref": "#/components/schemas/MemoryType"
},
"title": "Types",
"type": "array"
}
},
"required": [
"query"
],
"type": "object"
}
],
"description": "Specification model for searching memories.",
"title": "SearchMemoriesSpec"
},
"SearchResult": {
"description": "Response model for memory search results.",
"properties": {
"content": {
"$ref": "#/components/schemas/SearchResultContent"
},
"status": {
"default": 0,
"description": "The status code of the search operation. 0 typically indicates success.\n",
"example": 0,
"title": "Status",
"type": "integer"
}
},
"required": [
"content"
],
"title": "SearchResult",
"type": "object"
},
"SearchResultContent": {
"additionalProperties": false,
"description": "Payload for SearchResult.content returned by `/memories/search`.",
"properties": {
"episodic_memory": {
"$ref": "#/components/schemas/EpisodicSearchResult"
},
"semantic_memory": {
"description": "Semantic memory search results.",
"items": {
"$ref": "#/components/schemas/SemanticFeature"
},
"nullable": true,
"title": "Semantic Memory",
"type": "array"
}
},
"title": "SearchResultContent",
"type": "object"
},
"SemanticFeature": {
"description": "Semantic memory entry returned in API responses.",
"properties": {
"category": {
"description": "Category of the semantic feature.",
"title": "Category",
"type": "string"
},
"feature_name": {
"description": "Name of the semantic feature.",
"title": "Feature Name",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/Metadata"
},
"set_id": {
"description": "Identifier of the semantic set.",
"nullable": true,
"title": "Set Id",
"type": "string"
},
"tag": {
"description": "Tag associated with the semantic feature.",
"title": "Tag",
"type": "string"
},
"value": {
"description": "Value of the semantic feature.",
"title": "Value",
"type": "string"
}
},
"required": [
"category",
"tag",
"feature_name",
"value"
],
"title": "SemanticFeature",
"type": "object"
}
},
"securitySchemes": {
"BearerAuth": {
"scheme": "bearer",
"type": "http"
}
}
},
"info": {
"description": "REST API server for MemMachine memory system",
"title": "MemMachine Server",
"version": "0.1.0"
},
"openapi": "3.0.4",
"paths": {
"/health": {
"get": {
"description": "Health check endpoint to verify server is running.",
"operationId": "HealthCheck",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": {
"type": "string"
},
"title": "Response Health Check Api V2 Health Get",
"type": "object"
}
}
},
"description": "Successful Response"
},
"default": {
"$ref": "#/components/responses/UnexpectedError"
}
},
"security": [],
"summary": "Health Check",
"tags": [
"Health"
],
"x-mint": {
"href": "/platform/api-reference/system/health-check"
}
}
},
"/v2/memories": {
"post": {
"description": "Add memory messages to a project.\n\nThe `types` field in the request specifies which memory types to add to:\n- If `types` is empty or not provided, memories are added to all types (episodic and semantic)\n- If `types` only contains `\"episodic\"`, memories are added only to Episodic memory\n- If `types` only contains `\"semantic\"`, memories are added only to Semantic memory\n- If `types` contains both, memories are added to both types\n\nEach memory message represents a discrete piece of information to be stored\nin the project's memory system. Messages can include content, metadata,\ntimestamps, and other contextual details.\n\nThe producer field indicates who created the message, while the\nproduced_for field specifies the intended recipient. These fields help\nprovide context for the memory and if provided should be user-friendly names.\n\nThe endpoint accepts a batch of messages to be added in a single request.\n",
"operationId": "AddMemories",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddMemoriesSpec"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddMemoriesResponse"
}
}
},
"description": "Successful Response"
},
"default": {
"$ref": "#/components/responses/UnexpectedError"
}
},
"summary": "Add Memories",
"tags": [
"Memories"
],
"x-mint": {
"href": "/platform/api-reference/memories/add-memories"
}
}
},
"/v2/memories/episodic/delete": {
"post": {
"description": "Delete episodic memories from a project.\n\nThis operation permanently removes one or more episodic memories from the\nspecified project. Provide `episodic_ids` with the list of memory IDs to delete.\nThis action cannot be undone.\n\nIf any of the specified episodic memories do not exist, a not-found error\nis returned for those entries.\n",
"operationId": "DeleteEpisodicMemory",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteEpisodicMemorySpec"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Successful Response"
},
"default": {
"$ref": "#/components/responses/UnexpectedError"
}
},
"summary": "Delete Episodic Memory",
"tags": [
"Memories"
],
"x-mint": {
"href": "/platform/api-reference/memories/delete-episodic-memory"
}
}
},
"/v2/memories/list": {
"post": {
"description": "List memories within a project.\n\nSystem returns a paginated list of memories stored in the project.\nThe page_size and page_num fields control pagination.\n\nThe filter field allows for filtering based on metadata key-value pairs.\nThe type field allows specifying which memory type to list.\n",
"operationId": "ListMemories",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListMemoriesSpec"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListResult"
}
}
},
"description": "Successful Response"
},
"default": {
"$ref": "#/components/responses/UnexpectedError"
}
},
"summary": "List Memories",
"tags": [
"Memories"
],
"x-mint": {
"href": "/platform/api-reference/memories/list-memories"
}
}
},
"/v2/memories/search": {