Skip to main content
POST
/
api
/
v1
/
knowledge-engines
Create a new knowledge engine
curl --request POST \
  --url https://api.getdecisional.ai/api/v1/knowledge-engines \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Fintech Companies",
  "description": "Knowledge engine for processing and analyzing fintech companies",
  "notes": {
    "tags": "fintech, startups, venture capital"
  }
}
'
import requests

url = "https://api.getdecisional.ai/api/v1/knowledge-engines"

payload = {
"name": "Fintech Companies",
"description": "Knowledge engine for processing and analyzing fintech companies",
"notes": { "tags": "fintech, startups, venture capital" }
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Fintech Companies',
description: 'Knowledge engine for processing and analyzing fintech companies',
notes: {tags: 'fintech, startups, venture capital'}
})
};

fetch('https://api.getdecisional.ai/api/v1/knowledge-engines', 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.getdecisional.ai/api/v1/knowledge-engines",
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' => 'Fintech Companies',
'description' => 'Knowledge engine for processing and analyzing fintech companies',
'notes' => [
'tags' => 'fintech, startups, venture capital'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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.getdecisional.ai/api/v1/knowledge-engines"

payload := strings.NewReader("{\n \"name\": \"Fintech Companies\",\n \"description\": \"Knowledge engine for processing and analyzing fintech companies\",\n \"notes\": {\n \"tags\": \"fintech, startups, venture capital\"\n }\n}")

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

req.Header.Add("Authorization", "Basic <encoded-value>")
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.getdecisional.ai/api/v1/knowledge-engines")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Fintech Companies\",\n \"description\": \"Knowledge engine for processing and analyzing fintech companies\",\n \"notes\": {\n \"tags\": \"fintech, startups, venture capital\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.getdecisional.ai/api/v1/knowledge-engines")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Fintech Companies\",\n \"description\": \"Knowledge engine for processing and analyzing fintech companies\",\n \"notes\": {\n \"tags\": \"fintech, startups, venture capital\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "id": "kng_abc123xyz789",
  "name": "Fintech Companies",
  "description": "Knowledge engine for processing and analyzing fintech companies",
  "notes": {
    "category": "fintech"
  },
  "status": "ready",
  "created_at": 1679644800
}
{
"error": "Invalid knowledge engine name: exceeds maximum length of 50 characters"
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
name
string
required

Name of the knowledge engine

Maximum string length: 50
Example:

"Fintech Companies"

description
string

Short description of what the knowledge engine is comprised of

Example:

"Knowledge engine for processing and analyzing fintech companies"

notes
object

Custom attributes and fields

Example:
{
"tags": "fintech, startups, venture capital"
}

Response

Knowledge engine created successfully

id
string

Alphanumeric 14 character string identifier

Example:

"kng_abc123xyz789"

name
string

Name of the knowledge engine

Example:

"Fintech Companies"

description
string

Description of the knowledge engine

Example:

"Knowledge engine for processing and analyzing fintech companies"

notes
object

Custom attributes and fields

Example:
{ "category": "fintech" }
status
enum<string>

Current status of the knowledge engine

Available options:
processing,
ready
Example:

"ready"

created_at
integer<int64>

Unix timestamp when this entity was created

Example:

1679644800