@breign/client 1.0.5 → 1.0.6

package/dist/openapi.json

@@ -71,6 +71,7 @@
     "/health" : {
       "get" : {
         "description" : "Comprehensive health check that verifies system components",
+        "operationId" : "getHealth",
         "responses" : {
           "200" : {
             "content" : {
@@ -1024,7 +1025,7 @@
             "content" : {
               "application/json" : {
                 "schema" : {
-                  "$ref" : "#/components/schemas/duplicateAgent_201_response"
+                  "$ref" : "#/components/schemas/BodyWithId"
                 }
               }
             },
@@ -1100,6 +1101,13 @@
           "schema" : {
             "type" : "string"
           }
+        }, {
+          "description" : "Page number",
+          "in" : "query",
+          "name" : "page",
+          "schema" : {
+            "type" : "integer"
+          }
         } ],
         "responses" : {
           "200" : {
@@ -2815,14 +2823,15 @@
         "tags" : [ "engine" ]
       }
     },
-    "/engines/providers" : {
+    "/organizations/{organizationId}/engines/providers" : {
       "get" : {
         "description" : "Get providers for an organization",
         "operationId" : "getProviders",
         "parameters" : [ {
-          "description" : "Organization ID",
-          "in" : "query",
+          "description" : "ID of the organization",
+          "in" : "path",
           "name" : "organizationId",
+          "required" : true,
           "schema" : {
             "type" : "string"
           }
@@ -2848,6 +2857,15 @@
       "post" : {
         "description" : "Create a provider for an organization",
         "operationId" : "createProvider",
+        "parameters" : [ {
+          "description" : "ID of the organization",
+          "in" : "path",
+          "name" : "organizationId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
         "requestBody" : {
           "content" : {
             "application/json" : {
@@ -2890,6 +2908,7 @@
           "description" : "Organization ID",
           "in" : "query",
           "name" : "organizationId",
+          "required" : true,
           "schema" : {
             "type" : "string"
           }
@@ -3018,6 +3037,7 @@
     "/files" : {
       "get" : {
         "description" : "Retrieves a list of all files (admin only)",
+        "operationId" : "getFiles",
         "responses" : {
           "206" : {
             "content" : {
@@ -3044,6 +3064,7 @@
       },
       "post" : {
         "description" : "Creates a new file record and returns an upload URL (admin only)",
+        "operationId" : "createFile",
         "requestBody" : {
           "content" : {
             "application/json" : {
@@ -3082,6 +3103,7 @@
     "/files/{fileId}" : {
       "delete" : {
         "description" : "Deletes a file by ID (admin only)",
+        "operationId" : "deleteFileById",
         "parameters" : [ {
           "description" : "The ID of the file",
           "in" : "path",
@@ -3110,6 +3132,7 @@
       },
       "get" : {
         "description" : "Retrieves a specific file by ID and generates a download URL (admin only)",
+        "operationId" : "getFileById",
         "parameters" : [ {
           "description" : "The ID of the file",
           "in" : "path",
@@ -3147,6 +3170,7 @@
     "/metrics" : {
       "get" : {
         "description" : "Retrieves usage metrics for all agents within a date range (admin only)",
+        "operationId" : "getMetrics",
         "parameters" : [ {
           "description" : "Start date for metrics (ISO format)",
           "in" : "query",
@@ -3198,6 +3222,7 @@
     "/metrics/agents" : {
       "get" : {
         "description" : "Retrieves usage metrics broken down by agent within a date range (admin only)",
+        "operationId" : "getMetricsAgents",
         "parameters" : [ {
           "description" : "Start date for metrics (ISO format)",
           "in" : "query",
@@ -3248,6 +3273,7 @@
     },
     "/agents/{agentId}/guardians" : {
       "get" : {
+        "operationId" : "getGuardiansForAgent",
         "parameters" : [ {
           "description" : "ID of the agent",
           "in" : "path",
@@ -3286,6 +3312,7 @@
       },
       "post" : {
         "description" : "Creates a new guardian for content moderation",
+        "operationId" : "createGuardianForAgent",
         "parameters" : [ {
           "description" : "ID of the agent",
           "in" : "path",
@@ -3336,6 +3363,7 @@
     "/organizations/{organizationId}/guardians" : {
       "get" : {
         "description" : "Retrieves all guardians associated with the specified organization",
+        "operationId" : "getGuardiansForOrganization",
         "parameters" : [ {
           "description" : "ID of the organization",
           "in" : "path",
@@ -3374,6 +3402,7 @@
       },
       "post" : {
         "description" : "Creates a new organisation-level guardian for content moderation",
+        "operationId" : "createGuardianForOrganization",
         "parameters" : [ {
           "description" : "ID of the organization",
           "in" : "path",
@@ -3424,6 +3453,7 @@
     "/guardians/{guardianId}" : {
       "delete" : {
         "description" : "Deletes a guardian by ID",
+        "operationId" : "deleteGuardian",
         "parameters" : [ {
           "description" : "ID of the guardian",
           "in" : "path",
@@ -3454,6 +3484,7 @@
         "tags" : [ "guardians" ]
       },
       "get" : {
+        "operationId" : "getGuardian",
         "parameters" : [ {
           "description" : "ID of the guardian",
           "in" : "path",
@@ -3492,6 +3523,7 @@
       },
       "put" : {
         "description" : "Updates an existing guardian's configuration",
+        "operationId" : "updateGuardian",
         "parameters" : [ {
           "description" : "ID of the guardian",
           "in" : "path",
@@ -3545,6 +3577,7 @@
     "/guardians/{guardianId}/excluded-agents" : {
       "put" : {
         "description" : "Updates the excluded agents for a guardian",
+        "operationId" : "updateExcludedAgents",
         "parameters" : [ {
           "description" : "ID of the guardian",
           "in" : "path",
@@ -3558,7 +3591,10 @@
           "content" : {
             "application/json" : {
               "schema" : {
-                "$ref" : "#/components/schemas/GuardianExcludedAgentsRequest"
+                "items" : {
+                  "type" : "string"
+                },
+                "type" : "array"
               }
             }
           },
@@ -3598,6 +3634,7 @@
     "/organizations/{organizationId}" : {
       "get" : {
         "description" : "Retrieves an organization by its ID",
+        "operationId" : "getOrganizationById",
         "parameters" : [ {
           "description" : "ID of the organization",
           "in" : "path",
@@ -3638,6 +3675,7 @@
     "/manifests" : {
       "get" : {
         "description" : "Retrieves manifests, filtered by user ID for non-admin users",
+        "operationId" : "getManifests",
         "responses" : {
           "206" : {
             "content" : {
@@ -3664,6 +3702,7 @@
       },
       "post" : {
         "description" : "Creates a new manifest document",
+        "operationId" : "createManifest",
         "requestBody" : {
           "content" : {
             "application/json" : {
@@ -3702,6 +3741,7 @@
     "/manifests/{manifestId}" : {
       "delete" : {
         "description" : "Deletes a manifest by ID",
+        "operationId" : "deleteManifestById",
         "parameters" : [ {
           "description" : "ID of the manifest",
           "in" : "path",
@@ -3733,6 +3773,7 @@
       },
       "get" : {
         "description" : "Retrieves a specific manifest by its ID",
+        "operationId" : "getManifestById",
         "parameters" : [ {
           "description" : "ID of the manifest",
           "in" : "path",
@@ -3771,6 +3812,7 @@
       },
       "put" : {
         "description" : "Updates a manifest by ID",
+        "operationId" : "updateManifestById",
         "parameters" : [ {
           "description" : "ID of the manifest",
           "in" : "path",
@@ -3824,6 +3866,7 @@
     "/agents/{agentId}/knowledge/resets" : {
       "post" : {
         "description" : "Deletes all knowledge embeddings and files associated with an agent",
+        "operationId" : "resetAgentKnowledge",
         "parameters" : [ {
           "description" : "ID of the agent",
           "in" : "path",
@@ -3857,6 +3900,7 @@
     "/agents/{agentId}/knowledge/project-imports" : {
       "post" : {
         "description" : "Imports project data from a local JSON file into the agent's knowledge base",
+        "operationId" : "importProjectsToAgentKnowledge",
         "parameters" : [ {
           "description" : "ID of the agent",
           "in" : "path",
@@ -3890,6 +3934,7 @@
     "/agents/{agentId}/knowledge/documents" : {
       "post" : {
         "description" : "Adds a text document to the agent's knowledge base, splitting it into chunks if necessary",
+        "operationId" : "addDocumentToKnowledgeBase",
         "parameters" : [ {
           "description" : "ID of the agent",
           "in" : "path",
@@ -3943,6 +3988,7 @@
     "/agents/{agentId}/knowledge/file-imports" : {
       "post" : {
         "description" : "Processes documents like PDFs, CSVs, and text files, and adds them to the brain's knowledge base",
+        "operationId" : "importFileToAgentKnowledge",
         "parameters" : [ {
           "description" : "ID of the agent",
           "in" : "path",
@@ -3956,7 +4002,7 @@
           "content" : {
             "multipart/form-data" : {
               "schema" : {
-                "$ref" : "#/components/schemas/_agents__agentId__knowledge_file_imports_post_request"
+                "$ref" : "#/components/schemas/importFileToAgentKnowledge_request"
               }
             }
           },
@@ -3967,7 +4013,7 @@
             "content" : {
               "application/json" : {
                 "schema" : {
-                  "$ref" : "#/components/schemas/_agents__agentId__knowledge_file_imports_post_200_response"
+                  "$ref" : "#/components/schemas/importFileToAgentKnowledge_200_response"
                 }
               }
             },
@@ -3996,6 +4042,7 @@
     "/agents/{agentId}/knowledge/files" : {
       "post" : {
         "description" : "Registers a file for upload to the brain's knowledge base and returns an upload URL",
+        "operationId" : "prepareFileUpload",
         "parameters" : [ {
           "description" : "ID of the agent",
           "in" : "path",
@@ -4049,6 +4096,7 @@
     "/agents/{agentId}/knowledge/files/{fileId}/status" : {
       "post" : {
         "description" : "Updates the status of a knowledge file and triggers the indexing process if the file is uploaded",
+        "operationId" : "updateFileStatus",
         "parameters" : [ {
           "description" : "ID of the agent",
           "in" : "path",
@@ -4110,6 +4158,7 @@
     "/agents/{agentId}/knowledge/files/{fileId}" : {
       "delete" : {
         "description" : "Removes a file and its associated chunks from the agent's knowledge base",
+        "operationId" : "deleteFileFromAgentKnowledge",
         "parameters" : [ {
           "description" : "ID of the agent",
           "in" : "path",
@@ -4149,6 +4198,7 @@
       },
       "get" : {
         "description" : "Retrieves metadata for a file that has been imported into the agent's knowledge base",
+        "operationId" : "getFileFromAgentKnowledge",
         "parameters" : [ {
           "description" : "ID of the agent",
           "in" : "path",
@@ -4310,6 +4360,7 @@
     "/tools/text-to-speech" : {
       "post" : {
         "description" : "Converts text to speech using the specified provider",
+        "operationId" : "convertTextToSpeech",
         "parameters" : [ {
           "description" : "If true, returns a mock transcription without processing the file",
           "in" : "query",
@@ -4356,6 +4407,7 @@
     "/tools/speech-to-text" : {
       "post" : {
         "description" : "Transcribes audio files to text using OpenAI's Whisper model",
+        "operationId" : "convertSpeechToText",
         "parameters" : [ {
           "description" : "Language code for transcription (optional)",
           "in" : "query",
@@ -4434,6 +4486,7 @@
     "/remote/pin-requests" : {
       "post" : {
         "description" : "Creates a PIN request for remote access",
+        "operationId" : "createPinRequest",
         "requestBody" : {
           "content" : {
             "application/json" : {
@@ -4472,6 +4525,7 @@
     "/agents/{agentId}/prompts/flows" : {
       "post" : {
         "description" : "Starts a new conversation session for the specified agent with flow management",
+        "operationId" : "createConversationWithFlowManagement",
         "parameters" : [ {
           "description" : "ID of the agent",
           "in" : "path",
@@ -4525,6 +4579,7 @@
     "/agents/{agentId}/prompts" : {
       "post" : {
         "description" : "Starts a new conversation session for the specified agent",
+        "operationId" : "createPrompt",
         "parameters" : [ {
           "description" : "ID of the agent",
           "in" : "path",
@@ -4553,7 +4608,7 @@
                 }
               }
             },
-            "description" : "Conversation created successfully"
+            "description" : "Prompt created successfully"
           },
           "400" : {
             "description" : "Invalid request"
@@ -4571,13 +4626,14 @@
             "description" : "Server error"
           }
         },
-        "summary" : "Create a new conversation",
+        "summary" : "Create a new prompt",
         "tags" : [ "prompts" ]
       }
     },
     "/conversations" : {
       "post" : {
         "description" : "Create a new empty conversation for the specified agent.",
+        "operationId" : "createConversation",
         "parameters" : [ {
           "description" : "ID of the agent",
           "in" : "path",
@@ -4631,6 +4687,7 @@
     "/conversations/{conversationId}" : {
       "get" : {
         "description" : "Retrieves details of a specific conversation including all messages",
+        "operationId" : "getConversationById",
         "parameters" : [ {
           "description" : "The ID of the conversation",
           "in" : "path",
@@ -4668,6 +4725,7 @@
     "/conversations/{conversationId}/prompts" : {
       "post" : {
         "description" : "Adds a new message to an existing conversation and gets the AI response",
+        "operationId" : "sendMessageToConversation",
         "parameters" : [ {
           "description" : "The ID of the conversation",
           "in" : "path",
@@ -4721,6 +4779,7 @@
     "/conversations/{conversationId}/messages/{messageId}" : {
       "get" : {
         "description" : "Retrieves a specific message by ID from a conversation",
+        "operationId" : "getMessageById",
         "parameters" : [ {
           "description" : "The ID of the conversation",
           "in" : "path",
@@ -4803,6 +4862,14 @@
           "type" : "string"
         }
       },
+      "page" : {
+        "description" : "Page number",
+        "in" : "query",
+        "name" : "page",
+        "schema" : {
+          "type" : "integer"
+        }
+      },
       "instanceId" : {
         "description" : "Instance id",
         "in" : "query",
@@ -4919,10 +4986,11 @@
           "type" : "string"
         }
       },
-      "organizationId" : {
-        "description" : "Organization ID",
-        "in" : "query",
+      "organizationIdPath" : {
+        "description" : "ID of the organization",
+        "in" : "path",
         "name" : "organizationId",
+        "required" : true,
         "schema" : {
           "type" : "string"
         }
@@ -4936,9 +5004,9 @@
           "type" : "string"
         }
       },
-      "organizationIdPath" : {
-        "description" : "ID of the organization",
-        "in" : "path",
+      "organizationId" : {
+        "description" : "Organization ID",
+        "in" : "query",
         "name" : "organizationId",
         "required" : true,
         "schema" : {
@@ -5285,7 +5353,7 @@
             "type" : "boolean"
           }
         },
-        "required" : [ "engine", "name", "organisationId", "persona", "promptInit" ],
+        "required" : [ "name", "organisationId", "persona", "promptInit" ],
         "type" : "object"
       },
       "AgentPatch" : {
@@ -5297,7 +5365,7 @@
             "type" : "string"
           },
           "engine" : {
-            "$ref" : "#/components/schemas/Engine"
+            "$ref" : "#/components/schemas/AgentPatch_engine"
           },
           "modules" : {
             "additionalProperties" : true,
@@ -5311,6 +5379,7 @@
           },
           "flow" : {
             "format" : "uuid",
+            "nullable" : true,
             "type" : "string"
           },
           "subscription" : {
@@ -5756,6 +5825,15 @@
         "required" : [ "organisationId" ],
         "type" : "object"
       },
+      "BodyWithId" : {
+        "properties" : {
+          "id" : {
+            "type" : "string"
+          }
+        },
+        "required" : [ "id" ],
+        "type" : "object"
+      },
       "S3UploadBody" : {
         "properties" : {
           "postURL" : {
@@ -5797,7 +5875,7 @@
           },
           "messages" : {
             "items" : {
-              "$ref" : "#/components/schemas/ChatMessage"
+              "$ref" : "#/components/schemas/ChatMessageWithFlowNode"
             },
             "type" : "array"
           },
@@ -5814,6 +5892,19 @@
         "required" : [ "agentId", "context", "createdAt", "id", "lang", "messages", "updatedAt" ],
         "type" : "object"
       },
+      "ChatMessageWithFlowNode" : {
+        "allOf" : [ {
+          "$ref" : "#/components/schemas/ChatMessage"
+        }, {
+          "properties" : {
+            "flowNode" : {
+              "$ref" : "#/components/schemas/AgentFlow"
+            }
+          },
+          "required" : [ "flowNode" ],
+          "type" : "object"
+        } ]
+      },
       "ChatMessage" : {
         "properties" : {
           "id" : {
@@ -5845,7 +5936,6 @@
             "type" : "array"
           },
           "flowNode" : {
-            "format" : "uuid",
             "type" : "string"
           },
           "flowNodeRequirementsChecked" : {
@@ -5874,6 +5964,12 @@
               "$ref" : "#/components/schemas/FileAttachment"
             },
             "type" : "array"
+          },
+          "audio" : {
+            "items" : {
+              "$ref" : "#/components/schemas/ChatMessage_audio_inner"
+            },
+            "type" : "array"
           }
         },
         "required" : [ "content", "id", "role", "timestamp" ],
@@ -6363,15 +6459,6 @@
         },
         "type" : "object"
       },
-      "BodyWithId" : {
-        "properties" : {
-          "id" : {
-            "type" : "string"
-          }
-        },
-        "required" : [ "id" ],
-        "type" : "object"
-      },
       "AppTextToSpeechRequest" : {
         "properties" : {
           "text" : {
@@ -6748,17 +6835,14 @@
           "organizationId" : {
             "type" : "string"
           },
-          "type" : {
-            "type" : "string"
-          },
-          "provider" : {
+          "providerId" : {
             "type" : "string"
           },
           "model" : {
             "type" : "string"
           }
         },
-        "required" : [ "model", "organizationId", "provider", "type" ],
+        "required" : [ "model", "organizationId", "providerId" ],
         "type" : "object"
       },
       "Provider" : {
@@ -6784,7 +6868,7 @@
             "type" : "string"
           },
           "providerType" : {
-            "type" : "string"
+            "$ref" : "#/components/schemas/ProviderType"
           },
           "models" : {
             "items" : {
@@ -6797,12 +6881,9 @@
           },
           "endpoint" : {
             "type" : "string"
-          },
-          "organizationId" : {
-            "type" : "string"
           }
         },
-        "required" : [ "apiKey", "models", "name", "organizationId", "providerType" ],
+        "required" : [ "models", "name", "providerType" ],
         "type" : "object"
       },
       "ProviderSimple" : {
@@ -6967,6 +7048,9 @@
           "name" : {
             "type" : "string"
           },
+          "type" : {
+            "$ref" : "#/components/schemas/GuardianType"
+          },
           "description" : {
             "type" : "string"
           },
@@ -7016,7 +7100,7 @@
             "type" : "array"
           }
         },
-        "required" : [ "createdAt", "engine", "id", "role" ],
+        "required" : [ "createdAt", "engine", "id", "role", "type" ],
         "type" : "object"
       },
       "GuardianCreateRequest" : {
@@ -7036,6 +7120,9 @@
             },
             "type" : "object"
           },
+          "type" : {
+            "$ref" : "#/components/schemas/GuardianType"
+          },
           "forbiddenMessages" : {
             "items" : {
               "type" : "string"
@@ -7046,7 +7133,7 @@
             "$ref" : "#/components/schemas/GuardianEngine"
           }
         },
-        "required" : [ "engine", "role" ],
+        "required" : [ "engine", "role", "type" ],
         "type" : "object"
       },
       "GuardianPutRequest" : {
@@ -7057,6 +7144,9 @@
           "name" : {
             "type" : "string"
           },
+          "type" : {
+            "$ref" : "#/components/schemas/GuardianType"
+          },
           "description" : {
             "type" : "string"
           },
@@ -7081,18 +7171,6 @@
         },
         "type" : "object"
       },
-      "GuardianExcludedAgentsRequest" : {
-        "properties" : {
-          "excludedAgents" : {
-            "items" : {
-              "type" : "string"
-            },
-            "type" : "array"
-          }
-        },
-        "required" : [ "excludedAgents" ],
-        "type" : "object"
-      },
       "Organization" : {
         "properties" : {
           "id" : {
@@ -7351,15 +7429,14 @@
       },
       "Engine" : {
         "properties" : {
-          "type" : {
-            "$ref" : "#/components/schemas/EngineType"
+          "providerId" : {
+            "type" : "string"
           },
-          "configuration" : {
-            "additionalProperties" : true,
-            "type" : "object"
+          "model" : {
+            "type" : "string"
           }
         },
-        "required" : [ "configuration", "type" ],
+        "required" : [ "model", "providerId" ],
         "type" : "object"
       },
       "AgentType" : {
@@ -7430,21 +7507,26 @@
         "enum" : [ "reference" ],
         "type" : "string"
       },
+      "ProviderType" : {
+        "enum" : [ "llamacpp", "openai", "mistral", "other" ],
+        "type" : "string"
+      },
+      "GuardianType" : {
+        "enum" : [ "node", "openai", "llmguards" ],
+        "type" : "string"
+      },
       "GuardianRole" : {
         "enum" : [ "PROMPTCHECK", "WORDCHECK", "INTENTIONCHECK", "ATTACKCHECK", "ANONIMIZE" ],
         "type" : "string"
       },
       "GuardianEngine" : {
         "properties" : {
-          "type" : {
-            "$ref" : "#/components/schemas/GuardianEngineType"
-          },
           "configuration" : {
             "additionalProperties" : true,
             "type" : "object"
           }
         },
-        "required" : [ "configuration", "type" ],
+        "required" : [ "configuration" ],
         "type" : "object"
       },
       "GuardianPosition" : {
@@ -7455,24 +7537,7 @@
         "enum" : [ "ELEVENLABS" ],
         "type" : "string"
       },
-      "EngineType" : {
-        "enum" : [ "llamacpp", "openai" ],
-        "type" : "string"
-      },
-      "GuardianEngineType" : {
-        "enum" : [ "node", "openai", "llmguards" ],
-        "type" : "string"
-      },
-      "duplicateAgent_201_response" : {
-        "properties" : {
-          "id" : {
-            "type" : "string"
-          }
-        },
-        "required" : [ "id" ],
-        "type" : "object"
-      },
-      "_agents__agentId__knowledge_file_imports_post_request" : {
+      "importFileToAgentKnowledge_request" : {
         "properties" : {
           "file" : {
             "description" : "The file to import (PDF, CSV, TXT supported)",
@@ -7483,7 +7548,7 @@
         "required" : [ "file" ],
         "type" : "object"
       },
-      "_agents__agentId__knowledge_file_imports_post_200_response" : {
+      "importFileToAgentKnowledge_200_response" : {
         "properties" : {
           "id" : {
             "type" : "string"
@@ -7552,6 +7617,31 @@
         "required" : [ "contentType", "ext", "hash", "size" ],
         "type" : "object"
       },
+      "AgentPatch_engine" : {
+        "nullable" : true,
+        "properties" : {
+          "providerId" : {
+            "type" : "string"
+          },
+          "model" : {
+            "type" : "string"
+          }
+        },
+        "required" : [ "model", "providerId" ],
+        "type" : "object"
+      },
+      "ChatMessage_audio_inner" : {
+        "properties" : {
+          "sequence" : {
+            "type" : "number"
+          },
+          "audioFileId" : {
+            "type" : "string"
+          }
+        },
+        "required" : [ "audioFileId", "sequence" ],
+        "type" : "object"
+      },
       "ToolResults_tool" : {
         "properties" : {
           "tool" : {