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"
  }
}
'
{
  "id": "kng_abc123xyz789",
  "name": "Fintech Companies",
  "description": "Knowledge engine for processing and analyzing fintech companies",
  "notes": {
    "category": "fintech"
  },
  "status": "ready",
  "created_at": 1679644800
}

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