Create a new knowledge base
curl --request POST \
--url http://localhost:3000/api/knowledge-bases \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Product Documentation",
"description": "<string>",
"embeddingModel": "openai/text-embedding-3-small",
"chunkConfig": {
"strategy": "recursive",
"size": 512,
"overlap": 50
}
}
'import requests
url = "http://localhost:3000/api/knowledge-bases"
payload = {
"name": "Product Documentation",
"description": "<string>",
"embeddingModel": "openai/text-embedding-3-small",
"chunkConfig": {
"strategy": "recursive",
"size": 512,
"overlap": 50
}
}
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: 'Product Documentation',
description: '<string>',
embeddingModel: 'openai/text-embedding-3-small',
chunkConfig: {strategy: 'recursive', size: 512, overlap: 50}
})
};
fetch('http://localhost:3000/api/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_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/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' => 'Product Documentation',
'description' => '<string>',
'embeddingModel' => 'openai/text-embedding-3-small',
'chunkConfig' => [
'strategy' => 'recursive',
'size' => 512,
'overlap' => 50
]
]),
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 := "http://localhost:3000/api/knowledge-bases"
payload := strings.NewReader("{\n \"name\": \"Product Documentation\",\n \"description\": \"<string>\",\n \"embeddingModel\": \"openai/text-embedding-3-small\",\n \"chunkConfig\": {\n \"strategy\": \"recursive\",\n \"size\": 512,\n \"overlap\": 50\n }\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("http://localhost:3000/api/knowledge-bases")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Product Documentation\",\n \"description\": \"<string>\",\n \"embeddingModel\": \"openai/text-embedding-3-small\",\n \"chunkConfig\": {\n \"strategy\": \"recursive\",\n \"size\": 512,\n \"overlap\": 50\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/knowledge-bases")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Product Documentation\",\n \"description\": \"<string>\",\n \"embeddingModel\": \"openai/text-embedding-3-small\",\n \"chunkConfig\": {\n \"strategy\": \"recursive\",\n \"size\": 512,\n \"overlap\": 50\n }\n}"
response = http.request(request)
puts response.read_bodyKnowledge Base
Create a new knowledge base
POST
/
api
/
knowledge-bases
Create a new knowledge base
curl --request POST \
--url http://localhost:3000/api/knowledge-bases \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Product Documentation",
"description": "<string>",
"embeddingModel": "openai/text-embedding-3-small",
"chunkConfig": {
"strategy": "recursive",
"size": 512,
"overlap": 50
}
}
'import requests
url = "http://localhost:3000/api/knowledge-bases"
payload = {
"name": "Product Documentation",
"description": "<string>",
"embeddingModel": "openai/text-embedding-3-small",
"chunkConfig": {
"strategy": "recursive",
"size": 512,
"overlap": 50
}
}
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: 'Product Documentation',
description: '<string>',
embeddingModel: 'openai/text-embedding-3-small',
chunkConfig: {strategy: 'recursive', size: 512, overlap: 50}
})
};
fetch('http://localhost:3000/api/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_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/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' => 'Product Documentation',
'description' => '<string>',
'embeddingModel' => 'openai/text-embedding-3-small',
'chunkConfig' => [
'strategy' => 'recursive',
'size' => 512,
'overlap' => 50
]
]),
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 := "http://localhost:3000/api/knowledge-bases"
payload := strings.NewReader("{\n \"name\": \"Product Documentation\",\n \"description\": \"<string>\",\n \"embeddingModel\": \"openai/text-embedding-3-small\",\n \"chunkConfig\": {\n \"strategy\": \"recursive\",\n \"size\": 512,\n \"overlap\": 50\n }\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("http://localhost:3000/api/knowledge-bases")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Product Documentation\",\n \"description\": \"<string>\",\n \"embeddingModel\": \"openai/text-embedding-3-small\",\n \"chunkConfig\": {\n \"strategy\": \"recursive\",\n \"size\": 512,\n \"overlap\": 50\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/knowledge-bases")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Product Documentation\",\n \"description\": \"<string>\",\n \"embeddingModel\": \"openai/text-embedding-3-small\",\n \"chunkConfig\": {\n \"strategy\": \"recursive\",\n \"size\": 512,\n \"overlap\": 50\n }\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Knowledge base name
Required string length:
1 - 128Example:
"Product Documentation"
Knowledge base description
Maximum string length:
2000Embedding model identifier
Example:
"openai/text-embedding-3-small"
Chunk configuration
Show child attributes
Show child attributes
Response
Knowledge base created successfully
⌘I