Create a Knowledge Connector

POST

v2.0

knowledgestores

{knowledgeStoreId}

connectors

Create a Knowledge Connector

curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/knowledgestores/{knowledgeStoreId}/connectors \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "extension": "confluence",
  "version": "1.1.0",
  "type": "MyConfluenceConnector",
  "config": {},
  "name": "My Knowledge Connector",
  "schedule": {
    "enabled": true,
    "hour": 1,
    "minute": 1,
    "weekDays": [
      0,
      3
    ]
  }
}
'

import requests

url = "https://api-trial.cognigy.ai/new/v2.0/knowledgestores/{knowledgeStoreId}/connectors"

payload = {
    "extension": "confluence",
    "version": "1.1.0",
    "type": "MyConfluenceConnector",
    "config": {},
    "name": "My Knowledge Connector",
    "schedule": {
        "enabled": True,
        "hour": 1,
        "minute": 1,
        "weekDays": [0, 3]
    }
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    extension: 'confluence',
    version: '1.1.0',
    type: 'MyConfluenceConnector',
    config: {},
    name: 'My Knowledge Connector',
    schedule: {enabled: true, hour: 1, minute: 1, weekDays: [0, 3]}
  })
};

fetch('https://api-trial.cognigy.ai/new/v2.0/knowledgestores/{knowledgeStoreId}/connectors', 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-trial.cognigy.ai/new/v2.0/knowledgestores/{knowledgeStoreId}/connectors",
  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([
    'extension' => 'confluence',
    'version' => '1.1.0',
    'type' => 'MyConfluenceConnector',
    'config' => [
        
    ],
    'name' => 'My Knowledge Connector',
    'schedule' => [
        'enabled' => true,
        'hour' => 1,
        'minute' => 1,
        'weekDays' => [
                0,
                3
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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-trial.cognigy.ai/new/v2.0/knowledgestores/{knowledgeStoreId}/connectors"

	payload := strings.NewReader("{\n  \"extension\": \"confluence\",\n  \"version\": \"1.1.0\",\n  \"type\": \"MyConfluenceConnector\",\n  \"config\": {},\n  \"name\": \"My Knowledge Connector\",\n  \"schedule\": {\n    \"enabled\": true,\n    \"hour\": 1,\n    \"minute\": 1,\n    \"weekDays\": [\n      0,\n      3\n    ]\n  }\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	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-trial.cognigy.ai/new/v2.0/knowledgestores/{knowledgeStoreId}/connectors")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"extension\": \"confluence\",\n  \"version\": \"1.1.0\",\n  \"type\": \"MyConfluenceConnector\",\n  \"config\": {},\n  \"name\": \"My Knowledge Connector\",\n  \"schedule\": {\n    \"enabled\": true,\n    \"hour\": 1,\n    \"minute\": 1,\n    \"weekDays\": [\n      0,\n      3\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-trial.cognigy.ai/new/v2.0/knowledgestores/{knowledgeStoreId}/connectors")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"extension\": \"confluence\",\n  \"version\": \"1.1.0\",\n  \"type\": \"MyConfluenceConnector\",\n  \"config\": {},\n  \"name\": \"My Knowledge Connector\",\n  \"schedule\": {\n    \"enabled\": true,\n    \"hour\": 1,\n    \"minute\": 1,\n    \"weekDays\": [\n      0,\n      3\n    ]\n  }\n}"

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

{
  "extension": "confluence",
  "version": "1.1.0",
  "type": "MyConfluenceConnector",
  "config": {},
  "name": "My Knowledge Connector",
  "schedule": {
    "enabled": true,
    "start": 1694518620,
    "totalMinutes": 1,
    "hour": 1,
    "minute": 1,
    "timezone": "UTC",
    "weekDays": [
      0,
      3
    ]
  },
  "lastExecution": 1694518620,
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}

{
  "type": "Bad Request",
  "title": "Bad Request Error",
  "status": 400,
  "detail": "Validation failed. Missing payload.",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Unauthorized",
  "title": "Unauthorized Error",
  "status": 401,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 401,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Payment Required",
  "title": "Payment Required Error",
  "status": 402,
  "detail": "Validation failed. Missing payload.",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 402,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Forbidden",
  "title": "Forbidden Error",
  "status": 403,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Not Found",
  "title": "Not Found Error",
  "status": 404,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {},
  "logLevel": "error"
}

{
  "type": "Method Not Allowed",
  "title": "Method Not Allowed Error",
  "status": 405,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Conflict",
  "title": "Conflict Error",
  "status": 409,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1004,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Payload Too Large",
  "title": "Payload Too Large Error",
  "status": 413,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Internal Server Error",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Not Implemented",
  "title": "Not Implemented Error",
  "status": 501,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1009,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Bad Gateway",
  "title": "Bad Gateway Error",
  "status": 502,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Service Unavailable",
  "title": "Service Unavailable Error",
  "status": 503,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 503,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Gateway Timeout",
  "title": "Gateway Timeout Error",
  "status": 504,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

Authorizations

X-API-Key

string

header

required

Supply the API Key in the HTTP-Header

Headers

enum<string>

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Available options:

application/json,

application/hal+json,

application/xml,

text/xml,

text/csv

Path Parameters

knowledgeStoreId

string

required

The Id of the KnowledgeStore

Required string length: 24

Pattern: ^[a-z0-9]{24}$

Body

application/json

extension

string

The name of the extension

Example:

"confluence"

version

string

The version of extension identifier

Example:

"1.1.0"

type

string

The Knowledge Connector type identifier within an extension

Example:

"MyConfluenceConnector"

config

object

The configuration of the KnowledgeConnector

name

string

The name of the KnowledgeConnector

Example:

"My Knowledge Connector"

schedule

object

Show child attributes

Response

Returns KnowledgeSource metadata object.

The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.

extension

string

The name of the extension

Example:

"confluence"

version

string

The version of extension identifier

Example:

"1.1.0"

type

string

The Knowledge Connector type identifier within an extension

Example:

"MyConfluenceConnector"

config

object

The configuration of the KnowledgeConnector

name

string

The name of the KnowledgeConnector

Example:

"My Knowledge Connector"

schedule

object

Show child attributes

lastExecution

integer

Unix-timestamp when the last execution was triggered or null if never executed

Required range: 0 <= x <= 2147483647

Example:

1694518620

lastExecutionStatus

enum<string>

Last execution status of the KnowledgeConnector

Available options:

none,

queued,

active,

done,

error

_id

string

Required string length: 24

Pattern: ^[a-z0-9]{24}$

createdAt

integer

Unix-timestamp

Required range: 0 <= x <= 2147483647

Example:

1694518620

lastChanged

integer

Unix-timestamp

Required range: 0 <= x <= 2147483647

Example:

1694518620

createdBy

string

Required string length: 24

Pattern: ^[a-z0-9]{24}$

lastChangedBy

string

Required string length: 24

Pattern: ^[a-z0-9]{24}$

Last modified on July 22, 2026

Get a Knowledge ConnectorGets a Knowledge Connector from a Project.

Create a Knowledge Connector

curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/knowledgestores/{knowledgeStoreId}/connectors \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "extension": "confluence",
  "version": "1.1.0",
  "type": "MyConfluenceConnector",
  "config": {},
  "name": "My Knowledge Connector",
  "schedule": {
    "enabled": true,
    "hour": 1,
    "minute": 1,
    "weekDays": [
      0,
      3
    ]
  }
}
'

import requests

url = "https://api-trial.cognigy.ai/new/v2.0/knowledgestores/{knowledgeStoreId}/connectors"

payload = {
    "extension": "confluence",
    "version": "1.1.0",
    "type": "MyConfluenceConnector",
    "config": {},
    "name": "My Knowledge Connector",
    "schedule": {
        "enabled": True,
        "hour": 1,
        "minute": 1,
        "weekDays": [0, 3]
    }
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    extension: 'confluence',
    version: '1.1.0',
    type: 'MyConfluenceConnector',
    config: {},
    name: 'My Knowledge Connector',
    schedule: {enabled: true, hour: 1, minute: 1, weekDays: [0, 3]}
  })
};

fetch('https://api-trial.cognigy.ai/new/v2.0/knowledgestores/{knowledgeStoreId}/connectors', 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-trial.cognigy.ai/new/v2.0/knowledgestores/{knowledgeStoreId}/connectors",
  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([
    'extension' => 'confluence',
    'version' => '1.1.0',
    'type' => 'MyConfluenceConnector',
    'config' => [
        
    ],
    'name' => 'My Knowledge Connector',
    'schedule' => [
        'enabled' => true,
        'hour' => 1,
        'minute' => 1,
        'weekDays' => [
                0,
                3
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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-trial.cognigy.ai/new/v2.0/knowledgestores/{knowledgeStoreId}/connectors"

	payload := strings.NewReader("{\n  \"extension\": \"confluence\",\n  \"version\": \"1.1.0\",\n  \"type\": \"MyConfluenceConnector\",\n  \"config\": {},\n  \"name\": \"My Knowledge Connector\",\n  \"schedule\": {\n    \"enabled\": true,\n    \"hour\": 1,\n    \"minute\": 1,\n    \"weekDays\": [\n      0,\n      3\n    ]\n  }\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	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-trial.cognigy.ai/new/v2.0/knowledgestores/{knowledgeStoreId}/connectors")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"extension\": \"confluence\",\n  \"version\": \"1.1.0\",\n  \"type\": \"MyConfluenceConnector\",\n  \"config\": {},\n  \"name\": \"My Knowledge Connector\",\n  \"schedule\": {\n    \"enabled\": true,\n    \"hour\": 1,\n    \"minute\": 1,\n    \"weekDays\": [\n      0,\n      3\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-trial.cognigy.ai/new/v2.0/knowledgestores/{knowledgeStoreId}/connectors")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"extension\": \"confluence\",\n  \"version\": \"1.1.0\",\n  \"type\": \"MyConfluenceConnector\",\n  \"config\": {},\n  \"name\": \"My Knowledge Connector\",\n  \"schedule\": {\n    \"enabled\": true,\n    \"hour\": 1,\n    \"minute\": 1,\n    \"weekDays\": [\n      0,\n      3\n    ]\n  }\n}"

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

{
  "extension": "confluence",
  "version": "1.1.0",
  "type": "MyConfluenceConnector",
  "config": {},
  "name": "My Knowledge Connector",
  "schedule": {
    "enabled": true,
    "start": 1694518620,
    "totalMinutes": 1,
    "hour": 1,
    "minute": 1,
    "timezone": "UTC",
    "weekDays": [
      0,
      3
    ]
  },
  "lastExecution": 1694518620,
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}

{
  "type": "Bad Request",
  "title": "Bad Request Error",
  "status": 400,
  "detail": "Validation failed. Missing payload.",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Unauthorized",
  "title": "Unauthorized Error",
  "status": 401,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 401,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Payment Required",
  "title": "Payment Required Error",
  "status": 402,
  "detail": "Validation failed. Missing payload.",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 402,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Forbidden",
  "title": "Forbidden Error",
  "status": 403,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Not Found",
  "title": "Not Found Error",
  "status": 404,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {},
  "logLevel": "error"
}

{
  "type": "Method Not Allowed",
  "title": "Method Not Allowed Error",
  "status": 405,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Conflict",
  "title": "Conflict Error",
  "status": 409,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1004,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Payload Too Large",
  "title": "Payload Too Large Error",
  "status": 413,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Internal Server Error",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Not Implemented",
  "title": "Not Implemented Error",
  "status": 501,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1009,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Bad Gateway",
  "title": "Bad Gateway Error",
  "status": 502,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Service Unavailable",
  "title": "Service Unavailable Error",
  "status": 503,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 503,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Gateway Timeout",
  "title": "Gateway Timeout Error",
  "status": 504,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

Overview

Core Resources

Simulator

Authorizations

Headers

Path Parameters

Body

Response