Update a knowledge base
curl --request PUT \
--url https://api.orbit.devotel.io/api/v1/knowledge-bases/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Support Help Center (EN)",
"refresh_schedule": "weekly"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/knowledge-bases/{id}"
payload = {
"name": "Support Help Center (EN)",
"refresh_schedule": "weekly"
}
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: 'Support Help Center (EN)', refresh_schedule: 'weekly'})
};
fetch('https://api.orbit.devotel.io/api/v1/knowledge-bases/{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://api.orbit.devotel.io/api/v1/knowledge-bases/{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' => 'Support Help Center (EN)',
'refresh_schedule' => 'weekly'
]),
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://api.orbit.devotel.io/api/v1/knowledge-bases/{id}"
payload := strings.NewReader("{\n \"name\": \"Support Help Center (EN)\",\n \"refresh_schedule\": \"weekly\"\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://api.orbit.devotel.io/api/v1/knowledge-bases/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Support Help Center (EN)\",\n \"refresh_schedule\": \"weekly\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/knowledge-bases/{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\": \"Support Help Center (EN)\",\n \"refresh_schedule\": \"weekly\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"status": "<string>",
"document_count": 123,
"chunk_count": 123,
"refresh_schedule": "manual",
"next_refresh_at": "2023-11-07T05:31:56Z",
"last_refresh_at": "2023-11-07T05:31:56Z",
"config": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Knowledge Bases
Update a knowledge base
Update a knowledge base’s name, description, config, or refresh cadence. Only the fields you send are changed; omitted fields keep their current value. Returns the updated base. Requires the knowledge:write scope (admin / owner / developer).
PUT
/
api
/
v1
/
knowledge-bases
/
{id}
Update a knowledge base
curl --request PUT \
--url https://api.orbit.devotel.io/api/v1/knowledge-bases/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Support Help Center (EN)",
"refresh_schedule": "weekly"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/knowledge-bases/{id}"
payload = {
"name": "Support Help Center (EN)",
"refresh_schedule": "weekly"
}
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: 'Support Help Center (EN)', refresh_schedule: 'weekly'})
};
fetch('https://api.orbit.devotel.io/api/v1/knowledge-bases/{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://api.orbit.devotel.io/api/v1/knowledge-bases/{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' => 'Support Help Center (EN)',
'refresh_schedule' => 'weekly'
]),
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://api.orbit.devotel.io/api/v1/knowledge-bases/{id}"
payload := strings.NewReader("{\n \"name\": \"Support Help Center (EN)\",\n \"refresh_schedule\": \"weekly\"\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://api.orbit.devotel.io/api/v1/knowledge-bases/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Support Help Center (EN)\",\n \"refresh_schedule\": \"weekly\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/knowledge-bases/{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\": \"Support Help Center (EN)\",\n \"refresh_schedule\": \"weekly\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"status": "<string>",
"document_count": 123,
"chunk_count": 123,
"refresh_schedule": "manual",
"next_refresh_at": "2023-11-07T05:31:56Z",
"last_refresh_at": "2023-11-07T05:31:56Z",
"config": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Path Parameters
Knowledge base ID (kb_…).
Body
application/json
New name for the knowledge base.
Maximum string length:
200New summary of what this base contains.
Maximum string length:
1000New recurring re-scrape cadence for external-source documents.
Available options:
manual, hourly, daily, weekly Replacement configuration blob (source connectors, search config).
⌘I