Skip to main content
PATCH
/
v1
/
knowledge-bases
/
{id}
Update knowledge base entry
curl --request PATCH \
  --url https://api.topcalls.ai/v1/knowledge-bases/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "content": "<string>",
  "custom_description": "<string>"
}
'
import requests

url = "https://api.topcalls.ai/v1/knowledge-bases/{id}"

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

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

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

fetch('https://api.topcalls.ai/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.topcalls.ai/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 => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'content' => '<string>',
'custom_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://api.topcalls.ai/v1/knowledge-bases/{id}"

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

req, _ := http.NewRequest("PATCH", 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.patch("https://api.topcalls.ai/v1/knowledge-bases/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"content\": \"<string>\",\n \"custom_description\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.topcalls.ai/v1/knowledge-bases/{id}")

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

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

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "custom_description": "<string>",
  "content": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"code": "<string>",
"instance": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"errors": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"details": "<string>"
}
{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"code": "<string>",
"instance": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"errors": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"details": "<string>"
}
{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"code": "<string>",
"instance": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"errors": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"details": "<string>"
}
{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"code": "<string>",
"instance": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"errors": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"details": "<string>"
}
{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"code": "<string>",
"instance": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"errors": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"details": "<string>"
}
{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"code": "<string>",
"instance": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"errors": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"details": "<string>"
}

Authorizations

Authorization
string
header
required

Use Authorization: Bearer tc_live_xxxxx

Headers

Idempotency-Key
string

Optional client-supplied idempotency key. When present, the gateway caches the response for 24 hours and returns the same response on retried requests with the same key (account-scoped). Safe for retries on network blips. Format: 8-255 ASCII characters from [A-Za-z0-9_-].

Required string length: 8 - 255
Pattern: ^[A-Za-z0-9_-]+$
Example:

"a1b2c3d4-e5f6-7890-abcd-ef0123456789"

Path Parameters

id
string<uuid>
required

Body

application/json

Every field is optional, but the body must include at least one.

name
string
Required string length: 1 - 100
content
string
Required string length: 50 - 10000
description_category
enum<string>

Category label for a knowledge base entry. Use custom with a custom_description for a free-form label.

Available options:
company_information,
product_catalog,
service_offerings,
restaurant_menu,
cocktail_bar_menu,
real_estate_properties,
faq_support,
pricing_packages,
policies_procedures,
contact_information,
custom,
residential_properties,
commercial_properties,
luxury_properties,
property_features,
food_menu,
bar_cocktails,
restaurant_location,
restaurant_hours,
restaurant_events,
business_header,
real_estate_header,
restaurant_header,
products_services_header,
support_header
custom_description
string | null
Required string length: 1 - 100

Response

OK

id
string<uuid>
required
account_id
string<uuid>
required
name
string
required
description_category
enum<string>
required

Category label for a knowledge base entry. Use custom with a custom_description for a free-form label.

Available options:
company_information,
product_catalog,
service_offerings,
restaurant_menu,
cocktail_bar_menu,
real_estate_properties,
faq_support,
pricing_packages,
policies_procedures,
contact_information,
custom,
residential_properties,
commercial_properties,
luxury_properties,
property_features,
food_menu,
bar_cocktails,
restaurant_location,
restaurant_hours,
restaurant_events,
business_header,
real_estate_header,
restaurant_header,
products_services_header,
support_header
custom_description
string | null
required
content
string
required
status
enum<string>
required

Processing status. Entries are usable once they carry content.

Available options:
draft,
processing,
active,
failed,
archived,
updating
created_at
string<date-time>
required
updated_at
string<date-time>
required