Skip to main content
POST
/
knowledge-bases
Creates a Knowledge Base.
curl --request POST \
  --url https://api.totoy.ai/v1/knowledge-bases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Totoy Customer Support Assistant",
  "instructions": "You are a customer support assistant for the customers of the company Totoy.",
  "project_id": "pj_avX7imfLaPcQnv5ckvGlOEBA9"
}
'
import requests

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

payload = {
"name": "Totoy Customer Support Assistant",
"instructions": "You are a customer support assistant for the customers of the company Totoy.",
"project_id": "pj_avX7imfLaPcQnv5ckvGlOEBA9"
}
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: 'Totoy Customer Support Assistant',
instructions: 'You are a customer support assistant for the customers of the company Totoy.',
project_id: 'pj_avX7imfLaPcQnv5ckvGlOEBA9'
})
};

fetch('https://api.totoy.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.totoy.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' => 'Totoy Customer Support Assistant',
'instructions' => 'You are a customer support assistant for the customers of the company Totoy.',
'project_id' => 'pj_avX7imfLaPcQnv5ckvGlOEBA9'
]),
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.totoy.ai/v1/knowledge-bases"

payload := strings.NewReader("{\n \"name\": \"Totoy Customer Support Assistant\",\n \"instructions\": \"You are a customer support assistant for the customers of the company Totoy.\",\n \"project_id\": \"pj_avX7imfLaPcQnv5ckvGlOEBA9\"\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.totoy.ai/v1/knowledge-bases")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Totoy Customer Support Assistant\",\n \"instructions\": \"You are a customer support assistant for the customers of the company Totoy.\",\n \"project_id\": \"pj_avX7imfLaPcQnv5ckvGlOEBA9\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.totoy.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\": \"Totoy Customer Support Assistant\",\n \"instructions\": \"You are a customer support assistant for the customers of the company Totoy.\",\n \"project_id\": \"pj_avX7imfLaPcQnv5ckvGlOEBA9\"\n}"

response = http.request(request)
puts response.read_body
{
  "knowledge_base_id": "kb_feMfJbeqbAEj4u8K5HqmKpUbY",
  "name": "Totoy Customer Support Assistant",
  "instructions": "You are a customer support assistant for the customers of the company Totoy.",
  "project_id": "pj_avX7imfLaPcQnv5ckvGlOEBA9",
  "created_at": "2023-07-05T12:00:00Z",
  "updated_at": "2023-07-05T12:00:00Z"
}
{
"type": "https://docs.totoy.ai/probs/out-of-credit",
"title": "You do not have enough credit.",
"status": 403,
"detail": "You do not have enough credit to perform this operation.",
"instance": "/projects/pj_avX7imfLaPcQnv5ckvGlOEBA9"
}
{
"type": "https://docs.totoy.ai/probs/out-of-credit",
"title": "You do not have enough credit.",
"status": 403,
"detail": "You do not have enough credit to perform this operation.",
"instance": "/projects/pj_avX7imfLaPcQnv5ckvGlOEBA9"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string

The name for the Knowledge Base

Maximum string length: 256
Example:

"Totoy Customer Support Assistant"

instructions
string

The instructions for the Knowledge Base.

Maximum string length: 4096
Example:

"You are a customer support assistant for the customers of the company Totoy."

project_id
string

The unique identifier for the Project that the Knowledge Base will be assigned to. If no project_id is provided, the Knowledge Base will be assigned to the default Project.

Maximum string length: 28
Pattern: ^pj_[a-zA-Z0-9]{25}$
Example:

"pj_avX7imfLaPcQnv5ckvGlOEBA9"

Response

OK

knowledge_base_id
string
required

The unique identifier for the Knowledge Base.

Maximum string length: 28
Pattern: ^kb_[a-zA-Z0-9]{25}$
Example:

"kb_feMfJbeqbAEj4u8K5HqmKpUbY"

name
string
required

The name for the Knowledge Base.

Maximum string length: 256
Example:

"Totoy Customer Support Assistant"

created_at
string<date-time>
required

The date-time of when the Knowledge Base was created, in ISO 8601 format.

Example:

"2023-07-05T12:00:00Z"

updated_at
string<date-time>
required

The date-time of when the Knowledge Base was last modified, in ISO 8601 format.

Example:

"2023-07-05T12:00:00Z"

instructions
string
required

The instructions for the Knowledge Base.

Maximum string length: 4096
Example:

"You are a customer support assistant for the customers of the company Totoy."

project_id
string
required

The unique identifier for the Project that the Knowledge Base is assigned to.

Maximum string length: 28
Pattern: ^pj_[a-zA-Z0-9]{25}$
Example:

"pj_avX7imfLaPcQnv5ckvGlOEBA9"