@botpress/api 0.30.1 → 0.30.2
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 +46 -51
- package/dist/src/gen/state.d.ts +13 -23
- package/package.json +1 -1
- package/src/gen/metadata.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/state.ts +46 -51
package/dist/index.js
CHANGED
|
@@ -273484,19 +273484,19 @@ var state = {
|
|
|
273484
273484
|
},
|
|
273485
273485
|
"parameters": {}
|
|
273486
273486
|
},
|
|
273487
|
-
"
|
|
273488
|
-
"name": "
|
|
273487
|
+
"upsertFile": {
|
|
273488
|
+
"name": "upsertFile",
|
|
273489
273489
|
"path": "/v1/files",
|
|
273490
|
-
"description": "Creates a file
|
|
273491
|
-
"method": "
|
|
273490
|
+
"description": "Creates or updates a file using the `key` parameter as unique identifier. Updating a file will erase the existing content of the file. Upload the file content by sending it in a PUT request to the `uploadUrl` returned in the response.",
|
|
273491
|
+
"method": "put",
|
|
273492
273492
|
"requestBody": {
|
|
273493
|
-
"description": "
|
|
273493
|
+
"description": "Properties of the file to create or update.",
|
|
273494
273494
|
"schema": {
|
|
273495
273495
|
"type": "object",
|
|
273496
273496
|
"properties": {
|
|
273497
|
-
"
|
|
273497
|
+
"key": {
|
|
273498
273498
|
"type": "string",
|
|
273499
|
-
"description": "
|
|
273499
|
+
"description": "Unique key for the file. Must be unique across the bot (and the integration, when applicable)."
|
|
273500
273500
|
},
|
|
273501
273501
|
"tags": {
|
|
273502
273502
|
"type": "object",
|
|
@@ -273508,12 +273508,12 @@ var state = {
|
|
|
273508
273508
|
},
|
|
273509
273509
|
"size": {
|
|
273510
273510
|
"type": "number",
|
|
273511
|
-
"description": "File size in bytes. This will count against your
|
|
273511
|
+
"description": "File size in bytes. This will count against your File Storage quota. If the `index` parameter is set to `true`, this will also count against your Vector DB Storage quota."
|
|
273512
273512
|
},
|
|
273513
273513
|
"index": {
|
|
273514
273514
|
"default": false,
|
|
273515
273515
|
"type": "boolean",
|
|
273516
|
-
"description": "Set to a value of 'true' to index the file in vector storage. Only PDFs, Office documents, and text-based files are currently supported. Note that if a file is indexed, it will count towards the Vector Storage quota
|
|
273516
|
+
"description": "Set to a value of 'true' to index the file in vector storage. Only PDFs, Office documents, and text-based files are currently supported. Note that if a file is indexed, it will count towards both the Vector DB Storage quota and the File Storage quota of the workspace."
|
|
273517
273517
|
},
|
|
273518
273518
|
"accessPolicies": {
|
|
273519
273519
|
"type": "array",
|
|
@@ -273528,20 +273528,21 @@ var state = {
|
|
|
273528
273528
|
},
|
|
273529
273529
|
"contentType": {
|
|
273530
273530
|
"type": "string",
|
|
273531
|
-
"description": 'File content type. If omitted, the content type will be inferred from the file extension
|
|
273531
|
+
"description": 'File content type. If omitted, the content type will be inferred from the file extension (if any) specified in `key`. If a content type cannot be inferred, the default is "application/octet-stream".'
|
|
273532
273532
|
}
|
|
273533
273533
|
},
|
|
273534
273534
|
"required": [
|
|
273535
|
+
"key",
|
|
273535
273536
|
"size"
|
|
273536
273537
|
],
|
|
273537
|
-
"title": "
|
|
273538
|
+
"title": "upsertFileBody",
|
|
273538
273539
|
"additionalProperties": false
|
|
273539
273540
|
}
|
|
273540
273541
|
},
|
|
273541
273542
|
"contentType": "application/json",
|
|
273542
273543
|
"section": "files",
|
|
273543
273544
|
"response": {
|
|
273544
|
-
"description": "The created file",
|
|
273545
|
+
"description": "The created or updated file",
|
|
273545
273546
|
"schema": {
|
|
273546
273547
|
"type": "object",
|
|
273547
273548
|
"properties": {
|
|
@@ -273556,10 +273557,9 @@ var state = {
|
|
|
273556
273557
|
"type": "string",
|
|
273557
273558
|
"description": "The ID of the bot the file belongs to"
|
|
273558
273559
|
},
|
|
273559
|
-
"
|
|
273560
|
+
"key": {
|
|
273560
273561
|
"type": "string",
|
|
273561
|
-
"description": "
|
|
273562
|
-
"nullable": true
|
|
273562
|
+
"description": "Unique key for the file. Must be unique across the bot (and the integration, when applicable)."
|
|
273563
273563
|
},
|
|
273564
273564
|
"size": {
|
|
273565
273565
|
"type": "number",
|
|
@@ -273625,7 +273625,7 @@ var state = {
|
|
|
273625
273625
|
"required": [
|
|
273626
273626
|
"id",
|
|
273627
273627
|
"botId",
|
|
273628
|
-
"
|
|
273628
|
+
"key",
|
|
273629
273629
|
"size",
|
|
273630
273630
|
"contentType",
|
|
273631
273631
|
"tags",
|
|
@@ -273642,7 +273642,7 @@ var state = {
|
|
|
273642
273642
|
"required": [
|
|
273643
273643
|
"file"
|
|
273644
273644
|
],
|
|
273645
|
-
"title": "
|
|
273645
|
+
"title": "upsertFileResponse",
|
|
273646
273646
|
"additionalProperties": false
|
|
273647
273647
|
}
|
|
273648
273648
|
},
|
|
@@ -273712,10 +273712,9 @@ var state = {
|
|
|
273712
273712
|
"type": "string",
|
|
273713
273713
|
"description": "The ID of the bot the file belongs to"
|
|
273714
273714
|
},
|
|
273715
|
-
"
|
|
273715
|
+
"key": {
|
|
273716
273716
|
"type": "string",
|
|
273717
|
-
"description": "
|
|
273718
|
-
"nullable": true
|
|
273717
|
+
"description": "Unique key for the file. Must be unique across the bot (and the integration, when applicable)."
|
|
273719
273718
|
},
|
|
273720
273719
|
"url": {
|
|
273721
273720
|
"type": "string",
|
|
@@ -273782,7 +273781,7 @@ var state = {
|
|
|
273782
273781
|
"required": [
|
|
273783
273782
|
"id",
|
|
273784
273783
|
"botId",
|
|
273785
|
-
"
|
|
273784
|
+
"key",
|
|
273786
273785
|
"url",
|
|
273787
273786
|
"size",
|
|
273788
273787
|
"contentType",
|
|
@@ -273844,10 +273843,9 @@ var state = {
|
|
|
273844
273843
|
"type": "string",
|
|
273845
273844
|
"description": "The ID of the bot the file belongs to"
|
|
273846
273845
|
},
|
|
273847
|
-
"
|
|
273846
|
+
"key": {
|
|
273848
273847
|
"type": "string",
|
|
273849
|
-
"description": "
|
|
273850
|
-
"nullable": true
|
|
273848
|
+
"description": "Unique key for the file. Must be unique across the bot (and the integration, when applicable)."
|
|
273851
273849
|
},
|
|
273852
273850
|
"url": {
|
|
273853
273851
|
"type": "string",
|
|
@@ -273914,7 +273912,7 @@ var state = {
|
|
|
273914
273912
|
"required": [
|
|
273915
273913
|
"id",
|
|
273916
273914
|
"botId",
|
|
273917
|
-
"
|
|
273915
|
+
"key",
|
|
273918
273916
|
"url",
|
|
273919
273917
|
"size",
|
|
273920
273918
|
"contentType",
|
|
@@ -273936,10 +273934,10 @@ var state = {
|
|
|
273936
273934
|
}
|
|
273937
273935
|
}
|
|
273938
273936
|
},
|
|
273939
|
-
"
|
|
273940
|
-
"name": "
|
|
273937
|
+
"updateFileMetadata": {
|
|
273938
|
+
"name": "updateFileMetadata",
|
|
273941
273939
|
"path": "/v1/files/{id}",
|
|
273942
|
-
"description": "Update file",
|
|
273940
|
+
"description": "Update file metadata, without updating the file content.",
|
|
273943
273941
|
"method": "put",
|
|
273944
273942
|
"section": "files",
|
|
273945
273943
|
"parameters": {
|
|
@@ -273975,7 +273973,7 @@ var state = {
|
|
|
273975
273973
|
"description": "New access policies to set for the file. Omit to keep existing policies intact."
|
|
273976
273974
|
}
|
|
273977
273975
|
},
|
|
273978
|
-
"title": "
|
|
273976
|
+
"title": "updateFileMetadataBody",
|
|
273979
273977
|
"additionalProperties": false
|
|
273980
273978
|
}
|
|
273981
273979
|
},
|
|
@@ -273995,10 +273993,9 @@ var state = {
|
|
|
273995
273993
|
"type": "string",
|
|
273996
273994
|
"description": "The ID of the bot the file belongs to"
|
|
273997
273995
|
},
|
|
273998
|
-
"
|
|
273996
|
+
"key": {
|
|
273999
273997
|
"type": "string",
|
|
274000
|
-
"description": "
|
|
274001
|
-
"nullable": true
|
|
273998
|
+
"description": "Unique key for the file. Must be unique across the bot (and the integration, when applicable)."
|
|
274002
273999
|
},
|
|
274003
274000
|
"url": {
|
|
274004
274001
|
"type": "string",
|
|
@@ -274065,7 +274062,7 @@ var state = {
|
|
|
274065
274062
|
"required": [
|
|
274066
274063
|
"id",
|
|
274067
274064
|
"botId",
|
|
274068
|
-
"
|
|
274065
|
+
"key",
|
|
274069
274066
|
"url",
|
|
274070
274067
|
"size",
|
|
274071
274068
|
"contentType",
|
|
@@ -274082,7 +274079,7 @@ var state = {
|
|
|
274082
274079
|
"required": [
|
|
274083
274080
|
"file"
|
|
274084
274081
|
],
|
|
274085
|
-
"title": "
|
|
274082
|
+
"title": "updateFileMetadataResponse",
|
|
274086
274083
|
"additionalProperties": false
|
|
274087
274084
|
}
|
|
274088
274085
|
}
|
|
@@ -274147,11 +274144,6 @@ var state = {
|
|
|
274147
274144
|
"type": "string",
|
|
274148
274145
|
"description": "File ID"
|
|
274149
274146
|
},
|
|
274150
|
-
"name": {
|
|
274151
|
-
"type": "string",
|
|
274152
|
-
"description": "File name",
|
|
274153
|
-
"nullable": true
|
|
274154
|
-
},
|
|
274155
274147
|
"tags": {
|
|
274156
274148
|
"type": "object",
|
|
274157
274149
|
"additionalProperties": {
|
|
@@ -274171,7 +274163,6 @@ var state = {
|
|
|
274171
274163
|
},
|
|
274172
274164
|
"required": [
|
|
274173
274165
|
"id",
|
|
274174
|
-
"name",
|
|
274175
274166
|
"tags",
|
|
274176
274167
|
"createdAt",
|
|
274177
274168
|
"updatedAt"
|
|
@@ -275095,7 +275086,7 @@ var state = {
|
|
|
275095
275086
|
"title": "Botpress API",
|
|
275096
275087
|
"description": "API for Botpress Cloud",
|
|
275097
275088
|
"server": "https://api.botpress.cloud",
|
|
275098
|
-
"version": "0.30.
|
|
275089
|
+
"version": "0.30.2",
|
|
275099
275090
|
"prefix": "v1"
|
|
275100
275091
|
},
|
|
275101
275092
|
"errors": [
|
|
@@ -275169,6 +275160,11 @@ var state = {
|
|
|
275169
275160
|
"type": "ReferenceConstraint",
|
|
275170
275161
|
"description": "The resource cannot be deleted because it's referenced by another resource"
|
|
275171
275162
|
},
|
|
275163
|
+
{
|
|
275164
|
+
"status": 409,
|
|
275165
|
+
"type": "ResourceLockedConflict",
|
|
275166
|
+
"description": "The resource is current locked and cannot be operated on until the lock is released."
|
|
275167
|
+
},
|
|
275172
275168
|
{
|
|
275173
275169
|
"status": 400,
|
|
275174
275170
|
"type": "ReferenceNotFound",
|
|
@@ -275256,8 +275252,8 @@ var state = {
|
|
|
275256
275252
|
"updateIntegrationBody": true,
|
|
275257
275253
|
"changeAISpendQuotaBody": true,
|
|
275258
275254
|
"introspectBody": true,
|
|
275259
|
-
"
|
|
275260
|
-
"
|
|
275255
|
+
"upsertFileBody": true,
|
|
275256
|
+
"updateFileMetadataBody": true,
|
|
275261
275257
|
"getOrCreateTableBody": true,
|
|
275262
275258
|
"createTableBody": true,
|
|
275263
275259
|
"duplicateTableBody": true,
|
|
@@ -275370,11 +275366,11 @@ var state = {
|
|
|
275370
275366
|
"changeAISpendQuotaResponse": true,
|
|
275371
275367
|
"listActivitiesResponse": true,
|
|
275372
275368
|
"introspectResponse": true,
|
|
275373
|
-
"
|
|
275369
|
+
"upsertFileResponse": true,
|
|
275374
275370
|
"deleteFileResponse": true,
|
|
275375
275371
|
"listFilesResponse": true,
|
|
275376
275372
|
"getFileResponse": true,
|
|
275377
|
-
"
|
|
275373
|
+
"updateFileMetadataResponse": true,
|
|
275378
275374
|
"searchFilesResponse": true,
|
|
275379
275375
|
"listTablesResponse": true,
|
|
275380
275376
|
"getTableResponse": true,
|
|
@@ -277630,10 +277626,9 @@ var state = {
|
|
|
277630
277626
|
"type": "string",
|
|
277631
277627
|
"description": "The ID of the bot the file belongs to"
|
|
277632
277628
|
},
|
|
277633
|
-
"
|
|
277629
|
+
"key": {
|
|
277634
277630
|
"type": "string",
|
|
277635
|
-
"description": "
|
|
277636
|
-
"nullable": true
|
|
277631
|
+
"description": "Unique key for the file. Must be unique across the bot (and the integration, when applicable)."
|
|
277637
277632
|
},
|
|
277638
277633
|
"url": {
|
|
277639
277634
|
"type": "string",
|
|
@@ -277700,7 +277695,7 @@ var state = {
|
|
|
277700
277695
|
"required": [
|
|
277701
277696
|
"id",
|
|
277702
277697
|
"botId",
|
|
277703
|
-
"
|
|
277698
|
+
"key",
|
|
277704
277699
|
"url",
|
|
277705
277700
|
"size",
|
|
277706
277701
|
"contentType",
|
|
@@ -277977,11 +277972,11 @@ var state = {
|
|
|
277977
277972
|
"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 Office, HTML, CSV, 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.",
|
|
277978
277973
|
"name": "files",
|
|
277979
277974
|
"operations": [
|
|
277980
|
-
"
|
|
277975
|
+
"upsertFile",
|
|
277981
277976
|
"deleteFile",
|
|
277982
277977
|
"listFiles",
|
|
277983
277978
|
"getFile",
|
|
277984
|
-
"
|
|
277979
|
+
"updateFileMetadata",
|
|
277985
277980
|
"searchFiles"
|
|
277986
277981
|
],
|
|
277987
277982
|
"schema": "File"
|
package/dist/src/gen/state.d.ts
CHANGED
|
@@ -7543,17 +7543,17 @@ export declare const state: {
|
|
|
7543
7543
|
};
|
|
7544
7544
|
parameters: {};
|
|
7545
7545
|
};
|
|
7546
|
-
|
|
7546
|
+
upsertFile: {
|
|
7547
7547
|
name: string;
|
|
7548
7548
|
path: string;
|
|
7549
7549
|
description: string;
|
|
7550
|
-
method: "
|
|
7550
|
+
method: "put";
|
|
7551
7551
|
requestBody: {
|
|
7552
7552
|
description: string;
|
|
7553
7553
|
schema: {
|
|
7554
7554
|
type: "object";
|
|
7555
7555
|
properties: {
|
|
7556
|
-
|
|
7556
|
+
key: {
|
|
7557
7557
|
type: "string";
|
|
7558
7558
|
description: string;
|
|
7559
7559
|
};
|
|
@@ -7610,10 +7610,9 @@ export declare const state: {
|
|
|
7610
7610
|
type: "string";
|
|
7611
7611
|
description: string;
|
|
7612
7612
|
};
|
|
7613
|
-
|
|
7613
|
+
key: {
|
|
7614
7614
|
type: "string";
|
|
7615
7615
|
description: string;
|
|
7616
|
-
nullable: true;
|
|
7617
7616
|
};
|
|
7618
7617
|
size: {
|
|
7619
7618
|
type: "number";
|
|
@@ -7741,10 +7740,9 @@ export declare const state: {
|
|
|
7741
7740
|
type: "string";
|
|
7742
7741
|
description: string;
|
|
7743
7742
|
};
|
|
7744
|
-
|
|
7743
|
+
key: {
|
|
7745
7744
|
type: "string";
|
|
7746
7745
|
description: string;
|
|
7747
|
-
nullable: true;
|
|
7748
7746
|
};
|
|
7749
7747
|
url: {
|
|
7750
7748
|
type: "string";
|
|
@@ -7847,10 +7845,9 @@ export declare const state: {
|
|
|
7847
7845
|
type: "string";
|
|
7848
7846
|
description: string;
|
|
7849
7847
|
};
|
|
7850
|
-
|
|
7848
|
+
key: {
|
|
7851
7849
|
type: "string";
|
|
7852
7850
|
description: string;
|
|
7853
|
-
nullable: true;
|
|
7854
7851
|
};
|
|
7855
7852
|
url: {
|
|
7856
7853
|
type: "string";
|
|
@@ -7914,7 +7911,7 @@ export declare const state: {
|
|
|
7914
7911
|
};
|
|
7915
7912
|
};
|
|
7916
7913
|
};
|
|
7917
|
-
|
|
7914
|
+
updateFileMetadata: {
|
|
7918
7915
|
name: string;
|
|
7919
7916
|
path: string;
|
|
7920
7917
|
description: string;
|
|
@@ -7970,10 +7967,9 @@ export declare const state: {
|
|
|
7970
7967
|
type: "string";
|
|
7971
7968
|
description: string;
|
|
7972
7969
|
};
|
|
7973
|
-
|
|
7970
|
+
key: {
|
|
7974
7971
|
type: "string";
|
|
7975
7972
|
description: string;
|
|
7976
|
-
nullable: true;
|
|
7977
7973
|
};
|
|
7978
7974
|
url: {
|
|
7979
7975
|
type: "string";
|
|
@@ -8097,11 +8093,6 @@ export declare const state: {
|
|
|
8097
8093
|
type: "string";
|
|
8098
8094
|
description: string;
|
|
8099
8095
|
};
|
|
8100
|
-
name: {
|
|
8101
|
-
type: "string";
|
|
8102
|
-
description: string;
|
|
8103
|
-
nullable: true;
|
|
8104
|
-
};
|
|
8105
8096
|
tags: {
|
|
8106
8097
|
type: "object";
|
|
8107
8098
|
additionalProperties: {
|
|
@@ -9065,8 +9056,8 @@ export declare const state: {
|
|
|
9065
9056
|
updateIntegrationBody: true;
|
|
9066
9057
|
changeAISpendQuotaBody: true;
|
|
9067
9058
|
introspectBody: true;
|
|
9068
|
-
|
|
9069
|
-
|
|
9059
|
+
upsertFileBody: true;
|
|
9060
|
+
updateFileMetadataBody: true;
|
|
9070
9061
|
getOrCreateTableBody: true;
|
|
9071
9062
|
createTableBody: true;
|
|
9072
9063
|
duplicateTableBody: true;
|
|
@@ -9179,11 +9170,11 @@ export declare const state: {
|
|
|
9179
9170
|
changeAISpendQuotaResponse: true;
|
|
9180
9171
|
listActivitiesResponse: true;
|
|
9181
9172
|
introspectResponse: true;
|
|
9182
|
-
|
|
9173
|
+
upsertFileResponse: true;
|
|
9183
9174
|
deleteFileResponse: true;
|
|
9184
9175
|
listFilesResponse: true;
|
|
9185
9176
|
getFileResponse: true;
|
|
9186
|
-
|
|
9177
|
+
updateFileMetadataResponse: true;
|
|
9187
9178
|
searchFilesResponse: true;
|
|
9188
9179
|
listTablesResponse: true;
|
|
9189
9180
|
getTableResponse: true;
|
|
@@ -11041,10 +11032,9 @@ export declare const state: {
|
|
|
11041
11032
|
type: "string";
|
|
11042
11033
|
description: string;
|
|
11043
11034
|
};
|
|
11044
|
-
|
|
11035
|
+
key: {
|
|
11045
11036
|
type: "string";
|
|
11046
11037
|
description: string;
|
|
11047
|
-
nullable: true;
|
|
11048
11038
|
};
|
|
11049
11039
|
url: {
|
|
11050
11040
|
type: "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":"File","name":"file","operations":[]},{"description":"","title":"State","name":"state","operations":["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"},{"title":"Bot","description":"","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics","getBotIssue","listBotIssues","deleteBotIssue","listBotIssueEvents"],"schema":"Bot"},{"title":"Integration","description":"","name":"integration","operations":["listIntegrationApiKeys","createIntegrationApiKey","deleteIntegrationApiKey","createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration"],"schema":"Integration"},{"title":"Workspace","description":"","name":"workspace","operations":["setWorkspacePaymentMethod","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"],"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","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 Office, HTML, CSV, 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":["
|
|
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":"File","name":"file","operations":[]},{"description":"","title":"State","name":"state","operations":["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"},{"title":"Bot","description":"","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics","getBotIssue","listBotIssues","deleteBotIssue","listBotIssueEvents"],"schema":"Bot"},{"title":"Integration","description":"","name":"integration","operations":["listIntegrationApiKeys","createIntegrationApiKey","deleteIntegrationApiKey","createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration"],"schema":"Integration"},{"title":"Workspace","description":"","name":"workspace","operations":["setWorkspacePaymentMethod","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"],"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","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 Office, HTML, CSV, 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","searchFiles"],"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."}]}
|