@botpress/api 0.79.0 → 0.83.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 +585 -737
- package/dist/src/gen/state.d.ts +379 -0
- package/package.json +2 -2
- package/src/gen/metadata.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/state.ts +428 -3
package/dist/src/gen/state.d.ts
CHANGED
|
@@ -1597,6 +1597,16 @@ export declare const state: {
|
|
|
1597
1597
|
enum: string[];
|
|
1598
1598
|
description: string;
|
|
1599
1599
|
};
|
|
1600
|
+
sandboxIdentifiers: {
|
|
1601
|
+
type: "object";
|
|
1602
|
+
additionalProperties: {
|
|
1603
|
+
type: "object";
|
|
1604
|
+
nullable: true;
|
|
1605
|
+
additionalProperties: false;
|
|
1606
|
+
};
|
|
1607
|
+
nullable: true;
|
|
1608
|
+
description: string;
|
|
1609
|
+
};
|
|
1600
1610
|
};
|
|
1601
1611
|
title: string;
|
|
1602
1612
|
additionalProperties: false;
|
|
@@ -2885,6 +2895,22 @@ export declare const state: {
|
|
|
2885
2895
|
description: string;
|
|
2886
2896
|
additionalProperties: false;
|
|
2887
2897
|
};
|
|
2898
|
+
sandbox: {
|
|
2899
|
+
type: "object";
|
|
2900
|
+
properties: {
|
|
2901
|
+
identifierExtractScript: {
|
|
2902
|
+
type: "string";
|
|
2903
|
+
maxLength: number;
|
|
2904
|
+
description: string;
|
|
2905
|
+
};
|
|
2906
|
+
messageExtractScript: {
|
|
2907
|
+
type: "string";
|
|
2908
|
+
maxLength: number;
|
|
2909
|
+
description: string;
|
|
2910
|
+
};
|
|
2911
|
+
};
|
|
2912
|
+
additionalProperties: false;
|
|
2913
|
+
};
|
|
2888
2914
|
url: {
|
|
2889
2915
|
type: "string";
|
|
2890
2916
|
maxLength: number;
|
|
@@ -3481,6 +3507,22 @@ export declare const state: {
|
|
|
3481
3507
|
description: string;
|
|
3482
3508
|
additionalProperties: false;
|
|
3483
3509
|
};
|
|
3510
|
+
sandbox: {
|
|
3511
|
+
type: "object";
|
|
3512
|
+
properties: {
|
|
3513
|
+
identifierExtractScript: {
|
|
3514
|
+
type: "string";
|
|
3515
|
+
maxLength: number;
|
|
3516
|
+
description: string;
|
|
3517
|
+
};
|
|
3518
|
+
messageExtractScript: {
|
|
3519
|
+
type: "string";
|
|
3520
|
+
maxLength: number;
|
|
3521
|
+
description: string;
|
|
3522
|
+
};
|
|
3523
|
+
};
|
|
3524
|
+
additionalProperties: false;
|
|
3525
|
+
};
|
|
3484
3526
|
url: {
|
|
3485
3527
|
type: "string";
|
|
3486
3528
|
maxLength: number;
|
|
@@ -8764,6 +8806,22 @@ export declare const state: {
|
|
|
8764
8806
|
additionalProperties: false;
|
|
8765
8807
|
};
|
|
8766
8808
|
};
|
|
8809
|
+
sandbox: {
|
|
8810
|
+
type: "object";
|
|
8811
|
+
properties: {
|
|
8812
|
+
identifierExtractScript: {
|
|
8813
|
+
type: "string";
|
|
8814
|
+
maxLength: number;
|
|
8815
|
+
nullable: true;
|
|
8816
|
+
};
|
|
8817
|
+
messageExtractScript: {
|
|
8818
|
+
type: "string";
|
|
8819
|
+
maxLength: number;
|
|
8820
|
+
nullable: true;
|
|
8821
|
+
};
|
|
8822
|
+
};
|
|
8823
|
+
additionalProperties: false;
|
|
8824
|
+
};
|
|
8767
8825
|
secrets: {
|
|
8768
8826
|
type: "object";
|
|
8769
8827
|
additionalProperties: {
|
|
@@ -9293,6 +9351,22 @@ export declare const state: {
|
|
|
9293
9351
|
additionalProperties: false;
|
|
9294
9352
|
};
|
|
9295
9353
|
};
|
|
9354
|
+
sandbox: {
|
|
9355
|
+
type: "object";
|
|
9356
|
+
properties: {
|
|
9357
|
+
identifierExtractScript: {
|
|
9358
|
+
type: "string";
|
|
9359
|
+
maxLength: number;
|
|
9360
|
+
nullable: true;
|
|
9361
|
+
};
|
|
9362
|
+
messageExtractScript: {
|
|
9363
|
+
type: "string";
|
|
9364
|
+
maxLength: number;
|
|
9365
|
+
nullable: true;
|
|
9366
|
+
};
|
|
9367
|
+
};
|
|
9368
|
+
additionalProperties: false;
|
|
9369
|
+
};
|
|
9296
9370
|
secrets: {
|
|
9297
9371
|
type: "object";
|
|
9298
9372
|
additionalProperties: {
|
|
@@ -9366,6 +9440,12 @@ export declare const state: {
|
|
|
9366
9440
|
description: string;
|
|
9367
9441
|
type: "string";
|
|
9368
9442
|
};
|
|
9443
|
+
limit: {
|
|
9444
|
+
in: "query";
|
|
9445
|
+
description: string;
|
|
9446
|
+
type: "number";
|
|
9447
|
+
required: false;
|
|
9448
|
+
};
|
|
9369
9449
|
name: {
|
|
9370
9450
|
type: "string";
|
|
9371
9451
|
description: string;
|
|
@@ -9376,6 +9456,51 @@ export declare const state: {
|
|
|
9376
9456
|
description: string;
|
|
9377
9457
|
in: "query";
|
|
9378
9458
|
};
|
|
9459
|
+
interfaceId: {
|
|
9460
|
+
type: "string";
|
|
9461
|
+
description: string;
|
|
9462
|
+
in: "query";
|
|
9463
|
+
};
|
|
9464
|
+
interfaceName: {
|
|
9465
|
+
type: "string";
|
|
9466
|
+
description: string;
|
|
9467
|
+
in: "query";
|
|
9468
|
+
};
|
|
9469
|
+
visibility: {
|
|
9470
|
+
type: "string";
|
|
9471
|
+
description: string;
|
|
9472
|
+
in: "query";
|
|
9473
|
+
enum: string[];
|
|
9474
|
+
};
|
|
9475
|
+
installedByBotId: {
|
|
9476
|
+
in: "query";
|
|
9477
|
+
description: string;
|
|
9478
|
+
type: "string";
|
|
9479
|
+
required: false;
|
|
9480
|
+
};
|
|
9481
|
+
verificationStatus: {
|
|
9482
|
+
type: "string";
|
|
9483
|
+
description: string;
|
|
9484
|
+
in: "query";
|
|
9485
|
+
enum: string[];
|
|
9486
|
+
};
|
|
9487
|
+
search: {
|
|
9488
|
+
type: "string";
|
|
9489
|
+
description: string;
|
|
9490
|
+
in: "query";
|
|
9491
|
+
};
|
|
9492
|
+
sortBy: {
|
|
9493
|
+
type: "string";
|
|
9494
|
+
description: string;
|
|
9495
|
+
in: "query";
|
|
9496
|
+
enum: string[];
|
|
9497
|
+
};
|
|
9498
|
+
direction: {
|
|
9499
|
+
type: "string";
|
|
9500
|
+
description: string;
|
|
9501
|
+
in: "query";
|
|
9502
|
+
enum: string[];
|
|
9503
|
+
};
|
|
9379
9504
|
dev: {
|
|
9380
9505
|
in: "query";
|
|
9381
9506
|
description: string;
|
|
@@ -9443,6 +9568,54 @@ export declare const state: {
|
|
|
9443
9568
|
enum: string[];
|
|
9444
9569
|
description: string;
|
|
9445
9570
|
};
|
|
9571
|
+
matchedOn: {
|
|
9572
|
+
type: "object";
|
|
9573
|
+
properties: {
|
|
9574
|
+
name: {
|
|
9575
|
+
type: "boolean";
|
|
9576
|
+
description: string;
|
|
9577
|
+
};
|
|
9578
|
+
title: {
|
|
9579
|
+
type: "boolean";
|
|
9580
|
+
description: string;
|
|
9581
|
+
};
|
|
9582
|
+
description: {
|
|
9583
|
+
type: "boolean";
|
|
9584
|
+
description: string;
|
|
9585
|
+
};
|
|
9586
|
+
actions: {
|
|
9587
|
+
type: "array";
|
|
9588
|
+
items: {
|
|
9589
|
+
type: "string";
|
|
9590
|
+
};
|
|
9591
|
+
description: string;
|
|
9592
|
+
};
|
|
9593
|
+
interfaces: {
|
|
9594
|
+
type: "array";
|
|
9595
|
+
items: {
|
|
9596
|
+
type: "string";
|
|
9597
|
+
};
|
|
9598
|
+
description: string;
|
|
9599
|
+
};
|
|
9600
|
+
};
|
|
9601
|
+
description: string;
|
|
9602
|
+
};
|
|
9603
|
+
ownerWorkspace: {
|
|
9604
|
+
type: "object";
|
|
9605
|
+
properties: {
|
|
9606
|
+
id: {
|
|
9607
|
+
type: "string";
|
|
9608
|
+
};
|
|
9609
|
+
handle: {
|
|
9610
|
+
type: "string";
|
|
9611
|
+
nullable: true;
|
|
9612
|
+
};
|
|
9613
|
+
name: {
|
|
9614
|
+
type: "string";
|
|
9615
|
+
};
|
|
9616
|
+
};
|
|
9617
|
+
required: string[];
|
|
9618
|
+
};
|
|
9446
9619
|
};
|
|
9447
9620
|
required: string[];
|
|
9448
9621
|
};
|
|
@@ -12494,6 +12667,190 @@ export declare const state: {
|
|
|
12494
12667
|
};
|
|
12495
12668
|
};
|
|
12496
12669
|
};
|
|
12670
|
+
createKnowledgeBase: {
|
|
12671
|
+
name: string;
|
|
12672
|
+
path: string;
|
|
12673
|
+
description: string;
|
|
12674
|
+
method: "post";
|
|
12675
|
+
requestBody: {
|
|
12676
|
+
description: string;
|
|
12677
|
+
schema: {
|
|
12678
|
+
type: "object";
|
|
12679
|
+
properties: {
|
|
12680
|
+
name: {
|
|
12681
|
+
type: "string";
|
|
12682
|
+
description: string;
|
|
12683
|
+
};
|
|
12684
|
+
};
|
|
12685
|
+
required: string[];
|
|
12686
|
+
title: string;
|
|
12687
|
+
additionalProperties: false;
|
|
12688
|
+
};
|
|
12689
|
+
};
|
|
12690
|
+
contentType: "application/json";
|
|
12691
|
+
section: "files";
|
|
12692
|
+
response: {
|
|
12693
|
+
description: string;
|
|
12694
|
+
schema: {
|
|
12695
|
+
type: "object";
|
|
12696
|
+
properties: {
|
|
12697
|
+
knowledgeBase: {
|
|
12698
|
+
type: "object";
|
|
12699
|
+
properties: {
|
|
12700
|
+
id: {
|
|
12701
|
+
type: "string";
|
|
12702
|
+
description: string;
|
|
12703
|
+
};
|
|
12704
|
+
name: {
|
|
12705
|
+
type: "string";
|
|
12706
|
+
description: string;
|
|
12707
|
+
};
|
|
12708
|
+
};
|
|
12709
|
+
required: string[];
|
|
12710
|
+
additionalProperties: false;
|
|
12711
|
+
};
|
|
12712
|
+
};
|
|
12713
|
+
required: string[];
|
|
12714
|
+
title: string;
|
|
12715
|
+
additionalProperties: false;
|
|
12716
|
+
};
|
|
12717
|
+
};
|
|
12718
|
+
parameters: {};
|
|
12719
|
+
};
|
|
12720
|
+
deleteKnowledgeBase: {
|
|
12721
|
+
name: string;
|
|
12722
|
+
path: string;
|
|
12723
|
+
description: string;
|
|
12724
|
+
method: "delete";
|
|
12725
|
+
section: "files";
|
|
12726
|
+
parameters: {
|
|
12727
|
+
id: {
|
|
12728
|
+
type: "string";
|
|
12729
|
+
description: string;
|
|
12730
|
+
in: "path";
|
|
12731
|
+
};
|
|
12732
|
+
};
|
|
12733
|
+
response: {
|
|
12734
|
+
description: string;
|
|
12735
|
+
schema: {
|
|
12736
|
+
type: "object";
|
|
12737
|
+
title: string;
|
|
12738
|
+
additionalProperties: false;
|
|
12739
|
+
};
|
|
12740
|
+
};
|
|
12741
|
+
};
|
|
12742
|
+
updateKnowledgeBase: {
|
|
12743
|
+
name: string;
|
|
12744
|
+
path: string;
|
|
12745
|
+
description: string;
|
|
12746
|
+
method: "put";
|
|
12747
|
+
section: "files";
|
|
12748
|
+
parameters: {
|
|
12749
|
+
id: {
|
|
12750
|
+
type: "string";
|
|
12751
|
+
description: string;
|
|
12752
|
+
in: "path";
|
|
12753
|
+
};
|
|
12754
|
+
};
|
|
12755
|
+
requestBody: {
|
|
12756
|
+
description: string;
|
|
12757
|
+
schema: {
|
|
12758
|
+
type: "object";
|
|
12759
|
+
properties: {
|
|
12760
|
+
name: {
|
|
12761
|
+
type: "string";
|
|
12762
|
+
description: string;
|
|
12763
|
+
};
|
|
12764
|
+
};
|
|
12765
|
+
required: string[];
|
|
12766
|
+
title: string;
|
|
12767
|
+
additionalProperties: false;
|
|
12768
|
+
};
|
|
12769
|
+
};
|
|
12770
|
+
contentType: "application/json";
|
|
12771
|
+
response: {
|
|
12772
|
+
description: string;
|
|
12773
|
+
schema: {
|
|
12774
|
+
type: "object";
|
|
12775
|
+
properties: {
|
|
12776
|
+
knowledgeBase: {
|
|
12777
|
+
type: "object";
|
|
12778
|
+
properties: {
|
|
12779
|
+
id: {
|
|
12780
|
+
type: "string";
|
|
12781
|
+
description: string;
|
|
12782
|
+
};
|
|
12783
|
+
name: {
|
|
12784
|
+
type: "string";
|
|
12785
|
+
description: string;
|
|
12786
|
+
};
|
|
12787
|
+
};
|
|
12788
|
+
required: string[];
|
|
12789
|
+
additionalProperties: false;
|
|
12790
|
+
};
|
|
12791
|
+
};
|
|
12792
|
+
required: string[];
|
|
12793
|
+
title: string;
|
|
12794
|
+
additionalProperties: false;
|
|
12795
|
+
};
|
|
12796
|
+
};
|
|
12797
|
+
};
|
|
12798
|
+
listKnowledgeBases: {
|
|
12799
|
+
name: string;
|
|
12800
|
+
path: string;
|
|
12801
|
+
description: string;
|
|
12802
|
+
method: "get";
|
|
12803
|
+
section: "files";
|
|
12804
|
+
parameters: {
|
|
12805
|
+
nextToken: {
|
|
12806
|
+
in: "query";
|
|
12807
|
+
description: string;
|
|
12808
|
+
type: "string";
|
|
12809
|
+
};
|
|
12810
|
+
};
|
|
12811
|
+
response: {
|
|
12812
|
+
description: string;
|
|
12813
|
+
schema: {
|
|
12814
|
+
type: "object";
|
|
12815
|
+
properties: {
|
|
12816
|
+
knowledgeBases: {
|
|
12817
|
+
type: "array";
|
|
12818
|
+
items: {
|
|
12819
|
+
type: "object";
|
|
12820
|
+
properties: {
|
|
12821
|
+
id: {
|
|
12822
|
+
type: "string";
|
|
12823
|
+
description: string;
|
|
12824
|
+
};
|
|
12825
|
+
name: {
|
|
12826
|
+
type: "string";
|
|
12827
|
+
description: string;
|
|
12828
|
+
};
|
|
12829
|
+
createdAt: {
|
|
12830
|
+
type: "string";
|
|
12831
|
+
description: string;
|
|
12832
|
+
};
|
|
12833
|
+
};
|
|
12834
|
+
required: string[];
|
|
12835
|
+
};
|
|
12836
|
+
};
|
|
12837
|
+
meta: {
|
|
12838
|
+
type: "object";
|
|
12839
|
+
properties: {
|
|
12840
|
+
nextToken: {
|
|
12841
|
+
type: "string";
|
|
12842
|
+
description: string;
|
|
12843
|
+
};
|
|
12844
|
+
};
|
|
12845
|
+
additionalProperties: false;
|
|
12846
|
+
};
|
|
12847
|
+
};
|
|
12848
|
+
required: string[];
|
|
12849
|
+
title: string;
|
|
12850
|
+
additionalProperties: false;
|
|
12851
|
+
};
|
|
12852
|
+
};
|
|
12853
|
+
};
|
|
12497
12854
|
listTables: {
|
|
12498
12855
|
name: string;
|
|
12499
12856
|
path: string;
|
|
@@ -13684,6 +14041,8 @@ export declare const state: {
|
|
|
13684
14041
|
upsertFileBody: true;
|
|
13685
14042
|
updateFileMetadataBody: true;
|
|
13686
14043
|
copyFileBody: true;
|
|
14044
|
+
createKnowledgeBaseBody: true;
|
|
14045
|
+
updateKnowledgeBaseBody: true;
|
|
13687
14046
|
getOrCreateTableBody: true;
|
|
13688
14047
|
createTableBody: true;
|
|
13689
14048
|
duplicateTableBody: true;
|
|
@@ -13836,6 +14195,10 @@ export declare const state: {
|
|
|
13836
14195
|
listFilePassagesResponse: true;
|
|
13837
14196
|
listFileTagsResponse: true;
|
|
13838
14197
|
listFileTagValuesResponse: true;
|
|
14198
|
+
createKnowledgeBaseResponse: true;
|
|
14199
|
+
deleteKnowledgeBaseResponse: true;
|
|
14200
|
+
updateKnowledgeBaseResponse: true;
|
|
14201
|
+
listKnowledgeBasesResponse: true;
|
|
13839
14202
|
listTablesResponse: true;
|
|
13840
14203
|
getTableResponse: true;
|
|
13841
14204
|
getOrCreateTableResponse: true;
|
|
@@ -14356,6 +14719,22 @@ export declare const state: {
|
|
|
14356
14719
|
description: string;
|
|
14357
14720
|
additionalProperties: false;
|
|
14358
14721
|
};
|
|
14722
|
+
sandbox: {
|
|
14723
|
+
type: "object";
|
|
14724
|
+
properties: {
|
|
14725
|
+
identifierExtractScript: {
|
|
14726
|
+
type: "string";
|
|
14727
|
+
maxLength: number;
|
|
14728
|
+
description: string;
|
|
14729
|
+
};
|
|
14730
|
+
messageExtractScript: {
|
|
14731
|
+
type: "string";
|
|
14732
|
+
maxLength: number;
|
|
14733
|
+
description: string;
|
|
14734
|
+
};
|
|
14735
|
+
};
|
|
14736
|
+
additionalProperties: false;
|
|
14737
|
+
};
|
|
14359
14738
|
url: {
|
|
14360
14739
|
type: "string";
|
|
14361
14740
|
maxLength: number;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@botpress/api",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.83.0",
|
|
4
4
|
"main": "dist/index.js",
|
|
5
5
|
"types": "dist/src/index.d.ts",
|
|
6
6
|
"scripts": {
|
|
@@ -23,6 +23,6 @@
|
|
|
23
23
|
"zod": "^3.22.4"
|
|
24
24
|
},
|
|
25
25
|
"dependencies": {
|
|
26
|
-
"@bpinternal/opapi": "0.12.
|
|
26
|
+
"@bpinternal/opapi": "0.12.2"
|
|
27
27
|
}
|
|
28
28
|
}
|
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","validateIntegrationCreation","updateIntegration","validateIntegrationUpdate","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."}]}
|
|
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","validateIntegrationCreation","updateIntegration","validateIntegrationUpdate","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","createKnowledgeBase","deleteKnowledgeBase","updateKnowledgeBase","listKnowledgeBases"],"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."}]}
|