Create a knowledge base

POST

knowledge-bases

Create Kb

curl --request POST \
  --url https://api.vocily.ai/v1/knowledge-bases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Support policies",
  "description": "Refunds, delivery windows and escalation rules."
}
'

import requests

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

payload = {
    "name": "Support policies",
    "description": "Refunds, delivery windows and escalation rules."
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Support policies',
    description: 'Refunds, delivery windows and escalation rules.'
  })
};

fetch('https://api.vocily.ai/v1/knowledge-bases', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Support policies',
    'description' => 'Refunds, delivery windows and escalation rules.'
  ]),
  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"

	payload := strings.NewReader("{\n  \"name\": \"Support policies\",\n  \"description\": \"Refunds, delivery windows and escalation rules.\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.vocily.ai/v1/knowledge-bases")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Support policies\",\n  \"description\": \"Refunds, delivery windows and escalation rules.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vocily.ai/v1/knowledge-bases")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Support policies\",\n  \"description\": \"Refunds, delivery windows and escalation rules.\"\n}"

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

{
  "id": "00000013-0000-4000-8000-000000000013",
  "name": "Product FAQ",
  "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.356892+00:00"
}

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

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

{
  "code": "rate_limited"
}

Only name is required. The rest have defaults, so a minimal request is one field:

curl -X POST 'https://api.vocily.ai/v1/knowledge-bases' \
  -H 'Authorization: Bearer vk_…' -H 'Content-Type: application/json' \
  -d '{ "name": "Pricing FAQ" }'

Field
`name`	required	1-255 characters
`description`	optional	free text for your own reference
`language`	`english` \| `multilingual`	defaults to `english`
`kb_type`	`deterministic` \| `non_deterministic`	defaults to `non_deterministic`

kb_type selects how the agent retrieves from it. non_deterministic is standard retrieval: the agent synthesises an answer from the matching passages. deterministic answers only on a near-exact match and returns the stored text verbatim, which suits content that must not be paraphrased - pricing, policy wording, legal copy.

A knowledge base is created empty. Add content with POST /v1/knowledge-bases/{kb_id}/documents, then attach it to an agent by listing its id in knowledge_base_ids on PATCH /v1/agents/{agent_id}. There is no separate attach endpoint: the list is the attachment, so sending it replaces the whole set.

Authorizations

Authorization

string

header

required

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

Body

application/json

name

string

required

What to call this knowledge base.

Required string length: 1 - 255

description

string | null

Your own note about what is in it.

language

string

default:english

english or multilingual, matching the content you will upload.

Pattern: ^(english|multilingual)$

kb_type

string

default:non_deterministic

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 created 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

Create Kb

curl --request POST \
  --url https://api.vocily.ai/v1/knowledge-bases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Support policies",
  "description": "Refunds, delivery windows and escalation rules."
}
'

import requests

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

payload = {
    "name": "Support policies",
    "description": "Refunds, delivery windows and escalation rules."
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Support policies',
    description: 'Refunds, delivery windows and escalation rules.'
  })
};

fetch('https://api.vocily.ai/v1/knowledge-bases', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Support policies',
    'description' => 'Refunds, delivery windows and escalation rules.'
  ]),
  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"

	payload := strings.NewReader("{\n  \"name\": \"Support policies\",\n  \"description\": \"Refunds, delivery windows and escalation rules.\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.vocily.ai/v1/knowledge-bases")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Support policies\",\n  \"description\": \"Refunds, delivery windows and escalation rules.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vocily.ai/v1/knowledge-bases")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Support policies\",\n  \"description\": \"Refunds, delivery windows and escalation rules.\"\n}"

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

{
  "id": "00000013-0000-4000-8000-000000000013",
  "name": "Product FAQ",
  "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.356892+00:00"
}

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

{
  "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

Create a knowledge base

Authorizations

Body

Response