Skip to main content
POST
/
v2.0
/
knowledgestores
/
{knowledgeStoreId}
/
sources
Creates a new KnowledgeSource
curl --request POST \
  --url 'https://api-trial.cognigy.ai/new/v2.0/knowledgestores/{knowledgeStoreId}/sources?api_key=' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "mysource",
  "description": "mysource description",
  "type": "url",
  "metaData": {
    "tags": [
      "tag1"
    ]
  },
  "url": "https://www.some-article.com"
}
'
{
  "knowledgeSource": {
    "name": "mysource",
    "description": "mysource description",
    "type": "url",
    "metaData": {
      "tags": [
        "tag1"
      ]
    },
    "data": {
      "_id": "x4xU6hMntv23p",
      "sys_CreatedAt": "2019-12-16T11:40:45.7212",
      "sys_UpdatedAt": "2025-10-01T07:46:04.5932",
      "Type": "FAQ"
    },
    "chunkCount": 123,
    "status": "ready",
    "connectorReference": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "_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
ā€‹
name
string

The name of the KnowledgeSource

Example:

"mysource"

ā€‹
description
string

The description about what the knowledge source contains

Example:

"mysource description"

ā€‹
type
enum<string>

The type of source for the Knowledge store

Available options:
url,
manual,
pdf,
txt,
ctxt,
extension
ā€‹
metaData
object
ā€‹
url
string

The url of the website to scrape the data from. This is only applicable for KnowledgeSources of type "url"

Example:

"https://www.some-article.com"

Response

Returns KnowledgeSource metadata object.

ā€‹
knowledgeSource
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.