Update a knowledge base

PATCH

knowledge-bases

{kb_id}

Update Kb

curl --request PATCH \
  --url https://api.vocily.ai/v1/knowledge-bases/{kb_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Support policies (2026)"
}
'

import requests

url = "https://api.vocily.ai/v1/knowledge-bases/{kb_id}"

payload = { "name": "Support policies (2026)" }
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: 'Support policies (2026)'})
};

fetch('https://api.vocily.ai/v1/knowledge-bases/{kb_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.vocily.ai/v1/knowledge-bases/{kb_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' => 'Support policies (2026)'
  ]),
  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.vocily.ai/v1/knowledge-bases/{kb_id}"

	payload := strings.NewReader("{\n  \"name\": \"Support policies (2026)\"\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.vocily.ai/v1/knowledge-bases/{kb_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Support policies (2026)\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vocily.ai/v1/knowledge-bases/{kb_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\": \"Support policies (2026)\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "00000013-0000-4000-8000-000000000013",
  "name": "Product FAQ (2026)",
  "description": "Pricing pages and the returns policy, kept in sync with the website.",
  "language": "english",
  "kb_type": "non_deterministic",
  "document_count": 0,
  "created_at": "2026-09-16T19:38:04.356892+00:00",
  "updated_at": "2026-09-16T19:38:04.384922+00:00"
}

{
  "detail": "Invalid API key",
  "code": "UNAUTHORIZED"
}

{
  "detail": "Knowledge base not found in this workspace.",
  "code": "NOT_FOUND"
}

{
  "detail": {
    "code": "validation_error",
    "message": "<string>",
    "errors": [
      {
        "field": "<string>",
        "message": "<string>",
        "type": "<string>"
      }
    ]
  },
  "code": "VALIDATION_ERROR"
}

{
  "code": "rate_limited"
}

A PATCH applies only the fields you send. Anything you omit keeps its current value, so send just what is changing:

curl -X PATCH 'https://api.vocily.ai/v1/knowledge-bases/{kb_id}' \
  -H 'Authorization: Bearer vk_…' -H 'Content-Type: application/json' \
  -d '{ "description": "Q3 pricing, incl. enterprise tiers" }'

Sending a full object you read earlier is the common mistake: any field whose value you did not intend to change is still written. kb_type in particular changes how the agent retrieves from this knowledge base, so include it only when you mean to change it.

The allowed values are the same as on create: language is english or multilingual, and kb_type is deterministic or non_deterministic. Documents are not affected - editing the knowledge base does not re-run ingestion.

Authorizations

Authorization

string

header

required

Your API key as a Bearer token, e.g. Authorization: Bearer vk_….

Path Parameters

kb_id

string

required

The knowledge base's id, from POST/GET /v1/knowledge-bases.

Body

application/json

name

string | null

What to call this knowledge base.

Required string length: 1 - 255

description

string | null

Your own note about what is in it.

language

string | null

english or multilingual, matching the content you will upload.

Pattern: ^(english|multilingual)$

kb_type

string | null

non_deterministic composes an answer from matching passages; deterministic answers only on a near-exact match and returns the stored text verbatim — which suits pricing, policy and legal copy that must not be paraphrased.

Pattern: ^(deterministic|non_deterministic)$

Response

The updated knowledge base.

One knowledge base.

language and kb_type are both growing enums — match on the values you know and fall through on the rest, rather than switching exhaustively.

documents is returned by get-by-id and is null in the list, the same convention as transcript on a call.

string

required

The knowledge base's id. List it in an agent's knowledge_base_ids to attach it.

name

string

required

What it is called.

description

string | null

required

Your own note about what is in it.

language

string

required

The language its content is in.

kb_type

string

required

How answers are produced: non_deterministic composes an answer from matching passages, deterministic answers only on a near-exact match and returns the stored text verbatim — which suits pricing, policy and legal copy that must not be paraphrased.

document_count

integer

required

How many documents it holds.

created_at

string<date-time>

required

When it was created (UTC, ISO 8601).

updated_at

string<date-time>

required

When it last changed (UTC, ISO 8601).

documents

PublicKnowledgeBaseDocumentRead · object[] | null

The documents themselves, with their ingestion status.

Show child attributes

Update Kb

curl --request PATCH \
  --url https://api.vocily.ai/v1/knowledge-bases/{kb_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Support policies (2026)"
}
'

import requests

url = "https://api.vocily.ai/v1/knowledge-bases/{kb_id}"

payload = { "name": "Support policies (2026)" }
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: 'Support policies (2026)'})
};

fetch('https://api.vocily.ai/v1/knowledge-bases/{kb_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.vocily.ai/v1/knowledge-bases/{kb_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' => 'Support policies (2026)'
  ]),
  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.vocily.ai/v1/knowledge-bases/{kb_id}"

	payload := strings.NewReader("{\n  \"name\": \"Support policies (2026)\"\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.vocily.ai/v1/knowledge-bases/{kb_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Support policies (2026)\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vocily.ai/v1/knowledge-bases/{kb_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\": \"Support policies (2026)\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "00000013-0000-4000-8000-000000000013",
  "name": "Product FAQ (2026)",
  "description": "Pricing pages and the returns policy, kept in sync with the website.",
  "language": "english",
  "kb_type": "non_deterministic",
  "document_count": 0,
  "created_at": "2026-09-16T19:38:04.356892+00:00",
  "updated_at": "2026-09-16T19:38:04.384922+00:00"
}

{
  "detail": "Invalid API key",
  "code": "UNAUTHORIZED"
}

{
  "detail": "Knowledge base not found in this workspace.",
  "code": "NOT_FOUND"
}

{
  "detail": {
    "code": "validation_error",
    "message": "<string>",
    "errors": [
      {
        "field": "<string>",
        "message": "<string>",
        "type": "<string>"
      }
    ]
  },
  "code": "VALIDATION_ERROR"
}

{
  "code": "rate_limited"
}

Calls

Chats

Phone Numbers

Knowledge Bases

Files

Agents

Speech

Catalogues

Integrations

Custom Analysis

Memory

Widget

Webhooks

Update a knowledge base

Authorizations

Path Parameters

Body

Response