Knowledge Bases
Create Knowledge Base
Create a new knowledge base.
POST
/
v1
/
knowledge-bases
Create Knowledge Base
curl --request POST \
--url https://api.example.com/v1/knowledge-bases \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"embedding_model": "text-embedding-3-small",
"chunk_size": 512,
"chunk_overlap": 64
}
'import requests
url = "https://api.example.com/v1/knowledge-bases"
payload = {
"name": "<string>",
"description": "<string>",
"embedding_model": "text-embedding-3-small",
"chunk_size": 512,
"chunk_overlap": 64
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
embedding_model: 'text-embedding-3-small',
chunk_size: 512,
chunk_overlap: 64
})
};
fetch('https://api.example.com/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.example.com/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' => '<string>',
'description' => '<string>',
'embedding_model' => 'text-embedding-3-small',
'chunk_size' => 512,
'chunk_overlap' => 64
]),
CURLOPT_HTTPHEADER => [
"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.example.com/v1/knowledge-bases"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"embedding_model\": \"text-embedding-3-small\",\n \"chunk_size\": 512,\n \"chunk_overlap\": 64\n}")
req, _ := http.NewRequest("POST", url, payload)
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/v1/knowledge-bases")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"embedding_model\": \"text-embedding-3-small\",\n \"chunk_size\": 512,\n \"chunk_overlap\": 64\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/knowledge-bases")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"embedding_model\": \"text-embedding-3-small\",\n \"chunk_size\": 512,\n \"chunk_overlap\": 64\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
Body
application/json
Required string length:
1 - 255Maximum string length:
2000Maximum string length:
100Required range:
64 <= x <= 4096Required range:
0 <= x <= 512Response
Successful Response
The response is of type Response Create Knowledge Base V1 Knowledge Bases Post · object.
Was this page helpful?
⌘I
Create Knowledge Base
curl --request POST \
--url https://api.example.com/v1/knowledge-bases \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"embedding_model": "text-embedding-3-small",
"chunk_size": 512,
"chunk_overlap": 64
}
'import requests
url = "https://api.example.com/v1/knowledge-bases"
payload = {
"name": "<string>",
"description": "<string>",
"embedding_model": "text-embedding-3-small",
"chunk_size": 512,
"chunk_overlap": 64
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
embedding_model: 'text-embedding-3-small',
chunk_size: 512,
chunk_overlap: 64
})
};
fetch('https://api.example.com/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.example.com/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' => '<string>',
'description' => '<string>',
'embedding_model' => 'text-embedding-3-small',
'chunk_size' => 512,
'chunk_overlap' => 64
]),
CURLOPT_HTTPHEADER => [
"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.example.com/v1/knowledge-bases"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"embedding_model\": \"text-embedding-3-small\",\n \"chunk_size\": 512,\n \"chunk_overlap\": 64\n}")
req, _ := http.NewRequest("POST", url, payload)
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/v1/knowledge-bases")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"embedding_model\": \"text-embedding-3-small\",\n \"chunk_size\": 512,\n \"chunk_overlap\": 64\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/knowledge-bases")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"embedding_model\": \"text-embedding-3-small\",\n \"chunk_size\": 512,\n \"chunk_overlap\": 64\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}