@botpress/api 0.64.1 → 0.66.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 +179 -10
- package/dist/src/gen/state.d.ts +155 -5
- package/package.json +1 -1
- package/src/gen/metadata.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/state.ts +179 -10
package/dist/index.js
CHANGED
|
@@ -292504,7 +292504,22 @@ var state = {
|
|
|
292504
292504
|
"additionalProperties": false
|
|
292505
292505
|
},
|
|
292506
292506
|
"code": {
|
|
292507
|
-
"type": "
|
|
292507
|
+
"type": "object",
|
|
292508
|
+
"properties": {
|
|
292509
|
+
"node": {
|
|
292510
|
+
"type": "string",
|
|
292511
|
+
"description": "Code of plugin bundled for Node.JS"
|
|
292512
|
+
},
|
|
292513
|
+
"browser": {
|
|
292514
|
+
"type": "string",
|
|
292515
|
+
"description": "Code of plugin bundled for the browser"
|
|
292516
|
+
}
|
|
292517
|
+
},
|
|
292518
|
+
"required": [
|
|
292519
|
+
"node",
|
|
292520
|
+
"browser"
|
|
292521
|
+
],
|
|
292522
|
+
"additionalProperties": false
|
|
292508
292523
|
},
|
|
292509
292524
|
"dependencies": {
|
|
292510
292525
|
"type": "object",
|
|
@@ -292829,7 +292844,22 @@ var state = {
|
|
|
292829
292844
|
"additionalProperties": false
|
|
292830
292845
|
},
|
|
292831
292846
|
"code": {
|
|
292832
|
-
"type": "
|
|
292847
|
+
"type": "object",
|
|
292848
|
+
"properties": {
|
|
292849
|
+
"node": {
|
|
292850
|
+
"type": "string",
|
|
292851
|
+
"description": "Code of plugin bundled for Node.JS"
|
|
292852
|
+
},
|
|
292853
|
+
"browser": {
|
|
292854
|
+
"type": "string",
|
|
292855
|
+
"description": "Code of plugin bundled for the browser"
|
|
292856
|
+
}
|
|
292857
|
+
},
|
|
292858
|
+
"required": [
|
|
292859
|
+
"node",
|
|
292860
|
+
"browser"
|
|
292861
|
+
],
|
|
292862
|
+
"additionalProperties": false
|
|
292833
292863
|
},
|
|
292834
292864
|
"dependencies": {
|
|
292835
292865
|
"type": "object",
|
|
@@ -292998,6 +293028,50 @@ var state = {
|
|
|
292998
293028
|
}
|
|
292999
293029
|
}
|
|
293000
293030
|
},
|
|
293031
|
+
"getPluginCode": {
|
|
293032
|
+
"name": "getPluginCode",
|
|
293033
|
+
"description": "Get Plugin Code",
|
|
293034
|
+
"method": "get",
|
|
293035
|
+
"path": "/v1/admin/plugins/{id}/code/{platform}",
|
|
293036
|
+
"section": "plugin",
|
|
293037
|
+
"parameters": {
|
|
293038
|
+
"nextToken": {
|
|
293039
|
+
"in": "query",
|
|
293040
|
+
"description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
|
|
293041
|
+
"type": "string"
|
|
293042
|
+
},
|
|
293043
|
+
"id": {
|
|
293044
|
+
"in": "path",
|
|
293045
|
+
"type": "string",
|
|
293046
|
+
"description": "Plugin id"
|
|
293047
|
+
},
|
|
293048
|
+
"platform": {
|
|
293049
|
+
"in": "path",
|
|
293050
|
+
"type": "string",
|
|
293051
|
+
"enum": [
|
|
293052
|
+
"node",
|
|
293053
|
+
"browser"
|
|
293054
|
+
],
|
|
293055
|
+
"description": "Platform"
|
|
293056
|
+
}
|
|
293057
|
+
},
|
|
293058
|
+
"response": {
|
|
293059
|
+
"description": "Plugin code",
|
|
293060
|
+
"schema": {
|
|
293061
|
+
"type": "object",
|
|
293062
|
+
"properties": {
|
|
293063
|
+
"code": {
|
|
293064
|
+
"type": "string"
|
|
293065
|
+
}
|
|
293066
|
+
},
|
|
293067
|
+
"required": [
|
|
293068
|
+
"code"
|
|
293069
|
+
],
|
|
293070
|
+
"title": "getPluginCodeResponse",
|
|
293071
|
+
"additionalProperties": false
|
|
293072
|
+
}
|
|
293073
|
+
}
|
|
293074
|
+
},
|
|
293001
293075
|
"getUsage": {
|
|
293002
293076
|
"name": "getUsage",
|
|
293003
293077
|
"path": "/v1/admin/usages/{id}",
|
|
@@ -294697,6 +294771,99 @@ var state = {
|
|
|
294697
294771
|
}
|
|
294698
294772
|
}
|
|
294699
294773
|
},
|
|
294774
|
+
"listFileTags": {
|
|
294775
|
+
"name": "listFileTags",
|
|
294776
|
+
"path": "/v1/files/tags",
|
|
294777
|
+
"description": "List available tags",
|
|
294778
|
+
"method": "get",
|
|
294779
|
+
"section": "files",
|
|
294780
|
+
"parameters": {
|
|
294781
|
+
"nextToken": {
|
|
294782
|
+
"in": "query",
|
|
294783
|
+
"description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
|
|
294784
|
+
"type": "string"
|
|
294785
|
+
}
|
|
294786
|
+
},
|
|
294787
|
+
"response": {
|
|
294788
|
+
"description": "Returns the list of available tags used across all files of the bot.",
|
|
294789
|
+
"schema": {
|
|
294790
|
+
"type": "object",
|
|
294791
|
+
"properties": {
|
|
294792
|
+
"tags": {
|
|
294793
|
+
"type": "array",
|
|
294794
|
+
"items": {
|
|
294795
|
+
"type": "string"
|
|
294796
|
+
}
|
|
294797
|
+
},
|
|
294798
|
+
"meta": {
|
|
294799
|
+
"type": "object",
|
|
294800
|
+
"properties": {
|
|
294801
|
+
"nextToken": {
|
|
294802
|
+
"type": "string",
|
|
294803
|
+
"description": "The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint."
|
|
294804
|
+
}
|
|
294805
|
+
},
|
|
294806
|
+
"additionalProperties": false
|
|
294807
|
+
}
|
|
294808
|
+
},
|
|
294809
|
+
"required": [
|
|
294810
|
+
"tags",
|
|
294811
|
+
"meta"
|
|
294812
|
+
],
|
|
294813
|
+
"title": "listFileTagsResponse",
|
|
294814
|
+
"additionalProperties": false
|
|
294815
|
+
}
|
|
294816
|
+
}
|
|
294817
|
+
},
|
|
294818
|
+
"listFileTagValues": {
|
|
294819
|
+
"name": "listFileTagValues",
|
|
294820
|
+
"path": "/v1/files/tags/{tag}/values",
|
|
294821
|
+
"description": "List available tags",
|
|
294822
|
+
"method": "get",
|
|
294823
|
+
"section": "files",
|
|
294824
|
+
"parameters": {
|
|
294825
|
+
"nextToken": {
|
|
294826
|
+
"in": "query",
|
|
294827
|
+
"description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
|
|
294828
|
+
"type": "string"
|
|
294829
|
+
},
|
|
294830
|
+
"tag": {
|
|
294831
|
+
"type": "string",
|
|
294832
|
+
"description": "Tag name",
|
|
294833
|
+
"in": "path"
|
|
294834
|
+
}
|
|
294835
|
+
},
|
|
294836
|
+
"response": {
|
|
294837
|
+
"description": "Returns the list of available values used for a given tag across all files of the bot.",
|
|
294838
|
+
"schema": {
|
|
294839
|
+
"type": "object",
|
|
294840
|
+
"properties": {
|
|
294841
|
+
"values": {
|
|
294842
|
+
"type": "array",
|
|
294843
|
+
"items": {
|
|
294844
|
+
"type": "string"
|
|
294845
|
+
}
|
|
294846
|
+
},
|
|
294847
|
+
"meta": {
|
|
294848
|
+
"type": "object",
|
|
294849
|
+
"properties": {
|
|
294850
|
+
"nextToken": {
|
|
294851
|
+
"type": "string",
|
|
294852
|
+
"description": "The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint."
|
|
294853
|
+
}
|
|
294854
|
+
},
|
|
294855
|
+
"additionalProperties": false
|
|
294856
|
+
}
|
|
294857
|
+
},
|
|
294858
|
+
"required": [
|
|
294859
|
+
"values",
|
|
294860
|
+
"meta"
|
|
294861
|
+
],
|
|
294862
|
+
"title": "listFileTagValuesResponse",
|
|
294863
|
+
"additionalProperties": false
|
|
294864
|
+
}
|
|
294865
|
+
}
|
|
294866
|
+
},
|
|
294700
294867
|
"listTables": {
|
|
294701
294868
|
"name": "listTables",
|
|
294702
294869
|
"path": "/v1/tables",
|
|
@@ -295908,7 +296075,7 @@ var state = {
|
|
|
295908
296075
|
"title": "Botpress API",
|
|
295909
296076
|
"description": "API for Botpress Cloud",
|
|
295910
296077
|
"server": "https://api.botpress.cloud",
|
|
295911
|
-
"version": "0.
|
|
296078
|
+
"version": "0.66.0",
|
|
295912
296079
|
"prefix": "v1"
|
|
295913
296080
|
},
|
|
295914
296081
|
"errors": [
|
|
@@ -296218,6 +296385,7 @@ var state = {
|
|
|
296218
296385
|
"updatePluginResponse": true,
|
|
296219
296386
|
"deletePluginResponse": true,
|
|
296220
296387
|
"listPluginsResponse": true,
|
|
296388
|
+
"getPluginCodeResponse": true,
|
|
296221
296389
|
"getUsageResponse": true,
|
|
296222
296390
|
"getMultipleUsagesResponse": true,
|
|
296223
296391
|
"listUsageHistoryResponse": true,
|
|
@@ -296234,6 +296402,8 @@ var state = {
|
|
|
296234
296402
|
"copyFileResponse": true,
|
|
296235
296403
|
"searchFilesResponse": true,
|
|
296236
296404
|
"listFilePassagesResponse": true,
|
|
296405
|
+
"listFileTagsResponse": true,
|
|
296406
|
+
"listFileTagValuesResponse": true,
|
|
296237
296407
|
"listTablesResponse": true,
|
|
296238
296408
|
"getTableResponse": true,
|
|
296239
296409
|
"getOrCreateTableResponse": true,
|
|
@@ -297918,9 +298088,6 @@ var state = {
|
|
|
297918
298088
|
],
|
|
297919
298089
|
"description": "User object configuration",
|
|
297920
298090
|
"additionalProperties": false
|
|
297921
|
-
},
|
|
297922
|
-
"code": {
|
|
297923
|
-
"type": "string"
|
|
297924
298091
|
}
|
|
297925
298092
|
},
|
|
297926
298093
|
"required": [
|
|
@@ -297934,8 +298101,7 @@ var state = {
|
|
|
297934
298101
|
"events",
|
|
297935
298102
|
"actions",
|
|
297936
298103
|
"dependencies",
|
|
297937
|
-
"user"
|
|
297938
|
-
"code"
|
|
298104
|
+
"user"
|
|
297939
298105
|
],
|
|
297940
298106
|
"description": "Plugin definition",
|
|
297941
298107
|
"additionalProperties": false
|
|
@@ -299616,7 +299782,8 @@ var state = {
|
|
|
299616
299782
|
"getPluginByName",
|
|
299617
299783
|
"updatePlugin",
|
|
299618
299784
|
"deletePlugin",
|
|
299619
|
-
"listPlugins"
|
|
299785
|
+
"listPlugins",
|
|
299786
|
+
"getPluginCode"
|
|
299620
299787
|
],
|
|
299621
299788
|
"schema": "Plugin"
|
|
299622
299789
|
},
|
|
@@ -299746,7 +299913,9 @@ var state = {
|
|
|
299746
299913
|
"updateFileMetadata",
|
|
299747
299914
|
"copyFile",
|
|
299748
299915
|
"searchFiles",
|
|
299749
|
-
"listFilePassages"
|
|
299916
|
+
"listFilePassages",
|
|
299917
|
+
"listFileTags",
|
|
299918
|
+
"listFileTagValues"
|
|
299750
299919
|
],
|
|
299751
299920
|
"schema": "File"
|
|
299752
299921
|
}
|
package/dist/src/gen/state.d.ts
CHANGED
|
@@ -9240,7 +9240,19 @@ export declare const state: {
|
|
|
9240
9240
|
additionalProperties: false;
|
|
9241
9241
|
};
|
|
9242
9242
|
code: {
|
|
9243
|
-
type: "
|
|
9243
|
+
type: "object";
|
|
9244
|
+
properties: {
|
|
9245
|
+
node: {
|
|
9246
|
+
type: "string";
|
|
9247
|
+
description: string;
|
|
9248
|
+
};
|
|
9249
|
+
browser: {
|
|
9250
|
+
type: "string";
|
|
9251
|
+
description: string;
|
|
9252
|
+
};
|
|
9253
|
+
};
|
|
9254
|
+
required: string[];
|
|
9255
|
+
additionalProperties: false;
|
|
9244
9256
|
};
|
|
9245
9257
|
dependencies: {
|
|
9246
9258
|
type: "object";
|
|
@@ -9530,7 +9542,19 @@ export declare const state: {
|
|
|
9530
9542
|
additionalProperties: false;
|
|
9531
9543
|
};
|
|
9532
9544
|
code: {
|
|
9533
|
-
type: "
|
|
9545
|
+
type: "object";
|
|
9546
|
+
properties: {
|
|
9547
|
+
node: {
|
|
9548
|
+
type: "string";
|
|
9549
|
+
description: string;
|
|
9550
|
+
};
|
|
9551
|
+
browser: {
|
|
9552
|
+
type: "string";
|
|
9553
|
+
description: string;
|
|
9554
|
+
};
|
|
9555
|
+
};
|
|
9556
|
+
required: string[];
|
|
9557
|
+
additionalProperties: false;
|
|
9534
9558
|
};
|
|
9535
9559
|
dependencies: {
|
|
9536
9560
|
type: "object";
|
|
@@ -9684,6 +9708,45 @@ export declare const state: {
|
|
|
9684
9708
|
};
|
|
9685
9709
|
};
|
|
9686
9710
|
};
|
|
9711
|
+
getPluginCode: {
|
|
9712
|
+
name: string;
|
|
9713
|
+
description: string;
|
|
9714
|
+
method: "get";
|
|
9715
|
+
path: string;
|
|
9716
|
+
section: "plugin";
|
|
9717
|
+
parameters: {
|
|
9718
|
+
nextToken: {
|
|
9719
|
+
in: "query";
|
|
9720
|
+
description: string;
|
|
9721
|
+
type: "string";
|
|
9722
|
+
};
|
|
9723
|
+
id: {
|
|
9724
|
+
in: "path";
|
|
9725
|
+
type: "string";
|
|
9726
|
+
description: string;
|
|
9727
|
+
};
|
|
9728
|
+
platform: {
|
|
9729
|
+
in: "path";
|
|
9730
|
+
type: "string";
|
|
9731
|
+
enum: string[];
|
|
9732
|
+
description: string;
|
|
9733
|
+
};
|
|
9734
|
+
};
|
|
9735
|
+
response: {
|
|
9736
|
+
description: string;
|
|
9737
|
+
schema: {
|
|
9738
|
+
type: "object";
|
|
9739
|
+
properties: {
|
|
9740
|
+
code: {
|
|
9741
|
+
type: "string";
|
|
9742
|
+
};
|
|
9743
|
+
};
|
|
9744
|
+
required: string[];
|
|
9745
|
+
title: string;
|
|
9746
|
+
additionalProperties: false;
|
|
9747
|
+
};
|
|
9748
|
+
};
|
|
9749
|
+
};
|
|
9687
9750
|
getUsage: {
|
|
9688
9751
|
name: string;
|
|
9689
9752
|
path: string;
|
|
@@ -11100,6 +11163,93 @@ export declare const state: {
|
|
|
11100
11163
|
};
|
|
11101
11164
|
};
|
|
11102
11165
|
};
|
|
11166
|
+
listFileTags: {
|
|
11167
|
+
name: string;
|
|
11168
|
+
path: string;
|
|
11169
|
+
description: string;
|
|
11170
|
+
method: "get";
|
|
11171
|
+
section: "files";
|
|
11172
|
+
parameters: {
|
|
11173
|
+
nextToken: {
|
|
11174
|
+
in: "query";
|
|
11175
|
+
description: string;
|
|
11176
|
+
type: "string";
|
|
11177
|
+
};
|
|
11178
|
+
};
|
|
11179
|
+
response: {
|
|
11180
|
+
description: string;
|
|
11181
|
+
schema: {
|
|
11182
|
+
type: "object";
|
|
11183
|
+
properties: {
|
|
11184
|
+
tags: {
|
|
11185
|
+
type: "array";
|
|
11186
|
+
items: {
|
|
11187
|
+
type: "string";
|
|
11188
|
+
};
|
|
11189
|
+
};
|
|
11190
|
+
meta: {
|
|
11191
|
+
type: "object";
|
|
11192
|
+
properties: {
|
|
11193
|
+
nextToken: {
|
|
11194
|
+
type: "string";
|
|
11195
|
+
description: string;
|
|
11196
|
+
};
|
|
11197
|
+
};
|
|
11198
|
+
additionalProperties: false;
|
|
11199
|
+
};
|
|
11200
|
+
};
|
|
11201
|
+
required: string[];
|
|
11202
|
+
title: string;
|
|
11203
|
+
additionalProperties: false;
|
|
11204
|
+
};
|
|
11205
|
+
};
|
|
11206
|
+
};
|
|
11207
|
+
listFileTagValues: {
|
|
11208
|
+
name: string;
|
|
11209
|
+
path: string;
|
|
11210
|
+
description: string;
|
|
11211
|
+
method: "get";
|
|
11212
|
+
section: "files";
|
|
11213
|
+
parameters: {
|
|
11214
|
+
nextToken: {
|
|
11215
|
+
in: "query";
|
|
11216
|
+
description: string;
|
|
11217
|
+
type: "string";
|
|
11218
|
+
};
|
|
11219
|
+
tag: {
|
|
11220
|
+
type: "string";
|
|
11221
|
+
description: string;
|
|
11222
|
+
in: "path";
|
|
11223
|
+
};
|
|
11224
|
+
};
|
|
11225
|
+
response: {
|
|
11226
|
+
description: string;
|
|
11227
|
+
schema: {
|
|
11228
|
+
type: "object";
|
|
11229
|
+
properties: {
|
|
11230
|
+
values: {
|
|
11231
|
+
type: "array";
|
|
11232
|
+
items: {
|
|
11233
|
+
type: "string";
|
|
11234
|
+
};
|
|
11235
|
+
};
|
|
11236
|
+
meta: {
|
|
11237
|
+
type: "object";
|
|
11238
|
+
properties: {
|
|
11239
|
+
nextToken: {
|
|
11240
|
+
type: "string";
|
|
11241
|
+
description: string;
|
|
11242
|
+
};
|
|
11243
|
+
};
|
|
11244
|
+
additionalProperties: false;
|
|
11245
|
+
};
|
|
11246
|
+
};
|
|
11247
|
+
required: string[];
|
|
11248
|
+
title: string;
|
|
11249
|
+
additionalProperties: false;
|
|
11250
|
+
};
|
|
11251
|
+
};
|
|
11252
|
+
};
|
|
11103
11253
|
listTables: {
|
|
11104
11254
|
name: string;
|
|
11105
11255
|
path: string;
|
|
@@ -12419,6 +12569,7 @@ export declare const state: {
|
|
|
12419
12569
|
updatePluginResponse: true;
|
|
12420
12570
|
deletePluginResponse: true;
|
|
12421
12571
|
listPluginsResponse: true;
|
|
12572
|
+
getPluginCodeResponse: true;
|
|
12422
12573
|
getUsageResponse: true;
|
|
12423
12574
|
getMultipleUsagesResponse: true;
|
|
12424
12575
|
listUsageHistoryResponse: true;
|
|
@@ -12435,6 +12586,8 @@ export declare const state: {
|
|
|
12435
12586
|
copyFileResponse: true;
|
|
12436
12587
|
searchFilesResponse: true;
|
|
12437
12588
|
listFilePassagesResponse: true;
|
|
12589
|
+
listFileTagsResponse: true;
|
|
12590
|
+
listFileTagValuesResponse: true;
|
|
12438
12591
|
listTablesResponse: true;
|
|
12439
12592
|
getTableResponse: true;
|
|
12440
12593
|
getOrCreateTableResponse: true;
|
|
@@ -13873,9 +14026,6 @@ export declare const state: {
|
|
|
13873
14026
|
description: string;
|
|
13874
14027
|
additionalProperties: false;
|
|
13875
14028
|
};
|
|
13876
|
-
code: {
|
|
13877
|
-
type: "string";
|
|
13878
|
-
};
|
|
13879
14029
|
};
|
|
13880
14030
|
required: string[];
|
|
13881
14031
|
description: 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"],"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."}]}
|