Create a Knowledge Connector - Cognigy Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

POST

/v2.0/knowledgestores/{knowledgeStoreId}/connectors

Try it

Create a Knowledge Connector

cURL

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
    ]
  }
}
'```

### Python

```python
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)

JavaScript Fetch API

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;
}

Go

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))
}

HTTP Response Codes

Authorizations

API Key is required in the header as X-API-Key.
Supply the API Key in the HTTP-Header.

Headers

Path Parameters

Body