@botpress/api 1.28.1 → 1.29.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.
@@ -668,6 +668,10 @@ export declare const state: {
668
668
  };
669
669
  additionalProperties: false;
670
670
  };
671
+ maxExecutionTime: {
672
+ type: "number";
673
+ description: string;
674
+ };
671
675
  url: {
672
676
  type: "string";
673
677
  maxLength: number;
@@ -1304,6 +1308,10 @@ export declare const state: {
1304
1308
  };
1305
1309
  additionalProperties: false;
1306
1310
  };
1311
+ maxExecutionTime: {
1312
+ type: "number";
1313
+ description: string;
1314
+ };
1307
1315
  url: {
1308
1316
  type: "string";
1309
1317
  maxLength: number;
@@ -4053,6 +4061,10 @@ export declare const state: {
4053
4061
  blocked: {
4054
4062
  type: "boolean";
4055
4063
  };
4064
+ maxExecutionTime: {
4065
+ type: "integer";
4066
+ description: string;
4067
+ };
4056
4068
  alwaysAlive: {
4057
4069
  type: "boolean";
4058
4070
  description: string;
@@ -7046,6 +7058,72 @@ export declare const state: {
7046
7058
  };
7047
7059
  };
7048
7060
  };
7061
+ setWorkspacePreference: {
7062
+ name: string;
7063
+ description: string;
7064
+ method: "post";
7065
+ path: string;
7066
+ section: "workspace";
7067
+ disableDefaultParameters: {
7068
+ "x-workspace-id": boolean;
7069
+ };
7070
+ parameters: {
7071
+ key: {
7072
+ type: "string";
7073
+ description: string;
7074
+ in: "path";
7075
+ };
7076
+ };
7077
+ requestBody: {
7078
+ description: string;
7079
+ schema: {
7080
+ type: "object";
7081
+ properties: {
7082
+ value: {};
7083
+ };
7084
+ title: string;
7085
+ additionalProperties: false;
7086
+ };
7087
+ };
7088
+ response: {
7089
+ description: string;
7090
+ schema: {
7091
+ type: "object";
7092
+ title: string;
7093
+ additionalProperties: false;
7094
+ };
7095
+ };
7096
+ };
7097
+ getWorkspacePreference: {
7098
+ name: string;
7099
+ description: string;
7100
+ method: "get";
7101
+ path: string;
7102
+ section: "workspace";
7103
+ disableDefaultParameters: {
7104
+ "x-workspace-id": boolean;
7105
+ };
7106
+ parameters: {
7107
+ key: {
7108
+ type: "string";
7109
+ description: string;
7110
+ in: "path";
7111
+ };
7112
+ };
7113
+ response: {
7114
+ description: string;
7115
+ schema: {
7116
+ type: "object";
7117
+ properties: {
7118
+ value: {
7119
+ nullable: true;
7120
+ };
7121
+ };
7122
+ title: string;
7123
+ additionalProperties: false;
7124
+ };
7125
+ };
7126
+ };
7049
7127
  listWorkspaceMembers: {
7050
7128
  name: string;
7051
7129
  description: string;
@@ -7896,8 +7974,18 @@ export declare const state: {
7896
7974
  additionalProperties: false;
7897
7975
  };
7898
7976
  };
7899
- messageStatusChangeNotificationsEnabled: {
7900
- type: "boolean";
7977
+ extraOperations: {
7978
+ type: "object";
7979
+ additionalProperties: {
7980
+ type: "object";
7981
+ properties: {
7982
+ enabled: {
7983
+ type: "boolean";
7984
+ };
7985
+ };
7986
+ required: string[];
7987
+ additionalProperties: false;
7988
+ };
7901
7989
  description: string;
7902
7990
  };
7903
7991
  secrets: {
@@ -8447,8 +8535,18 @@ export declare const state: {
8447
8535
  additionalProperties: false;
8448
8536
  };
8449
8537
  };
8450
- messageStatusChangeNotificationsEnabled: {
8451
- type: "boolean";
8538
+ extraOperations: {
8539
+ type: "object";
8540
+ additionalProperties: {
8541
+ type: "object";
8542
+ properties: {
8543
+ enabled: {
8544
+ type: "boolean";
8545
+ };
8546
+ };
8547
+ required: string[];
8548
+ additionalProperties: false;
8549
+ };
8452
8550
  description: string;
8453
8551
  };
8454
8552
  secrets: {
@@ -8611,8 +8709,18 @@ export declare const state: {
8611
8709
  };
8612
8710
  description: string;
8613
8711
  };
8614
- messageStatusChangeNotificationsEnabled: {
8615
- type: "boolean";
8712
+ extraOperations: {
8713
+ type: "object";
8714
+ additionalProperties: {
8715
+ type: "object";
8716
+ properties: {
8717
+ enabled: {
8718
+ type: "boolean";
8719
+ };
8720
+ };
8721
+ required: string[];
8722
+ additionalProperties: false;
8723
+ };
8616
8724
  description: string;
8617
8725
  };
8618
8726
  channels: {
@@ -8724,6 +8832,10 @@ export declare const state: {
8724
8832
  additionalProperties: false;
8725
8833
  };
8726
8834
  };
8835
+ maxExecutionTime: {
8836
+ type: "integer";
8837
+ description: string;
8838
+ };
8727
8839
  identifier: {
8728
8840
  type: "object";
8729
8841
  properties: {
@@ -9169,8 +9281,18 @@ export declare const state: {
9169
9281
  };
9170
9282
  description: string;
9171
9283
  };
9172
- messageStatusChangeNotificationsEnabled: {
9173
- type: "boolean";
9284
+ extraOperations: {
9285
+ type: "object";
9286
+ additionalProperties: {
9287
+ type: "object";
9288
+ properties: {
9289
+ enabled: {
9290
+ type: "boolean";
9291
+ };
9292
+ };
9293
+ required: string[];
9294
+ additionalProperties: false;
9295
+ };
9174
9296
  description: string;
9175
9297
  };
9176
9298
  channels: {
@@ -9282,6 +9404,10 @@ export declare const state: {
9282
9404
  additionalProperties: false;
9283
9405
  };
9284
9406
  };
9407
+ maxExecutionTime: {
9408
+ type: "integer";
9409
+ description: string;
9410
+ };
9285
9411
  identifier: {
9286
9412
  type: "object";
9287
9413
  properties: {
@@ -12106,6 +12232,7 @@ export declare const state: {
12106
12232
  createWorkspaceBody: true;
12107
12233
  updateWorkspaceBody: true;
12108
12234
  checkHandleAvailabilityBody: true;
12235
+ setWorkspacePreferenceBody: true;
12109
12236
  createWorkspaceMemberBody: true;
12110
12237
  updateWorkspaceMemberBody: true;
12111
12238
  createIntegrationApiKeyBody: true;
@@ -12186,6 +12313,8 @@ export declare const state: {
12186
12313
  listPublicWorkspacesResponse: true;
12187
12314
  deleteWorkspaceResponse: true;
12188
12315
  getAuditRecordsResponse: true;
12316
+ setWorkspacePreferenceResponse: true;
12317
+ getWorkspacePreferenceResponse: true;
12189
12318
  listWorkspaceMembersResponse: true;
12190
12319
  getWorkspaceMemberResponse: true;
12191
12320
  deleteWorkspaceMemberResponse: true;
@@ -12463,6 +12592,10 @@ export declare const state: {
12463
12592
  };
12464
12593
  description: string;
12465
12594
  };
12595
+ maxExecutionTime: {
12596
+ type: "number";
12597
+ description: string;
12598
+ };
12466
12599
  user: {
12467
12600
  type: "object";
12468
12601
  properties: {
@@ -12850,6 +12983,10 @@ export declare const state: {
12850
12983
  };
12851
12984
  additionalProperties: false;
12852
12985
  };
12986
+ maxExecutionTime: {
12987
+ type: "number";
12988
+ description: string;
12989
+ };
12853
12990
  url: {
12854
12991
  type: "string";
12855
12992
  maxLength: number;
@@ -1794,6 +1794,10 @@ export declare const state: {
1794
1794
  };
1795
1795
  description: string;
1796
1796
  };
1797
+ maxExecutionTime: {
1798
+ type: "number";
1799
+ description: string;
1800
+ };
1797
1801
  user: {
1798
1802
  type: "object";
1799
1803
  properties: {
@@ -2181,6 +2185,10 @@ export declare const state: {
2181
2185
  };
2182
2186
  additionalProperties: false;
2183
2187
  };
2188
+ maxExecutionTime: {
2189
+ type: "number";
2190
+ description: string;
2191
+ };
2184
2192
  url: {
2185
2193
  type: "string";
2186
2194
  maxLength: number;
@@ -2712,6 +2712,10 @@ export declare const state: {
2712
2712
  };
2713
2713
  description: string;
2714
2714
  };
2715
+ maxExecutionTime: {
2716
+ type: "number";
2717
+ description: string;
2718
+ };
2715
2719
  user: {
2716
2720
  type: "object";
2717
2721
  properties: {
@@ -3099,6 +3103,10 @@ export declare const state: {
3099
3103
  };
3100
3104
  additionalProperties: false;
3101
3105
  };
3106
+ maxExecutionTime: {
3107
+ type: "number";
3108
+ description: string;
3109
+ };
3102
3110
  url: {
3103
3111
  type: "string";
3104
3112
  maxLength: number;
@@ -3015,6 +3015,10 @@ export declare const state: {
3015
3015
  };
3016
3016
  additionalProperties: false;
3017
3017
  };
3018
+ maxExecutionTime: {
3019
+ type: "number";
3020
+ description: string;
3021
+ };
3018
3022
  url: {
3019
3023
  type: "string";
3020
3024
  maxLength: number;
@@ -3651,6 +3655,10 @@ export declare const state: {
3651
3655
  };
3652
3656
  additionalProperties: false;
3653
3657
  };
3658
+ maxExecutionTime: {
3659
+ type: "number";
3660
+ description: string;
3661
+ };
3654
3662
  url: {
3655
3663
  type: "string";
3656
3664
  maxLength: number;
@@ -6400,6 +6408,10 @@ export declare const state: {
6400
6408
  blocked: {
6401
6409
  type: "boolean";
6402
6410
  };
6411
+ maxExecutionTime: {
6412
+ type: "integer";
6413
+ description: string;
6414
+ };
6403
6415
  alwaysAlive: {
6404
6416
  type: "boolean";
6405
6417
  description: string;
@@ -9393,6 +9405,72 @@ export declare const state: {
9393
9405
  };
9394
9406
  };
9395
9407
  };
9408
+ setWorkspacePreference: {
9409
+ name: string;
9410
+ description: string;
9411
+ method: "post";
9412
+ path: string;
9413
+ section: "workspace";
9414
+ disableDefaultParameters: {
9415
+ "x-workspace-id": boolean;
9416
+ };
9417
+ parameters: {
9418
+ key: {
9419
+ type: "string";
9420
+ description: string;
9421
+ in: "path";
9422
+ };
9423
+ };
9424
+ requestBody: {
9425
+ description: string;
9426
+ schema: {
9427
+ type: "object";
9428
+ properties: {
9429
+ value: {};
9430
+ };
9431
+ title: string;
9432
+ additionalProperties: false;
9433
+ };
9434
+ };
9435
+ response: {
9436
+ description: string;
9437
+ schema: {
9438
+ type: "object";
9439
+ title: string;
9440
+ additionalProperties: false;
9441
+ };
9442
+ };
9443
+ };
9444
+ getWorkspacePreference: {
9445
+ name: string;
9446
+ description: string;
9447
+ method: "get";
9448
+ path: string;
9449
+ section: "workspace";
9450
+ disableDefaultParameters: {
9451
+ "x-workspace-id": boolean;
9452
+ };
9453
+ parameters: {
9454
+ key: {
9455
+ type: "string";
9456
+ description: string;
9457
+ in: "path";
9458
+ };
9459
+ };
9460
+ response: {
9461
+ description: string;
9462
+ schema: {
9463
+ type: "object";
9464
+ properties: {
9465
+ value: {
9466
+ nullable: true;
9467
+ };
9468
+ };
9469
+ title: string;
9470
+ additionalProperties: false;
9471
+ };
9472
+ };
9473
+ };
9396
9474
  listWorkspaceMembers: {
9397
9475
  name: string;
9398
9476
  description: string;
@@ -10244,8 +10322,18 @@ export declare const state: {
10244
10322
  additionalProperties: false;
10245
10323
  };
10246
10324
  };
10247
- messageStatusChangeNotificationsEnabled: {
10248
- type: "boolean";
10325
+ extraOperations: {
10326
+ type: "object";
10327
+ additionalProperties: {
10328
+ type: "object";
10329
+ properties: {
10330
+ enabled: {
10331
+ type: "boolean";
10332
+ };
10333
+ };
10334
+ required: string[];
10335
+ additionalProperties: false;
10336
+ };
10249
10337
  description: string;
10250
10338
  };
10251
10339
  secrets: {
@@ -10795,8 +10883,18 @@ export declare const state: {
10795
10883
  additionalProperties: false;
10796
10884
  };
10797
10885
  };
10798
- messageStatusChangeNotificationsEnabled: {
10799
- type: "boolean";
10886
+ extraOperations: {
10887
+ type: "object";
10888
+ additionalProperties: {
10889
+ type: "object";
10890
+ properties: {
10891
+ enabled: {
10892
+ type: "boolean";
10893
+ };
10894
+ };
10895
+ required: string[];
10896
+ additionalProperties: false;
10897
+ };
10800
10898
  description: string;
10801
10899
  };
10802
10900
  secrets: {
@@ -10959,8 +11057,18 @@ export declare const state: {
10959
11057
  };
10960
11058
  description: string;
10961
11059
  };
10962
- messageStatusChangeNotificationsEnabled: {
10963
- type: "boolean";
11060
+ extraOperations: {
11061
+ type: "object";
11062
+ additionalProperties: {
11063
+ type: "object";
11064
+ properties: {
11065
+ enabled: {
11066
+ type: "boolean";
11067
+ };
11068
+ };
11069
+ required: string[];
11070
+ additionalProperties: false;
11071
+ };
10964
11072
  description: string;
10965
11073
  };
10966
11074
  channels: {
@@ -11072,6 +11180,10 @@ export declare const state: {
11072
11180
  additionalProperties: false;
11073
11181
  };
11074
11182
  };
11183
+ maxExecutionTime: {
11184
+ type: "integer";
11185
+ description: string;
11186
+ };
11075
11187
  identifier: {
11076
11188
  type: "object";
11077
11189
  properties: {
@@ -11517,8 +11629,18 @@ export declare const state: {
11517
11629
  };
11518
11630
  description: string;
11519
11631
  };
11520
- messageStatusChangeNotificationsEnabled: {
11521
- type: "boolean";
11632
+ extraOperations: {
11633
+ type: "object";
11634
+ additionalProperties: {
11635
+ type: "object";
11636
+ properties: {
11637
+ enabled: {
11638
+ type: "boolean";
11639
+ };
11640
+ };
11641
+ required: string[];
11642
+ additionalProperties: false;
11643
+ };
11522
11644
  description: string;
11523
11645
  };
11524
11646
  channels: {
@@ -11630,6 +11752,10 @@ export declare const state: {
11630
11752
  additionalProperties: false;
11631
11753
  };
11632
11754
  };
11755
+ maxExecutionTime: {
11756
+ type: "integer";
11757
+ description: string;
11758
+ };
11633
11759
  identifier: {
11634
11760
  type: "object";
11635
11761
  properties: {
@@ -17034,6 +17160,7 @@ export declare const state: {
17034
17160
  createWorkspaceBody: true;
17035
17161
  updateWorkspaceBody: true;
17036
17162
  checkHandleAvailabilityBody: true;
17163
+ setWorkspacePreferenceBody: true;
17037
17164
  createWorkspaceMemberBody: true;
17038
17165
  updateWorkspaceMemberBody: true;
17039
17166
  createIntegrationApiKeyBody: true;
@@ -17176,6 +17303,8 @@ export declare const state: {
17176
17303
  listPublicWorkspacesResponse: true;
17177
17304
  deleteWorkspaceResponse: true;
17178
17305
  getAuditRecordsResponse: true;
17306
+ setWorkspacePreferenceResponse: true;
17307
+ getWorkspacePreferenceResponse: true;
17179
17308
  listWorkspaceMembersResponse: true;
17180
17309
  getWorkspaceMemberResponse: true;
17181
17310
  deleteWorkspaceMemberResponse: true;
@@ -17485,6 +17614,10 @@ export declare const state: {
17485
17614
  };
17486
17615
  description: string;
17487
17616
  };
17617
+ maxExecutionTime: {
17618
+ type: "number";
17619
+ description: string;
17620
+ };
17488
17621
  user: {
17489
17622
  type: "object";
17490
17623
  properties: {
@@ -17872,6 +18005,10 @@ export declare const state: {
17872
18005
  };
17873
18006
  additionalProperties: false;
17874
18007
  };
18008
+ maxExecutionTime: {
18009
+ type: "number";
18010
+ description: string;
18011
+ };
17875
18012
  url: {
17876
18013
  type: "string";
17877
18014
  maxLength: number;
@@ -1406,6 +1406,10 @@ export declare const state: {
1406
1406
  };
1407
1407
  description: string;
1408
1408
  };
1409
+ maxExecutionTime: {
1410
+ type: "number";
1411
+ description: string;
1412
+ };
1409
1413
  user: {
1410
1414
  type: "object";
1411
1415
  properties: {
@@ -1793,6 +1797,10 @@ export declare const state: {
1793
1797
  };
1794
1798
  additionalProperties: false;
1795
1799
  };
1800
+ maxExecutionTime: {
1801
+ type: "number";
1802
+ description: string;
1803
+ };
1796
1804
  url: {
1797
1805
  type: "string";
1798
1806
  maxLength: number;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "1.28.1",
3
+ "version": "1.29.0",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/src/index.d.ts",
6
6
  "scripts": {
@@ -1 +1 @@
1
- {"sections":[{"description":"","title":"User","name":"user","operations":[],"schema":"User"},{"description":"","title":"Conversation","name":"conversation","operations":[],"schema":"Conversation"},{"description":"","title":"Event","name":"event","operations":[],"schema":"Event"},{"description":"","title":"Message","name":"message","operations":[],"schema":"Message"},{"description":"","title":"State","name":"state","operations":[],"schema":"State"},{"title":"Hub","description":"","name":"hub","operations":["listPublicIntegrations","getPublicIntegrationById","getPublicIntegration","listPublicPlugins","getPublicPluginById","getDereferencedPublicPluginById","getPublicPlugin","getPublicPluginCode","listPublicInterfaces","getPublicInterfaceById","getPublicInterface"]},{"description":"","title":"Action","name":"action","operations":[]},{"description":"","title":"Task","name":"task","operations":[],"schema":"Task"},{"description":"","title":"Workflow","name":"workflow","operations":[],"schema":"Workflow"},{"description":"","title":"Tag","name":"tag","operations":[]},{"title":"Bot","description":"","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics","listActionRuns","getBotIssue","listBotIssues","deleteBotIssue","listBotIssueEvents","listBotVersions","getBotVersion","getBotJson","publishFromBotJson","createBotVersion","deployBotVersion","createIntegrationShareableId","deleteIntegrationShareableId","getIntegrationShareableId","unlinkSandboxedConversations","listBotApiKeys","createBotApiKey","deleteBotApiKey"],"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","getDereferencedPlugin","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","deleteAccount","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":[],"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":[],"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":[],"schema":"User"},{"description":"","title":"Conversation","name":"conversation","operations":[],"schema":"Conversation"},{"description":"","title":"Event","name":"event","operations":[],"schema":"Event"},{"description":"","title":"Message","name":"message","operations":[],"schema":"Message"},{"description":"","title":"State","name":"state","operations":[],"schema":"State"},{"title":"Hub","description":"","name":"hub","operations":["listPublicIntegrations","getPublicIntegrationById","getPublicIntegration","listPublicPlugins","getPublicPluginById","getDereferencedPublicPluginById","getPublicPlugin","getPublicPluginCode","listPublicInterfaces","getPublicInterfaceById","getPublicInterface"]},{"description":"","title":"Action","name":"action","operations":[]},{"description":"","title":"Task","name":"task","operations":[],"schema":"Task"},{"description":"","title":"Workflow","name":"workflow","operations":[],"schema":"Workflow"},{"description":"","title":"Tag","name":"tag","operations":[]},{"title":"Bot","description":"","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics","listActionRuns","getBotIssue","listBotIssues","deleteBotIssue","listBotIssueEvents","listBotVersions","getBotVersion","getBotJson","publishFromBotJson","createBotVersion","deployBotVersion","createIntegrationShareableId","deleteIntegrationShareableId","getIntegrationShareableId","unlinkSandboxedConversations","listBotApiKeys","createBotApiKey","deleteBotApiKey"],"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","getDereferencedPlugin","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","setWorkspacePreference","getWorkspacePreference"],"schema":"Workspace"},{"title":"Workspace Member","description":"","name":"workspaceMember","operations":["listWorkspaceMembers","getWorkspaceMember","deleteWorkspaceMember","createWorkspaceMember","updateWorkspaceMember"],"schema":"WorkspaceMember"},{"title":"Account","description":"","name":"account","operations":["getAccount","updateAccount","deleteAccount","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":[],"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":[],"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."}]}