Skip to main content
PUT
/
user
/
knowledgebases
/
{id}
Update knowledgebase
curl --request PUT \
  --url https://app.botrep.ai/api/user/knowledgebases/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
import requests

url = "https://app.botrep.ai/api/user/knowledgebases/{id}"

payload = {
"name": "<string>",
"description": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', description: '<string>'})
};

fetch('https://app.botrep.ai/api/user/knowledgebases/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://app.botrep.ai/api/user/knowledgebases/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://app.botrep.ai/api/user/knowledgebases/{id}"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://app.botrep.ai/api/user/knowledgebases/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.botrep.ai/api/user/knowledgebases/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "message": "Knowledgebase updated successfully.",
  "data": {
    "id": 1,
    "name": "Updated Product Documentation",
    "description": "Updated description for our technical docs",
    "status": "active",
    "status_label": "Active",
    "updated_at": "2025-01-08T15:45:00.000000Z"
  }
}
{
  "error": "Knowledgebase not found."
}
{
  "message": "The name may not be greater than 255 characters.",
  "errors": {
    "name": [
      "The name may not be greater than 255 characters."
    ]
  }
}
This endpoint updates the name and/or description of an existing knowledgebase.

Path Parameters

id
integer
required
The unique identifier of the knowledgebase to update

Request Body

name
string
The new name for the knowledgebase (max 255 characters)
description
string
The new description for the knowledgebase (max 255 characters)

Response

message
string
Success message
data
object
The updated knowledgebase object
{
  "message": "Knowledgebase updated successfully.",
  "data": {
    "id": 1,
    "name": "Updated Product Documentation",
    "description": "Updated description for our technical docs",
    "status": "active",
    "status_label": "Active",
    "updated_at": "2025-01-08T15:45:00.000000Z"
  }
}
{
  "error": "Knowledgebase not found."
}
{
  "message": "The name may not be greater than 255 characters.",
  "errors": {
    "name": [
      "The name may not be greater than 255 characters."
    ]
  }
}
Updating a knowledgebase’s name or description does not affect its documents or processing status.