Get Knowledge Engine

Returns a single knowledge engine by ID

GET /api/v1/knowledge-engines/{id}

Get a knowledge engine

cURL

curl --request GET \
  --url https://api.getdecisional.ai/api/v1/knowledge-engines/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

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

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.getdecisional.ai/api/v1/knowledge-engines/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.getdecisional.ai/api/v1/knowledge-engines/{id}")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

200

{
  "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.

Path Parameters

id · string · required

Knowledge engine ID

Response

200

application/json

Knowledge engine found

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