@breign/client 1.0.82 → 1.0.84

package/dist/openapi.json

@@ -66,6 +66,9 @@
   }, {
     "description" : "Chat prompts and conversation management",
     "name" : "prompts"
+  }, {
+    "description" : "Skills management endpoints",
+    "name" : "skills"
   } ],
   "paths" : {
     "/health" : {
@@ -6081,6 +6084,185 @@
         "tags" : [ "knowledge" ]
       }
     },
+    "/knowledge-bases/{knowledgebaseId}/configuration" : {
+      "get" : {
+        "description" : "Returns the current configuration for a knowledge base",
+        "operationId" : "getKnowledgeBaseConfiguration",
+        "parameters" : [ {
+          "description" : "ID of the knowledge base to retrieve",
+          "in" : "path",
+          "name" : "knowledgebaseId",
+          "required" : true,
+          "schema" : {
+            "format" : "uuid",
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/KnowledgeBaseConfiguration"
+                }
+              }
+            },
+            "description" : "Configuration retrieved successfully"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "404" : {
+            "description" : "Knowledge base not found"
+          },
+          "500" : {
+            "description" : "Server error"
+          }
+        },
+        "summary" : "Get knowledge base configuration",
+        "tags" : [ "knowledge" ]
+      },
+      "put" : {
+        "description" : "Updates the module configuration for a knowledge base",
+        "operationId" : "updateKnowledgeBaseConfiguration",
+        "parameters" : [ {
+          "description" : "ID of the knowledge base to retrieve",
+          "in" : "path",
+          "name" : "knowledgebaseId",
+          "required" : true,
+          "schema" : {
+            "format" : "uuid",
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/KnowledgeBaseConfiguration"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "additionalProperties" : true,
+                  "type" : "object"
+                }
+              }
+            },
+            "description" : "Configuration updated successfully"
+          },
+          "400" : {
+            "description" : "Invalid configuration payload"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "404" : {
+            "description" : "Knowledge base not found"
+          },
+          "500" : {
+            "description" : "Server error"
+          }
+        },
+        "summary" : "Update knowledge base configuration",
+        "tags" : [ "knowledge" ]
+      }
+    },
+    "/knowledge-files/{fileId}" : {
+      "get" : {
+        "description" : "Retrieves metadata for a specific knowledge file by file ID",
+        "operationId" : "getKnowledgeFile",
+        "parameters" : [ {
+          "description" : "The ID of the file",
+          "in" : "path",
+          "name" : "fileId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/FileWithDownloadUrl"
+                }
+              }
+            },
+            "description" : "File details retrieved successfully"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "404" : {
+            "description" : "File not found"
+          },
+          "500" : {
+            "description" : "Server error"
+          }
+        },
+        "summary" : "Get a specific knowledge file",
+        "tags" : [ "knowledge" ]
+      }
+    },
+    "/knowledge-files/{fileId}/status" : {
+      "post" : {
+        "description" : "Updates the status of a knowledge file and triggers indexing when uploaded",
+        "operationId" : "updateKnowledgeFileStatus",
+        "parameters" : [ {
+          "description" : "The ID of the file",
+          "in" : "path",
+          "name" : "fileId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/FileStatusUpdateRequest"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/File"
+                }
+              }
+            },
+            "description" : "File status updated successfully"
+          },
+          "400" : {
+            "description" : "Invalid status update"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "404" : {
+            "description" : "File not found"
+          },
+          "500" : {
+            "description" : "Server error"
+          }
+        },
+        "summary" : "Update knowledge file status",
+        "tags" : [ "knowledge" ]
+      }
+    },
     "/knowledge-files/by-ids" : {
       "post" : {
         "description" : "Returns knowledge file summaries (id and name) for the given file IDs.",
@@ -6120,6 +6302,53 @@
         "tags" : [ "knowledge" ]
       }
     },
+    "/knowledge-files/{fileId}/page-preview" : {
+      "get" : {
+        "description" : "Returns a presigned URL to preview a specific page image (ColPali knowledge bases only).",
+        "operationId" : "getKnowledgeFilePagePreview",
+        "parameters" : [ {
+          "description" : "The ID of the file",
+          "in" : "path",
+          "name" : "fileId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "description" : "Zero-based page index.",
+          "in" : "query",
+          "name" : "pageIndex",
+          "required" : true,
+          "schema" : {
+            "minimum" : 0,
+            "type" : "integer"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/KnowledgeFilePagePreview"
+                }
+              }
+            },
+            "description" : "Presigned preview URL"
+          },
+          "400" : {
+            "description" : "Invalid page index or unsupported knowledge base type"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "404" : {
+            "description" : "File not found"
+          }
+        },
+        "summary" : "Get a presigned preview URL for a knowledge file page",
+        "tags" : [ "knowledge" ]
+      }
+    },
     "/tools" : {
       "get" : {
         "description" : "Returns tools matching optional search query, with pagination",
@@ -6693,43 +6922,405 @@
         "tags" : [ "tools" ]
       }
     },
-    "/remote/pin-requests" : {
-      "post" : {
-        "description" : "Creates a PIN request for remote access",
-        "operationId" : "createPinRequest",
-        "requestBody" : {
-          "content" : {
-            "application/json" : {
-              "schema" : {
-                "$ref" : "#/components/schemas/PinRequest"
-              }
-            }
-          },
-          "required" : true
-        },
+    "/skills" : {
+      "get" : {
+        "description" : "Returns a paginated list of skills scoped to an organization",
+        "operationId" : "listSkills",
+        "parameters" : [ {
+          "description" : "Organization ID",
+          "in" : "query",
+          "name" : "organizationId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "description" : "Page number",
+          "in" : "query",
+          "name" : "page",
+          "schema" : {
+            "type" : "integer"
+          }
+        }, {
+          "description" : "Maximum number of skills to return",
+          "in" : "query",
+          "name" : "limit",
+          "schema" : {
+            "default" : 20,
+            "maximum" : 100,
+            "type" : "integer"
+          }
+        } ],
         "responses" : {
-          "201" : {
+          "200" : {
             "content" : {
               "application/json" : {
                 "schema" : {
-                  "$ref" : "#/components/schemas/BodyWithMessage"
+                  "items" : {
+                    "$ref" : "#/components/schemas/Skill"
+                  },
+                  "type" : "array"
                 }
               }
             },
-            "description" : "PIN request created successfully"
-          },
-          "400" : {
-            "description" : "Invalid request format"
-          },
-          "404" : {
-            "description" : "User not found"
-          },
-          "500" : {
-            "description" : "Server error"
-          }
-        },
-        "summary" : "Create a remote access PIN request",
-        "tags" : [ "remotes" ]
+            "description" : "List of skills",
+            "headers" : {
+              "X-Total-Count" : {
+                "description" : "Total number of skills in the organization",
+                "schema" : {
+                  "type" : "integer"
+                }
+              },
+              "X-Page" : {
+                "schema" : {
+                  "type" : "integer"
+                }
+              },
+              "X-Limit" : {
+                "schema" : {
+                  "type" : "integer"
+                }
+              },
+              "X-Total-Pages" : {
+                "schema" : {
+                  "type" : "integer"
+                }
+              }
+            }
+          },
+          "400" : {
+            "description" : "MISSING_ORG_ID"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden"
+          }
+        },
+        "summary" : "List skills in an organization",
+        "tags" : [ "skills" ]
+      },
+      "post" : {
+        "description" : "Creates a new skill in an organization",
+        "operationId" : "createSkill",
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/SkillCreateRequest"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "201" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/Skill"
+                }
+              }
+            },
+            "description" : "Skill created successfully"
+          },
+          "400" : {
+            "description" : "Invalid request body"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden"
+          },
+          "409" : {
+            "description" : "SKILL_SLUG_ALREADY_EXISTS"
+          }
+        },
+        "summary" : "Create a skill",
+        "tags" : [ "skills" ]
+      }
+    },
+    "/skills/{skillId}" : {
+      "delete" : {
+        "operationId" : "deleteSkill",
+        "parameters" : [ {
+          "description" : "Skill identifier",
+          "in" : "path",
+          "name" : "skillId",
+          "required" : true,
+          "schema" : {
+            "format" : "uuid",
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "204" : {
+            "description" : "Skill deleted successfully"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden"
+          },
+          "404" : {
+            "description" : "SKILL_NOT_FOUND"
+          }
+        },
+        "summary" : "Delete a skill",
+        "tags" : [ "skills" ]
+      },
+      "get" : {
+        "operationId" : "getSkill",
+        "parameters" : [ {
+          "description" : "Skill identifier",
+          "in" : "path",
+          "name" : "skillId",
+          "required" : true,
+          "schema" : {
+            "format" : "uuid",
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/Skill"
+                }
+              }
+            },
+            "description" : "Skill details"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden"
+          },
+          "404" : {
+            "description" : "SKILL_NOT_FOUND"
+          }
+        },
+        "summary" : "Get a skill by ID",
+        "tags" : [ "skills" ]
+      },
+      "patch" : {
+        "operationId" : "updateSkill",
+        "parameters" : [ {
+          "description" : "Skill identifier",
+          "in" : "path",
+          "name" : "skillId",
+          "required" : true,
+          "schema" : {
+            "format" : "uuid",
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/SkillUpdateRequest"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/Skill"
+                }
+              }
+            },
+            "description" : "Skill updated successfully"
+          },
+          "400" : {
+            "description" : "Invalid request body"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden"
+          },
+          "404" : {
+            "description" : "SKILL_NOT_FOUND"
+          },
+          "409" : {
+            "description" : "SKILL_SLUG_ALREADY_EXISTS"
+          }
+        },
+        "summary" : "Update a skill",
+        "tags" : [ "skills" ]
+      }
+    },
+    "/agents/{agentId}/skills" : {
+      "get" : {
+        "operationId" : "getAgentSkills",
+        "parameters" : [ {
+          "description" : "ID of the agent",
+          "in" : "path",
+          "name" : "agentId",
+          "required" : true,
+          "schema" : {
+            "format" : "uuid",
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "items" : {
+                    "$ref" : "#/components/schemas/Skill"
+                  },
+                  "type" : "array"
+                }
+              }
+            },
+            "description" : "List of skills assigned to the agent"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden"
+          },
+          "404" : {
+            "description" : "AGENT_NOT_FOUND"
+          }
+        },
+        "summary" : "Get skills assigned to an agent",
+        "tags" : [ "skills" ]
+      },
+      "post" : {
+        "operationId" : "assignSkillToAgent",
+        "parameters" : [ {
+          "description" : "ID of the agent",
+          "in" : "path",
+          "name" : "agentId",
+          "required" : true,
+          "schema" : {
+            "format" : "uuid",
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/SkillAssignRequest"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "200" : {
+            "description" : "Skill assigned (or already assigned — idempotent)"
+          },
+          "400" : {
+            "description" : "Invalid request body"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden — SKILL_ORG_MISMATCH if skill belongs to a different org"
+          },
+          "404" : {
+            "description" : "AGENT_NOT_FOUND or SKILL_NOT_FOUND"
+          }
+        },
+        "summary" : "Assign a skill to an agent",
+        "tags" : [ "skills" ]
+      }
+    },
+    "/agents/{agentId}/skills/{skillId}" : {
+      "delete" : {
+        "operationId" : "unassignSkillFromAgent",
+        "parameters" : [ {
+          "description" : "ID of the agent",
+          "in" : "path",
+          "name" : "agentId",
+          "required" : true,
+          "schema" : {
+            "format" : "uuid",
+            "type" : "string"
+          }
+        }, {
+          "description" : "Skill identifier",
+          "in" : "path",
+          "name" : "skillId",
+          "required" : true,
+          "schema" : {
+            "format" : "uuid",
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "204" : {
+            "description" : "Skill unassigned successfully"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden"
+          },
+          "404" : {
+            "description" : "AGENT_NOT_FOUND or assignment not found"
+          }
+        },
+        "summary" : "Unassign a skill from an agent",
+        "tags" : [ "skills" ]
+      }
+    },
+    "/remote/pin-requests" : {
+      "post" : {
+        "description" : "Creates a PIN request for remote access",
+        "operationId" : "createPinRequest",
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/PinRequest"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "201" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/BodyWithMessage"
+                }
+              }
+            },
+            "description" : "PIN request created successfully"
+          },
+          "400" : {
+            "description" : "Invalid request format"
+          },
+          "404" : {
+            "description" : "User not found"
+          },
+          "500" : {
+            "description" : "Server error"
+          }
+        },
+        "summary" : "Create a remote access PIN request",
+        "tags" : [ "remotes" ]
       }
     },
     "/agents/{agentId}/prompts/flows" : {
@@ -7564,6 +8155,16 @@
           "type" : "string"
         }
       },
+      "skillIdPath" : {
+        "description" : "Skill identifier",
+        "in" : "path",
+        "name" : "skillId",
+        "required" : true,
+        "schema" : {
+          "format" : "uuid",
+          "type" : "string"
+        }
+      },
       "async" : {
         "description" : "If true, run the operation in async mode (poll the ressource then).",
         "in" : "query",
@@ -10800,6 +11401,84 @@
         "enum" : [ "SCRAPING", "PENDING", "UPLOADED", "PROCESSING", "INDEXED" ],
         "type" : "string"
       },
+      "KnowledgeBaseConfiguration" : {
+        "properties" : {
+          "host" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "scheme" : {
+            "enum" : [ "http", "https" ],
+            "nullable" : true,
+            "type" : "string"
+          },
+          "authentication" : {
+            "$ref" : "#/components/schemas/KnowledgeBaseConfiguration_authentication"
+          },
+          "indexName" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "colpaliKnowledgeBaseId" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "emptyKnowledgeResult" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "additionalInstructions" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "fusionType" : {
+            "enum" : [ "rankedFusion", "relativeScoreFusion" ],
+            "nullable" : true,
+            "type" : "string"
+          },
+          "toolDescription" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "toolParametersQueryDescription" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "scoreThreshold" : {
+            "nullable" : true,
+            "type" : "number"
+          },
+          "maxDocuments" : {
+            "nullable" : true,
+            "type" : "number"
+          },
+          "maxRetrievalLength" : {
+            "nullable" : true,
+            "type" : "number"
+          },
+          "vectorizerModel" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "vectorizerModelDimensions" : {
+            "nullable" : true,
+            "type" : "number"
+          },
+          "embeddingProviderId" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "embeddingModelId" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "embeddingDimensions" : {
+            "nullable" : true,
+            "type" : "number"
+          }
+        },
+        "type" : "object"
+      },
       "KnowledgeFilesByIdsRequest" : {
         "properties" : {
           "ids" : {
@@ -10813,6 +11492,21 @@
         "required" : [ "ids" ],
         "type" : "object"
       },
+      "KnowledgeFilePagePreview" : {
+        "properties" : {
+          "url" : {
+            "type" : "string"
+          },
+          "key" : {
+            "type" : "string"
+          },
+          "pageIndex" : {
+            "type" : "integer"
+          }
+        },
+        "required" : [ "pageIndex", "url" ],
+        "type" : "object"
+      },
       "ToolCreateRequest" : {
         "additionalProperties" : false,
         "properties" : {
@@ -10998,6 +11692,105 @@
         "title" : "RevealTokenResponse",
         "type" : "object"
       },
+      "Skill" : {
+        "properties" : {
+          "id" : {
+            "format" : "uuid",
+            "type" : "string"
+          },
+          "orgId" : {
+            "format" : "uuid",
+            "type" : "string"
+          },
+          "name" : {
+            "type" : "string"
+          },
+          "slug" : {
+            "type" : "string"
+          },
+          "description" : {
+            "type" : "string"
+          },
+          "content" : {
+            "type" : "string"
+          },
+          "isActive" : {
+            "type" : "boolean"
+          },
+          "createdBy" : {
+            "format" : "uuid",
+            "nullable" : true,
+            "type" : "string"
+          },
+          "createdAt" : {
+            "format" : "date-time",
+            "type" : "string"
+          },
+          "updatedAt" : {
+            "format" : "date-time",
+            "type" : "string"
+          }
+        },
+        "required" : [ "content", "description", "id", "isActive", "name", "orgId", "slug" ],
+        "type" : "object"
+      },
+      "SkillCreateRequest" : {
+        "additionalProperties" : false,
+        "properties" : {
+          "orgId" : {
+            "format" : "uuid",
+            "type" : "string"
+          },
+          "name" : {
+            "maxLength" : 255,
+            "minLength" : 1,
+            "type" : "string"
+          },
+          "slug" : {
+            "pattern" : "^[a-z0-9]+(?:-[a-z0-9]+)*$",
+            "type" : "string"
+          },
+          "description" : {
+            "type" : "string"
+          },
+          "content" : {
+            "type" : "string"
+          }
+        },
+        "required" : [ "content", "description", "name", "orgId", "slug" ],
+        "type" : "object"
+      },
+      "SkillUpdateRequest" : {
+        "additionalProperties" : false,
+        "properties" : {
+          "name" : {
+            "maxLength" : 255,
+            "minLength" : 1,
+            "type" : "string"
+          },
+          "description" : {
+            "type" : "string"
+          },
+          "content" : {
+            "type" : "string"
+          },
+          "isActive" : {
+            "type" : "boolean"
+          }
+        },
+        "type" : "object"
+      },
+      "SkillAssignRequest" : {
+        "additionalProperties" : false,
+        "properties" : {
+          "skill_id" : {
+            "format" : "uuid",
+            "type" : "string"
+          }
+        },
+        "required" : [ "skill_id" ],
+        "type" : "object"
+      },
       "PinRequest" : {
         "properties" : {
           "user" : {
@@ -12120,6 +12913,28 @@
           "type" : "array"
         } ]
       },
+      "KnowledgeBaseConfiguration_authentication_oneOf" : {
+        "nullable" : true,
+        "properties" : {
+          "apiKey" : {
+            "type" : "string"
+          },
+          "type" : {
+            "enum" : [ "API_KEY" ],
+            "type" : "string"
+          }
+        },
+        "type" : "object"
+      },
+      "KnowledgeBaseConfiguration_authentication" : {
+        "oneOf" : [ {
+          "enum" : [ "NONE" ],
+          "nullable" : true,
+          "type" : "string"
+        }, {
+          "$ref" : "#/components/schemas/KnowledgeBaseConfiguration_authentication_oneOf"
+        } ]
+      },
       "ToolSecure_configuration" : {
         "additionalProperties" : true,
         "properties" : {