Skip to main content
POST
/
knowledge_bases
/
Create a new knowledge base
curl --request POST \
  --url https://api.example.com/knowledge_bases/ \
  --header 'Content-Type: application/json' \
  --header 'x-user-id: <x-user-id>' \
  --data '
{
  "name": "<string>",
  "embedding_model_config": {
    "type": "<string>",
    "credential_id": "<string>",
    "model": "<string>",
    "dimensions": 123,
    "parameters": {}
  },
  "description": ""
}
'
import requests

url = "https://api.example.com/knowledge_bases/"

payload = {
"name": "<string>",
"embedding_model_config": {
"type": "<string>",
"credential_id": "<string>",
"model": "<string>",
"dimensions": 123,
"parameters": {}
},
"description": ""
}
headers = {
"x-user-id": "<x-user-id>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'x-user-id': '<x-user-id>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
embedding_model_config: {
type: '<string>',
credential_id: '<string>',
model: '<string>',
dimensions: 123,
parameters: {}
},
description: ''
})
};

fetch('https://api.example.com/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.example.com/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' => '<string>',
'embedding_model_config' => [
'type' => '<string>',
'credential_id' => '<string>',
'model' => '<string>',
'dimensions' => 123,
'parameters' => [

]
],
'description' => ''
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-user-id: <x-user-id>"
],
]);

$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.example.com/knowledge_bases/"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"embedding_model_config\": {\n \"type\": \"<string>\",\n \"credential_id\": \"<string>\",\n \"model\": \"<string>\",\n \"dimensions\": 123,\n \"parameters\": {}\n },\n \"description\": \"\"\n}")

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

req.Header.Add("x-user-id", "<x-user-id>")
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.example.com/knowledge_bases/")
.header("x-user-id", "<x-user-id>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"embedding_model_config\": {\n \"type\": \"<string>\",\n \"credential_id\": \"<string>\",\n \"model\": \"<string>\",\n \"dimensions\": 123,\n \"parameters\": {}\n },\n \"description\": \"\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/knowledge_bases/")

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

request = Net::HTTP::Post.new(url)
request["x-user-id"] = '<x-user-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"embedding_model_config\": {\n \"type\": \"<string>\",\n \"credential_id\": \"<string>\",\n \"model\": \"<string>\",\n \"dimensions\": 123,\n \"parameters\": {}\n },\n \"description\": \"\"\n}"

response = http.request(request)
puts response.read_body
{
  "knowledge_base_id": "<string>"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Headers

x-user-id
string
required

Caller's user ID. Temporary header-based identity; will be replaced by JWT auth.

Body

application/json

Request body for creating a new knowledge base.

name
string
required

Display name of the knowledge base.

embedding_model_config
EmbeddingModelConfig · object
required

Embedding model used both at indexing and at query time. Cannot be changed after creation — switching would invalidate every previously inserted vector.

description
string
default:""

Free-form description shown in the UI.

Response

Successful Response

Response body after creating a knowledge base.

knowledge_base_id
string
required

Server-assigned knowledge base identifier.