@botpress/api 0.65.0 → 0.67.0
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.
- package/dist/index.js +171 -9
- package/dist/src/gen/state.d.ts +150 -6
- package/package.json +1 -1
- package/src/gen/metadata.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/state.ts +171 -9
package/dist/index.js
CHANGED
|
@@ -292503,8 +292503,53 @@ var state = {
|
|
|
292503
292503
|
"description": "User object configuration",
|
|
292504
292504
|
"additionalProperties": false
|
|
292505
292505
|
},
|
|
292506
|
+
"conversation": {
|
|
292507
|
+
"type": "object",
|
|
292508
|
+
"properties": {
|
|
292509
|
+
"tags": {
|
|
292510
|
+
"type": "object",
|
|
292511
|
+
"additionalProperties": {
|
|
292512
|
+
"type": "object",
|
|
292513
|
+
"properties": {
|
|
292514
|
+
"title": {
|
|
292515
|
+
"type": "string",
|
|
292516
|
+
"maxLength": 64,
|
|
292517
|
+
"description": "Title of the tag"
|
|
292518
|
+
},
|
|
292519
|
+
"description": {
|
|
292520
|
+
"type": "string",
|
|
292521
|
+
"maxLength": 256,
|
|
292522
|
+
"description": "Description of the tag"
|
|
292523
|
+
}
|
|
292524
|
+
},
|
|
292525
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
292526
|
+
"additionalProperties": false
|
|
292527
|
+
}
|
|
292528
|
+
}
|
|
292529
|
+
},
|
|
292530
|
+
"required": [
|
|
292531
|
+
"tags"
|
|
292532
|
+
],
|
|
292533
|
+
"description": "Conversation object configuration",
|
|
292534
|
+
"additionalProperties": false
|
|
292535
|
+
},
|
|
292506
292536
|
"code": {
|
|
292507
|
-
"type": "
|
|
292537
|
+
"type": "object",
|
|
292538
|
+
"properties": {
|
|
292539
|
+
"node": {
|
|
292540
|
+
"type": "string",
|
|
292541
|
+
"description": "Code of plugin bundled for Node.JS"
|
|
292542
|
+
},
|
|
292543
|
+
"browser": {
|
|
292544
|
+
"type": "string",
|
|
292545
|
+
"description": "Code of plugin bundled for the browser"
|
|
292546
|
+
}
|
|
292547
|
+
},
|
|
292548
|
+
"required": [
|
|
292549
|
+
"node",
|
|
292550
|
+
"browser"
|
|
292551
|
+
],
|
|
292552
|
+
"additionalProperties": false
|
|
292508
292553
|
},
|
|
292509
292554
|
"dependencies": {
|
|
292510
292555
|
"type": "object",
|
|
@@ -292817,6 +292862,37 @@ var state = {
|
|
|
292817
292862
|
}
|
|
292818
292863
|
},
|
|
292819
292864
|
"description": "Definition of a tag that can be provided on the object",
|
|
292865
|
+
"nullable": true,
|
|
292866
|
+
"additionalProperties": false
|
|
292867
|
+
}
|
|
292868
|
+
}
|
|
292869
|
+
},
|
|
292870
|
+
"required": [
|
|
292871
|
+
"tags"
|
|
292872
|
+
],
|
|
292873
|
+
"additionalProperties": false
|
|
292874
|
+
},
|
|
292875
|
+
"conversation": {
|
|
292876
|
+
"type": "object",
|
|
292877
|
+
"properties": {
|
|
292878
|
+
"tags": {
|
|
292879
|
+
"type": "object",
|
|
292880
|
+
"additionalProperties": {
|
|
292881
|
+
"type": "object",
|
|
292882
|
+
"properties": {
|
|
292883
|
+
"title": {
|
|
292884
|
+
"type": "string",
|
|
292885
|
+
"maxLength": 64,
|
|
292886
|
+
"description": "Title of the tag"
|
|
292887
|
+
},
|
|
292888
|
+
"description": {
|
|
292889
|
+
"type": "string",
|
|
292890
|
+
"maxLength": 256,
|
|
292891
|
+
"description": "Description of the tag"
|
|
292892
|
+
}
|
|
292893
|
+
},
|
|
292894
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
292895
|
+
"nullable": true,
|
|
292820
292896
|
"additionalProperties": false
|
|
292821
292897
|
}
|
|
292822
292898
|
}
|
|
@@ -292824,12 +292900,25 @@ var state = {
|
|
|
292824
292900
|
"required": [
|
|
292825
292901
|
"tags"
|
|
292826
292902
|
],
|
|
292827
|
-
"description": "User object configuration",
|
|
292828
|
-
"nullable": true,
|
|
292829
292903
|
"additionalProperties": false
|
|
292830
292904
|
},
|
|
292831
292905
|
"code": {
|
|
292832
|
-
"type": "
|
|
292906
|
+
"type": "object",
|
|
292907
|
+
"properties": {
|
|
292908
|
+
"node": {
|
|
292909
|
+
"type": "string",
|
|
292910
|
+
"description": "Code of plugin bundled for Node.JS"
|
|
292911
|
+
},
|
|
292912
|
+
"browser": {
|
|
292913
|
+
"type": "string",
|
|
292914
|
+
"description": "Code of plugin bundled for the browser"
|
|
292915
|
+
}
|
|
292916
|
+
},
|
|
292917
|
+
"required": [
|
|
292918
|
+
"node",
|
|
292919
|
+
"browser"
|
|
292920
|
+
],
|
|
292921
|
+
"additionalProperties": false
|
|
292833
292922
|
},
|
|
292834
292923
|
"dependencies": {
|
|
292835
292924
|
"type": "object",
|
|
@@ -292998,6 +293087,50 @@ var state = {
|
|
|
292998
293087
|
}
|
|
292999
293088
|
}
|
|
293000
293089
|
},
|
|
293090
|
+
"getPluginCode": {
|
|
293091
|
+
"name": "getPluginCode",
|
|
293092
|
+
"description": "Get Plugin Code",
|
|
293093
|
+
"method": "get",
|
|
293094
|
+
"path": "/v1/admin/plugins/{id}/code/{platform}",
|
|
293095
|
+
"section": "plugin",
|
|
293096
|
+
"parameters": {
|
|
293097
|
+
"nextToken": {
|
|
293098
|
+
"in": "query",
|
|
293099
|
+
"description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
|
|
293100
|
+
"type": "string"
|
|
293101
|
+
},
|
|
293102
|
+
"id": {
|
|
293103
|
+
"in": "path",
|
|
293104
|
+
"type": "string",
|
|
293105
|
+
"description": "Plugin id"
|
|
293106
|
+
},
|
|
293107
|
+
"platform": {
|
|
293108
|
+
"in": "path",
|
|
293109
|
+
"type": "string",
|
|
293110
|
+
"enum": [
|
|
293111
|
+
"node",
|
|
293112
|
+
"browser"
|
|
293113
|
+
],
|
|
293114
|
+
"description": "Platform"
|
|
293115
|
+
}
|
|
293116
|
+
},
|
|
293117
|
+
"response": {
|
|
293118
|
+
"description": "Plugin code",
|
|
293119
|
+
"schema": {
|
|
293120
|
+
"type": "object",
|
|
293121
|
+
"properties": {
|
|
293122
|
+
"code": {
|
|
293123
|
+
"type": "string"
|
|
293124
|
+
}
|
|
293125
|
+
},
|
|
293126
|
+
"required": [
|
|
293127
|
+
"code"
|
|
293128
|
+
],
|
|
293129
|
+
"title": "getPluginCodeResponse",
|
|
293130
|
+
"additionalProperties": false
|
|
293131
|
+
}
|
|
293132
|
+
}
|
|
293133
|
+
},
|
|
293001
293134
|
"getUsage": {
|
|
293002
293135
|
"name": "getUsage",
|
|
293003
293136
|
"path": "/v1/admin/usages/{id}",
|
|
@@ -296001,7 +296134,7 @@ var state = {
|
|
|
296001
296134
|
"title": "Botpress API",
|
|
296002
296135
|
"description": "API for Botpress Cloud",
|
|
296003
296136
|
"server": "https://api.botpress.cloud",
|
|
296004
|
-
"version": "0.
|
|
296137
|
+
"version": "0.67.0",
|
|
296005
296138
|
"prefix": "v1"
|
|
296006
296139
|
},
|
|
296007
296140
|
"errors": [
|
|
@@ -296311,6 +296444,7 @@ var state = {
|
|
|
296311
296444
|
"updatePluginResponse": true,
|
|
296312
296445
|
"deletePluginResponse": true,
|
|
296313
296446
|
"listPluginsResponse": true,
|
|
296447
|
+
"getPluginCodeResponse": true,
|
|
296314
296448
|
"getUsageResponse": true,
|
|
296315
296449
|
"getMultipleUsagesResponse": true,
|
|
296316
296450
|
"listUsageHistoryResponse": true,
|
|
@@ -298014,8 +298148,35 @@ var state = {
|
|
|
298014
298148
|
"description": "User object configuration",
|
|
298015
298149
|
"additionalProperties": false
|
|
298016
298150
|
},
|
|
298017
|
-
"
|
|
298018
|
-
"type": "
|
|
298151
|
+
"conversation": {
|
|
298152
|
+
"type": "object",
|
|
298153
|
+
"properties": {
|
|
298154
|
+
"tags": {
|
|
298155
|
+
"type": "object",
|
|
298156
|
+
"additionalProperties": {
|
|
298157
|
+
"type": "object",
|
|
298158
|
+
"properties": {
|
|
298159
|
+
"title": {
|
|
298160
|
+
"type": "string",
|
|
298161
|
+
"maxLength": 64,
|
|
298162
|
+
"description": "Title of the tag"
|
|
298163
|
+
},
|
|
298164
|
+
"description": {
|
|
298165
|
+
"type": "string",
|
|
298166
|
+
"maxLength": 256,
|
|
298167
|
+
"description": "Description of the tag"
|
|
298168
|
+
}
|
|
298169
|
+
},
|
|
298170
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
298171
|
+
"additionalProperties": false
|
|
298172
|
+
}
|
|
298173
|
+
}
|
|
298174
|
+
},
|
|
298175
|
+
"required": [
|
|
298176
|
+
"tags"
|
|
298177
|
+
],
|
|
298178
|
+
"description": "Conversation object configuration",
|
|
298179
|
+
"additionalProperties": false
|
|
298019
298180
|
}
|
|
298020
298181
|
},
|
|
298021
298182
|
"required": [
|
|
@@ -298030,7 +298191,7 @@ var state = {
|
|
|
298030
298191
|
"actions",
|
|
298031
298192
|
"dependencies",
|
|
298032
298193
|
"user",
|
|
298033
|
-
"
|
|
298194
|
+
"conversation"
|
|
298034
298195
|
],
|
|
298035
298196
|
"description": "Plugin definition",
|
|
298036
298197
|
"additionalProperties": false
|
|
@@ -299711,7 +299872,8 @@ var state = {
|
|
|
299711
299872
|
"getPluginByName",
|
|
299712
299873
|
"updatePlugin",
|
|
299713
299874
|
"deletePlugin",
|
|
299714
|
-
"listPlugins"
|
|
299875
|
+
"listPlugins",
|
|
299876
|
+
"getPluginCode"
|
|
299715
299877
|
],
|
|
299716
299878
|
"schema": "Plugin"
|
|
299717
299879
|
},
|
package/dist/src/gen/state.d.ts
CHANGED
|
@@ -9239,8 +9239,48 @@ export declare const state: {
|
|
|
9239
9239
|
description: string;
|
|
9240
9240
|
additionalProperties: false;
|
|
9241
9241
|
};
|
|
9242
|
+
conversation: {
|
|
9243
|
+
type: "object";
|
|
9244
|
+
properties: {
|
|
9245
|
+
tags: {
|
|
9246
|
+
type: "object";
|
|
9247
|
+
additionalProperties: {
|
|
9248
|
+
type: "object";
|
|
9249
|
+
properties: {
|
|
9250
|
+
title: {
|
|
9251
|
+
type: "string";
|
|
9252
|
+
maxLength: number;
|
|
9253
|
+
description: string;
|
|
9254
|
+
};
|
|
9255
|
+
description: {
|
|
9256
|
+
type: "string";
|
|
9257
|
+
maxLength: number;
|
|
9258
|
+
description: string;
|
|
9259
|
+
};
|
|
9260
|
+
};
|
|
9261
|
+
description: string;
|
|
9262
|
+
additionalProperties: false;
|
|
9263
|
+
};
|
|
9264
|
+
};
|
|
9265
|
+
};
|
|
9266
|
+
required: string[];
|
|
9267
|
+
description: string;
|
|
9268
|
+
additionalProperties: false;
|
|
9269
|
+
};
|
|
9242
9270
|
code: {
|
|
9243
|
-
type: "
|
|
9271
|
+
type: "object";
|
|
9272
|
+
properties: {
|
|
9273
|
+
node: {
|
|
9274
|
+
type: "string";
|
|
9275
|
+
description: string;
|
|
9276
|
+
};
|
|
9277
|
+
browser: {
|
|
9278
|
+
type: "string";
|
|
9279
|
+
description: string;
|
|
9280
|
+
};
|
|
9281
|
+
};
|
|
9282
|
+
required: string[];
|
|
9283
|
+
additionalProperties: false;
|
|
9244
9284
|
};
|
|
9245
9285
|
dependencies: {
|
|
9246
9286
|
type: "object";
|
|
@@ -9520,17 +9560,56 @@ export declare const state: {
|
|
|
9520
9560
|
};
|
|
9521
9561
|
};
|
|
9522
9562
|
description: string;
|
|
9563
|
+
nullable: true;
|
|
9564
|
+
additionalProperties: false;
|
|
9565
|
+
};
|
|
9566
|
+
};
|
|
9567
|
+
};
|
|
9568
|
+
required: string[];
|
|
9569
|
+
additionalProperties: false;
|
|
9570
|
+
};
|
|
9571
|
+
conversation: {
|
|
9572
|
+
type: "object";
|
|
9573
|
+
properties: {
|
|
9574
|
+
tags: {
|
|
9575
|
+
type: "object";
|
|
9576
|
+
additionalProperties: {
|
|
9577
|
+
type: "object";
|
|
9578
|
+
properties: {
|
|
9579
|
+
title: {
|
|
9580
|
+
type: "string";
|
|
9581
|
+
maxLength: number;
|
|
9582
|
+
description: string;
|
|
9583
|
+
};
|
|
9584
|
+
description: {
|
|
9585
|
+
type: "string";
|
|
9586
|
+
maxLength: number;
|
|
9587
|
+
description: string;
|
|
9588
|
+
};
|
|
9589
|
+
};
|
|
9590
|
+
description: string;
|
|
9591
|
+
nullable: true;
|
|
9523
9592
|
additionalProperties: false;
|
|
9524
9593
|
};
|
|
9525
9594
|
};
|
|
9526
9595
|
};
|
|
9527
9596
|
required: string[];
|
|
9528
|
-
description: string;
|
|
9529
|
-
nullable: true;
|
|
9530
9597
|
additionalProperties: false;
|
|
9531
9598
|
};
|
|
9532
9599
|
code: {
|
|
9533
|
-
type: "
|
|
9600
|
+
type: "object";
|
|
9601
|
+
properties: {
|
|
9602
|
+
node: {
|
|
9603
|
+
type: "string";
|
|
9604
|
+
description: string;
|
|
9605
|
+
};
|
|
9606
|
+
browser: {
|
|
9607
|
+
type: "string";
|
|
9608
|
+
description: string;
|
|
9609
|
+
};
|
|
9610
|
+
};
|
|
9611
|
+
required: string[];
|
|
9612
|
+
additionalProperties: false;
|
|
9534
9613
|
};
|
|
9535
9614
|
dependencies: {
|
|
9536
9615
|
type: "object";
|
|
@@ -9684,6 +9763,45 @@ export declare const state: {
|
|
|
9684
9763
|
};
|
|
9685
9764
|
};
|
|
9686
9765
|
};
|
|
9766
|
+
getPluginCode: {
|
|
9767
|
+
name: string;
|
|
9768
|
+
description: string;
|
|
9769
|
+
method: "get";
|
|
9770
|
+
path: string;
|
|
9771
|
+
section: "plugin";
|
|
9772
|
+
parameters: {
|
|
9773
|
+
nextToken: {
|
|
9774
|
+
in: "query";
|
|
9775
|
+
description: string;
|
|
9776
|
+
type: "string";
|
|
9777
|
+
};
|
|
9778
|
+
id: {
|
|
9779
|
+
in: "path";
|
|
9780
|
+
type: "string";
|
|
9781
|
+
description: string;
|
|
9782
|
+
};
|
|
9783
|
+
platform: {
|
|
9784
|
+
in: "path";
|
|
9785
|
+
type: "string";
|
|
9786
|
+
enum: string[];
|
|
9787
|
+
description: string;
|
|
9788
|
+
};
|
|
9789
|
+
};
|
|
9790
|
+
response: {
|
|
9791
|
+
description: string;
|
|
9792
|
+
schema: {
|
|
9793
|
+
type: "object";
|
|
9794
|
+
properties: {
|
|
9795
|
+
code: {
|
|
9796
|
+
type: "string";
|
|
9797
|
+
};
|
|
9798
|
+
};
|
|
9799
|
+
required: string[];
|
|
9800
|
+
title: string;
|
|
9801
|
+
additionalProperties: false;
|
|
9802
|
+
};
|
|
9803
|
+
};
|
|
9804
|
+
};
|
|
9687
9805
|
getUsage: {
|
|
9688
9806
|
name: string;
|
|
9689
9807
|
path: string;
|
|
@@ -12506,6 +12624,7 @@ export declare const state: {
|
|
|
12506
12624
|
updatePluginResponse: true;
|
|
12507
12625
|
deletePluginResponse: true;
|
|
12508
12626
|
listPluginsResponse: true;
|
|
12627
|
+
getPluginCodeResponse: true;
|
|
12509
12628
|
getUsageResponse: true;
|
|
12510
12629
|
getMultipleUsagesResponse: true;
|
|
12511
12630
|
listUsageHistoryResponse: true;
|
|
@@ -13962,8 +14081,33 @@ export declare const state: {
|
|
|
13962
14081
|
description: string;
|
|
13963
14082
|
additionalProperties: false;
|
|
13964
14083
|
};
|
|
13965
|
-
|
|
13966
|
-
type: "
|
|
14084
|
+
conversation: {
|
|
14085
|
+
type: "object";
|
|
14086
|
+
properties: {
|
|
14087
|
+
tags: {
|
|
14088
|
+
type: "object";
|
|
14089
|
+
additionalProperties: {
|
|
14090
|
+
type: "object";
|
|
14091
|
+
properties: {
|
|
14092
|
+
title: {
|
|
14093
|
+
type: "string";
|
|
14094
|
+
maxLength: number;
|
|
14095
|
+
description: string;
|
|
14096
|
+
};
|
|
14097
|
+
description: {
|
|
14098
|
+
type: "string";
|
|
14099
|
+
maxLength: number;
|
|
14100
|
+
description: string;
|
|
14101
|
+
};
|
|
14102
|
+
};
|
|
14103
|
+
description: string;
|
|
14104
|
+
additionalProperties: false;
|
|
14105
|
+
};
|
|
14106
|
+
};
|
|
14107
|
+
};
|
|
14108
|
+
required: string[];
|
|
14109
|
+
description: string;
|
|
14110
|
+
additionalProperties: false;
|
|
13967
14111
|
};
|
|
13968
14112
|
};
|
|
13969
14113
|
required: string[];
|
package/package.json
CHANGED
package/src/gen/metadata.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"sections":[{"description":"","title":"User","name":"user","operations":["createUser","getUser","listUsers","getOrCreateUser","updateUser","deleteUser"],"schema":"User"},{"description":"","title":"Conversation","name":"conversation","operations":["createConversation","getConversation","listConversations","getOrCreateConversation","updateConversation","deleteConversation","listParticipants","addParticipant","getParticipant","removeParticipant"],"schema":"Conversation"},{"description":"","title":"Event","name":"event","operations":["createEvent","getEvent","listEvents"],"schema":"Event"},{"description":"","title":"Message","name":"message","operations":["createMessage","getOrCreateMessage","getMessage","updateMessage","listMessages","deleteMessage"],"schema":"Message"},{"description":"","title":"State","name":"state","operations":["setStateExpiry","getState","setState","getOrSetState","patchState"],"schema":"State"},{"title":"Hub","description":"","name":"hub","operations":["listPublicIntegrations","getPublicIntegrationById","getPublicIntegration"]},{"description":"","title":"Action","name":"action","operations":["callAction"]},{"description":"","title":"Task","name":"task","operations":["getTask","createTask","updateTask","deleteTask","listTasks"],"schema":"Task"},{"description":"","title":"Workflow","name":"workflow","operations":["createWorkflow","getWorkflow","updateWorkflow","deleteWorkflow","listWorkflows","getOrCreateWorkflow"],"schema":"Workflow"},{"description":"","title":"Tag","name":"tag","operations":["listTagValues"]},{"title":"Bot","description":"","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics","getBotIssue","listBotIssues","deleteBotIssue","listBotIssueEvents","listBotVersions","getBotVersion","createBotVersion","deployBotVersion"],"schema":"Bot"},{"title":"Integration","description":"","name":"integration","operations":["listIntegrationApiKeys","createIntegrationApiKey","deleteIntegrationApiKey","createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration","requestIntegrationVerification"],"schema":"Integration"},{"title":"Interface","description":"","name":"interface","operations":["createInterface","getInterface","getInterfaceByName","updateInterface","deleteInterface","listInterfaces"],"schema":"Interface"},{"title":"Plugin","description":"","name":"plugin","operations":["createPlugin","getPlugin","getPluginByName","updatePlugin","deletePlugin","listPlugins"],"schema":"Plugin"},{"title":"Workspace","description":"","name":"workspace","operations":["listWorkspaceInvoices","getUpcomingInvoice","chargeWorkspaceUnpaidInvoices","createWorkspace","getPublicWorkspace","getWorkspace","listWorkspaceUsages","breakDownWorkspaceUsageByBot","getAllWorkspaceQuotaCompletion","getWorkspaceQuota","listWorkspaceQuotas","updateWorkspace","checkHandleAvailability","listWorkspaces","listPublicWorkspaces","deleteWorkspace","getAuditRecords"],"schema":"Workspace"},{"title":"Workspace Member","description":"","name":"workspaceMember","operations":["listWorkspaceMembers","getWorkspaceMember","deleteWorkspaceMember","createWorkspaceMember","updateWorkspaceMember"],"schema":"WorkspaceMember"},{"title":"Account","description":"","name":"account","operations":["getAccount","updateAccount","listPersonalAccessTokens","createPersonalAccessToken","deletePersonalAccessToken","setAccountPreference","getAccountPreference"],"schema":"Account"},{"title":"Usage","description":"","name":"usage","operations":["getUsage","getMultipleUsages","listUsageActivityDaily"],"schema":"Usage"},{"title":"Quotas","description":"","name":"quotas","operations":["changeAISpendQuota"]},{"title":"Helper","description":"","name":"helper","operations":["runVrl"]},{"title":"Activity","description":"","name":"activity","operations":["listActivities"],"schema":"Activity"},{"title":"Tables","description":"Manage and interact with table structures, including creation, updates, and querying of tables and their rows.","name":"tables","operations":["listTables","getTable","getOrCreateTable","createTable","duplicateTable","exportTable","getTableJobs","importTable","updateTable","renameTableColumn","deleteTable","getTableRow","findTableRows","createTableRows","deleteTableRows","updateTableRows","upsertTableRows"],"schema":"Table"},{"title":"Files","description":"The Files API allows you to create, manage, and index files that can be used by your bots and integrations. Files can be in any text or binary format, and documents (such as PDF, Microsoft Word, HTML, Markdown, etc.) can be indexed to be used for semantic search in RAG (Retrieval Augmented Generation) implementations. Files are private by default but can be made publicly accessible through a permanent URL that's unique for each file.","name":"files","operations":["upsertFile","deleteFile","listFiles","getFile","updateFileMetadata","copyFile","searchFiles","listFilePassages","listFileTags","listFileTagValues"],"schema":"File"}],"errors":[{"status":500,"type":"Unknown","description":"An unknown error occurred"},{"status":500,"type":"Internal","description":"An internal error occurred"},{"status":401,"type":"Unauthorized","description":"The request requires to be authenticated."},{"status":403,"type":"Forbidden","description":"The requested action can't be peform by this resource."},{"status":413,"type":"PayloadTooLarge","description":"The request payload is too large."},{"status":400,"type":"InvalidPayload","description":"The request payload is invalid."},{"status":415,"type":"UnsupportedMediaType","description":"The request is invalid because the content-type is not supported."},{"status":405,"type":"MethodNotFound","description":"The requested method does not exist."},{"status":404,"type":"ResourceNotFound","description":"The requested resource does not exist."},{"status":400,"type":"InvalidJsonSchema","description":"The provided JSON schema is invalid."},{"status":400,"type":"InvalidDataFormat","description":"The provided data doesn't respect the provided JSON schema."},{"status":400,"type":"InvalidIdentifier","description":"The provided identifier is not valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters."},{"status":409,"type":"RelationConflict","description":"The resource is related with a different resource that the one referenced in the request. This is usually caused when providing two resource identifiers that aren't linked together."},{"status":409,"type":"ReferenceConstraint","description":"The resource cannot be deleted because it's referenced by another resource"},{"status":409,"type":"ResourceLockedConflict","description":"The resource is current locked and cannot be operated on until the lock is released."},{"status":400,"type":"ReferenceNotFound","description":"The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request."},{"status":400,"type":"InvalidQuery","description":"The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource."},{"status":400,"type":"Runtime","description":"An error happened during the execution of a runtime (bot or integration)."},{"status":409,"type":"AlreadyExists","description":"The record attempted to be created already exists."},{"status":429,"type":"RateLimited","description":"The request has been rate limited."},{"status":402,"type":"PaymentRequired","description":"A payment is required to perform this request."},{"status":403,"type":"QuotaExceeded","description":"The request exceeds the allowed quota. Quotas are a soft limit that can be increased."},{"status":413,"type":"LimitExceeded","description":"The request exceeds the allowed limit. Limits are a hard limit that cannot be increased."},{"status":400,"type":"BreakingChanges","description":"Request payload contains breaking changes which is not allowed for this resource without a version increment."}]}
|
|
1
|
+
{"sections":[{"description":"","title":"User","name":"user","operations":["createUser","getUser","listUsers","getOrCreateUser","updateUser","deleteUser"],"schema":"User"},{"description":"","title":"Conversation","name":"conversation","operations":["createConversation","getConversation","listConversations","getOrCreateConversation","updateConversation","deleteConversation","listParticipants","addParticipant","getParticipant","removeParticipant"],"schema":"Conversation"},{"description":"","title":"Event","name":"event","operations":["createEvent","getEvent","listEvents"],"schema":"Event"},{"description":"","title":"Message","name":"message","operations":["createMessage","getOrCreateMessage","getMessage","updateMessage","listMessages","deleteMessage"],"schema":"Message"},{"description":"","title":"State","name":"state","operations":["setStateExpiry","getState","setState","getOrSetState","patchState"],"schema":"State"},{"title":"Hub","description":"","name":"hub","operations":["listPublicIntegrations","getPublicIntegrationById","getPublicIntegration"]},{"description":"","title":"Action","name":"action","operations":["callAction"]},{"description":"","title":"Task","name":"task","operations":["getTask","createTask","updateTask","deleteTask","listTasks"],"schema":"Task"},{"description":"","title":"Workflow","name":"workflow","operations":["createWorkflow","getWorkflow","updateWorkflow","deleteWorkflow","listWorkflows","getOrCreateWorkflow"],"schema":"Workflow"},{"description":"","title":"Tag","name":"tag","operations":["listTagValues"]},{"title":"Bot","description":"","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics","getBotIssue","listBotIssues","deleteBotIssue","listBotIssueEvents","listBotVersions","getBotVersion","createBotVersion","deployBotVersion"],"schema":"Bot"},{"title":"Integration","description":"","name":"integration","operations":["listIntegrationApiKeys","createIntegrationApiKey","deleteIntegrationApiKey","createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration","requestIntegrationVerification"],"schema":"Integration"},{"title":"Interface","description":"","name":"interface","operations":["createInterface","getInterface","getInterfaceByName","updateInterface","deleteInterface","listInterfaces"],"schema":"Interface"},{"title":"Plugin","description":"","name":"plugin","operations":["createPlugin","getPlugin","getPluginByName","updatePlugin","deletePlugin","listPlugins","getPluginCode"],"schema":"Plugin"},{"title":"Workspace","description":"","name":"workspace","operations":["listWorkspaceInvoices","getUpcomingInvoice","chargeWorkspaceUnpaidInvoices","createWorkspace","getPublicWorkspace","getWorkspace","listWorkspaceUsages","breakDownWorkspaceUsageByBot","getAllWorkspaceQuotaCompletion","getWorkspaceQuota","listWorkspaceQuotas","updateWorkspace","checkHandleAvailability","listWorkspaces","listPublicWorkspaces","deleteWorkspace","getAuditRecords"],"schema":"Workspace"},{"title":"Workspace Member","description":"","name":"workspaceMember","operations":["listWorkspaceMembers","getWorkspaceMember","deleteWorkspaceMember","createWorkspaceMember","updateWorkspaceMember"],"schema":"WorkspaceMember"},{"title":"Account","description":"","name":"account","operations":["getAccount","updateAccount","listPersonalAccessTokens","createPersonalAccessToken","deletePersonalAccessToken","setAccountPreference","getAccountPreference"],"schema":"Account"},{"title":"Usage","description":"","name":"usage","operations":["getUsage","getMultipleUsages","listUsageActivityDaily"],"schema":"Usage"},{"title":"Quotas","description":"","name":"quotas","operations":["changeAISpendQuota"]},{"title":"Helper","description":"","name":"helper","operations":["runVrl"]},{"title":"Activity","description":"","name":"activity","operations":["listActivities"],"schema":"Activity"},{"title":"Tables","description":"Manage and interact with table structures, including creation, updates, and querying of tables and their rows.","name":"tables","operations":["listTables","getTable","getOrCreateTable","createTable","duplicateTable","exportTable","getTableJobs","importTable","updateTable","renameTableColumn","deleteTable","getTableRow","findTableRows","createTableRows","deleteTableRows","updateTableRows","upsertTableRows"],"schema":"Table"},{"title":"Files","description":"The Files API allows you to create, manage, and index files that can be used by your bots and integrations. Files can be in any text or binary format, and documents (such as PDF, Microsoft Word, HTML, Markdown, etc.) can be indexed to be used for semantic search in RAG (Retrieval Augmented Generation) implementations. Files are private by default but can be made publicly accessible through a permanent URL that's unique for each file.","name":"files","operations":["upsertFile","deleteFile","listFiles","getFile","updateFileMetadata","copyFile","searchFiles","listFilePassages","listFileTags","listFileTagValues"],"schema":"File"}],"errors":[{"status":500,"type":"Unknown","description":"An unknown error occurred"},{"status":500,"type":"Internal","description":"An internal error occurred"},{"status":401,"type":"Unauthorized","description":"The request requires to be authenticated."},{"status":403,"type":"Forbidden","description":"The requested action can't be peform by this resource."},{"status":413,"type":"PayloadTooLarge","description":"The request payload is too large."},{"status":400,"type":"InvalidPayload","description":"The request payload is invalid."},{"status":415,"type":"UnsupportedMediaType","description":"The request is invalid because the content-type is not supported."},{"status":405,"type":"MethodNotFound","description":"The requested method does not exist."},{"status":404,"type":"ResourceNotFound","description":"The requested resource does not exist."},{"status":400,"type":"InvalidJsonSchema","description":"The provided JSON schema is invalid."},{"status":400,"type":"InvalidDataFormat","description":"The provided data doesn't respect the provided JSON schema."},{"status":400,"type":"InvalidIdentifier","description":"The provided identifier is not valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters."},{"status":409,"type":"RelationConflict","description":"The resource is related with a different resource that the one referenced in the request. This is usually caused when providing two resource identifiers that aren't linked together."},{"status":409,"type":"ReferenceConstraint","description":"The resource cannot be deleted because it's referenced by another resource"},{"status":409,"type":"ResourceLockedConflict","description":"The resource is current locked and cannot be operated on until the lock is released."},{"status":400,"type":"ReferenceNotFound","description":"The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request."},{"status":400,"type":"InvalidQuery","description":"The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource."},{"status":400,"type":"Runtime","description":"An error happened during the execution of a runtime (bot or integration)."},{"status":409,"type":"AlreadyExists","description":"The record attempted to be created already exists."},{"status":429,"type":"RateLimited","description":"The request has been rate limited."},{"status":402,"type":"PaymentRequired","description":"A payment is required to perform this request."},{"status":403,"type":"QuotaExceeded","description":"The request exceeds the allowed quota. Quotas are a soft limit that can be increased."},{"status":413,"type":"LimitExceeded","description":"The request exceeds the allowed limit. Limits are a hard limit that cannot be increased."},{"status":400,"type":"BreakingChanges","description":"Request payload contains breaking changes which is not allowed for this resource without a version increment."}]}
|