COcognigy
Knowledge Sources
Knowledge Stores

Run a Knowledge Extension

Runs a Knowledge Extension to extract and import knowledge from external sources.

post/v2.0/knowledgestores/{knowledgeStoreId}/extensions/run

Request

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
typestring
updateKnowledgeboolean
configobject

Response

Returns KnowledgeSource metadata object.

namestring

The name of the KnowledgeSource

descriptionstring

The description about what the knowledge source contains

type'url' | 'manual' | 'pdf' | 'txt' | 'ctxt' | 'extension'

The type of source for the Knowledge store

dataobject

Custom metadata object to store additional information in the KnowledgeSource

chunkCountinteger
status'ready' | 'ingesting' | 'disabled'
connectorReferencestring uuid

The connector Id associated with the KnowledgeSource. This is only applicable for KnowledgeSources of type "extension"

referenceIdstring uuid
_idstring
createdAtinteger

Unix-timestamp

lastChangedinteger

Unix-timestamp

createdBystring
lastChangedBystring

Example response

{
  "name": "mysource",
  "description": "mysource description",
  "metaData": {
    "tags": [
      "tag1"
    ]
  },
  "data": {
    "_id": "x4xU6hMntv23p",
    "sys_CreatedAt": "2019-12-16T11:40:45.7212",
    "sys_UpdatedAt": "2025-10-01T07:46:04.5932",
    "Type": "FAQ"
  },
  "createdAt": 1694518620,
  "lastChanged": 1694518620
}

Changes

No recorded changes to this operation across all 1 revision of this API.