@botpress/api 0.30.1 → 0.30.3

package/dist/index.js

@@ -271549,6 +271549,13 @@ var state = {
                       "administrator",
                       "owner"
                     ]
+                  },
+                  "profilePicture": {
+                    "type": "string"
+                  },
+                  "displayName": {
+                    "type": "string",
+                    "maxLength": 100
                   }
                 },
                 "required": [
@@ -271613,6 +271620,13 @@ var state = {
                 "administrator",
                 "owner"
               ]
+            },
+            "profilePicture": {
+              "type": "string"
+            },
+            "displayName": {
+              "type": "string",
+              "maxLength": 100
             }
           },
           "required": [
@@ -271712,6 +271726,13 @@ var state = {
                 "administrator",
                 "owner"
               ]
+            },
+            "profilePicture": {
+              "type": "string"
+            },
+            "displayName": {
+              "type": "string",
+              "maxLength": 100
             }
           },
           "required": [
@@ -271788,6 +271809,13 @@ var state = {
                 "administrator",
                 "owner"
               ]
+            },
+            "profilePicture": {
+              "type": "string"
+            },
+            "displayName": {
+              "type": "string",
+              "maxLength": 100
             }
           },
           "required": [
@@ -273484,19 +273512,19 @@ var state = {
       },
       "parameters": {}
     },
-    "createFile": {
-      "name": "createFile",
+    "upsertFile": {
+      "name": "upsertFile",
       "path": "/v1/files",
-      "description": "Creates a file. Once the file is created, use the uploadUrl from the response body to upload the file content, using a PUT request.",
-      "method": "post",
+      "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.",
+      "method": "put",
       "requestBody": {
-        "description": "The file to upload.",
+        "description": "Properties of the file to create or update.",
         "schema": {
           "type": "object",
           "properties": {
-            "name": {
+            "key": {
               "type": "string",
-              "description": "File name"
+              "description": "Unique key for the file. Must be unique across the bot (and the integration, when applicable)."
             },
             "tags": {
               "type": "object",
@@ -273508,12 +273536,12 @@ var state = {
             },
             "size": {
               "type": "number",
-              "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 database storage quota."
+              "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."
             },
             "index": {
               "default": false,
               "type": "boolean",
-              "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 of the workspace rather than the File Storage quota."
+              "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."
             },
             "accessPolicies": {
               "type": "array",
@@ -273528,20 +273556,21 @@ var state = {
             },
             "contentType": {
               "type": "string",
-              "description": 'File content type. If omitted, the content type will be inferred from the file extension. If a type cannot be inferred, the default is "application/octet-stream".'
+              "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".'
             }
           },
           "required": [
+            "key",
             "size"
           ],
-          "title": "createFileBody",
+          "title": "upsertFileBody",
           "additionalProperties": false
         }
       },
       "contentType": "application/json",
       "section": "files",
       "response": {
-        "description": "The created file",
+        "description": "The created or updated file",
         "schema": {
           "type": "object",
           "properties": {
@@ -273556,10 +273585,9 @@ var state = {
                   "type": "string",
                   "description": "The ID of the bot the file belongs to"
                 },
-                "name": {
+                "key": {
                   "type": "string",
-                  "description": "File name",
-                  "nullable": true
+                  "description": "Unique key for the file. Must be unique across the bot (and the integration, when applicable)."
                 },
                 "size": {
                   "type": "number",
@@ -273625,7 +273653,7 @@ var state = {
               "required": [
                 "id",
                 "botId",
-                "name",
+                "key",
                 "size",
                 "contentType",
                 "tags",
@@ -273642,7 +273670,7 @@ var state = {
           "required": [
             "file"
           ],
-          "title": "createFileResponse",
+          "title": "upsertFileResponse",
           "additionalProperties": false
         }
       },
@@ -273712,10 +273740,9 @@ var state = {
                     "type": "string",
                     "description": "The ID of the bot the file belongs to"
                   },
-                  "name": {
+                  "key": {
                     "type": "string",
-                    "description": "File name",
-                    "nullable": true
+                    "description": "Unique key for the file. Must be unique across the bot (and the integration, when applicable)."
                   },
                   "url": {
                     "type": "string",
@@ -273782,7 +273809,7 @@ var state = {
                 "required": [
                   "id",
                   "botId",
-                  "name",
+                  "key",
                   "url",
                   "size",
                   "contentType",
@@ -273844,10 +273871,9 @@ var state = {
                   "type": "string",
                   "description": "The ID of the bot the file belongs to"
                 },
-                "name": {
+                "key": {
                   "type": "string",
-                  "description": "File name",
-                  "nullable": true
+                  "description": "Unique key for the file. Must be unique across the bot (and the integration, when applicable)."
                 },
                 "url": {
                   "type": "string",
@@ -273914,7 +273940,7 @@ var state = {
               "required": [
                 "id",
                 "botId",
-                "name",
+                "key",
                 "url",
                 "size",
                 "contentType",
@@ -273936,10 +273962,10 @@ var state = {
         }
       }
     },
-    "updateFile": {
-      "name": "updateFile",
+    "updateFileMetadata": {
+      "name": "updateFileMetadata",
       "path": "/v1/files/{id}",
-      "description": "Update file",
+      "description": "Update file metadata, without updating the file content.",
       "method": "put",
       "section": "files",
       "parameters": {
@@ -273975,7 +274001,7 @@ var state = {
               "description": "New access policies to set for the file. Omit to keep existing policies intact."
             }
           },
-          "title": "updateFileBody",
+          "title": "updateFileMetadataBody",
           "additionalProperties": false
         }
       },
@@ -273995,10 +274021,9 @@ var state = {
                   "type": "string",
                   "description": "The ID of the bot the file belongs to"
                 },
-                "name": {
+                "key": {
                   "type": "string",
-                  "description": "File name",
-                  "nullable": true
+                  "description": "Unique key for the file. Must be unique across the bot (and the integration, when applicable)."
                 },
                 "url": {
                   "type": "string",
@@ -274065,7 +274090,7 @@ var state = {
               "required": [
                 "id",
                 "botId",
-                "name",
+                "key",
                 "url",
                 "size",
                 "contentType",
@@ -274082,7 +274107,7 @@ var state = {
           "required": [
             "file"
           ],
-          "title": "updateFileResponse",
+          "title": "updateFileMetadataResponse",
           "additionalProperties": false
         }
       }
@@ -274147,11 +274172,6 @@ var state = {
                         "type": "string",
                         "description": "File ID"
                       },
-                      "name": {
-                        "type": "string",
-                        "description": "File name",
-                        "nullable": true
-                      },
                       "tags": {
                         "type": "object",
                         "additionalProperties": {
@@ -274171,7 +274191,6 @@ var state = {
                     },
                     "required": [
                       "id",
-                      "name",
                       "tags",
                       "createdAt",
                       "updatedAt"
@@ -275095,7 +275114,7 @@ var state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "0.30.1",
+    "version": "0.30.3",
     "prefix": "v1"
   },
   "errors": [
@@ -275169,6 +275188,11 @@ var state = {
       "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",
@@ -275256,8 +275280,8 @@ var state = {
       "updateIntegrationBody": true,
       "changeAISpendQuotaBody": true,
       "introspectBody": true,
-      "createFileBody": true,
-      "updateFileBody": true,
+      "upsertFileBody": true,
+      "updateFileMetadataBody": true,
       "getOrCreateTableBody": true,
       "createTableBody": true,
       "duplicateTableBody": true,
@@ -275370,11 +275394,11 @@ var state = {
       "changeAISpendQuotaResponse": true,
       "listActivitiesResponse": true,
       "introspectResponse": true,
-      "createFileResponse": true,
+      "upsertFileResponse": true,
       "deleteFileResponse": true,
       "listFilesResponse": true,
       "getFileResponse": true,
-      "updateFileResponse": true,
+      "updateFileMetadataResponse": true,
       "searchFilesResponse": true,
       "listTablesResponse": true,
       "getTableResponse": true,
@@ -276556,6 +276580,13 @@ var state = {
               "administrator",
               "owner"
             ]
+          },
+          "profilePicture": {
+            "type": "string"
+          },
+          "displayName": {
+            "type": "string",
+            "maxLength": 100
           }
         },
         "required": [
@@ -277630,10 +277661,9 @@ var state = {
             "type": "string",
             "description": "The ID of the bot the file belongs to"
           },
-          "name": {
+          "key": {
             "type": "string",
-            "description": "File name",
-            "nullable": true
+            "description": "Unique key for the file. Must be unique across the bot (and the integration, when applicable)."
           },
           "url": {
             "type": "string",
@@ -277700,7 +277730,7 @@ var state = {
         "required": [
           "id",
           "botId",
-          "name",
+          "key",
           "url",
           "size",
           "contentType",
@@ -277977,11 +278007,11 @@ var state = {
       "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": [
-        "createFile",
+        "upsertFile",
         "deleteFile",
         "listFiles",
         "getFile",
-        "updateFile",
+        "updateFileMetadata",
         "searchFiles"
       ],
       "schema": "File"

package/dist/src/gen/state.d.ts

@@ -5834,6 +5834,13 @@ export declare const state: {
                                         type: "string";
                                         enum: string[];
                                     };
+                                    profilePicture: {
+                                        type: "string";
+                                    };
+                                    displayName: {
+                                        type: "string";
+                                        maxLength: number;
+                                    };
                                 };
                                 required: string[];
                             };
@@ -5883,6 +5890,13 @@ export declare const state: {
                             type: "string";
                             enum: string[];
                         };
+                        profilePicture: {
+                            type: "string";
+                        };
+                        displayName: {
+                            type: "string";
+                            maxLength: number;
+                        };
                     };
                     required: string[];
                     title: string;
@@ -5960,6 +5974,13 @@ export declare const state: {
                             type: "string";
                             enum: string[];
                         };
+                        profilePicture: {
+                            type: "string";
+                        };
+                        displayName: {
+                            type: "string";
+                            maxLength: number;
+                        };
                     };
                     required: string[];
                     title: string;
@@ -6017,6 +6038,13 @@ export declare const state: {
                             type: "string";
                             enum: string[];
                         };
+                        profilePicture: {
+                            type: "string";
+                        };
+                        displayName: {
+                            type: "string";
+                            maxLength: number;
+                        };
                     };
                     required: string[];
                     title: string;
@@ -7543,17 +7571,17 @@ export declare const state: {
             };
             parameters: {};
         };
-        createFile: {
+        upsertFile: {
             name: string;
             path: string;
             description: string;
-            method: "post";
+            method: "put";
             requestBody: {
                 description: string;
                 schema: {
                     type: "object";
                     properties: {
-                        name: {
+                        key: {
                             type: "string";
                             description: string;
                         };
@@ -7610,10 +7638,9 @@ export declare const state: {
                                     type: "string";
                                     description: string;
                                 };
-                                name: {
+                                key: {
                                     type: "string";
                                     description: string;
-                                    nullable: true;
                                 };
                                 size: {
                                     type: "number";
@@ -7741,10 +7768,9 @@ export declare const state: {
                                         type: "string";
                                         description: string;
                                     };
-                                    name: {
+                                    key: {
                                         type: "string";
                                         description: string;
-                                        nullable: true;
                                     };
                                     url: {
                                         type: "string";
@@ -7847,10 +7873,9 @@ export declare const state: {
                                     type: "string";
                                     description: string;
                                 };
-                                name: {
+                                key: {
                                     type: "string";
                                     description: string;
-                                    nullable: true;
                                 };
                                 url: {
                                     type: "string";
@@ -7914,7 +7939,7 @@ export declare const state: {
                 };
             };
         };
-        updateFile: {
+        updateFileMetadata: {
             name: string;
             path: string;
             description: string;
@@ -7970,10 +7995,9 @@ export declare const state: {
                                     type: "string";
                                     description: string;
                                 };
-                                name: {
+                                key: {
                                     type: "string";
                                     description: string;
-                                    nullable: true;
                                 };
                                 url: {
                                     type: "string";
@@ -8097,11 +8121,6 @@ export declare const state: {
                                                 type: "string";
                                                 description: string;
                                             };
-                                            name: {
-                                                type: "string";
-                                                description: string;
-                                                nullable: true;
-                                            };
                                             tags: {
                                                 type: "object";
                                                 additionalProperties: {
@@ -9065,8 +9084,8 @@ export declare const state: {
             updateIntegrationBody: true;
             changeAISpendQuotaBody: true;
             introspectBody: true;
-            createFileBody: true;
-            updateFileBody: true;
+            upsertFileBody: true;
+            updateFileMetadataBody: true;
             getOrCreateTableBody: true;
             createTableBody: true;
             duplicateTableBody: true;
@@ -9179,11 +9198,11 @@ export declare const state: {
             changeAISpendQuotaResponse: true;
             listActivitiesResponse: true;
             introspectResponse: true;
-            createFileResponse: true;
+            upsertFileResponse: true;
             deleteFileResponse: true;
             listFilesResponse: true;
             getFileResponse: true;
-            updateFileResponse: true;
+            updateFileMetadataResponse: true;
             searchFilesResponse: true;
             listTablesResponse: true;
             getTableResponse: true;
@@ -10180,6 +10199,13 @@ export declare const state: {
                         type: "string";
                         enum: string[];
                     };
+                    profilePicture: {
+                        type: "string";
+                    };
+                    displayName: {
+                        type: "string";
+                        maxLength: number;
+                    };
                 };
                 required: string[];
                 additionalProperties: false;
@@ -11041,10 +11067,9 @@ export declare const state: {
                         type: "string";
                         description: string;
                     };
-                    name: {
+                    key: {
                         type: "string";
                         description: string;
-                        nullable: true;
                     };
                     url: {
                         type: "string";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/api",
-  "version": "0.30.1",
+  "version": "0.30.3",
   "main": "dist/index.js",
   "types": "dist/src/index.d.ts",
   "scripts": {

package/src/gen/metadata.json

@@ -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":["createFile","deleteFile","listFiles","getFile","updateFile","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":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."}]}
+{"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."}]}