@breign/client 1.0.124 → 1.0.125

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. package/dist/apis/AgentApi.d.ts +17 -12
  2. package/dist/apis/AgentApi.js +29 -14
  3. package/dist/apis/KnowledgeApi.d.ts +1 -113
  4. package/dist/apis/KnowledgeApi.js +0 -282
  5. package/dist/apis/MetricsApi.d.ts +15 -13
  6. package/dist/apis/MetricsApi.js +27 -21
  7. package/dist/apis/OrganizationsApi.d.ts +1 -26
  8. package/dist/apis/OrganizationsApi.js +0 -64
  9. package/dist/apis/SkillsApi.d.ts +14 -1
  10. package/dist/apis/SkillsApi.js +29 -0
  11. package/dist/models/AddModuleRequestUio.d.ts +60 -0
  12. package/dist/models/AddModuleRequestUio.js +68 -0
  13. package/dist/models/AgentPatchUio.d.ts +0 -30
  14. package/dist/models/AgentPatchUio.js +0 -10
  15. package/dist/models/AgentRefUio.d.ts +38 -0
  16. package/dist/models/AgentRefUio.js +54 -0
  17. package/dist/models/AgentRequestUio.d.ts +0 -59
  18. package/dist/models/AgentRequestUio.js +0 -22
  19. package/dist/models/AgentUio.d.ts +6 -44
  20. package/dist/models/AgentUio.js +2 -14
  21. package/dist/models/index.d.ts +2 -6
  22. package/dist/models/index.js +2 -6
  23. package/dist/openapi.json +281 -770
  24. package/package.json +1 -1
  25. package/dist/models/AgentRequestProfilePictureUio.d.ts +0 -50
  26. package/dist/models/AgentRequestProfilePictureUio.js +0 -62
  27. package/dist/models/DocumentAddRequestUio.d.ts +0 -38
  28. package/dist/models/DocumentAddRequestUio.js +0 -52
  29. package/dist/models/ImportFileToAgentKnowledge200ResponseUio.d.ts +0 -56
  30. package/dist/models/ImportFileToAgentKnowledge200ResponseUio.js +0 -56
  31. package/dist/models/UserAgentAccessAgentUio.d.ts +0 -38
  32. package/dist/models/UserAgentAccessAgentUio.js +0 -54
  33. package/dist/models/UserAgentAccessRequestUio.d.ts +0 -38
  34. package/dist/models/UserAgentAccessRequestUio.js +0 -54
  35. package/dist/models/UserAgentAccessUio.d.ts +0 -45
  36. package/dist/models/UserAgentAccessUio.js +0 -59
package/dist/openapi.json CHANGED
@@ -99,7 +99,7 @@
99
99
  "description" : "Get all agents accessible to user",
100
100
  "operationId" : "getAgents",
101
101
  "parameters" : [ {
102
- "description" : "If true, only returns agents created by the authenticated user.\n",
102
+ "description" : "If true, only returns agents created by the authenticated user.",
103
103
  "in" : "query",
104
104
  "name" : "isCreator",
105
105
  "required" : false,
@@ -115,6 +115,49 @@
115
115
  "enum" : [ "EXTERNAL", "INTERNAL" ],
116
116
  "type" : "string"
117
117
  }
118
+ }, {
119
+ "in" : "query",
120
+ "name" : "page",
121
+ "required" : false,
122
+ "schema" : {
123
+ "minimum" : 1,
124
+ "type" : "integer"
125
+ }
126
+ }, {
127
+ "in" : "query",
128
+ "name" : "limit",
129
+ "required" : false,
130
+ "schema" : {
131
+ "maximum" : 500,
132
+ "minimum" : 1,
133
+ "type" : "integer"
134
+ }
135
+ }, {
136
+ "in" : "query",
137
+ "name" : "search",
138
+ "required" : false,
139
+ "schema" : {
140
+ "type" : "string"
141
+ }
142
+ }, {
143
+ "explode" : true,
144
+ "in" : "query",
145
+ "name" : "roleIds",
146
+ "required" : false,
147
+ "schema" : {
148
+ "items" : {
149
+ "type" : "string"
150
+ },
151
+ "type" : "array"
152
+ },
153
+ "style" : "form"
154
+ }, {
155
+ "in" : "query",
156
+ "name" : "personal",
157
+ "required" : false,
158
+ "schema" : {
159
+ "type" : "boolean"
160
+ }
118
161
  } ],
119
162
  "responses" : {
120
163
  "200" : {
@@ -128,7 +171,33 @@
128
171
  }
129
172
  }
130
173
  },
131
- "description" : "Agents retrieved successfully"
174
+ "description" : "Agents retrieved successfully",
175
+ "headers" : {
176
+ "X-Total-Count" : {
177
+ "description" : "Total number of agents",
178
+ "schema" : {
179
+ "type" : "integer"
180
+ }
181
+ },
182
+ "X-Page" : {
183
+ "description" : "Current page number",
184
+ "schema" : {
185
+ "type" : "integer"
186
+ }
187
+ },
188
+ "X-Limit" : {
189
+ "description" : "Maximum number of items per page",
190
+ "schema" : {
191
+ "type" : "integer"
192
+ }
193
+ },
194
+ "X-Total-Pages" : {
195
+ "description" : "Total number of pages",
196
+ "schema" : {
197
+ "type" : "integer"
198
+ }
199
+ }
200
+ }
132
201
  }
133
202
  },
134
203
  "summary" : "Get all agents",
@@ -234,7 +303,7 @@
234
303
  },
235
304
  "/agents/{agentId}" : {
236
305
  "delete" : {
237
- "description" : "Deletes an agent and all its associated flows",
306
+ "description" : "Deletes an agent by ID",
238
307
  "operationId" : "deleteAgentById",
239
308
  "parameters" : [ {
240
309
  "description" : "ID of the agent",
@@ -327,7 +396,7 @@
327
396
  "content" : {
328
397
  "application/json" : {
329
398
  "schema" : {
330
- "$ref" : "#/components/schemas/AgentPatch"
399
+ "$ref" : "#/components/schemas/Agent"
331
400
  }
332
401
  }
333
402
  },
@@ -411,7 +480,7 @@
411
480
  "content" : {
412
481
  "application/json" : {
413
482
  "schema" : {
414
- "$ref" : "#/components/schemas/AgentModule"
483
+ "$ref" : "#/components/schemas/addModule_request"
415
484
  }
416
485
  }
417
486
  },
@@ -906,7 +975,7 @@
906
975
  },
907
976
  "/agents/{agentId}/flows/{flowId}" : {
908
977
  "delete" : {
909
- "description" : "Deletes a specific conversation flow",
978
+ "description" : "Deletes an existing conversation flow",
910
979
  "operationId" : "deleteFlow",
911
980
  "parameters" : [ {
912
981
  "description" : "ID of the agent",
@@ -1645,7 +1714,7 @@
1645
1714
  },
1646
1715
  "/agents/{agentId}/tools/{toolId}" : {
1647
1716
  "delete" : {
1648
- "description" : "Removes a tool from the specified agent",
1717
+ "description" : "Unlinks an organization tool from the specified agent",
1649
1718
  "operationId" : "unlinkToolFromAgent",
1650
1719
  "parameters" : [ {
1651
1720
  "description" : "ID of the agent",
@@ -1676,7 +1745,7 @@
1676
1745
  "description" : "Forbidden - User doesn't have access to this agent"
1677
1746
  },
1678
1747
  "404" : {
1679
- "description" : "Agent not found"
1748
+ "description" : "Agent or tool not found"
1680
1749
  },
1681
1750
  "500" : {
1682
1751
  "description" : "Internal server error"
@@ -2706,7 +2775,7 @@
2706
2775
  }
2707
2776
  } ],
2708
2777
  "responses" : {
2709
- "200" : {
2778
+ "206" : {
2710
2779
  "content" : {
2711
2780
  "application/json" : {
2712
2781
  "schema" : {
@@ -5857,10 +5926,10 @@
5857
5926
  "tags" : [ "metrics" ]
5858
5927
  }
5859
5928
  },
5860
- "/metrics/agents" : {
5929
+ "/metrics/brains" : {
5861
5930
  "get" : {
5862
- "description" : "Retrieves usage metrics broken down by agent within a date range (admin only)",
5863
- "operationId" : "getMetricsAgents",
5931
+ "description" : "Retrieves usage metrics broken down by agent within an optional date range (admin only)",
5932
+ "operationId" : "getBrainsMetrics",
5864
5933
  "parameters" : [ {
5865
5934
  "description" : "Start date for metrics (ISO format)",
5866
5935
  "in" : "query",
@@ -5888,7 +5957,7 @@
5888
5957
  }
5889
5958
  }
5890
5959
  },
5891
- "description" : "Agent metrics retrieved successfully"
5960
+ "description" : "Brains metrics retrieved successfully"
5892
5961
  },
5893
5962
  "400" : {
5894
5963
  "description" : "Invalid date format"
@@ -5903,7 +5972,7 @@
5903
5972
  "description" : "Server error"
5904
5973
  }
5905
5974
  },
5906
- "summary" : "Get agent-specific metrics",
5975
+ "summary" : "Get brains metrics",
5907
5976
  "tags" : [ "metrics" ]
5908
5977
  }
5909
5978
  },
@@ -7419,92 +7488,6 @@
7419
7488
  "tags" : [ "organizations" ]
7420
7489
  }
7421
7490
  },
7422
- "/organizations/{organizationId}/users/{userId}/agents-access" : {
7423
- "get" : {
7424
- "operationId" : "getOrganizationUserAgentsAccess",
7425
- "parameters" : [ {
7426
- "description" : "ID of the organization",
7427
- "in" : "path",
7428
- "name" : "organizationId",
7429
- "required" : true,
7430
- "schema" : {
7431
- "type" : "string"
7432
- }
7433
- }, {
7434
- "in" : "path",
7435
- "name" : "userId",
7436
- "required" : true,
7437
- "schema" : {
7438
- "type" : "string"
7439
- }
7440
- } ],
7441
- "responses" : {
7442
- "200" : {
7443
- "content" : {
7444
- "application/json" : {
7445
- "schema" : {
7446
- "$ref" : "#/components/schemas/UserAgentAccess"
7447
- }
7448
- }
7449
- },
7450
- "description" : "User agent access configuration"
7451
- },
7452
- "401" : {
7453
- "description" : "Unauthorized"
7454
- },
7455
- "404" : {
7456
- "description" : "Organization or user not found"
7457
- }
7458
- },
7459
- "summary" : "Get user agent access configuration",
7460
- "tags" : [ "organizations" ]
7461
- },
7462
- "put" : {
7463
- "operationId" : "setOrganizationUserAgentsAccess",
7464
- "parameters" : [ {
7465
- "description" : "ID of the organization",
7466
- "in" : "path",
7467
- "name" : "organizationId",
7468
- "required" : true,
7469
- "schema" : {
7470
- "type" : "string"
7471
- }
7472
- }, {
7473
- "in" : "path",
7474
- "name" : "userId",
7475
- "required" : true,
7476
- "schema" : {
7477
- "type" : "string"
7478
- }
7479
- } ],
7480
- "requestBody" : {
7481
- "content" : {
7482
- "application/json" : {
7483
- "schema" : {
7484
- "$ref" : "#/components/schemas/UserAgentAccessRequest"
7485
- }
7486
- }
7487
- },
7488
- "required" : true
7489
- },
7490
- "responses" : {
7491
- "204" : {
7492
- "description" : "User agent access updated"
7493
- },
7494
- "400" : {
7495
- "description" : "Invalid request body"
7496
- },
7497
- "401" : {
7498
- "description" : "Unauthorized"
7499
- },
7500
- "404" : {
7501
- "description" : "Organization or user not found"
7502
- }
7503
- },
7504
- "summary" : "Set user agent access configuration",
7505
- "tags" : [ "organizations" ]
7506
- }
7507
- },
7508
7491
  "/organizations/{organizationId}/engine" : {
7509
7492
  "get" : {
7510
7493
  "description" : "Retrieves only the engine configuration (providerId, model, options) for a given organization.",
@@ -7546,11 +7529,25 @@
7546
7529
  "tags" : [ "organizations" ]
7547
7530
  }
7548
7531
  },
7549
- "/organizations/{organizationId}/metrics/agents/{agentId}" : {
7532
+ "/organizations/{organizationId}/agents/{agentId}" : {
7550
7533
  "get" : {
7551
7534
  "description" : "Retrieves metrics for a brain agent",
7552
7535
  "operationId" : "getMetricsBrainsAgent",
7553
7536
  "parameters" : [ {
7537
+ "description" : "Start date for metrics (ISO format)",
7538
+ "in" : "query",
7539
+ "name" : "startDate",
7540
+ "schema" : {
7541
+ "type" : "string"
7542
+ }
7543
+ }, {
7544
+ "description" : "End date for metrics (ISO format)",
7545
+ "in" : "query",
7546
+ "name" : "endDate",
7547
+ "schema" : {
7548
+ "type" : "string"
7549
+ }
7550
+ }, {
7554
7551
  "description" : "ID of the organization",
7555
7552
  "in" : "path",
7556
7553
  "name" : "organizationId",
@@ -7579,6 +7576,9 @@
7579
7576
  },
7580
7577
  "description" : "Metrics for a brain agent found"
7581
7578
  },
7579
+ "400" : {
7580
+ "description" : "Invalid date format"
7581
+ },
7582
7582
  "401" : {
7583
7583
  "description" : "Unauthorized"
7584
7584
  },
@@ -7787,41 +7787,6 @@
7787
7787
  "tags" : [ "manifests" ]
7788
7788
  }
7789
7789
  },
7790
- "/agents/{agentId}/knowledge/resets" : {
7791
- "post" : {
7792
- "description" : "Deletes all knowledge embeddings and files associated with an agent",
7793
- "operationId" : "resetAgentKnowledge",
7794
- "parameters" : [ {
7795
- "description" : "ID of the agent",
7796
- "in" : "path",
7797
- "name" : "agentId",
7798
- "required" : true,
7799
- "schema" : {
7800
- "format" : "uuid",
7801
- "type" : "string"
7802
- }
7803
- } ],
7804
- "responses" : {
7805
- "204" : {
7806
- "description" : "Knowledge base reset successfully"
7807
- },
7808
- "401" : {
7809
- "description" : "Unauthorized"
7810
- },
7811
- "403" : {
7812
- "description" : "Forbidden - User cannot access this agent"
7813
- },
7814
- "404" : {
7815
- "description" : "Agent not found"
7816
- },
7817
- "500" : {
7818
- "description" : "Server error"
7819
- }
7820
- },
7821
- "summary" : "Reset all knowledge for an agent",
7822
- "tags" : [ "knowledge" ]
7823
- }
7824
- },
7825
7790
  "/agents/{agentId}/knowledge-files" : {
7826
7791
  "get" : {
7827
7792
  "description" : "Returns all knowledge bases attached to the agent and their indexed files.",
@@ -7883,424 +7848,70 @@
7883
7848
  "tags" : [ "knowledge" ]
7884
7849
  }
7885
7850
  },
7886
- "/agents/{agentId}/knowledge/project-imports" : {
7851
+ "/organizations/{organizationId}/modules" : {
7887
7852
  "post" : {
7888
- "description" : "Imports project data from a local JSON file into the agent's knowledge base",
7889
- "operationId" : "importProjectsToAgentKnowledge",
7853
+ "description" : "Create a new module for an organization",
7854
+ "operationId" : "createModuleForOrganization",
7890
7855
  "parameters" : [ {
7891
- "description" : "ID of the agent",
7856
+ "description" : "ID of the organization",
7892
7857
  "in" : "path",
7893
- "name" : "agentId",
7858
+ "name" : "organizationId",
7894
7859
  "required" : true,
7895
7860
  "schema" : {
7896
- "format" : "uuid",
7897
7861
  "type" : "string"
7898
7862
  }
7899
7863
  } ],
7900
- "responses" : {
7901
- "200" : {
7902
- "description" : "Project import started successfully"
7903
- },
7904
- "401" : {
7905
- "description" : "Unauthorized"
7906
- },
7907
- "403" : {
7908
- "description" : "Forbidden - User cannot access this agent"
7909
- },
7910
- "404" : {
7911
- "description" : "Agent not found or ContextualKnowledgeWeaviate module not installed"
7864
+ "requestBody" : {
7865
+ "content" : {
7866
+ "application/json" : {
7867
+ "schema" : {
7868
+ "$ref" : "#/components/schemas/AgentModule"
7869
+ }
7870
+ }
7912
7871
  },
7913
- "500" : {
7914
- "description" : "Server error"
7872
+ "required" : true
7873
+ },
7874
+ "responses" : {
7875
+ "201" : {
7876
+ "content" : {
7877
+ "application/json" : {
7878
+ "schema" : {
7879
+ "$ref" : "#/components/schemas/AgentModule"
7880
+ }
7881
+ }
7882
+ },
7883
+ "description" : "Module created successfully"
7915
7884
  }
7916
7885
  },
7917
- "summary" : "Import projects into agent knowledge",
7886
+ "summary" : "Create a new module for an organization",
7918
7887
  "tags" : [ "knowledge" ]
7919
7888
  }
7920
7889
  },
7921
- "/agents/{agentId}/knowledge/documents" : {
7922
- "post" : {
7923
- "description" : "Adds a text document to the agent's knowledge base, splitting it into chunks if necessary",
7924
- "operationId" : "addDocumentToKnowledgeBase",
7890
+ "/organizations/{organizationId}/agents/{agentId}/available-knowledge-bases" : {
7891
+ "get" : {
7892
+ "description" : "Returns all knowledge bases belonging to the organization that can be assigned to the specified agent…\n",
7893
+ "operationId" : "getAvailableKnowledgeBases",
7925
7894
  "parameters" : [ {
7926
- "description" : "ID of the agent",
7895
+ "in" : "path",
7896
+ "name" : "organizationId",
7897
+ "required" : true,
7898
+ "schema" : {
7899
+ "type" : "string"
7900
+ }
7901
+ }, {
7927
7902
  "in" : "path",
7928
7903
  "name" : "agentId",
7929
7904
  "required" : true,
7930
7905
  "schema" : {
7931
- "format" : "uuid",
7932
7906
  "type" : "string"
7933
7907
  }
7934
7908
  }, {
7935
- "description" : "Whether to disable automatic document splitting",
7909
+ "description" : "Optional prefix used to filter knowledge bases by name (autocomplete). Case-insensitive.\n",
7936
7910
  "in" : "query",
7937
- "name" : "noSplit",
7911
+ "name" : "searchName",
7912
+ "required" : false,
7938
7913
  "schema" : {
7939
- "type" : "boolean"
7940
- }
7941
- } ],
7942
- "requestBody" : {
7943
- "content" : {
7944
- "application/json" : {
7945
- "schema" : {
7946
- "$ref" : "#/components/schemas/DocumentAddRequest"
7947
- }
7948
- }
7949
- },
7950
- "required" : true
7951
- },
7952
- "responses" : {
7953
- "201" : {
7954
- "description" : "Document imported successfully"
7955
- },
7956
- "400" : {
7957
- "description" : "Invalid request body"
7958
- },
7959
- "401" : {
7960
- "description" : "Unauthorized"
7961
- },
7962
- "403" : {
7963
- "description" : "Forbidden - User cannot access this brain"
7964
- },
7965
- "404" : {
7966
- "description" : "Brain not found or ContextualKnowledgeWeaviate module not installed"
7967
- },
7968
- "500" : {
7969
- "description" : "Server error"
7970
- }
7971
- },
7972
- "summary" : "Add a document to agent's knowledge base",
7973
- "tags" : [ "knowledge" ]
7974
- }
7975
- },
7976
- "/agents/{agentId}/knowledge/file-imports" : {
7977
- "post" : {
7978
- "description" : "Processes documents like PDFs, CSVs, and text files, and adds them to the brain's knowledge base",
7979
- "operationId" : "importFileToAgentKnowledge",
7980
- "parameters" : [ {
7981
- "description" : "ID of the agent",
7982
- "in" : "path",
7983
- "name" : "agentId",
7984
- "required" : true,
7985
- "schema" : {
7986
- "format" : "uuid",
7987
- "type" : "string"
7988
- }
7989
- } ],
7990
- "requestBody" : {
7991
- "content" : {
7992
- "multipart/form-data" : {
7993
- "schema" : {
7994
- "$ref" : "#/components/schemas/importFileToAgentKnowledge_request"
7995
- }
7996
- }
7997
- },
7998
- "required" : true
7999
- },
8000
- "responses" : {
8001
- "200" : {
8002
- "content" : {
8003
- "application/json" : {
8004
- "schema" : {
8005
- "$ref" : "#/components/schemas/importFileToAgentKnowledge_200_response"
8006
- }
8007
- }
8008
- },
8009
- "description" : "File imported successfully"
8010
- },
8011
- "400" : {
8012
- "description" : "Invalid file or parameters"
8013
- },
8014
- "401" : {
8015
- "description" : "Unauthorized"
8016
- },
8017
- "403" : {
8018
- "description" : "Forbidden - User cannot access this brain"
8019
- },
8020
- "404" : {
8021
- "description" : "Brain not found"
8022
- },
8023
- "500" : {
8024
- "description" : "Server error"
8025
- }
8026
- },
8027
- "summary" : "Upload and import a file into the brain's knowledge base",
8028
- "tags" : [ "knowledge" ]
8029
- }
8030
- },
8031
- "/agents/{agentId}/knowledge/files" : {
8032
- "post" : {
8033
- "description" : "Registers a file for upload to the brain's knowledge base and returns an upload URL",
8034
- "operationId" : "prepareFileUpload",
8035
- "parameters" : [ {
8036
- "description" : "ID of the agent",
8037
- "in" : "path",
8038
- "name" : "agentId",
8039
- "required" : true,
8040
- "schema" : {
8041
- "format" : "uuid",
8042
- "type" : "string"
8043
- }
8044
- } ],
8045
- "requestBody" : {
8046
- "content" : {
8047
- "application/json" : {
8048
- "schema" : {
8049
- "$ref" : "#/components/schemas/FileCreationRequest"
8050
- }
8051
- }
8052
- },
8053
- "required" : true
8054
- },
8055
- "responses" : {
8056
- "201" : {
8057
- "content" : {
8058
- "application/json" : {
8059
- "schema" : {
8060
- "$ref" : "#/components/schemas/FileCreationResponse"
8061
- }
8062
- }
8063
- },
8064
- "description" : "File preparation successful with upload URL"
8065
- },
8066
- "400" : {
8067
- "description" : "Invalid file description"
8068
- },
8069
- "401" : {
8070
- "description" : "Unauthorized"
8071
- },
8072
- "403" : {
8073
- "description" : "Forbidden - User cannot access this brain"
8074
- },
8075
- "404" : {
8076
- "description" : "Brain not found"
8077
- },
8078
- "500" : {
8079
- "description" : "Server error"
8080
- }
8081
- },
8082
- "summary" : "Prepare file upload for knowledge base",
8083
- "tags" : [ "knowledge" ]
8084
- }
8085
- },
8086
- "/agents/{agentId}/knowledge/files/{fileId}/status" : {
8087
- "post" : {
8088
- "description" : "Updates the status of a knowledge file and triggers the indexing process if the file is uploaded",
8089
- "operationId" : "updateFileStatus",
8090
- "parameters" : [ {
8091
- "description" : "ID of the agent",
8092
- "in" : "path",
8093
- "name" : "agentId",
8094
- "required" : true,
8095
- "schema" : {
8096
- "format" : "uuid",
8097
- "type" : "string"
8098
- }
8099
- }, {
8100
- "description" : "The ID of the file",
8101
- "in" : "path",
8102
- "name" : "fileId",
8103
- "required" : true,
8104
- "schema" : {
8105
- "type" : "string"
8106
- }
8107
- } ],
8108
- "requestBody" : {
8109
- "content" : {
8110
- "application/json" : {
8111
- "schema" : {
8112
- "$ref" : "#/components/schemas/FileStatusUpdateRequest"
8113
- }
8114
- }
8115
- },
8116
- "required" : true
8117
- },
8118
- "responses" : {
8119
- "200" : {
8120
- "content" : {
8121
- "application/json" : {
8122
- "schema" : {
8123
- "$ref" : "#/components/schemas/File"
8124
- }
8125
- }
8126
- },
8127
- "description" : "File status updated and indexing initiated"
8128
- },
8129
- "400" : {
8130
- "description" : "Invalid status update"
8131
- },
8132
- "401" : {
8133
- "description" : "Unauthorized"
8134
- },
8135
- "403" : {
8136
- "description" : "Forbidden - User cannot access this agent"
8137
- },
8138
- "404" : {
8139
- "description" : "File not found"
8140
- },
8141
- "500" : {
8142
- "description" : "Server error"
8143
- }
8144
- },
8145
- "summary" : "Update file status and trigger indexing",
8146
- "tags" : [ "knowledge" ]
8147
- }
8148
- },
8149
- "/agents/{agentId}/knowledge/files/{fileId}" : {
8150
- "delete" : {
8151
- "description" : "Removes a file and its associated chunks from the agent's knowledge base",
8152
- "operationId" : "deleteFileFromAgentKnowledge",
8153
- "parameters" : [ {
8154
- "description" : "ID of the agent",
8155
- "in" : "path",
8156
- "name" : "agentId",
8157
- "required" : true,
8158
- "schema" : {
8159
- "format" : "uuid",
8160
- "type" : "string"
8161
- }
8162
- }, {
8163
- "description" : "The ID of the file",
8164
- "in" : "path",
8165
- "name" : "fileId",
8166
- "required" : true,
8167
- "schema" : {
8168
- "type" : "string"
8169
- }
8170
- } ],
8171
- "responses" : {
8172
- "204" : {
8173
- "description" : "File deleted successfully"
8174
- },
8175
- "401" : {
8176
- "description" : "Unauthorized"
8177
- },
8178
- "403" : {
8179
- "description" : "Forbidden - User cannot access this agent"
8180
- },
8181
- "404" : {
8182
- "description" : "Agent or file not found"
8183
- },
8184
- "500" : {
8185
- "description" : "Server error"
8186
- }
8187
- },
8188
- "summary" : "Delete a knowledge file from an agent",
8189
- "tags" : [ "knowledge" ]
8190
- },
8191
- "get" : {
8192
- "description" : "Retrieves metadata for a file that has been imported into the agent's knowledge base",
8193
- "operationId" : "getFileFromAgentKnowledge",
8194
- "parameters" : [ {
8195
- "description" : "ID of the agent",
8196
- "in" : "path",
8197
- "name" : "agentId",
8198
- "required" : true,
8199
- "schema" : {
8200
- "format" : "uuid",
8201
- "type" : "string"
8202
- }
8203
- }, {
8204
- "description" : "The ID of the file",
8205
- "in" : "path",
8206
- "name" : "fileId",
8207
- "required" : true,
8208
- "schema" : {
8209
- "type" : "string"
8210
- }
8211
- } ],
8212
- "responses" : {
8213
- "200" : {
8214
- "content" : {
8215
- "application/json" : {
8216
- "schema" : {
8217
- "$ref" : "#/components/schemas/FileWithDownloadUrl"
8218
- }
8219
- }
8220
- },
8221
- "description" : "File details retrieved successfully"
8222
- },
8223
- "401" : {
8224
- "description" : "Unauthorized"
8225
- },
8226
- "403" : {
8227
- "description" : "Forbidden - User cannot access this agent"
8228
- },
8229
- "404" : {
8230
- "description" : "Agent or file not found"
8231
- },
8232
- "500" : {
8233
- "description" : "Server error"
8234
- }
8235
- },
8236
- "summary" : "Get a specific knowledge file from an agent",
8237
- "tags" : [ "knowledge" ]
8238
- }
8239
- },
8240
- "/organizations/{organizationId}/modules" : {
8241
- "post" : {
8242
- "description" : "Create a new module for an organization",
8243
- "operationId" : "createModuleForOrganization",
8244
- "parameters" : [ {
8245
- "description" : "ID of the organization",
8246
- "in" : "path",
8247
- "name" : "organizationId",
8248
- "required" : true,
8249
- "schema" : {
8250
- "type" : "string"
8251
- }
8252
- } ],
8253
- "requestBody" : {
8254
- "content" : {
8255
- "application/json" : {
8256
- "schema" : {
8257
- "$ref" : "#/components/schemas/AgentModule"
8258
- }
8259
- }
8260
- },
8261
- "required" : true
8262
- },
8263
- "responses" : {
8264
- "201" : {
8265
- "content" : {
8266
- "application/json" : {
8267
- "schema" : {
8268
- "$ref" : "#/components/schemas/AgentModule"
8269
- }
8270
- }
8271
- },
8272
- "description" : "Module created successfully"
8273
- }
8274
- },
8275
- "summary" : "Create a new module for an organization",
8276
- "tags" : [ "knowledge" ]
8277
- }
8278
- },
8279
- "/organizations/{organizationId}/agents/{agentId}/available-knowledge-bases" : {
8280
- "get" : {
8281
- "description" : "Returns all knowledge bases belonging to the organization that can be assigned to the specified agent…\n",
8282
- "operationId" : "getAvailableKnowledgeBases",
8283
- "parameters" : [ {
8284
- "in" : "path",
8285
- "name" : "organizationId",
8286
- "required" : true,
8287
- "schema" : {
8288
- "type" : "string"
8289
- }
8290
- }, {
8291
- "in" : "path",
8292
- "name" : "agentId",
8293
- "required" : true,
8294
- "schema" : {
8295
- "type" : "string"
8296
- }
8297
- }, {
8298
- "description" : "Optional prefix used to filter knowledge bases by name (autocomplete). Case-insensitive.\n",
8299
- "in" : "query",
8300
- "name" : "searchName",
8301
- "required" : false,
8302
- "schema" : {
8303
- "type" : "string"
7914
+ "type" : "string"
8304
7915
  }
8305
7916
  } ],
8306
7917
  "responses" : {
@@ -10677,6 +10288,45 @@
10677
10288
  "tags" : [ "skills" ]
10678
10289
  }
10679
10290
  },
10291
+ "/skills/{skillId}/agents" : {
10292
+ "get" : {
10293
+ "description" : "Returns all agents that have this skill installed. La réponse est une projection minimale : les deux adaptateurs ne sélectionnent que `id` et `name` (skills-pg.adapter.ts, skills-mongodb.adapter.ts).",
10294
+ "operationId" : "getSkillAgents",
10295
+ "parameters" : [ {
10296
+ "description" : "Skill identifier",
10297
+ "in" : "path",
10298
+ "name" : "skillId",
10299
+ "required" : true,
10300
+ "schema" : {
10301
+ "format" : "uuid",
10302
+ "type" : "string"
10303
+ }
10304
+ } ],
10305
+ "responses" : {
10306
+ "200" : {
10307
+ "content" : {
10308
+ "application/json" : {
10309
+ "schema" : {
10310
+ "items" : {
10311
+ "$ref" : "#/components/schemas/AgentRef"
10312
+ },
10313
+ "type" : "array"
10314
+ }
10315
+ }
10316
+ },
10317
+ "description" : "Agents retrieved successfully"
10318
+ },
10319
+ "401" : {
10320
+ "description" : "Unauthorized"
10321
+ },
10322
+ "404" : {
10323
+ "description" : "Skill not found"
10324
+ }
10325
+ },
10326
+ "summary" : "Get agents using a skill",
10327
+ "tags" : [ "skills" ]
10328
+ }
10329
+ },
10680
10330
  "/agents/{agentId}/skills" : {
10681
10331
  "get" : {
10682
10332
  "operationId" : "getAgentSkills",
@@ -11085,7 +10735,7 @@
11085
10735
  "required" : true
11086
10736
  },
11087
10737
  "responses" : {
11088
- "201" : {
10738
+ "200" : {
11089
10739
  "content" : {
11090
10740
  "application/json" : {
11091
10741
  "schema" : {
@@ -11166,6 +10816,16 @@
11166
10816
  },
11167
10817
  "description" : "Prompt created successfully"
11168
10818
  },
10819
+ "202" : {
10820
+ "content" : {
10821
+ "application/json" : {
10822
+ "schema" : {
10823
+ "$ref" : "#/components/schemas/PromptCreateResponse"
10824
+ }
10825
+ }
10826
+ },
10827
+ "description" : "Prompt accepted (async mode). Même enveloppe que la réponse synchrone, avec `text` vide et sans suggestions ni tools puisque rien n'est encore calculé."
10828
+ },
11169
10829
  "400" : {
11170
10830
  "description" : "Invalid request"
11171
10831
  },
@@ -12246,14 +11906,6 @@
12246
11906
  "type" : "string"
12247
11907
  }
12248
11908
  },
12249
- "noSplit" : {
12250
- "description" : "Whether to disable automatic document splitting",
12251
- "in" : "query",
12252
- "name" : "noSplit",
12253
- "schema" : {
12254
- "type" : "boolean"
12255
- }
12256
- },
12257
11909
  "knowledgebaseIdPath" : {
12258
11910
  "description" : "ID of the knowledge base to retrieve",
12259
11911
  "in" : "path",
@@ -12580,12 +12232,6 @@
12580
12232
  "additionalProperties" : true,
12581
12233
  "type" : "object"
12582
12234
  },
12583
- "tools" : {
12584
- "items" : {
12585
- "$ref" : "#/components/schemas/AgentTool"
12586
- },
12587
- "type" : "array"
12588
- },
12589
12235
  "knowledgeBaseIds" : {
12590
12236
  "items" : {
12591
12237
  "type" : "string"
@@ -12629,15 +12275,6 @@
12629
12275
  "description" : {
12630
12276
  "type" : "string"
12631
12277
  },
12632
- "template" : {
12633
- "type" : "string"
12634
- },
12635
- "color" : {
12636
- "type" : "string"
12637
- },
12638
- "picture" : {
12639
- "type" : "string"
12640
- },
12641
12278
  "createdAt" : {
12642
12279
  "type" : "string"
12643
12280
  },
@@ -12645,21 +12282,10 @@
12645
12282
  "type" : "string"
12646
12283
  },
12647
12284
  "isActivated" : {
12648
- "type" : "boolean"
12649
- },
12650
- "isTemplate" : {
12651
- "type" : "boolean"
12652
- },
12653
- "deleted" : {
12654
- "type" : "boolean"
12655
- },
12656
- "agentType" : {
12657
- "$ref" : "#/components/schemas/AgentType"
12658
- },
12659
- "favoriteOutfit" : {
12660
- "additionalProperties" : true,
12661
- "maxProperties" : 100,
12662
- "type" : "object"
12285
+ "type" : "boolean"
12286
+ },
12287
+ "agentType" : {
12288
+ "$ref" : "#/components/schemas/AgentType"
12663
12289
  },
12664
12290
  "personal" : {
12665
12291
  "type" : "boolean"
@@ -12700,53 +12326,16 @@
12700
12326
  "providerSource" : {
12701
12327
  "enum" : [ "EXTERNAL", "INTERNAL" ],
12702
12328
  "type" : "string"
12703
- }
12704
- },
12705
- "required" : [ "id", "modules", "name", "organisationId", "persona", "promptInit" ],
12706
- "type" : "object"
12707
- },
12708
- "AgentTool" : {
12709
- "properties" : {
12710
- "id" : {
12711
- "type" : "string"
12712
- },
12713
- "name" : {
12714
- "type" : "string"
12715
- },
12716
- "type" : {
12717
- "type" : "string"
12718
- },
12719
- "orgId" : {
12720
- "type" : "string"
12721
- },
12722
- "description" : {
12723
- "type" : "string"
12724
- },
12725
- "scope" : {
12726
- "description" : "Credentials scope. Defaults to organization for legacy tools.",
12727
- "enum" : [ "organization", "user" ],
12728
- "type" : "string"
12729
- },
12730
- "configuration" : {
12731
- "additionalProperties" : true,
12732
- "type" : "object"
12733
- },
12734
- "manifest" : {
12735
- "additionalProperties" : true,
12736
- "type" : "object"
12737
- },
12738
- "mcp" : {
12739
- "additionalProperties" : true,
12740
- "type" : "object"
12741
- },
12742
- "restricted" : {
12743
- "type" : "boolean"
12744
12329
  },
12745
- "isSetup" : {
12746
- "type" : "boolean"
12330
+ "tools" : {
12331
+ "description" : "Réhydraté en objets par GET /agents/{agentId}, le seul endpoint qui joint la table des tools de l'organisation. Les autres endpoints qui renvoient un agent (liste, création, mise à jour) omettent la propriété : en base elle ne contient que des identifiants.",
12332
+ "items" : {
12333
+ "$ref" : "#/components/schemas/AgentTool"
12334
+ },
12335
+ "type" : "array"
12747
12336
  }
12748
12337
  },
12749
- "required" : [ "description", "id", "name", "orgId", "type" ],
12338
+ "required" : [ "id", "modules", "name", "organisationId", "persona", "promptInit" ],
12750
12339
  "type" : "object"
12751
12340
  },
12752
12341
  "Persona" : {
@@ -12869,6 +12458,50 @@
12869
12458
  "required" : [ "backend", "enabled", "ttlDays" ],
12870
12459
  "type" : "object"
12871
12460
  },
12461
+ "AgentTool" : {
12462
+ "properties" : {
12463
+ "id" : {
12464
+ "type" : "string"
12465
+ },
12466
+ "name" : {
12467
+ "type" : "string"
12468
+ },
12469
+ "type" : {
12470
+ "type" : "string"
12471
+ },
12472
+ "orgId" : {
12473
+ "type" : "string"
12474
+ },
12475
+ "description" : {
12476
+ "type" : "string"
12477
+ },
12478
+ "scope" : {
12479
+ "description" : "Credentials scope. Defaults to organization for legacy tools.",
12480
+ "enum" : [ "organization", "user" ],
12481
+ "type" : "string"
12482
+ },
12483
+ "configuration" : {
12484
+ "additionalProperties" : true,
12485
+ "type" : "object"
12486
+ },
12487
+ "manifest" : {
12488
+ "additionalProperties" : true,
12489
+ "type" : "object"
12490
+ },
12491
+ "mcp" : {
12492
+ "additionalProperties" : true,
12493
+ "type" : "object"
12494
+ },
12495
+ "restricted" : {
12496
+ "type" : "boolean"
12497
+ },
12498
+ "isSetup" : {
12499
+ "type" : "boolean"
12500
+ }
12501
+ },
12502
+ "required" : [ "description", "id", "name", "orgId", "type" ],
12503
+ "type" : "object"
12504
+ },
12872
12505
  "AgentRequest" : {
12873
12506
  "properties" : {
12874
12507
  "name" : {
@@ -12877,15 +12510,9 @@
12877
12510
  "persona" : {
12878
12511
  "$ref" : "#/components/schemas/Persona"
12879
12512
  },
12880
- "engine" : {
12881
- "$ref" : "#/components/schemas/Engine"
12882
- },
12883
12513
  "promptInit" : {
12884
12514
  "$ref" : "#/components/schemas/PromptInit"
12885
12515
  },
12886
- "profilePicture" : {
12887
- "$ref" : "#/components/schemas/AgentRequest_profilePicture"
12888
- },
12889
12516
  "organisationId" : {
12890
12517
  "type" : "string"
12891
12518
  },
@@ -12898,32 +12525,8 @@
12898
12525
  "description" : {
12899
12526
  "type" : "string"
12900
12527
  },
12901
- "template" : {
12902
- "type" : "string"
12903
- },
12904
- "color" : {
12905
- "type" : "string"
12906
- },
12907
- "picture" : {
12908
- "type" : "string"
12909
- },
12910
- "createdAt" : {
12911
- "type" : "string"
12912
- },
12913
- "isActivated" : {
12914
- "type" : "boolean"
12915
- },
12916
- "modules" : {
12917
- "additionalProperties" : {
12918
- "$ref" : "#/components/schemas/AgentModule"
12919
- },
12920
- "type" : "object"
12921
- },
12922
12528
  "personal" : {
12923
12529
  "type" : "boolean"
12924
- },
12925
- "createdBy" : {
12926
- "type" : "string"
12927
12530
  }
12928
12531
  },
12929
12532
  "required" : [ "name", "organisationId", "persona", "promptInit" ],
@@ -12980,15 +12583,6 @@
12980
12583
  "description" : {
12981
12584
  "type" : "string"
12982
12585
  },
12983
- "template" : {
12984
- "type" : "string"
12985
- },
12986
- "color" : {
12987
- "type" : "string"
12988
- },
12989
- "picture" : {
12990
- "type" : "string"
12991
- },
12992
12586
  "createdAt" : {
12993
12587
  "type" : "string"
12994
12588
  },
@@ -13001,12 +12595,6 @@
13001
12595
  },
13002
12596
  "type" : "array"
13003
12597
  },
13004
- "isTemplate" : {
13005
- "type" : "boolean"
13006
- },
13007
- "deleted" : {
13008
- "type" : "boolean"
13009
- },
13010
12598
  "agentType" : {
13011
12599
  "$ref" : "#/components/schemas/AgentType"
13012
12600
  },
@@ -16526,55 +16114,6 @@
16526
16114
  "required" : [ "permissions" ],
16527
16115
  "type" : "object"
16528
16116
  },
16529
- "UserAgentAccess" : {
16530
- "properties" : {
16531
- "scoped" : {
16532
- "description" : "When true, only listed agents are accessible (org-wide agent.read is ignored for listing).",
16533
- "type" : "boolean"
16534
- },
16535
- "agentIds" : {
16536
- "items" : {
16537
- "type" : "string"
16538
- },
16539
- "type" : "array"
16540
- },
16541
- "availableAgents" : {
16542
- "items" : {
16543
- "$ref" : "#/components/schemas/UserAgentAccessAgent"
16544
- },
16545
- "type" : "array"
16546
- }
16547
- },
16548
- "required" : [ "agentIds", "availableAgents", "scoped" ],
16549
- "type" : "object"
16550
- },
16551
- "UserAgentAccessAgent" : {
16552
- "properties" : {
16553
- "id" : {
16554
- "type" : "string"
16555
- },
16556
- "name" : {
16557
- "type" : "string"
16558
- }
16559
- },
16560
- "required" : [ "id", "name" ],
16561
- "type" : "object"
16562
- },
16563
- "UserAgentAccessRequest" : {
16564
- "properties" : {
16565
- "scoped" : {
16566
- "type" : "boolean"
16567
- },
16568
- "agentIds" : {
16569
- "items" : {
16570
- "type" : "string"
16571
- },
16572
- "type" : "array"
16573
- }
16574
- },
16575
- "required" : [ "agentIds", "scoped" ],
16576
- "type" : "object"
16577
- },
16578
16117
  "OrganizationEngine" : {
16579
16118
  "additionalProperties" : false,
16580
16119
  "description" : "Engine configuration attached to an organization.",
@@ -16731,20 +16270,6 @@
16731
16270
  "required" : [ "id", "name" ],
16732
16271
  "type" : "object"
16733
16272
  },
16734
- "DocumentAddRequest" : {
16735
- "properties" : {
16736
- "document" : {
16737
- "description" : "The text document to add to the knowledge base",
16738
- "type" : "string"
16739
- },
16740
- "customId" : {
16741
- "description" : "Optional custom ID for the document",
16742
- "type" : "string"
16743
- }
16744
- },
16745
- "required" : [ "document" ],
16746
- "type" : "object"
16747
- },
16748
16273
  "FileStatusUpdateRequest" : {
16749
16274
  "properties" : {
16750
16275
  "status" : {
@@ -17371,6 +16896,18 @@
17371
16896
  },
17372
16897
  "type" : "object"
17373
16898
  },
16899
+ "AgentRef" : {
16900
+ "properties" : {
16901
+ "id" : {
16902
+ "type" : "string"
16903
+ },
16904
+ "name" : {
16905
+ "type" : "string"
16906
+ }
16907
+ },
16908
+ "required" : [ "id", "name" ],
16909
+ "type" : "object"
16910
+ },
17374
16911
  "SkillAssignRequest" : {
17375
16912
  "additionalProperties" : false,
17376
16913
  "properties" : {
@@ -18013,6 +17550,29 @@
18013
17550
  },
18014
17551
  "type" : "object"
18015
17552
  },
17553
+ "addModule_request" : {
17554
+ "additionalProperties" : false,
17555
+ "properties" : {
17556
+ "type" : {
17557
+ "enum" : [ "ContextualKnowledgeWeaviate", "External" ],
17558
+ "type" : "string"
17559
+ },
17560
+ "name" : {
17561
+ "pattern" : "^[a-zA-Z0-9]+$",
17562
+ "type" : "string"
17563
+ },
17564
+ "_configuration" : {
17565
+ "additionalProperties" : true,
17566
+ "type" : "object"
17567
+ },
17568
+ "restricted" : {
17569
+ "nullable" : true,
17570
+ "type" : "boolean"
17571
+ }
17572
+ },
17573
+ "required" : [ "_configuration", "name", "type" ],
17574
+ "type" : "object"
17575
+ },
18016
17576
  "deleteMessageAudio_200_response" : {
18017
17577
  "properties" : {
18018
17578
  "message" : {
@@ -18056,37 +17616,6 @@
18056
17616
  "required" : [ "title" ],
18057
17617
  "type" : "object"
18058
17618
  },
18059
- "importFileToAgentKnowledge_request" : {
18060
- "properties" : {
18061
- "file" : {
18062
- "description" : "The file to import (PDF, CSV, TXT supported)",
18063
- "format" : "binary",
18064
- "type" : "string"
18065
- }
18066
- },
18067
- "required" : [ "file" ],
18068
- "type" : "object"
18069
- },
18070
- "importFileToAgentKnowledge_200_response" : {
18071
- "properties" : {
18072
- "id" : {
18073
- "type" : "string"
18074
- },
18075
- "name" : {
18076
- "type" : "string"
18077
- },
18078
- "type" : {
18079
- "type" : "string"
18080
- },
18081
- "size" : {
18082
- "type" : "number"
18083
- },
18084
- "chunkCount" : {
18085
- "type" : "number"
18086
- }
18087
- },
18088
- "type" : "object"
18089
- },
18090
17619
  "patchKnowledgeBase_request" : {
18091
17620
  "properties" : {
18092
17621
  "name" : {
@@ -18493,24 +18022,6 @@
18493
18022
  "required" : [ "modelId", "providerId" ],
18494
18023
  "type" : "object"
18495
18024
  },
18496
- "AgentRequest_profilePicture" : {
18497
- "properties" : {
18498
- "hash" : {
18499
- "type" : "string"
18500
- },
18501
- "size" : {
18502
- "type" : "number"
18503
- },
18504
- "contentType" : {
18505
- "type" : "string"
18506
- },
18507
- "ext" : {
18508
- "type" : "string"
18509
- }
18510
- },
18511
- "required" : [ "contentType", "ext", "hash", "size" ],
18512
- "type" : "object"
18513
- },
18514
18025
  "AgentPatch_engine" : {
18515
18026
  "nullable" : true,
18516
18027
  "properties" : {