v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB

Knowledge Connectors

Create a Knowledge Connector

Creates a Knowledge Connector.

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

Path parameters

knowledgeStoreIdstring required

The Id of the KnowledgeStore

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

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.

Request body

extensionstring

The name of the extension

versionstring

The version of extension identifier

typestring

The Knowledge Connector type identifier within an extension

configobject

The configuration of the KnowledgeConnector

namestring

The name of the KnowledgeConnector

Example request

{
  "extension": "confluence",
  "version": "1.1.0",
  "type": "MyConfluenceConnector",
  "name": "My Knowledge Connector",
  "schedule": {
    "enabled": true,
    "hour": 1,
    "minute": 1,
    "weekDays": [
      0,
      3
    ]
  }
}

Response

Returns KnowledgeSource metadata object.

extensionstring

The name of the extension

versionstring

The version of extension identifier

typestring

The Knowledge Connector type identifier within an extension

configobject

The configuration of the KnowledgeConnector

namestring

The name of the KnowledgeConnector

lastExecutioninteger

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

lastExecutionStatus'none' | 'queued' | 'active' | 'done' | 'error'

Last execution status of the KnowledgeConnector

_idstring

createdAtinteger

Unix-timestamp

lastChangedinteger

Unix-timestamp

createdBystring

lastChangedBystring

Example response

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