Skip to main content
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?api_key=' \
  --header 'Authorization: Bearer <token>' \
  --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,
    "start": 1694518620,
    "hour": 1,
    "minute": 1,
    "weekDays": [
      0,
      3
    ]
  }
}
'
{
  "extension": "confluence",
  "version": "1.1.0",
  "type": "MyConfluenceConnector",
  "config": {},
  "name": "My Knowledge Connector",
  "schedule": {
    "enabled": true,
    "start": 1694518620,
    "hour": 1,
    "minute": 1,
    "weekDays": [
      0,
      3
    ]
  },
  "lastExecution": 1694518620,
  "lastExecutionStatus": "none",
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}

Authorizations

ā€‹
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

ā€‹
api_key
string
query
required

Supply the API Key in the Url-Query

ā€‹
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

ā€‹
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

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

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

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
ā€‹
lastExecution
integer

Unix-timestamp when the last execution was triggered

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
ā€‹
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
ā€‹
lastChangedBy
string
Required string length: 24