@botpress/api 1.70.1 → 1.71.0

package/dist/index.js

@@ -279357,13 +279357,95 @@ var state = {
           "required": false
         }
       }
+    },
+    "captureObservation": {
+      "name": "captureObservation",
+      "description": "Capture a bot runtime observation. Does not support integration observations yet.",
+      "method": "post",
+      "path": "/v1/chat/observations",
+      "requestBody": {
+        "description": "Add an event to the analytics",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "name": {
+              "type": "string",
+              "description": "Name of the observation"
+            },
+            "data": {
+              "type": "object",
+              "additionalProperties": true,
+              "description": "Data of the observation"
+            },
+            "messageId": {
+              "type": "string",
+              "description": "ID of the message associated with the observation"
+            },
+            "eventId": {
+              "type": "string",
+              "description": "ID of the event associated with the observation"
+            },
+            "conversationId": {
+              "type": "string",
+              "description": "ID of the conversation associated with the observation"
+            },
+            "userId": {
+              "type": "string",
+              "description": "ID of the user associated with the observation"
+            },
+            "errorId": {
+              "type": "string",
+              "description": "ID of the error associated with the observation"
+            },
+            "traceId": {
+              "type": "string",
+              "description": "ID of the trace associated with the observation"
+            }
+          },
+          "required": [
+            "name",
+            "data"
+          ],
+          "title": "captureObservationBody",
+          "additionalProperties": false
+        }
+      },
+      "response": {
+        "description": "Success",
+        "status": 200,
+        "schema": {
+          "type": "object",
+          "title": "captureObservationResponse",
+          "additionalProperties": false
+        }
+      },
+      "parameters": {
+        "x-bot-id": {
+          "in": "header",
+          "description": "Bot id",
+          "type": "string",
+          "required": true
+        },
+        "x-integration-id": {
+          "in": "header",
+          "description": "Integration id",
+          "type": "string",
+          "required": false
+        },
+        "x-integration-alias": {
+          "in": "header",
+          "description": "Integration alias",
+          "type": "string",
+          "required": false
+        }
+      }
     }
   },
   "metadata": {
     "title": "Botpress Runtime API",
     "description": "API for Botpress Runtime",
     "server": "https://api.botpress.cloud",
-    "version": "1.70.1",
+    "version": "1.71.0",
     "prefix": "v1"
   },
   "defaultParameters": {
@@ -279545,7 +279627,8 @@ var state = {
       "createWorkflowBody": true,
       "updateWorkflowBody": true,
       "getOrCreateWorkflowBody": true,
-      "trackAnalyticsBody": true
+      "trackAnalyticsBody": true,
+      "captureObservationBody": true
     },
     "responses": {
       "createConversationResponse": true,
@@ -279595,7 +279678,8 @@ var state = {
       "listWorkflowsResponse": true,
       "getOrCreateWorkflowResponse": true,
       "listTagValuesResponse": true,
-      "trackAnalyticsResponse": true
+      "trackAnalyticsResponse": true,
+      "captureObservationResponse": true
     },
     "schemas": {
       "User": true,
@@ -295787,7 +295871,7 @@ var state2 = {
     "title": "Botpress Admin API",
     "description": "API for Botpress Cloud Manager",
     "server": "https://api.botpress.cloud",
-    "version": "1.70.1",
+    "version": "1.71.0",
     "prefix": "v1"
   },
   "defaultParameters": {
@@ -301296,7 +301380,7 @@ var state3 = {
     "title": "Botpress Files API",
     "description": "API for Botpress Files",
     "server": "https://api.botpress.cloud",
-    "version": "1.70.1",
+    "version": "1.71.0",
     "prefix": "v1"
   },
   "defaultParameters": {
@@ -303592,7 +303676,7 @@ var state4 = {
     "title": "Botpress Tables API",
     "description": "API for Botpress Tables",
     "server": "https://api.botpress.cloud",
-    "version": "1.70.1",
+    "version": "1.71.0",
     "prefix": "v1"
   },
   "defaultParameters": {
@@ -307370,6 +307454,69 @@ var state5 = {
       },
       "parameters": {}
     },
+    "captureObservation": {
+      "name": "captureObservation",
+      "description": "Capture a bot runtime observation. Does not support integration observations yet.",
+      "method": "post",
+      "path": "/v1/chat/observations",
+      "requestBody": {
+        "description": "Add an event to the analytics",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "name": {
+              "type": "string",
+              "description": "Name of the observation"
+            },
+            "data": {
+              "type": "object",
+              "additionalProperties": true,
+              "description": "Data of the observation"
+            },
+            "messageId": {
+              "type": "string",
+              "description": "ID of the message associated with the observation"
+            },
+            "eventId": {
+              "type": "string",
+              "description": "ID of the event associated with the observation"
+            },
+            "conversationId": {
+              "type": "string",
+              "description": "ID of the conversation associated with the observation"
+            },
+            "userId": {
+              "type": "string",
+              "description": "ID of the user associated with the observation"
+            },
+            "errorId": {
+              "type": "string",
+              "description": "ID of the error associated with the observation"
+            },
+            "traceId": {
+              "type": "string",
+              "description": "ID of the trace associated with the observation"
+            }
+          },
+          "required": [
+            "name",
+            "data"
+          ],
+          "title": "captureObservationBody",
+          "additionalProperties": false
+        }
+      },
+      "response": {
+        "description": "Success",
+        "status": 200,
+        "schema": {
+          "type": "object",
+          "title": "captureObservationResponse",
+          "additionalProperties": false
+        }
+      },
+      "parameters": {}
+    },
     "runVrl": {
       "name": "runVrl",
       "description": "Run a VRL script",
@@ -325003,7 +325150,7 @@ var state5 = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "1.70.1",
+    "version": "1.71.0",
     "prefix": "v1"
   },
   "errors": [
@@ -325166,6 +325313,7 @@ var state5 = {
       "updateWorkflowBody": true,
       "getOrCreateWorkflowBody": true,
       "trackAnalyticsBody": true,
+      "captureObservationBody": true,
       "runVrlBody": true,
       "updateAccountBody": true,
       "deleteAccountBody": true,
@@ -325266,6 +325414,7 @@ var state5 = {
       "getOrCreateWorkflowResponse": true,
       "listTagValuesResponse": true,
       "trackAnalyticsResponse": true,
+      "captureObservationResponse": true,
       "runVrlResponse": true,
       "getAccountResponse": true,
       "updateAccountResponse": true,
@@ -330282,7 +330431,7 @@ var state6 = {
     "title": "Botpress Billing Public API",
     "description": "API for Botpress Billing",
     "server": "https://api.botpress.cloud",
-    "version": "1.70.1",
+    "version": "1.71.0",
     "prefix": "v2"
   },
   "defaultParameters": {

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

@@ -3611,6 +3611,85 @@ export declare const state: {
                 };
             };
         };
+        captureObservation: {
+            name: string;
+            description: string;
+            method: "post";
+            path: string;
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        name: {
+                            type: "string";
+                            description: string;
+                        };
+                        data: {
+                            type: "object";
+                            additionalProperties: true;
+                            description: string;
+                        };
+                        messageId: {
+                            type: "string";
+                            description: string;
+                        };
+                        eventId: {
+                            type: "string";
+                            description: string;
+                        };
+                        conversationId: {
+                            type: "string";
+                            description: string;
+                        };
+                        userId: {
+                            type: "string";
+                            description: string;
+                        };
+                        errorId: {
+                            type: "string";
+                            description: string;
+                        };
+                        traceId: {
+                            type: "string";
+                            description: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            response: {
+                description: string;
+                status: 200;
+                schema: {
+                    type: "object";
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            parameters: {
+                "x-bot-id": {
+                    in: "header";
+                    description: string;
+                    type: "string";
+                    required: true;
+                };
+                "x-integration-id": {
+                    in: "header";
+                    description: string;
+                    type: "string";
+                    required: false;
+                };
+                "x-integration-alias": {
+                    in: "header";
+                    description: string;
+                    type: "string";
+                    required: false;
+                };
+            };
+        };
     };
     metadata: {
         title: string;
@@ -3720,6 +3799,7 @@ export declare const state: {
             updateWorkflowBody: true;
             getOrCreateWorkflowBody: true;
             trackAnalyticsBody: true;
+            captureObservationBody: true;
         };
         responses: {
             createConversationResponse: true;
@@ -3770,6 +3850,7 @@ export declare const state: {
             getOrCreateWorkflowResponse: true;
             listTagValuesResponse: true;
             trackAnalyticsResponse: true;
+            captureObservationResponse: true;
         };
         schemas: {
             User: true;

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

@@ -2732,6 +2732,66 @@ export declare const state: {
             };
             parameters: {};
         };
+        captureObservation: {
+            name: string;
+            description: string;
+            method: "post";
+            path: string;
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        name: {
+                            type: "string";
+                            description: string;
+                        };
+                        data: {
+                            type: "object";
+                            additionalProperties: true;
+                            description: string;
+                        };
+                        messageId: {
+                            type: "string";
+                            description: string;
+                        };
+                        eventId: {
+                            type: "string";
+                            description: string;
+                        };
+                        conversationId: {
+                            type: "string";
+                            description: string;
+                        };
+                        userId: {
+                            type: "string";
+                            description: string;
+                        };
+                        errorId: {
+                            type: "string";
+                            description: string;
+                        };
+                        traceId: {
+                            type: "string";
+                            description: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            response: {
+                description: string;
+                status: 200;
+                schema: {
+                    type: "object";
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            parameters: {};
+        };
         runVrl: {
             name: string;
             description: string;
@@ -18113,6 +18173,7 @@ export declare const state: {
             updateWorkflowBody: true;
             getOrCreateWorkflowBody: true;
             trackAnalyticsBody: true;
+            captureObservationBody: true;
             runVrlBody: true;
             updateAccountBody: true;
             deleteAccountBody: true;
@@ -18213,6 +18274,7 @@ export declare const state: {
             getOrCreateWorkflowResponse: true;
             listTagValuesResponse: true;
             trackAnalyticsResponse: true;
+            captureObservationResponse: true;
             runVrlResponse: true;
             getAccountResponse: true;
             updateAccountResponse: true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/api",
-  "version": "1.70.1",
+  "version": "1.71.0",
   "main": "dist/index.js",
   "types": "dist/src/index.d.ts",
   "devDependencies": {
@@ -8,11 +8,11 @@
     "esbuild": "0.27.1",
     "zod": "^3.24.4",
     "typescript": "5.9.3",
-    "@botpress/bridge": "1.8.0",
-    "@botpress/cloud-manager": "0.2.0",
     "@botpress/common": "0.5.0",
+    "@botpress/bridge": "1.8.0",
     "@botpress/files-api": "0.18.0",
     "@bpinternal/const": "0.4.2",
+    "@botpress/cloud-manager": "0.2.0",
     "@bpinternal/tables-api": "0.17.2",
     "@botpress/smaug": "1.0.0"
   },