@breign/client 1.0.0 → 1.0.2

package/dist/openapi.json

@@ -0,0 +1,1668 @@
+{
+  "openapi" : "3.0.1",
+  "info" : {
+    "description" : "Api ands models for brain-app and brain-app",
+    "title" : "brain-client",
+    "version" : "0.0.0-SNAPSHOT"
+  },
+  "servers" : [ {
+    "description" : "Generated server url",
+    "url" : "http://localhost:8080/brain-client"
+  } ],
+  "tags" : [ {
+    "description" : "Brain management endpoints",
+    "name" : "brain"
+  } ],
+  "paths" : {
+    "/brains" : {
+      "get" : {
+        "description" : "Get all brains (admin only)",
+        "operationId" : "getBrains",
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "items" : {
+                    "$ref" : "#/components/schemas/Brain"
+                  },
+                  "type" : "array"
+                }
+              }
+            },
+            "description" : "Brains retrieved successfully"
+          }
+        },
+        "security" : [ {
+          "ApiKeyAuth" : [ ]
+        } ],
+        "summary" : "Get all brains",
+        "tags" : [ "brain" ]
+      },
+      "post" : {
+        "description" : "Creates a new brain with specified configuration (admin only)",
+        "operationId" : "createBrain",
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/BrainRequest"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "201" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/Brain"
+                }
+              }
+            },
+            "description" : "Brain created successfully"
+          },
+          "400" : {
+            "description" : "Invalid request body"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User is not an admin"
+          }
+        },
+        "security" : [ {
+          "ApiKeyAuth" : [ ]
+        } ],
+        "summary" : "Create a new brain",
+        "tags" : [ "brain" ]
+      }
+    },
+    "/brains/{brainId}" : {
+      "delete" : {
+        "description" : "Deletes a brain and all its associated agents",
+        "operationId" : "deleteBrainById",
+        "parameters" : [ {
+          "description" : "ID of the brain",
+          "in" : "path",
+          "name" : "brainId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "204" : {
+            "description" : "Brain deleted successfully"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User doesn't have access to this brain"
+          },
+          "404" : {
+            "description" : "Brain not found"
+          }
+        },
+        "security" : [ {
+          "ApiKeyAuth" : [ ]
+        } ],
+        "summary" : "Delete a brain",
+        "tags" : [ "brain" ]
+      },
+      "get" : {
+        "operationId" : "getBrainById",
+        "parameters" : [ {
+          "description" : "ID of the brain",
+          "in" : "path",
+          "name" : "brainId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/Brain"
+                }
+              }
+            },
+            "description" : "Brain details"
+          },
+          "404" : {
+            "description" : "Brain not found"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User cannot access this brain"
+          }
+        },
+        "security" : [ {
+          "ApiKeyAuth" : [ ]
+        } ],
+        "summary" : "Get a specific brain by ID",
+        "tags" : [ "brain" ]
+      },
+      "patch" : {
+        "description" : "Updates an existing brain's properties",
+        "operationId" : "updateBrainById",
+        "parameters" : [ {
+          "description" : "ID of the brain",
+          "in" : "path",
+          "name" : "brainId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/BrainPatch"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/BrainPatch"
+                }
+              }
+            },
+            "description" : "Brain updated successfully"
+          },
+          "400" : {
+            "description" : "Invalid request body or flow not found"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User doesn't have access to this brain"
+          },
+          "404" : {
+            "description" : "Brain not found"
+          },
+          "500" : {
+            "description" : "Brain not found after update (server error)"
+          }
+        },
+        "security" : [ {
+          "ApiKeyAuth" : [ ]
+        } ],
+        "summary" : "Update a brain",
+        "tags" : [ "brain" ]
+      }
+    },
+    "/brains/{brainId}/modules" : {
+      "get" : {
+        "description" : "Retrieves all modules for a specific brain",
+        "operationId" : "getModules",
+        "parameters" : [ {
+          "description" : "ID of the brain",
+          "in" : "path",
+          "name" : "brainId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/BrainModule"
+                }
+              }
+            },
+            "description" : "Brain modules retrieved successfully"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User doesn't have access to this brain"
+          },
+          "404" : {
+            "description" : "Brain not found"
+          },
+          "500" : {
+            "description" : "Internal server error"
+          }
+        },
+        "security" : [ {
+          "ApiKeyAuth" : [ ]
+        } ],
+        "summary" : "Get brain modules",
+        "tags" : [ "brain" ]
+      },
+      "post" : {
+        "description" : "Adds a new module to the specified brain",
+        "operationId" : "addModule",
+        "parameters" : [ {
+          "description" : "ID of the brain",
+          "in" : "path",
+          "name" : "brainId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/BrainModule"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "201" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/BrainModule"
+                }
+              }
+            },
+            "description" : "Module added successfully"
+          },
+          "400" : {
+            "description" : "Invalid request body or module configuration"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User doesn't have access to this brain"
+          },
+          "404" : {
+            "description" : "Brain not found"
+          },
+          "500" : {
+            "description" : "Internal server error"
+          }
+        },
+        "security" : [ {
+          "ApiKeyAuth" : [ ]
+        } ],
+        "summary" : "Add a module to a brain",
+        "tags" : [ "brain" ]
+      }
+    },
+    "/brains/{brainId}/modules/{moduleName}" : {
+      "delete" : {
+        "description" : "Deletes a specific module from the brain",
+        "operationId" : "deleteModule",
+        "parameters" : [ {
+          "description" : "ID of the brain",
+          "in" : "path",
+          "name" : "brainId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "description" : "Name of the module to remove",
+          "in" : "path",
+          "name" : "moduleName",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "204" : {
+            "description" : "Module removed successfully"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User doesn't have access to this brain"
+          },
+          "404" : {
+            "description" : "Brain or module not found"
+          },
+          "500" : {
+            "description" : "Internal server error"
+          }
+        },
+        "security" : [ {
+          "ApiKeyAuth" : [ ]
+        } ],
+        "summary" : "Remove a module from a brain",
+        "tags" : [ "brain" ]
+      }
+    },
+    "/brains/{brainId}/metrics/overview" : {
+      "get" : {
+        "description" : "Retrieves usage metrics overview for a specific brain",
+        "operationId" : "getBrainMetricsOverview",
+        "parameters" : [ {
+          "description" : "ID of the brain",
+          "in" : "path",
+          "name" : "brainId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "description" : "Start date for metrics (ISO format)",
+          "in" : "query",
+          "name" : "startDate",
+          "schema" : {
+            "format" : "date-time",
+            "type" : "string"
+          }
+        }, {
+          "description" : "End date for metrics (ISO format)",
+          "in" : "query",
+          "name" : "endDate",
+          "schema" : {
+            "format" : "date-time",
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/BrainMetricsOverview"
+                }
+              }
+            },
+            "description" : "Metrics overview retrieved successfully"
+          },
+          "400" : {
+            "description" : "Invalid date format"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User doesn't have access to this brain"
+          },
+          "404" : {
+            "description" : "Brain not found"
+          },
+          "500" : {
+            "description" : "Internal server error"
+          }
+        },
+        "security" : [ {
+          "ApiKeyAuth" : [ ]
+        } ],
+        "summary" : "Get brain metrics overview",
+        "tags" : [ "brain" ]
+      }
+    },
+    "/brains/{brainId}/metrics" : {
+      "get" : {
+        "description" : "Retrieves detailed usage metrics for a specific brain (admin only)",
+        "operationId" : "getBrainMetrics",
+        "parameters" : [ {
+          "description" : "ID of the brain",
+          "in" : "path",
+          "name" : "brainId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "description" : "Start date for metrics (ISO format)",
+          "in" : "query",
+          "name" : "startDate",
+          "schema" : {
+            "format" : "date-time",
+            "type" : "string"
+          }
+        }, {
+          "description" : "End date for metrics (ISO format)",
+          "in" : "query",
+          "name" : "endDate",
+          "schema" : {
+            "format" : "date-time",
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "items" : {
+                    "$ref" : "#/components/schemas/BrainUsageMetrics"
+                  },
+                  "type" : "array"
+                }
+              }
+            },
+            "description" : "Detailed metrics retrieved successfully"
+          },
+          "400" : {
+            "description" : "Invalid date format"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User is not an admin"
+          },
+          "500" : {
+            "description" : "Internal server error"
+          }
+        },
+        "security" : [ {
+          "ApiKeyAuth" : [ ]
+        } ],
+        "summary" : "Get detailed brain metrics",
+        "tags" : [ "brain" ]
+      }
+    },
+    "/brains/{brainId}/metrics/events" : {
+      "get" : {
+        "description" : "Retrieves detailed metric events for a specific brain (admin only)",
+        "operationId" : "getBrainMetricsEvents",
+        "parameters" : [ {
+          "description" : "ID of the brain",
+          "in" : "path",
+          "name" : "brainId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "description" : "Number of events to skip",
+          "in" : "query",
+          "name" : "offset",
+          "schema" : {
+            "minimum" : 0,
+            "type" : "integer"
+          }
+        }, {
+          "description" : "Start date for metrics (ISO format)",
+          "in" : "query",
+          "name" : "startDate",
+          "schema" : {
+            "format" : "date-time",
+            "type" : "string"
+          }
+        }, {
+          "description" : "End date for metrics (ISO format)",
+          "in" : "query",
+          "name" : "endDate",
+          "schema" : {
+            "format" : "date-time",
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "items" : {
+                    "$ref" : "#/components/schemas/BrainMetricsEvent"
+                  },
+                  "type" : "array"
+                }
+              }
+            },
+            "description" : "Metric events retrieved successfully"
+          },
+          "400" : {
+            "description" : "Invalid parameters"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User is not an admin"
+          },
+          "500" : {
+            "description" : "Internal server error"
+          }
+        },
+        "security" : [ {
+          "ApiKeyAuth" : [ ]
+        } ],
+        "summary" : "Get brain metrics events",
+        "tags" : [ "brain" ]
+      }
+    },
+    "/brains/{brainId}/flows" : {
+      "get" : {
+        "description" : "Retrieves all conversation flows associated with a specific brain",
+        "operationId" : "getFlows",
+        "parameters" : [ {
+          "description" : "ID of the brain",
+          "in" : "path",
+          "name" : "brainId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "items" : {
+                    "$ref" : "#/components/schemas/BrainFlow"
+                  },
+                  "type" : "array"
+                }
+              }
+            },
+            "description" : "Flows retrieved successfully"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User doesn't have access to this brain"
+          },
+          "404" : {
+            "description" : "Brain not found"
+          },
+          "500" : {
+            "description" : "Internal server error"
+          }
+        },
+        "security" : [ {
+          "ApiKeyAuth" : [ ]
+        } ],
+        "summary" : "Get all flows for a brain",
+        "tags" : [ "brain" ]
+      },
+      "post" : {
+        "description" : "Creates a new conversation flow for a specific brain",
+        "operationId" : "createFlow",
+        "parameters" : [ {
+          "description" : "ID of the brain",
+          "in" : "path",
+          "name" : "brainId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/BrainFlowCreate"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "201" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/BrainFlow"
+                }
+              }
+            },
+            "description" : "Flow created successfully"
+          },
+          "400" : {
+            "description" : "Invalid request body"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User doesn't have access to this brain"
+          },
+          "404" : {
+            "description" : "Brain not found"
+          },
+          "500" : {
+            "description" : "Internal server error"
+          }
+        },
+        "security" : [ {
+          "ApiKeyAuth" : [ ]
+        } ],
+        "summary" : "Create a new flow",
+        "tags" : [ "brain" ]
+      }
+    },
+    "/brains/{brainId}/flows/{flowId}" : {
+      "delete" : {
+        "description" : "Deletes a specific conversation flow",
+        "operationId" : "deleteFlow",
+        "parameters" : [ {
+          "description" : "ID of the brain",
+          "in" : "path",
+          "name" : "brainId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "description" : "ID of the flow to retrieve",
+          "in" : "path",
+          "name" : "flowId",
+          "required" : true,
+          "schema" : {
+            "format" : "uuid",
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "204" : {
+            "description" : "Flow deleted successfully"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User doesn't have access to this brain"
+          },
+          "404" : {
+            "description" : "Flow not found"
+          },
+          "500" : {
+            "description" : "Internal server error"
+          }
+        },
+        "security" : [ {
+          "ApiKeyAuth" : [ ]
+        } ],
+        "summary" : "Delete a flow",
+        "tags" : [ "brain" ]
+      },
+      "get" : {
+        "description" : "Retrieves a specific conversation flow by ID",
+        "operationId" : "getFlow",
+        "parameters" : [ {
+          "description" : "ID of the brain",
+          "in" : "path",
+          "name" : "brainId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "description" : "ID of the flow to retrieve",
+          "in" : "path",
+          "name" : "flowId",
+          "required" : true,
+          "schema" : {
+            "format" : "uuid",
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/BrainFlow"
+                }
+              }
+            },
+            "description" : "Flow retrieved successfully"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User doesn't have access to this brain"
+          },
+          "404" : {
+            "description" : "Flow not found"
+          },
+          "500" : {
+            "description" : "Internal server error"
+          }
+        },
+        "security" : [ {
+          "ApiKeyAuth" : [ ]
+        } ],
+        "summary" : "Get a specific flow",
+        "tags" : [ "brain" ]
+      },
+      "put" : {
+        "description" : "Updates an existing conversation flow",
+        "operationId" : "updateFlow",
+        "parameters" : [ {
+          "description" : "ID of the brain",
+          "in" : "path",
+          "name" : "brainId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "description" : "ID of the flow to retrieve",
+          "in" : "path",
+          "name" : "flowId",
+          "required" : true,
+          "schema" : {
+            "format" : "uuid",
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/BrainFlow"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/BrainFlow"
+                }
+              }
+            },
+            "description" : "Flow updated successfully"
+          },
+          "400" : {
+            "description" : "Invalid request body"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User doesn't have access to this brain"
+          },
+          "404" : {
+            "description" : "Flow not found"
+          },
+          "500" : {
+            "description" : "Internal server error"
+          }
+        },
+        "security" : [ {
+          "ApiKeyAuth" : [ ]
+        } ],
+        "summary" : "Update a flow",
+        "tags" : [ "brain" ]
+      }
+    },
+    "/brains/{brainId}/subscription" : {
+      "delete" : {
+        "description" : "Removes the subscription plan from a brain (admin only)",
+        "operationId" : "removeBrainSubscription",
+        "parameters" : [ {
+          "description" : "ID of the brain",
+          "in" : "path",
+          "name" : "brainId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "204" : {
+            "description" : "Subscription removed successfully"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User is not an admin"
+          },
+          "404" : {
+            "description" : "Brain not found"
+          }
+        },
+        "security" : [ {
+          "ApiKeyAuth" : [ ]
+        } ],
+        "summary" : "Remove brain subscription",
+        "tags" : [ "brain" ]
+      },
+      "put" : {
+        "description" : "Sets or updates a subscription plan for a brain (admin only)",
+        "operationId" : "updateBrainSubscription",
+        "parameters" : [ {
+          "description" : "ID of the brain",
+          "in" : "path",
+          "name" : "brainId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/BrainSubscription"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/BrainSubscription"
+                }
+              }
+            },
+            "description" : "Subscription set successfully"
+          },
+          "400" : {
+            "description" : "Invalid request body"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User is not an admin"
+          },
+          "404" : {
+            "description" : "Brain not found"
+          }
+        },
+        "security" : [ {
+          "ApiKeyAuth" : [ ]
+        } ],
+        "summary" : "Update brain subscription",
+        "tags" : [ "brain" ]
+      }
+    },
+    "/brains/{brainId}/files" : {
+      "delete" : {
+        "description" : "Removes the profile image for a brain",
+        "operationId" : "removeBrainProfileImage",
+        "parameters" : [ {
+          "description" : "ID of the brain",
+          "in" : "path",
+          "name" : "brainId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "204" : {
+            "description" : "Profile image removed successfully"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User doesn't have access to this brain"
+          },
+          "404" : {
+            "description" : "Brain not found"
+          },
+          "500" : {
+            "description" : "Failed to delete brain image"
+          }
+        },
+        "security" : [ {
+          "ApiKeyAuth" : [ ]
+        } ],
+        "summary" : "Remove brain profile image",
+        "tags" : [ "brain" ]
+      },
+      "post" : {
+        "description" : "Uploads a profile image for a brain and returns an upload URL",
+        "operationId" : "uploadBrainProfileImage",
+        "parameters" : [ {
+          "description" : "ID of the brain",
+          "in" : "path",
+          "name" : "brainId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/FileCreationRequest"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "201" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/File"
+                }
+              }
+            },
+            "description" : "Profile image upload prepared successfully"
+          },
+          "400" : {
+            "description" : "Invalid request body"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User doesn't have access to this brain"
+          }
+        },
+        "security" : [ {
+          "ApiKeyAuth" : [ ]
+        } ],
+        "summary" : "Upload brain profile image",
+        "tags" : [ "brain" ]
+      }
+    }
+  },
+  "components" : {
+    "parameters" : {
+      "brainIdPath" : {
+        "description" : "ID of the brain",
+        "in" : "path",
+        "name" : "brainId",
+        "required" : true,
+        "schema" : {
+          "type" : "string"
+        }
+      },
+      "startDate" : {
+        "description" : "Start date for metrics (ISO format)",
+        "in" : "query",
+        "name" : "startDate",
+        "schema" : {
+          "format" : "date-time",
+          "type" : "string"
+        }
+      },
+      "endDate" : {
+        "description" : "End date for metrics (ISO format)",
+        "in" : "query",
+        "name" : "endDate",
+        "schema" : {
+          "format" : "date-time",
+          "type" : "string"
+        }
+      },
+      "flowIdPath" : {
+        "description" : "ID of the flow to retrieve",
+        "in" : "path",
+        "name" : "flowId",
+        "required" : true,
+        "schema" : {
+          "format" : "uuid",
+          "type" : "string"
+        }
+      }
+    },
+    "schemas" : {
+      "Brain" : {
+        "properties" : {
+          "id" : {
+            "type" : "string"
+          },
+          "name" : {
+            "type" : "string"
+          },
+          "engine" : {
+            "$ref" : "#/components/schemas/Engine"
+          },
+          "modules" : {
+            "additionalProperties" : true,
+            "type" : "object"
+          },
+          "persona" : {
+            "$ref" : "#/components/schemas/Persona"
+          },
+          "promptInit" : {
+            "$ref" : "#/components/schemas/PromptInit"
+          },
+          "flow" : {
+            "type" : "string"
+          },
+          "subscription" : {
+            "$ref" : "#/components/schemas/BrainSubscription"
+          },
+          "speechOverrides" : {
+            "additionalProperties" : {
+              "type" : "string"
+            },
+            "maxProperties" : 100,
+            "type" : "object"
+          },
+          "imageBrain" : {
+            "type" : "string"
+          },
+          "organisationId" : {
+            "type" : "string"
+          },
+          "role" : {
+            "type" : "string"
+          },
+          "defaultLanguage" : {
+            "type" : "string"
+          },
+          "description" : {
+            "type" : "string"
+          },
+          "template" : {
+            "type" : "string"
+          },
+          "color" : {
+            "type" : "string"
+          },
+          "picture" : {
+            "type" : "string"
+          },
+          "createdAt" : {
+            "type" : "string"
+          },
+          "isActivated" : {
+            "type" : "boolean"
+          },
+          "knowledgeBaseId" : {
+            "items" : {
+              "type" : "string"
+            },
+            "type" : "array"
+          },
+          "isTemplate" : {
+            "type" : "boolean"
+          },
+          "deleted" : {
+            "type" : "boolean"
+          }
+        },
+        "required" : [ "engine", "id", "modules", "name", "organisationId", "persona", "promptInit" ],
+        "type" : "object"
+      },
+      "Engine" : {
+        "properties" : {
+          "type" : {
+            "$ref" : "#/components/schemas/EngineType"
+          },
+          "configuration" : {
+            "additionalProperties" : true,
+            "type" : "object"
+          }
+        },
+        "required" : [ "configuration", "type" ],
+        "type" : "object"
+      },
+      "Persona" : {
+        "additionalProperties" : {
+          "type" : "string"
+        },
+        "maxProperties" : 200,
+        "minProperties" : 1,
+        "properties" : {
+          "default" : {
+            "maxLength" : 5000,
+            "minLength" : 1,
+            "type" : "string"
+          }
+        },
+        "required" : [ "default" ],
+        "type" : "object"
+      },
+      "PromptInit" : {
+        "additionalProperties" : {
+          "type" : "string"
+        },
+        "maxProperties" : 200,
+        "minProperties" : 1,
+        "properties" : {
+          "default" : {
+            "maxLength" : 50000,
+            "minLength" : 1,
+            "type" : "string"
+          }
+        },
+        "required" : [ "default" ],
+        "type" : "object"
+      },
+      "BrainSubscription" : {
+        "properties" : {
+          "textInteractions" : {
+            "$ref" : "#/components/schemas/BrainSubscription_textInteractions"
+          },
+          "voiceInteractions" : {
+            "$ref" : "#/components/schemas/BrainSubscription_textInteractions"
+          },
+          "canGoBeyondIncluded" : {
+            "type" : "boolean"
+          },
+          "startDate" : {
+            "format" : "date-time",
+            "type" : "string"
+          },
+          "endDate" : {
+            "format" : "date-time",
+            "type" : "string"
+          }
+        },
+        "required" : [ "canGoBeyondIncluded", "textInteractions", "voiceInteractions" ],
+        "type" : "object"
+      },
+      "Additional" : {
+        "properties" : {
+          "price" : {
+            "type" : "string"
+          },
+          "amountForPrice" : {
+            "type" : "string"
+          },
+          "currency" : {
+            "type" : "string"
+          }
+        },
+        "required" : [ "amountForPrice", "currency", "price" ],
+        "type" : "object"
+      },
+      "BrainRequest" : {
+        "properties" : {
+          "name" : {
+            "type" : "string"
+          },
+          "persona" : {
+            "$ref" : "#/components/schemas/Persona"
+          },
+          "engine" : {
+            "$ref" : "#/components/schemas/Engine"
+          },
+          "promptInit" : {
+            "$ref" : "#/components/schemas/PromptInit"
+          },
+          "imageBrain" : {
+            "$ref" : "#/components/schemas/BrainRequest_imageBrain"
+          },
+          "organisationId" : {
+            "type" : "string"
+          },
+          "role" : {
+            "type" : "string"
+          },
+          "defaultLanguage" : {
+            "type" : "string"
+          },
+          "description" : {
+            "type" : "string"
+          },
+          "template" : {
+            "type" : "string"
+          },
+          "color" : {
+            "type" : "string"
+          },
+          "picture" : {
+            "type" : "string"
+          },
+          "createdAt" : {
+            "type" : "string"
+          },
+          "isActivated" : {
+            "type" : "boolean"
+          }
+        },
+        "required" : [ "engine", "name", "organisationId", "persona", "promptInit" ],
+        "type" : "object"
+      },
+      "BrainPatch" : {
+        "allOf" : [ {
+          "$ref" : "#/components/schemas/Brain"
+        }, {
+          "properties" : {
+            "flow" : {
+              "format" : "uuid",
+              "type" : "string"
+            },
+            "speechOverrides" : {
+              "additionalProperties" : {
+                "type" : "string"
+              },
+              "maxProperties" : 100,
+              "type" : "object"
+            }
+          },
+          "type" : "object"
+        } ]
+      },
+      "BrainModule" : {
+        "properties" : {
+          "type" : {
+            "$ref" : "#/components/schemas/BrainModuleType"
+          },
+          "name" : {
+            "type" : "string"
+          },
+          "configuration" : {
+            "type" : "object"
+          },
+          "restricted" : {
+            "type" : "boolean"
+          }
+        },
+        "required" : [ "configuration", "name", "type" ],
+        "type" : "object"
+      },
+      "BrainMetricsOverview" : {
+        "properties" : {
+          "textConversationCount" : {
+            "type" : "number"
+          },
+          "voiceConversationCount" : {
+            "type" : "number"
+          },
+          "userTextMessagesCount" : {
+            "type" : "number"
+          },
+          "userVoiceMessagesCount" : {
+            "type" : "number"
+          },
+          "subscription" : {
+            "$ref" : "#/components/schemas/SubscriptionMetric"
+          },
+          "costs" : {
+            "$ref" : "#/components/schemas/CostMetric"
+          }
+        },
+        "required" : [ "textConversationCount", "userTextMessagesCount", "userVoiceMessagesCount", "voiceConversationCount" ],
+        "type" : "object"
+      },
+      "SubscriptionMetric" : {
+        "properties" : {
+          "textInteractions" : {
+            "type" : "object"
+          },
+          "voiceInteractions" : {
+            "type" : "object"
+          },
+          "canGoBeyondIncluded" : {
+            "type" : "boolean"
+          },
+          "startDate" : {
+            "format" : "date-time",
+            "type" : "string"
+          },
+          "endDate" : {
+            "format" : "date-time",
+            "type" : "string"
+          }
+        },
+        "type" : "object"
+      },
+      "CostMetric" : {
+        "properties" : {
+          "voiceInteractions" : {
+            "$ref" : "#/components/schemas/Transaction"
+          },
+          "textInteractions" : {
+            "$ref" : "#/components/schemas/Transaction"
+          },
+          "total" : {
+            "$ref" : "#/components/schemas/Transaction"
+          }
+        },
+        "required" : [ "textInteractions", "voiceInteractions" ],
+        "type" : "object"
+      },
+      "Transaction" : {
+        "properties" : {
+          "amount" : {
+            "type" : "string"
+          },
+          "currency" : {
+            "type" : "string"
+          }
+        },
+        "required" : [ "amount", "currency" ],
+        "type" : "object"
+      },
+      "BrainUsageMetrics" : {
+        "properties" : {
+          "_id" : {
+            "$ref" : "#/components/schemas/BrainUsageMetricsId"
+          },
+          "total" : {
+            "type" : "number"
+          },
+          "cost" : {
+            "$ref" : "#/components/schemas/Transaction"
+          }
+        },
+        "type" : "object"
+      },
+      "BrainUsageMetricsId" : {
+        "properties" : {
+          "provider" : {
+            "type" : "string"
+          },
+          "model" : {
+            "type" : "string"
+          },
+          "type" : {
+            "type" : "string"
+          }
+        },
+        "type" : "object"
+      },
+      "BrainMetricsEvent" : {
+        "properties" : {
+          "brainId" : {
+            "type" : "string"
+          },
+          "agentId" : {
+            "type" : "string"
+          },
+          "source" : {
+            "additionalProperties" : true,
+            "type" : "object"
+          },
+          "timestamp" : {
+            "type" : "string"
+          },
+          "task" : {
+            "type" : "string"
+          },
+          "value" : {
+            "items" : {
+              "$ref" : "#/components/schemas/BrainMetricsValue"
+            },
+            "type" : "array"
+          }
+        },
+        "required" : [ "brainId", "source", "task", "timestamp", "value" ],
+        "type" : "object"
+      },
+      "BrainMetricsValue" : {
+        "properties" : {
+          "units" : {
+            "$ref" : "#/components/schemas/BrainMetricsUnitsType"
+          },
+          "type" : {
+            "type" : "string"
+          },
+          "amount" : {
+            "type" : "number"
+          },
+          "model" : {
+            "type" : "string"
+          },
+          "provider" : {
+            "type" : "string"
+          }
+        },
+        "required" : [ "amount", "type", "units" ],
+        "type" : "object"
+      },
+      "BrainFlow" : {
+        "allOf" : [ {
+          "$ref" : "#/components/schemas/BrainFlowCreate"
+        }, {
+          "properties" : {
+            "id" : {
+              "format" : "uuid",
+              "type" : "string"
+            },
+            "brainId" : {
+              "type" : "string"
+            }
+          },
+          "required" : [ "brainId", "id" ],
+          "type" : "object"
+        } ],
+        "type" : "object"
+      },
+      "BrainFlowCreate" : {
+        "properties" : {
+          "entrypoints" : {
+            "$ref" : "#/components/schemas/FlowEntrypoints"
+          },
+          "exits" : {
+            "type" : "object"
+          },
+          "contents" : {
+            "$ref" : "#/components/schemas/FlowContents"
+          },
+          "options" : {
+            "items" : {
+              "$ref" : "#/components/schemas/FlowOptions"
+            },
+            "type" : "array"
+          }
+        },
+        "type" : "object"
+      },
+      "FlowEntrypoints" : {
+        "properties" : {
+          "intents" : {
+            "items" : {
+              "type" : "string"
+            },
+            "type" : "array"
+          },
+          "nodes" : {
+            "items" : {
+              "type" : "string"
+            },
+            "type" : "array"
+          }
+        },
+        "required" : [ "intents" ],
+        "type" : "object"
+      },
+      "FlowContents" : {
+        "properties" : {
+          "rephrase" : {
+            "type" : "boolean"
+          },
+          "text" : {
+            "type" : "string"
+          },
+          "texts" : {
+            "items" : {
+              "type" : "string"
+            },
+            "type" : "array"
+          },
+          "instructions" : {
+            "type" : "string"
+          },
+          "tools" : {
+            "$ref" : "#/components/schemas/ContentsTools"
+          },
+          "suggestions" : {
+            "items" : {
+              "$ref" : "#/components/schemas/FlowContentsSuggestion"
+            },
+            "type" : "array"
+          }
+        },
+        "type" : "object"
+      },
+      "ContentsTools" : {
+        "properties" : {
+          "exclusive" : {
+            "items" : {
+              "type" : "string"
+            },
+            "type" : "array"
+          },
+          "forbidden" : {
+            "items" : {
+              "type" : "string"
+            },
+            "type" : "array"
+          },
+          "allowed" : {
+            "items" : {
+              "type" : "string"
+            },
+            "type" : "array"
+          }
+        },
+        "type" : "object"
+      },
+      "FlowContentsSuggestion" : {
+        "properties" : {
+          "id" : {
+            "type" : "string"
+          },
+          "text" : {
+            "type" : "string"
+          }
+        },
+        "required" : [ "id", "text" ],
+        "type" : "object"
+      },
+      "FlowOptions" : {
+        "properties" : {
+          "conditions" : {
+            "additionalProperties" : {
+              "type" : "object"
+            },
+            "type" : "object"
+          },
+          "exits" : {
+            "type" : "object"
+          },
+          "contents" : {
+            "type" : "object"
+          }
+        },
+        "required" : [ "conditions" ],
+        "type" : "object"
+      },
+      "FileCreationRequest" : {
+        "properties" : {
+          "contentType" : {
+            "description" : "MIME type of the image file",
+            "type" : "string"
+          },
+          "ext" : {
+            "description" : "File extension",
+            "pattern" : "^[a-zA-Z0-9]{1,10}$",
+            "type" : "string"
+          },
+          "size" : {
+            "description" : "File size in bytes",
+            "type" : "number"
+          },
+          "hash" : {
+            "description" : "File hash",
+            "type" : "string"
+          }
+        },
+        "required" : [ "contentType", "ext", "hash", "size" ],
+        "type" : "object"
+      },
+      "File" : {
+        "properties" : {
+          "id" : {
+            "type" : "string"
+          },
+          "contentType" : {
+            "type" : "string"
+          },
+          "ext" : {
+            "type" : "string"
+          },
+          "key" : {
+            "type" : "string"
+          },
+          "size" : {
+            "type" : "number"
+          },
+          "createdAt" : {
+            "format" : "date-time",
+            "type" : "string"
+          },
+          "status" : {
+            "$ref" : "#/components/schemas/FileStatus"
+          },
+          "postURL" : {
+            "description" : "URL to upload the image to",
+            "type" : "string"
+          }
+        },
+        "required" : [ "contentType", "createdAt", "ext", "id", "key", "postURL", "size", "status" ],
+        "type" : "object"
+      },
+      "EngineType" : {
+        "enum" : [ "llamacpp", "openai" ],
+        "type" : "string"
+      },
+      "BrainModuleType" : {
+        "enum" : [ "ContextualKnowledgeWeaviate", "External" ],
+        "type" : "string"
+      },
+      "BrainMetricsUnitsType" : {
+        "enum" : [ "TOKENS", "CURRENCY", "MILLISECONDS", "CHARACTERS" ],
+        "type" : "string"
+      },
+      "FileStatus" : {
+        "enum" : [ "PENDING", "UPLOADED" ],
+        "type" : "string"
+      },
+      "BrainSubscription_textInteractions" : {
+        "properties" : {
+          "included" : {
+            "type" : "number"
+          },
+          "additional" : {
+            "$ref" : "#/components/schemas/Additional"
+          }
+        },
+        "required" : [ "additional", "included" ],
+        "type" : "object"
+      },
+      "BrainRequest_imageBrain" : {
+        "properties" : {
+          "hash" : {
+            "type" : "string"
+          },
+          "size" : {
+            "type" : "number"
+          },
+          "contentType" : {
+            "type" : "string"
+          },
+          "ext" : {
+            "type" : "string"
+          }
+        },
+        "required" : [ "contentType", "ext", "hash", "size" ],
+        "type" : "object"
+      }
+    }
+  }
+}